Dela via

Använda öppna telemetri- och aktivitetsspårningar

Data API Builder (DAB) stöder OpenTelemetry för distribuerad spårning och mått, så att du kan övervaka och diagnostisera programmets beteende i REST, GraphQL, databasåtgärder och interna mellanprogram.

Spårning av data-API-byggare

DAB skapar OpenTelemetry "aktiviteter" för:

  • Inkommande HTTP-begäranden (REST-slutpunkter )
  • GraphQL operations
  • Database queries (per entity)
  • Interna mellanprogramssteg (t.ex. hantering av begäranden, felspårning)

Varje aktivitet innehåller detaljerade taggar (metadata), till exempel:

  • http.method, http.url, , http.querystringstatus.code
  • action.type (CRUD, GraphQL-åtgärd)
  • user.role, user-agent
  • data-source.type, data-source.name
  • api.type (REST eller GraphQL)

Fel och undantag spåras också med detaljerad information.

Mått för data-API-byggare

DAB genererar OpenTelemetry-mått som:

  • Total Requests: Counter, labeled by HTTP method, status, endpoint, and API type.
  • Errors: Counter, labeled by error type, HTTP method, status, endpoint, and API type.
  • Request Duration: Histogram (in milliseconds), labeled as above.
  • Active Requests: Up/down counter for concurrent requests.

Mått använder .NET Meter API och OpenTelemetry SDK.

Configuration

Lägg till ett open-telemetry avsnitt under runtime.telemetry i konfigurationsfilen.

{
    "runtime": {
        "telemetry": {
            "open-telemetry": {
                "enabled": true,
                "endpoint": "http://otel-collector:4317",
                "service-name": "dab",
                "exporter-protocol": "grpc"
            }
        }
    }
}

CLI Options

Configure OpenTelemetry via CLI flags:

  • dab configure --otel-enabled true
  • dab configure --otel-endpoint "http://otel-collector:4317"
  • dab configure --otel-protocol "grpc"
  • dab configure --otel-service-name "dab"
  • dab configure --otel-headers

Exportera och visualisera

Telemetri exporteras via .NET OpenTelemetry SDK till din konfigurerade serverdel, till exempel Azure Monitor eller Jaeger. Kontrollera att serverdelen körs och kan nås på den angivna endpoint.

Implementation Notes

  • Spårningar och mått omfattar alla REST-, GraphQL- och DB-åtgärder
  • Mellanprogram och felhanterare genererar också telemetri
  • Kontexten sprids via begäranden