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.

Sign up for GitHub

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

Jump to bottom

[receiver/otlpjsonfile] Clarify file format documentation #31888

Closed
tigrannajaryan opened this issue Mar 21, 2024 · 2 comments · Fixed by #32365
Closed

[receiver/otlpjsonfile] Clarify file format documentation #31888

tigrannajaryan opened this issue Mar 21, 2024 · 2 comments · Fixed by #32365
Assignees
@atoulme @djaglowski
Labels
documentation Improvements or additions to documentation receiver/otlpjsonfile

Comments

@tigrannajaryan
Copy link
Member

Component(s)

receiver/otlpjsonfile

Describe the issue you're reporting

The docs of the component currently say:

Please note that there is no guarantee that exact field names will remain stable. This intended for primarily for debugging Collector without setting up backends.

Given that the file format is part of the specification should we delete this phrase and refer to the spec for the expected format?
@tigrannajaryan tigrannajaryan added the needs triage New item requiring triage label Mar 21, 2024
@tigrannajaryan tigrannajaryan changed the title Clarify file format documentation [receiver/otlpjsonfile] Clarify file format documentation Mar 21, 2024
@github-actions GitHub Actions
Copy link
Contributor

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@djaglowski djaglowski added documentation Improvements or additions to documentation and removed needs triage New item requiring triage labels Mar 21, 2024
@atoulme
Copy link
Contributor

atoulme commented Mar 22, 2024

Sounds good. I will send a PR.

@github-actions github-actions bot mentioned this issue Mar 26, 2024
Closed
@atoulme atoulme mentioned this issue Apr 13, 2024
Merged
djaglowski pushed a commit that referenced this issue Apr 15, 2024
@atoulme
[chore] link otlpjsonfilereceiver to the otel spec (#32365)
707236c 
Fixes
#31888

This is a simple doc change as per the issue.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@atoulme atoulme

@djaglowski djaglowski

Labels
documentation Improvements or additions to documentation receiver/otlpjsonfile
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[chore] link otlpjsonfilereceiver to the otel spec atoulme/opentelemetry-collector-contrib
3 participants
@atoulme @tigrannajaryan @djaglowski