From c4a0f44750623bfa34f75fb5175099c9171fbf0d Mon Sep 17 00:00:00 2001 From: Sylvain Hellegouarch Date: Tue, 1 Aug 2023 08:40:05 +0200 Subject: [PATCH] improved readme Signed-off-by: Sylvain Hellegouarch --- README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/README.md b/README.md index f60dc05..96ac0b7 100644 --- a/README.md +++ b/README.md @@ -96,6 +96,26 @@ You can also instrument a variety of frameworks like this: This will enable the according instrumentation automatically. +#### AWS + +This extension supports AWS X-Ray directly. Simply set the following +variable: + +``` +export OTEL_VENDOR=aws +``` + +This can also be set in the configuration block: + +```json +{ + "configuration": { + "otel_vendor": "aws" + } +} +``` + + #### Google Cloud Platform Traces If you intend on using Google Cloud Platform to export your traces to, please @@ -117,6 +137,22 @@ To authenticate the client, you can either: In all cases, point to a service account which has the `roles/cloudtrace.agent` role as nthe name of the target project. +Finally, set the following variable: + +``` +export OTEL_VENDOR=gcp +``` + +This can also be set in the configuration block: + +```json +{ + "configuration": { + "otel_vendor": "gcp" + } +} +``` + #### Azure Traces To use this package to send traces to Azure monitors, please install the @@ -129,12 +165,34 @@ $ pip install chaostoolkit-opentracing[azure] Then set the `APPLICATIONINSIGHTS_CONNECTION_STRING` environment variable appropriately. + +Finally, set the following variable: + +``` +export OTEL_VENDOR=azure +``` + +This can also be set in the configuration block: + +```json +{ + "configuration": { + "otel_vendor": "azure" + } +} +``` + See Azure documentation for more details: * https://learn.microsoft.com/en-us/python/api/overview/azure/core-tracing-opentelemetry-readme * https://learn.microsoft.com/en-us/python/api/overview/azure/monitor-opentelemetry-exporter-readme +#### Other Open Telemetry vendors + +Other vendors should work out of the box with the default settings. Otherwise, +feel free to open an issue. + ### Legacy Open Tracing This extensions supports the [Open Tracing](https://opentracing.io/) export