Skip to content

Issue-1147 Adding description to the environment variables#1898

Merged
codeboten merged 5 commits intoopen-telemetry:mainfrom
rnishtala:issue_1147
Jun 21, 2021
Merged

Issue-1147 Adding description to the environment variables#1898
codeboten merged 5 commits intoopen-telemetry:mainfrom
rnishtala:issue_1147

Conversation

@rnishtala
Copy link
Copy Markdown
Contributor

@rnishtala rnishtala commented Jun 9, 2021 •
edited
Loading

Description

Added description to environment variables in the opentelemetry-specification

Fixes # 1147

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • This change requires a documentation update

How Has This Been Tested?

Documentation update only.

  • The docs test (tox) ran successfully.

Does This PR Require a Contrib Repo Change?

  • No.

Checklist:

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

@rnishtala rnishtala requested review from a team, lzchen and ocelotl and removed request for a team June 9, 2021 03:34
@linux-foundation-easycla
Copy link
Copy Markdown

linux-foundation-easycla bot commented Jun 9, 2021 •
edited
Loading

CLA Signed

The committers are authorized under a signed CLA.

codeboten
codeboten reviewed Jun 9, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

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

Thanks so much for tackling this, please sign the CLA and we should be good to go!

lzchen
lzchen reviewed Jun 9, 2021
View reviewed changes
opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py
The :envvar:`OTEL_EXPORTER_JAEGER_PASSWORD` represents the password to be used for HTTP basic authentication.
"""

OTEL_EXPORTER_JAEGER_TIMEOUT = "OTEL_EXPORTER_JAEGER_TIMEOUT"
Copy link
Copy Markdown
Contributor

@lzchen lzchen Jun 9, 2021

Choose a reason for hiding this comment

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

Missing timeout?

lzchen
lzchen reviewed Jun 9, 2021
View reviewed changes
opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py
@@ -140,16 +183,28 @@
OTEL_EXPORTER_OTLP_PROTOCOL = "OTEL_EXPORTER_OTLP_PROTOCOL"
Copy link
Copy Markdown
Contributor

@lzchen lzchen Jun 9, 2021

Choose a reason for hiding this comment

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

Missing Zipkin?

Copy link
Copy Markdown
Contributor Author

@rnishtala rnishtala Jun 10, 2021

Choose a reason for hiding this comment

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

Hey Leighton, not sure what I'm missing here (Zipkin). I plan to address all the other changes mentioned.

The following Zipkin variables are defined:

  • OTEL_EXPORTER_ZIPKIN_ENDPOINT
  • OTEL_EXPORTER_ZIPKIN_TIMEOUT

Copy link
Copy Markdown
Contributor

@ocelotl ocelotl Jun 10, 2021

Choose a reason for hiding this comment

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

Right, @rnishtala. Can you please format the default value of OTEL_EXPORTER_ZIPKIN_TIMEOUT in the same way as the rest, with Default: some_value?

Copy link
Copy Markdown
Contributor

@lzchen lzchen Jun 11, 2021

Choose a reason for hiding this comment

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

My mistake, must've missed these :)

ocelotl
ocelotl suggested changes Jun 9, 2021
View reviewed changes
ocelotl
ocelotl suggested changes Jun 10, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@ocelotl ocelotl left a comment

Choose a reason for hiding this comment

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

Looking good ✌️ Just a few changes requested.

opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py
@@ -140,16 +183,28 @@
OTEL_EXPORTER_OTLP_PROTOCOL = "OTEL_EXPORTER_OTLP_PROTOCOL"
Copy link
Copy Markdown
Contributor

@ocelotl ocelotl Jun 10, 2021

Choose a reason for hiding this comment

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

Right, @rnishtala. Can you please format the default value of OTEL_EXPORTER_ZIPKIN_TIMEOUT in the same way as the rest, with Default: some_value?

opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py Outdated
.. envvar:: OTEL_EXPORTER_OTLP_TRACES_PROTOCOL

The :envvar:`OTEL_EXPORTER_OTLP_PROTOCOL` represents the the transport protocol for spans.
There is no specified default.
Copy link
Copy Markdown
Contributor

@ocelotl ocelotl Jun 10, 2021

Choose a reason for hiding this comment

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

Suggested change
There is no specified default.

There are other environment variables that also lack a default value. Better to keep things consistent by not having this comment here.

srikanthccv
srikanthccv suggested changes Jun 11, 2021
View reviewed changes
srikanthccv
srikanthccv approved these changes Jun 12, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@srikanthccv srikanthccv left a comment

Choose a reason for hiding this comment

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

Thanks for addressing my comments.

@rnishtala
Copy link
Copy Markdown
Contributor Author

rnishtala commented Jun 12, 2021

Thanks all for reviewing this PR! I don't have permissions to merge this PR to opentelemetry:main. I am assuming that an authorized user will eventually merge this PR?

@srikanthccv
Copy link
Copy Markdown
Member

srikanthccv commented Jun 13, 2021

Thanks all for reviewing this PR! I don't have permissions to merge this PR to opentelemetry:main. I am assuming that an authorized user will eventually merge this PR?

Correct!

owais
owais reviewed Jun 14, 2021
View reviewed changes
opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py Outdated

Maximum time the Zipkin exporter will wait for each batch export, the default
timeout is 10s.
Maximum time the Zipkin exporter will wait for each batch export.
Copy link
Copy Markdown
Contributor

@owais owais Jun 14, 2021

Choose a reason for hiding this comment

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

Suggested change
Maximum time the Zipkin exporter will wait for each batch export.
Maximum time (in seconds) the Zipkin exporter will wait for each batch export.

codeboten
codeboten approved these changes Jun 16, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

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

Nice! @owais can you please take a look and ensure all your comments have been addressed.

@rnishtala
Copy link
Copy Markdown
Contributor Author

rnishtala commented Jun 20, 2021

@owais @codeboten Hey folks, I believe that I have addressed all pending comments, please let me know if there's anything else that needs looking into.

@codeboten codeboten merged commit a83b6f1 into open-telemetry:main Jun 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@owais owais owais left review comments

@lzchen lzchen lzchen approved these changes

+3 more reviewers

@codeboten codeboten codeboten approved these changes

@ocelotl ocelotl ocelotl approved these changes

@srikanthccv srikanthccv srikanthccv approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@rnishtala @srikanthccv @owais @codeboten @ocelotl @lzchen
⚡