Remove `Configuration` #1523

ocelotl · 2021-01-12T06:15:13Z

Remove Configuration from everywhere.

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Test A

Does This PR Require a Contrib Repo Change?

Answer the following question based on these examples of changes that would require a Contrib Repo Change:

The OTel specification has changed which prompted this PR to update the method interfaces of opentelemetry-api/ or opentelemetry-sdk/
The method interfaces of opentelemetry-instrumentation/ have changed
The method interfaces of test/util have changed
Scripts in scripts/ that were copied over to the Contrib repo have changed
Configuration files that were copied over to the Contrib repo have changed (when consistency between repositories is applicable) such as in
- pyproject.toml
- isort.cfg
- .flake8
When a new .github/CODEOWNER is added
Major changes to project information, such as in:
- README.md
- CONTRIBUTING.md
Yes. - Link to PR: Remove Configuration from instrumentations opentelemetry-python-contrib#285
No.

Checklist:

Followed the style guidelines of this project
Changelogs have been updated
Unit tests have been added
Documentation has been updated

lzchen · 2021-01-13T00:36:31Z

Now that we are removing the Configuration API, should we have a single place where all of the env variables are defined?

codeboten

This looks great. Please update the changelog.

CHANGELOG.md

ocelotl · 2021-01-19T15:48:08Z

Now that we are removing the Configuration API, should we have a single place where all of the env variables are defined?

Hm, maybe...

But how would this work? Having a file with something like this:

# environment_variables.py

OTEL_PROPAGATORS = "OTEL_PROPAGATORS"
OTEL_TRACE_EXPORTER = "OTEL_TRACE_EXPORTER"
...

for other Python modules to do from opentelemetry.environment_variables import OTEL_PROPAGATORS?

We could do that, but is there any value in having that file? We pretty much are only defining constants that are named exactly after strings.

Should we include all the environment variables defined in the spec (that would make us have to keep this hypothetical file updated with the spec)?

aabmass · 2021-01-21T17:41:05Z

We should be able to generate these with that semconvgen tool eventually. The nice thing there is it updates from the spec with new/modified envvars.

We can also add sphinx docstrings in the generated code to document the envvars with .. envvar directive

codeboten

A few changes requested and some questions. Thanks for cleaning up the PR!

CHANGELOG.md

docs-requirements.txt

exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/exporter.py

opentelemetry-api/src/opentelemetry/environment_variables/__init__.py

opentelemetry-instrumentation/src/opentelemetry/instrumentation/bootstrap.py

ocelotl · 2021-01-25T18:37:04Z

I have been trying pretty much anything to fix the documentation issue. Tests pass in my laptop but fail in CI, so there will be some weird commits from my side while I try to fix this. Moving this PR to draft in the meantime, to reflect this, but feel free to leave comments if you feels like it, sorry for the inconveniences.

codeboten · 2021-01-29T01:09:18Z

Worth noting that this also fixes #1554

codeboten · 2021-01-29T01:16:12Z

CHANGELOG.md

+### Removed
+- Remove Configuration
+  ([#1523](https://github.com/open-telemetry/opentelemetry-python/pull/1523))
+


we should probably also add a changelog note about the changing variable names

codeboten · 2021-01-29T01:23:55Z

CHANGELOG.md

+### Removed
+- Remove Configuration
+  ([#1523](https://github.com/open-telemetry/opentelemetry-python/pull/1523))
+


should also contain a note about the changing args in opentelemetry-instrument

codeboten

Thanks for address my comments. I'll approve, but would like to see the updates to the changelog before merging

opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py

opentelemetry-api/src/opentelemetry/environment_variables/__init__.py

srikanthccv · 2021-01-29T16:50:17Z

opentelemetry-instrumentation/tests/test_run.py


        with patch("sys.argv", ["instrument", "-s", "my-service", "1", "2"]):
            auto_instrumentation.run()
-            self.assertEqual(environ.get("OTEL_SERVICE_NAME"), "my-service")
+            self.assertEqual(
+                environ.get(OTEL_PYTHON_SERVICE_NAME), "my-service"


Probably not in this PR scope. I believe this is used for exporter service_name param. Shouldn't we remove this env and service_name arg and rely on Resource attributes for service name.

srikanthccv · 2021-01-29T16:53:53Z

opentelemetry-sdk/tests/trace/export/test_export.py

+    OTEL_BSP_EXPORT_TIMEOUT,
+    OTEL_BSP_MAX_EXPORT_BATCH_SIZE,
+    OTEL_BSP_MAX_QUEUE_SIZE,
+    OTEL_BSP_SCHEDULE_DELAY,


Nice, didn't know you removed the _MILLIS in this PR itself. That was updated very recently in the spec. I should close #1554

This reverts commit d3fe740.

ocelotl requested a review from a team January 12, 2021 06:15

ocelotl self-assigned this Jan 12, 2021

ocelotl requested review from owais and lzchen and removed request for a team January 12, 2021 06:15

ocelotl force-pushed the issue_1494 branch 2 times, most recently from 5a584e8 to 8c69947 Compare January 12, 2021 06:18

ocelotl mentioned this pull request Jan 12, 2021

Remove Configuration from instrumentations open-telemetry/opentelemetry-python-contrib#285

Merged

10 tasks

ocelotl force-pushed the issue_1494 branch from 8c69947 to 1abcf4e Compare January 12, 2021 22:37

codeboten added the 1.0.0rc1 label Jan 14, 2021

codeboten approved these changes Jan 14, 2021

View reviewed changes

CHANGELOG.md Show resolved Hide resolved

ocelotl force-pushed the issue_1494 branch from b8d65be to acb02af Compare January 16, 2021 01:30

codeboten approved these changes Jan 19, 2021

View reviewed changes

ocelotl force-pushed the issue_1494 branch 2 times, most recently from 910986e to 73929d2 Compare January 21, 2021 16:09

ocelotl force-pushed the issue_1494 branch 5 times, most recently from ef8974b to 3123115 Compare January 22, 2021 22:16

owais approved these changes Jan 22, 2021

View reviewed changes

codeboten suggested changes Jan 23, 2021

View reviewed changes

ocelotl marked this pull request as draft January 25, 2021 18:34

srikanthccv mentioned this pull request Jan 27, 2021

Remove _MILLIS from BatchSpanProcessor env and follow duration semantic conventions #1554

Closed

ocelotl force-pushed the issue_1494 branch from 7e6cdf4 to 4ff5b75 Compare January 28, 2021 16:56

Remove duplicate entry

66739c6

ocelotl requested a review from codeboten January 28, 2021 23:21

Fix lint

1cce236

codeboten reviewed Jan 29, 2021

View reviewed changes

codeboten approved these changes Jan 29, 2021

View reviewed changes

opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py Outdated Show resolved Hide resolved

opentelemetry-api/src/opentelemetry/environment_variables/__init__.py Show resolved Hide resolved

Base automatically changed from master to main January 29, 2021 16:49

srikanthccv approved these changes Jan 29, 2021

View reviewed changes

srikanthccv reviewed Jan 29, 2021

View reviewed changes

ocelotl force-pushed the issue_1494 branch from b2b3db1 to e06d5fe Compare January 29, 2021 22:32

Rename variables to add to spec

0aff92e

ocelotl force-pushed the issue_1494 branch from e06d5fe to 0aff92e Compare January 29, 2021 22:41

ocelotl added 10 commits January 29, 2021 17:11

Try to remove cache

d3fe740

Revert "Try to remove cache"

05648ea

This reverts commit d3fe740.

Update contrib sha

6329a25

Another attempt to clear cache

a2f0e3f

And again

7e593ad

Another attempt

291179f

Try with v2 again

6bebd84

Downgrade version to clear cache and make docs tests pass

09b010c

Removed wrong path

ffe29db

Fix lint

d45bc85

codeboten approved these changes Jan 30, 2021

View reviewed changes

Merge branch 'main' into issue_1494

21134b4

codeboten merged commit 731f32c into open-telemetry:main Jan 30, 2021

srikanthccv mentioned this pull request Jan 31, 2021

Add support for exporter selection env variables OTEL_TRACE_EXPORTER and OTEL_METRICS_EXPORTER #1527

Closed

ocelotl deleted the issue_1494 branch February 1, 2021 15:58

ocelotl mentioned this pull request Feb 2, 2021

Actions cache is set to V1 for some virtual environments #1564

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove `Configuration` #1523

Remove `Configuration` #1523

ocelotl commented Jan 12, 2021 •

edited

Loading

lzchen commented Jan 13, 2021

codeboten left a comment

ocelotl commented Jan 19, 2021

aabmass commented Jan 21, 2021

codeboten left a comment

ocelotl commented Jan 25, 2021

codeboten commented Jan 29, 2021

codeboten Jan 29, 2021

codeboten Jan 29, 2021

codeboten left a comment

srikanthccv Jan 29, 2021

srikanthccv Jan 29, 2021

Remove Configuration #1523

Remove Configuration #1523

Conversation

ocelotl commented Jan 12, 2021 • edited Loading

Type of change

How Has This Been Tested?

Does This PR Require a Contrib Repo Change?

Checklist:

lzchen commented Jan 13, 2021

codeboten left a comment

Choose a reason for hiding this comment

ocelotl commented Jan 19, 2021

aabmass commented Jan 21, 2021

codeboten left a comment

Choose a reason for hiding this comment

ocelotl commented Jan 25, 2021

codeboten commented Jan 29, 2021

codeboten Jan 29, 2021

Choose a reason for hiding this comment

codeboten Jan 29, 2021

Choose a reason for hiding this comment

codeboten left a comment

Choose a reason for hiding this comment

srikanthccv Jan 29, 2021

Choose a reason for hiding this comment

srikanthccv Jan 29, 2021

Choose a reason for hiding this comment

Remove `Configuration` #1523

Remove `Configuration` #1523

ocelotl commented Jan 12, 2021 •

edited

Loading