Commande add-telemetry

Ajoutez ou mettez à jour les paramètres OpenTelemetry et Azure Application Insights dans un fichier de configuration existant du générateur d’API de données. Si la runtime.telemetry section n’existe pas, elle est créée. Les options non spécifiées conservent les valeurs existantes inchangées.

Note

Les paramètres de télémétrie ne sont pas configurables avec dab configure. Utilisez-la dab add-telemetry pour toutes les runtime.telemetry modifications.

Pour obtenir des instructions conceptuelles et des procédures pas à pas de bout en bout, consultez Utiliser les traces d’activité et OpenTelemetry etUtiliser Azure Application Insights.

Syntaxe

dab add-telemetry [options]

Aperçu rapide

Choix Résumé
-c, --config Chemin du fichier de configuration. dab-config.jsonpar défaut .

Section OpenTelemetry

Choix Résumé
--otel-enabled Activez ou désactivez OpenTelemetry.
--otel-endpoint URL du point de terminaison du collecteur OpenTelemetry.
--otel-protocol Protocole d’exportation. Valeurs autorisées : grpc, httpprotobuf.
--otel-service-name Balise de nom de service sur toutes les données de télémétrie.
--otel-headers En-têtes supplémentaires à envoyer au collecteur OpenTelemetry.

Section Azure Application Insights

Choix Résumé
--app-insights-enabled Activez ou désactivez Azure Application Insights.
--app-insights-conn-string Chaîne de connexion Application Insights.

-c, --config

Chemin d'accès au fichier de configuration. Par défaut, dab-config.json sauf dab-config.<DAB_ENVIRONMENT>.json s’il existe, où DAB_ENVIRONMENT est une variable d’environnement.

Exemple

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

--otel-enabled

Activez ou désactivez l’exportateur OpenTelemetry. Valeurs acceptées : true, false.

Exemple

dab add-telemetry \
  --otel-enabled true

Configuration résultante

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

--otel-endpoint

URL de votre collecteur OpenTelemetry ou back-end. Pour gRPC, utilisez http://<host>:<port>. Pour HTTP, incluez le chemin d’accès complet, par exemple http://<host>:<port>/v1/traces.

Exemple

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

Configuration résultante

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

--otel-protocol

Exporter le protocole pour l’exportateur OpenTelemetry. Valeurs autorisées : grpc, httpprotobuf. La valeur par défaut est grpc.

Exemple

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

Configuration résultante

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

--otel-service-name

Balise de nom de service attachée à toutes les traces et métriques. Apparaît en tant qu’identificateur de service dans votre back-end de télémétrie. La valeur par défaut est dab.

Exemple

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

Configuration résultante

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

--otel-headers

En-têtes HTTP supplémentaires à inclure lors de l’exportation des données de télémétrie vers le collecteur. Utilisez une liste séparée par des virgules key=value . Utilisez cette option pour les points de terminaison de collecteur authentifiés qui nécessitent une clé API ou un en-tête d’autorisation.

Exemple

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

--app-insights-enabled

Activez ou désactivez la télémétrie Azure Application Insights. Valeurs acceptées : true, false.

Exemple

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

Configuration résultante

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

--app-insights-conn-string

Chaîne de connexion pour votre ressource Azure Application Insights. Utilisez une référence de variable d’environnement pour éviter de valider les secrets dans le contrôle de code source.

Avertissement

Ne codez jamais en dur la chaîne de connexion directement dans votre fichier de configuration. Utiliser @env('<variable-name>') ou un gestionnaire de secrets.

Exemple

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

Configuration résultante

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

Exemple complet : OpenTelemetry et Application Insights

L’exemple suivant active OpenTelemetry et Application Insights dans une seule commande.

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

Configuration résultante

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

Contenu connexe

  • Last updated on