Freigeben über

add-telemetry-Befehl

Fügen Sie openTelemetry- und Azure Application Insights-Einstellungen in einer vorhandenen Konfigurationsdatei des Daten-API-Generators hinzu, oder aktualisieren Sie sie. Wenn der runtime.telemetry Abschnitt nicht vorhanden ist, wird er erstellt. Nicht angegebene Optionen lassen vorhandene Werte unverändert.

Hinweis

Telemetrieeinstellungen können nicht mit dab configure. Wird für alle runtime.telemetry Änderungen verwendetdab add-telemetry.

Konzeptionelle Anleitungen und end-to-End-exemplarische Vorgehensweisen finden Sie unter "Verwenden von OpenTelemetry" und "Aktivitätsablaufverfolgungen" und"Verwenden von Azure Application Insights".

Syntax

dab add-telemetry [options]

Schnellblick

Auswahl Zusammenfassung
-c, --config Konfigurationsdateipfad. Standard-dab-config.json.

OpenTelemetry-Abschnitt

Auswahl Zusammenfassung
--otel-enabled Aktivieren oder deaktivieren Sie OpenTelemetry.
--otel-endpoint OpenTelemetry-Endpunkt-URL.
--otel-protocol Exportprotokoll. Zulässige Werte: grpc, httpprotobuf.
--otel-service-name Tag des Dienstnamens für alle Telemetriedaten.
--otel-headers Zusätzliche Kopfzeilen, die an den OpenTelemetry-Sammler gesendet werden sollen.

Abschnitt "Azure Application Insights"

Auswahl Zusammenfassung
--app-insights-enabled Aktivieren oder Deaktivieren von Azure Application Insights.
--app-insights-conn-string Application Insights-Verbindungszeichenfolge.

-c, --config

Pfad zur Konfigurationsdatei. Der Standardwert ist, dab-config.json sofern nicht dab-config.<DAB_ENVIRONMENT>.json vorhanden, wobei DAB_ENVIRONMENT es sich um eine Umgebungsvariable handelt.

Beispiel

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

--otel-enabled

Aktivieren oder deaktivieren Sie den OpenTelemetry-Exporter. Zulässige Werte: true, false.

Beispiel

dab add-telemetry \
  --otel-enabled true

Resultierende Konfiguration

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

--otel-endpoint

URL des OpenTelemetry-Sammlers oder Back-Ends. Verwenden Sie http://<host>:<port>für gRPC . Fügen Sie für HTTP den vollständigen Pfad ein, z. B http://<host>:<port>/v1/traces. .

Beispiel

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

Resultierende Konfiguration

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

--otel-protocol

Exportprotokoll für den OpenTelemetry-Exporter. Zulässige Werte: grpc, httpprotobuf. Wird standardmäßig auf grpc festgelegt.

Beispiel

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

Resultierende Konfiguration

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

--otel-service-name

Dienstnametag, das an alle Ablaufverfolgungen und Metriken angefügt ist. Wird als Dienstbezeichner in Ihrem Telemetrie-Back-End angezeigt. Wird standardmäßig auf dab festgelegt.

Beispiel

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

Resultierende Konfiguration

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

--otel-headers

Zusätzliche HTTP-Header, die beim Exportieren von Telemetrie in den Sammelvorgang eingeschlossen werden sollen. Verwenden Sie eine durch Trennzeichen getrennte key=value Liste. Verwenden Sie diese Option für authentifizierte Sammelendpunkte, für die ein API-Schlüssel oder Autorisierungsheader erforderlich ist.

Beispiel

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

--app-insights-enabled

Aktivieren oder Deaktivieren der Azure Application Insights-Telemetrie. Zulässige Werte: true, false.

Beispiel

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

Resultierende Konfiguration

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

--app-insights-conn-string

Verbindungszeichenfolge für Ihre Azure Application Insights-Ressource. Verwenden Sie einen Umgebungsvariablenverweis, um das Commit geheimer Schlüssel zur Quellcodeverwaltung zu vermeiden.

Warnung

Codieren Sie die Verbindungszeichenfolge niemals direkt in Der Konfigurationsdatei. Verwenden Sie @env('<variable-name>') einen geheimen Manager oder einen geheimen Manager.

Beispiel

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

Resultierende Konfiguration

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

Vollständiges Beispiel: OpenTelemetry und Application Insights

Im folgenden Beispiel werden sowohl OpenTelemetry als auch Application Insights in einem einzigen Befehl aktiviert.

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')"

Resultierende 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')"
      }
    }
  }
}

Verwandte Inhalte

  • Last updated on