Dela via

add-telemetry kommando

Lägg till eller uppdatera OpenTelemetry- och Azure Application Insights-inställningarna i en befintlig konfigurationsfil för Data API Builder. Om avsnittet runtime.telemetry inte finns skapas det. Ospecificerade alternativ lämnar befintliga värden oförändrade.

Anmärkning

Telemetriinställningar kan inte konfigureras med dab configure. Använd dab add-telemetry för alla runtime.telemetry ändringar.

Konceptuell vägledning och genomgångar från slutpunkt till slutpunkt finns i Använda OpenTelemetry och aktivitetsspårningar och Använda Azure Application Insights.

Syntax

dab add-telemetry [options]

Snabbblick

Option Sammanfattning
-c, --config Konfigurationsfilsökväg. Standard dab-config.json.

OpenTelemetry-avsnitt

Option Sammanfattning
--otel-enabled Aktivera eller inaktivera OpenTelemetry.
--otel-endpoint Url för OpenTelemetry-insamlaren.
--otel-protocol Exportera protokoll. Tillåtna värden: grpc, httpprotobuf.
--otel-service-name Tjänstnamnstagg på all telemetri.
--otel-headers Extra rubriker att skicka till OpenTelemetry-insamlaren.

Avsnittet Azure Application Insights

Option Sammanfattning
--app-insights-enabled Aktivera eller inaktivera Azure Application Insights.
--app-insights-conn-string Application Insights-anslutningssträng.

-c, --config

Sökväg till konfigurationsfilen. Standardvärdet dab-config.json är om det inte dab-config.<DAB_ENVIRONMENT>.json finns, där DAB_ENVIRONMENT är en miljövariabel.

Exempel

dab add-telemetry \
  --config ./my-config.json \
  --otel-enabled true

--otel-enabled

Aktivera eller inaktivera OpenTelemetry-exportören. Godkända värden: true, false.

Exempel

dab add-telemetry \
  --otel-enabled true

Resulterande konfiguration

{
  "runtime": {
    "telemetry": {
      "open-telemetry": {
        "enabled": true
      }
    }
  }
}

--otel-endpoint

URL för din OpenTelemetry-insamlare eller serverdel. För gRPC använder du http://<host>:<port>. För HTTP inkluderar du den fullständiga sökvägen, till exempel http://<host>:<port>/v1/traces.

Exempel

dab add-telemetry \
  --otel-enabled true \
  --otel-endpoint "http://localhost:4317"

Resulterande konfiguration

{
  "runtime": {
    "telemetry": {
      "open-telemetry": {
        "enabled": true,
        "endpoint": "http://localhost:4317"
      }
    }
  }
}

--otel-protocol

Exportera protokoll för OpenTelemetry-exportören. Tillåtna värden: grpc, httpprotobuf. Standardinställningen är grpc.

Exempel

dab add-telemetry \
  --otel-enabled true \
  --otel-endpoint "http://localhost:4318" \
  --otel-protocol "httpprotobuf"

Resulterande konfiguration

{
  "runtime": {
    "telemetry": {
      "open-telemetry": {
        "enabled": true,
        "endpoint": "http://localhost:4318",
        "exporter-protocol": "httpprotobuf"
      }
    }
  }
}

--otel-service-name

Tjänstnamnstagg som är kopplad till alla spårningar och mått. Visas som tjänstidentifierare i telemetrins serverdel. Standardinställningen är dab.

Exempel

dab add-telemetry \
  --otel-enabled true \
  --otel-service-name "my-dab-api"

Resulterande konfiguration

{
  "runtime": {
    "telemetry": {
      "open-telemetry": {
        "enabled": true,
        "service-name": "my-dab-api"
      }
    }
  }
}

--otel-headers

Extra HTTP-huvuden att inkludera när du exporterar telemetri till insamlaren. Använd en kommaavgränsad key=value lista. Använd det här alternativet för autentiserade insamlareslutpunkter som kräver en API-nyckel eller auktoriseringshuvud.

Exempel

dab add-telemetry \
  --otel-enabled true \
  --otel-endpoint "https://collector.example.com:4317" \
  --otel-headers "api-key=my-secret-key"

--app-insights-enabled

Aktivera eller inaktivera Telemetri för Azure Application Insights. Godkända värden: true, false.

Exempel

dab add-telemetry \
  --app-insights-enabled true

Resulterande konfiguration

{
  "runtime": {
    "telemetry": {
      "application-insights": {
        "enabled": true
      }
    }
  }
}

--app-insights-conn-string

Anslutningssträng för din Azure Application Insights-resurs. Använd en miljövariabelreferens för att undvika att begå hemligheter till källkontroll.

Varning

Hårdkoda aldrig anslutningssträngen direkt i konfigurationsfilen. Använd @env('<variable-name>') eller en hemlig chef.

Exempel

dab add-telemetry \
  --app-insights-enabled true \
  --app-insights-conn-string "@env('APP_INSIGHTS_CONN_STRING')"

Resulterande konfiguration

{
  "runtime": {
    "telemetry": {
      "application-insights": {
        "enabled": true,
        "connection-string": "@env('APP_INSIGHTS_CONN_STRING')"
      }
    }
  }
}

Fullständigt exempel: OpenTelemetry och Application Insights

I följande exempel aktiveras både OpenTelemetry och Application Insights i ett enda kommando.

dab add-telemetry \
  --otel-enabled true \
  --otel-endpoint "http://localhost:4317" \
  --otel-protocol "grpc" \
  --otel-service-name "my-dab-api" \
  --app-insights-enabled true \
  --app-insights-conn-string "@env('APP_INSIGHTS_CONN_STRING')"

Resulterande konfiguration

{
  "runtime": {
    "telemetry": {
      "open-telemetry": {
        "enabled": true,
        "endpoint": "http://localhost:4317",
        "service-name": "my-dab-api",
        "exporter-protocol": "grpc"
      },
      "application-insights": {
        "enabled": true,
        "connection-string": "@env('APP_INSIGHTS_CONN_STRING')"
      }
    }
  }
}

Relaterat innehåll

  • Last updated on