Get started with auto-instrumentation¶

This guide will explain how to get started with auto-instrumentation your applications with OpenTelemetry data for Tracing, Metrics and Logs using the OpenTelemetry Agent.

The main benefit of auto-instrumentation is that is requires little to no effort on the part of the team developing the application while providing insight into popular libraries, frameworks and external services such as PostgreSQL, Redis, Kafka and HTTP clients.

Auto-instrumentation is a preferred way to get started with tracing in NAIS, and can also be used for metrics and logs collection.This type of instrumentation is available for Java, Node.js and Python applications, but can also be used for other in sdk mode where it will only set up the OpenTelemetry configuration.

Info

Auto-instrumentation is a new feature and is only available for nais applications running in GCP.

Enable auto-instrumentation for Java/Kotlin applications¶

...
spec:
  observability:
    autoInstrumentation:
      enabled: true
      runtime: java

Enable auto-instrumentation for Node.js applications¶

...
spec:
  observability:
    autoInstrumentation:
      enabled: true
      runtime: nodejs

Enable auto-instrumentation for Python applications¶

...
spec:
  observability:
    autoInstrumentation:
      enabled: true
      runtime: python

Enable auto-instrumentation for other applications¶

If your application runtime is not one of the supported runtimes or you want to instrument your application yourself you can stil get benefit from the auto instrumentation configuration.

This will only set up the OpenTelemetry configuration for the application, but it will not inject the OpenTelemetry Agent into the application.

...
spec:
  observability:
    autoInstrumentation:
      enabled: true
      runtime: sdk

Resources¶

OpenTelemetry Auto-Instrumentation Configuration Reference