Skip to content

Update ValueError message that is misleading - #3769

Merged
lzchen merged 7 commits into
open-telemetry:mainfrom
howardyoo:patch-3
Mar 18, 2024
Merged

Update ValueError message that is misleading#3769
lzchen merged 7 commits into
open-telemetry:mainfrom
howardyoo:patch-3

Conversation

@howardyoo

@howardyoo howardyoo commented Mar 10, 2024

Copy link
Copy Markdown
Contributor

Description

The ValueError message is misleading that it does not include infinity as accepted value as interval. The message therefore needs to be changed as developers were getting confused.

Fixes #3768

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?

The behavior can be seen when you try to set the reporting interval with Zero. However, setting the value as math.inf does work.

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 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:

  • No.

Checklist:

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

@howardyoo
howardyoo requested a review from a team March 10, 2024 04:49
Comment thread opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/export/__init__.py Outdated
@howardyoo

howardyoo commented Mar 11, 2024 via email

Copy link
Copy Markdown
Contributor Author

@tammy-baylis-swi tammy-baylis-swi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you!

@lzchen
lzchen enabled auto-merge (squash) March 14, 2024 17:19
@lzchen

lzchen commented Mar 14, 2024

Copy link
Copy Markdown
Contributor

@howardyoo

Please fix the conflicts and we can get this merged! Thanks!

Related issue: open-telemetry#3768
where error message does not include 'infinity' as one of the accepted range of values for interval.
added to changelog.md
fixed the sentence to be more concise.
auto-merge was automatically disabled March 14, 2024 18:05

Pull Request is not mergeable

@ocelotl
ocelotl enabled auto-merge (squash) March 14, 2024 19:36
auto-merge was automatically disabled March 14, 2024 19:40

Pull Request is not mergeable

@howardyoo

Copy link
Copy Markdown
Contributor Author

@howardyoo

Please fix the conflicts and we can get this merged! Thanks!

I don't see any conflicts. What are you referring to?

@lzchen
lzchen enabled auto-merge (squash) March 18, 2024 17:12
@lzchen
lzchen merged commit d5f4946 into open-telemetry:main Mar 18, 2024
ocelotl pushed a commit to ocelotl/opentelemetry-python that referenced this pull request Mar 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

PeriodicExportingMetricReader: Incorrect ValueError message of not accepting infinity as interval value

5 participants