Observability#

This section covers monitoring, metrics, and telemetry options for the MSA Search NIM.

Metrics#

The MSA Search NIM exposes Prometheus metrics at the /v1/metrics endpoint. These metrics can be used for monitoring service health, performance, and usage patterns.

curl http://localhost:8000/v1/metrics

Telemetry#

NIM Telemetry helps NVIDIA deliver a faster, more reliable experience with greater compatibility across a wide range of environments, while maintaining strict privacy protections and giving users full control.

Benefits#

  • Enhances performance and reliability: Provides anonymous system and NIM-level insights that help NVIDIA identify bottlenecks, tune performance across hardware configurations, and improve runtime stability.

  • Improves compatibility across deployments: Helps detect and resolve version, driver, and environment compatibility issues early, reducing friction across diverse infrastructure setups.

  • Accelerates troubleshooting and bug resolution: Allows NVIDIA to diagnose errors and regressions faster, leading to quicker support response times and higher overall availability.

  • Informs smarter optimizations and future releases: Real-world, aggregated telemetry data helps guide the optimization of NIM runtimes, model packaging, and deployment workflows, ensuring updates target the scenarios that matter most to users.

  • Protects user privacy and data security: Collects only minimal, anonymous metadata, such as hardware type and NIM version. No user data, input sequences, or prediction results are collected.

  • Fully optional and configurable: Telemetry collection is disabled by default. You can toggle telemetry at any time using environment variables.

Configuration#

Environment Variable

Default

Description

NIM_TELEMETRY_MODE

0

Controls telemetry collection. Set to 0 to disable (default), set to 1 to enable.

NIM_TELEMETRY_ENABLE_LOGGING

true

Enables logging for telemetry operations. Only applicable when NIM_TELEMETRY_MODE=1.

More Information#

For more information about data privacy, what is collected, and how to configure telemetry, refer to: