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.

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

docs: add documentation for Metrics API instruments #1720

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

xuan-cao-swi
Copy link
Contributor

Closes #1707

Copy link
Contributor

@kaylareopelle kaylareopelle left a comment

Choose a reason for hiding this comment

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

Thank you!

@@ -29,26 +29,123 @@ def initialize
@instrument_registry = {}
end

# Counter is a synchronous Instrument which supports non-negative increments.

Choose a reason for hiding this comment

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

What do we think about hyperlinking to the docs? I noticed some of them provide additional links and examples that may be useful. Could go either way!

Suggested change
# Counter is a synchronous Instrument which supports non-negative increments.
# {https://opentelemetry.io/docs/specs/otel/metrics/api/#counter Counter} is a synchronous Instrument which supports non-negative increments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for Metrics API instruments
3 participants