Auto instrumentation parameters #3864
Open
+166
−25
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jeremydvoss
changed the title
xrmx
reviewed
Apr 23, 2024
opentelemetry-sdk/src/opentelemetry/sdk/_configuration/__init__.py
Outdated
Show resolved
Hide resolved
opentelemetry-sdk/src/opentelemetry/sdk/_configuration/__init__.py
Outdated
Show resolved
Hide resolved
lzchen
reviewed
Apr 25, 2024
xrmx
reviewed
May 21, 2024
opentelemetry-sdk/src/opentelemetry/sdk/_configuration/__init__.py
Outdated
Show resolved
Hide resolved
opentelemetry-sdk/src/opentelemetry/sdk/_configuration/__init__.py
Outdated
Show resolved
Hide resolved
opentelemetry-sdk/src/opentelemetry/sdk/_configuration/__init__.py
Outdated
Show resolved
Hide resolved
jeremydvoss
changed the title
6 tasks
jeremydvoss
changed the title
| @@ -38,6 +38,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 | |||
| ([#3823] (https://github.com/open-telemetry/opentelemetry-python/pull/3823)) | |||
| - Add span flags to OTLP spans and links | |||
| ([#3881](https://github.com/open-telemetry/opentelemetry-python/pull/3881)) | |||
| - Add parameters for Distros and configurators to configure autoinstrumentation | |||
There was a problem hiding this comment.
In this approach, exporters given by params would be ADDED to those from env vars. Resource attributes would be merged with those from env vars and resource detectors. Since there's only 1 sampler, param would take precedence. Same for logging_enabled.
It would be great to have this part of the description posted somewhere, though I'm not sure where. Changelog might be too concise, so just an idea:
Suggested change
| - Add parameters for Distros and configurators to configure autoinstrumentation | |
| - Add parameters for Distros and configurators to configure autoinstrumentation with environment variable merging |
tammy-baylis-swi
approved these changes
May 24, 2024
lzchen
reviewed
May 24, 2024
| @@ -1,4 +1,4 @@ | |||
| [codespell] | |||
| # skipping auto generated folders | |||
| skip = ./.tox,./.mypy_cache,./docs/_build,./target,*/LICENSE,./venv,.git,./opentelemetry-semantic-conventions | |||
| ignore-words-list = ans,ue,ot,hist,ro | |||
| ignore-words-list = ans,assertIn,ue,ot,hist,ro, | |||
There was a problem hiding this comment.
Probably don't need this anymore after #3930
lzchen
reviewed
May 24, 2024
| if log_exporter_names is None: | ||
| log_exporter_names = [] | ||
| span_exporters, metric_exporters, log_exporters = _import_exporters( | ||
| span_exporter_names + _get_exporter_names("traces"), |
There was a problem hiding this comment.
Should this be additive or should we have the in-code configuration take priority and replace entrypoints similar to how we override env var? Would users be surprised by the "default" behavior?
lzchen
reviewed
May 24, 2024
| _get_exporter_names("logs"), | ||
| def _initialize_components( | ||
| auto_instrumentation_version: Optional[str] = None, | ||
| span_exporter_names: Optional[List[str]] = None, |
There was a problem hiding this comment.
Should we stick with trace_exporter_names instead?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Currently, the only way for custom Configurators to configure is through setting or defaulting environment variables. While it makes sense for customers to configure autoinstrumentation with env vars, there is no reason Configurators should not be able to directly configure start up (exporters, samplers...etc). Exposing autoinstrumentation configuration of otel via env var defaults is invasive, confusing, and easy for users to mess up. For instance, even a blank env var or a left-over setting from previous run could interfere with a distro starting up.
In this approach, configurators can pass kwargs to _initialize_components to easily configure autoinstrumentation which currently only considers env vars.
Precedence of params over env vars
Params would be preferred over (or merged with) env vars. This follows the approach towards env vars elsewhere in OTel Python. And doing so would be necessary for custom distros to guarantee certain behavior.
In this approach, exporters given by params would be ADDED to those from env vars. Resource attributes would be merged with those from env vars and resource detectors. Since there's only 1 sampler, param would take precedence. Same for logging_enabled.