Skip to content

Commit

Permalink
distro selection docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremydvoss authored and chalin committed Jun 9, 2023
1 parent 87bb7e1 commit f91c98e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
4 changes: 4 additions & 0 deletions content/en/docs/instrumentation/python/automatic/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ opentelemetry-instrument \
--metrics_exporter console \
--service_name your-service-name \
--exporter_otlp_endpoint 0.0.0.0:4317 \
--distro distro
--configurator configurator
python myapp.py
```

Expand All @@ -58,6 +60,8 @@ OTEL_SERVICE_NAME=your-service-name \
OTEL_TRACES_EXPORTER=console,otlp \
OTEL_METRICS_EXPORTER=console \
OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=0.0.0.0:4317
OTEL_PYTHON_DISTRO=distro
OTEL_PYTHON_CONFIGURATOR=configurator
opentelemetry-instrument \
python myapp.py
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Here's an example of agent configuration via configuration properties:

```sh
opentelemetry-instrument \
--distro distro \
--configurator configurator \
--traces_exporter console,otlp \
--metrics_exporter console \
--service_name your-service-name \
Expand All @@ -26,6 +28,8 @@ opentelemetry-instrument \

Here's an explanation of what each configuration does:

- `distro` specifies which distro should be loaded. Argument should be the entry point name of the desired distro. If only a single distro exists, this argument may be left out.
- `configurator` specifies which configurator should be loaded. Argument should be the entry point name of the desired configurator. If only a single configurator exists, this argument may be left out.
- `traces_exporter` specifies which traces exporter to use. In this case, traces
are being exported to `console` (stdout) and with `otlp`. The `otlp` option
tells `opentelemetry-instrument` to send the traces to an endpoint that
Expand Down Expand Up @@ -67,6 +71,10 @@ For example, `exporter_otlp_endpoint` would convert to
There are some python specific configuration options you can set by prefixing
environment variables with `OTEL_PYTHON_`.

### Selecting Distro and Configurator

In addition to the `distro` and `configurator` arguments, you can use the `OTEL_PYTHON_DISTRO` and `OTEL_PYTHON_CONFIGURATOR` environment variables. If only a single distro or configurator exists, these arguments may be left out.

### Excluded URLs

Comma-separated regexes representing which URLs to exclude across all
Expand Down

0 comments on commit f91c98e

Please sign in to comment.