This document is relevant for: Trn2, Trn3
Reference: Neuron Observer configuration#
Use this page to look up the type, default, and purpose of Neuron Observer Helm chart values commonly configured during the public beta. All values live under observer.* in the shared chart’s values.yaml, including fields that the chart writes to mounted component configuration files.
Note
Neuron Observer is in public beta. APIs, metric names, and installation steps can change before general availability.
Overview#
For installation examples that use the observer.* values in these tables, see How to install and configure Neuron Observer on Amazon EKS.
Daemon image and scheduling#
Value |
Type |
Default |
Purpose |
|---|---|---|---|
|
bool |
false |
Set to |
|
string |
|
Container image repository. |
|
string |
|
Container image tag. |
|
string |
|
Kubernetes image pull policy. |
|
map |
|
Schedules the daemon only on nodes labeled as containing Neuron devices. |
|
bool |
true |
Runs the daemon in the host network namespace so it can read EFA/RDMA hardware counters. The chart mounts host |
|
list |
|
Toleration for the Neuron taint. Extend it if your nodes have extra taints. |
Prometheus scraping#
The daemon always serves Prometheus metrics from /metrics on its API port. This native pull endpoint does not require observer.daemon.config.export.enabled or an OpenTelemetry collector.
Value |
Type |
Default |
Purpose |
|---|---|---|---|
|
string |
|
Value of the |
|
map |
|
Labels added to all Observer Prometheus Operator resources. |
|
bool or null |
null |
Controls creation of a |
|
duration |
|
Prometheus scrape interval. |
|
duration or null |
unset |
Optional Prometheus scrape timeout. |
|
string or null |
unset |
Overrides |
|
map |
|
Additional labels added only to the |
Grafana dashboards#
Enable the dashboard bundle to create ConfigMap resources for the cluster overview, node diagnostics, and device health dashboards. A Grafana dashboard sidecar container discovers these resources.
Value |
Type |
Default |
Purpose |
|---|---|---|---|
|
bool |
false |
Creates the three dashboard |
|
string |
|
Namespace where the chart creates the dashboard |
|
string |
|
Label key used by the Grafana dashboard sidecar to discover the |
|
string |
|
Value assigned to the dashboard discovery label. |
|
map |
|
Additional labels added to each dashboard |
|
map |
|
Annotations added to each dashboard |
Daemon runtime configuration#
The chart mounts these settings at /etc/neuron-observer/config.yaml.
Value |
Type |
Default |
Purpose |
|---|---|---|---|
|
int |
5 |
Seconds between hardware collection cycles. Must be greater than zero. |
|
string |
|
Absolute path to the procfs tree used for host and process metrics. The chart mounts the node’s |
|
bool |
true |
Reads runtime device statistics and ioctl data through |
|
bool |
true |
Reads Neuron health, device information, and ECC data from sysfs. |
|
bool |
true |
Reads the configured procfs tree for host CPU, memory, and process metrics. |
|
bool |
true |
Queries IMDS for |
|
bool |
true |
Reads EFA network counters from |
|
bool |
true |
Enables background sampling used to produce per-core latency percentile metrics. |
|
int |
50 |
Microseconds between latency-stream samples. Must be greater than zero. |
|
bool |
false |
Replays a built-in snapshot instead of collecting from hardware. Intended for testing and development. |
|
bool |
false |
Enables OTLP push from the daemon. If |
|
int |
5 |
Seconds between OTLP exports. Must be greater than zero. |
|
string or null |
unset |
Exact OTLP/HTTP metrics endpoint. A non-empty value overrides the standard OpenTelemetry endpoint environment variables and must include |
|
map or null |
unset |
Metric export mapping. Omit this value to use the built-in default, specify |
|
string |
|
Tracing filter directive. Use a level such as |
|
string |
|
|
|
string |
|
IPv4 or IPv6 address on which the daemon API listens. Use |
|
int |
7001 |
TCP port for the daemon API and native Prometheus metrics. Must be greater than zero. |
|
int |
5 |
Grace period for in-flight requests after shutdown begins. Must be greater than zero. |
|
int |
4096 |
Maximum number of fault events retained in memory for replay to reconnecting clients. |
|
int |
1000 |
Milliseconds between heartbeat frames on live event-stream connections. |
OpenTelemetry export#
When daemon export is enabled, the chart creates a separate daemon-mode OpenTelemetry collector.
These values configure the daemon collector:
Value |
Type |
Default |
Purpose |
|---|---|---|---|
|
bool |
false |
Pushes metrics to Amazon CloudWatch through the EMF exporter. |
|
string |
|
CloudWatch metric namespace. |
|
string |
|
CloudWatch Logs log group used by the EMF exporter. |
|
string |
|
CloudWatch Logs stream used by the EMF exporter. |
|
int |
1 |
CloudWatch metric storage resolution in seconds. |
|
list or null |
null |
Replaces the chart’s default EMF metric declarations when set. |
|
bool |
false |
Pushes metrics to Amazon Managed Service for Prometheus (AMP) through Prometheus remote write. |
|
string |
|
AMP workspace |
|
bool |
false |
Forwards metrics to another OTLP HTTP endpoint. |
|
string |
|
Destination OTLP HTTP endpoint. Required when this pipeline is enabled. |
|
string |
|
AWS Region used by the CloudWatch and AMP exporters. Required when either pipeline is enabled. |
Namespace#
Value |
Type |
Default |
Purpose |
|---|---|---|---|
|
bool |
false |
Creates the |
Learn more#
How to install and configure Neuron Observer on Amazon EKS — install and configure Neuron Observer on Amazon EKS.
Get started with Neuron Observer on Amazon EKS — a quickstart from installation to first metrics.
Troubleshooting and FAQs: Neuron Observer — common issues, FAQs, and beta limitations.
This document is relevant for: Trn2, Trn3