Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

distro selection docs #2788

Closed
wants to merge 2 commits into from
Closed

distro selection docs #2788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f91c98e
distro selection docs
jeremydvoss May 24, 2023
e8777b5
lint
jeremydvoss May 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions content/en/docs/instrumentation/python/automatic/_index.md
View file
Open in desktop
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
14 changes: 14 additions & 0 deletions content/en/docs/instrumentation/python/automatic/agent-config.md
View file
Open in desktop
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,12 @@ 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.
Comment on lines +31 to +36
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for someone who is not involved with the python SIG I have no idea what this should mean. What other distros are there available? What is the difference here? Are we talking about vendor-specific distros or something else?

Same for the configurator, what options to I have and why would I choose another one?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 even as someone involved I don't remember what distro vs configurator is. Would be nice to have something explaining what they are.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do have documentation (at least for distros) here. I'm not sure this is the place where we should document what a distro or a configurator is. We don't do any explanation for --traces_exporter or --metrics_exporter either.

Maybe just a link to the general documentation would be enough here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I always found the distros page you linked confusing because it replicates a lot of what is written in the automatic documentation, so we need to merge them eventually. Also, Python is the only language as far as I am aware that has this understanding of a distribution.

I have no issue with distro and configurator being documented as outlined here, but what we need is examples what options I have as an enduser, if there are currently only 1 option and they will come later, then let's postpone this for now and add it when people have a choise.

We don't do any explanation for --traces_exporter or --metrics_exporter either.

We could have them.

- `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 +75,12 @@ 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