Add OpenTelemetry SDK

Choose instrumentation approach

Azure Monitor soporta 2 primary instromentation approaches

Autoinstrumentation

Permite telemetry collection a través de config sin tener que modificar app code.

Funciona muy bien para los entornos soportados como Azure Functions o Azure Virtual Machines, pero ofrece control limitado sobre la telemetria que se recolecta, o sobre como se enriquece de datos.

Manual instrumentation

Meter el SDK en tu app code. Este approach te da full control sobre la recoleccion de telemetria, pero puede ser demasiado para situaciones simples.

Install Azure Monitor OpenTelemetry Distro

El Azure Monitor OpenTelemetry Distro es el approach recomendado para SDKs. Es una distribucion de OpenTelemetry que hace bundle del OpenTelemetry SDK con Azure Monitor exporters y librerias, en un único package.

Se distribuye como un único pip package que incluye todo

pip install azure-monitor-opentelemetry

Lo invocamos con configure_azure_monitor() en el startup. Esta llamada inicializa el tracer provider, el meter provider, el logger provider y los configura todos para exportar en Application Insights.

# Code fragment - focus on minimal OpenTelemetry setup with Azure Monitor
from azure.monitor.opentelemetry import configure_azure_monitor

configure_azure_monitor()

Understand automatic data collection

El Azure Monitor OpenTelemetry Distro automaticamente recoge telemetria de common frameworks y libraries sin tener que escribir codigo.

Esta recoleccion automatica incluye

  • requests library outgoing HTTP calls
  • urllib outgoing HTTP calls
  • Flask / Django / FastAPI: incoming HTTP requests
  • psycoph2: PostgreSQL database queries
  • Azure SDK: llamadas hechas a Azure a través del SDK
  • logging

Configure the connection string

Environment var

Usar la environment var APPLICATIONINSIGHTS_CONNECTION_STRING. Esto mantiene la config fuera del codigo

export APPLICATIONINSIGHTS_CONNECTION_STRING="InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://eastus-0.in.applicationinsights.azure.com/"

Code-based conf

Pasar la connection string directamente a configure_azure_monitor()

# Code fragment - focus on code-based connection string configuration
from azure.monitor.opentelemetry import configure_azure_monitor

configure_azure_monitor(
    connection_string="InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://eastus-0.in.applicationinsights.azure.com/"
)

Set the cloud role name

Cuando multiples servicios mandan telemetria al mismo Application Insights, cada servicio necesita un cloud role name distinto para aparecer como un nodo separado en el Application Map. Si no lo ponemos, todos los servicios aparecen como un single node.

El cloud role name deriva de service.name y service.namespace OpenTelemetry resource attributes. Juntos combinados forma el cloud role name.

como configurarlo

# Code fragment - focus on setting cloud role name via resource attributes
from azure.monitor.opentelemetry import configure_azure_monitor
from opentelemetry.sdk.resources import Resource

configure_azure_monitor(
    resource=Resource.create({
        "service.name": "embedding-service",
        "service.namespace": "rag-pipeline",
        "service.instance.id": "embedding-instance-1",
    })
)