add-telemetry příkaz

Přidejte nebo aktualizujte nastavení OpenTelemetry a Azure Application Insights v existujícím konfiguračním souboru tvůrce rozhraní Data API. runtime.telemetry Pokud oddíl neexistuje, vytvoří se. Nezadané možnosti ponechá existující hodnoty beze změny.

Poznámka:

Nastavení telemetrie není možné konfigurovat pomocí dab configure. Použije se dab add-telemetry pro všechny runtime.telemetry změny.

Koncepční pokyny a kompletní návody najdete v tématu Použití OpenTelemetry a trasování aktivit a použití Azure Application Insights.

Syntaxe

dab add-telemetry [options]

Rychlý přehled

Možnost Shrnutí
-c, --config Cesta ke konfiguračnímu souboru. Výchozí dab-config.json.

Oddíl OpenTelemetry

Možnost Shrnutí
--otel-enabled Povolte nebo zakažte OpenTelemetry.
--otel-endpoint Adresa URL koncového bodu kolektoru OpenTelemetry
--otel-protocol Exportní protokol. Povolené hodnoty: grpc, httpprotobuf.
--otel-service-name Značka názvu služby pro veškerou telemetrii
--otel-headers Další hlavičky pro odeslání do kolektoru OpenTelemetry.

Oddíl Azure Application Insights

Možnost Shrnutí
--app-insights-enabled Povolte nebo zakažte Azure Application Insights.
--app-insights-conn-string Připojovací řetězec pro „Application Insights“

-c, --config

Cesta ke konfiguračnímu souboru. Výchozí hodnota je dab-config.json , pokud dab-config.<DAB_ENVIRONMENT>.json neexistuje, kde DAB_ENVIRONMENT je proměnná prostředí.

Příklad

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

--otel-enabled

Povolte nebo zakažte vývozce OpenTelemetry. Přijaté hodnoty: true, false.

Příklad

dab add-telemetry \
  --otel-enabled true

Výsledná konfigurace

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

--otel-endpoint

Adresa URL vašeho kolektoru OpenTelemetry nebo back-endu Pro gRPC použijte http://<host>:<port>. V případě protokolu HTTP zahrňte úplnou cestu, například http://<host>:<port>/v1/traces.

Příklad

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

Výsledná konfigurace

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

--otel-protocol

Exportní protokol pro vývozce OpenTelemetry. Povolené hodnoty: grpc, httpprotobuf. Výchozí hodnota je grpc.

Příklad

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

Výsledná konfigurace

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

--otel-service-name

Značka názvu služby připojená ke všem trasování a metrikám Zobrazí se jako identifikátor služby v back-endu telemetrie. Výchozí hodnota je dab.

Příklad

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

Výsledná konfigurace

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

--otel-headers

Extra hlavičky HTTP, které se mají zahrnout při exportu telemetrie do kolektoru. Použijte čárkami oddělený key=value seznam. Tuto možnost použijte pro ověřené koncové body kolektoru, které vyžadují klíč rozhraní API nebo autorizační hlavičku.

Příklad

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

--app-insights-enabled

Povolte nebo zakažte telemetrii Azure Application Insights. Přijaté hodnoty: true, false.

Příklad

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

Výsledná konfigurace

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

--app-insights-conn-string

Připojovací řetězec pro váš prostředek Azure Application Insights Pomocí odkazu na proměnnou prostředí se vyhněte potvrzení tajných kódů do správy zdrojového kódu.

Výstraha

Nikdy pevně nezakódujte připojovací řetězec přímo v konfiguračním souboru. Použijte @env('<variable-name>') nebo správce tajných kódů.

Příklad

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

Výsledná konfigurace

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

Úplný příklad: OpenTelemetry a Application Insights

Následující příklad umožňuje OpenTelemetry i Application Insights v jednom příkazu.

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

Výsledná konfigurace

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

Související obsah

  • Last updated on