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: OpenTelemetry's document is out of date #7439

Closed
juzhiyuan opened this issue Jul 12, 2022 · 4 comments
Closed

docs: OpenTelemetry's document is out of date #7439

juzhiyuan opened this issue Jul 12, 2022 · 4 comments
Labels
doc Documentation things stale

Comments

@juzhiyuan
Copy link
Member

juzhiyuan commented Jul 12, 2022

Current State

  1. Visit this plugin's document[1][2].
  2. Check additional_attributes[0] field: It's required according to the document.
  3. Check this plugin's schema[3]. This field needs at least 1 item.
  4. Visit this plugin's document[1][2], and check How-to-enable section[4], this sample doesn't contain additional_attributes field.

[1] master branch: https://apisix.apache.org/docs/apisix/next/plugins/opentelemetry
[2] 2.14 version: https://apisix.apache.org/docs/apisix/plugins/opentelemetry
[3] https://github.com/apache/apisix/blob/master/apisix/plugins/opentelemetry.lua#L166-L171
[4] https://apisix.apache.org/docs/apisix/plugins/opentelemetry/#how-to-enable

Desired State

I'm unsure which one is correct: the attributes part or How to enable?

Also, please help check the whole document's content. Not sure if there have other misleading or wrong contents.

Other

  1. PR: feat: add opentelemetry plugin #6119
  2. Guide: https://opentelemetry.io/blog/2022/apisix/
@juzhiyuan juzhiyuan added the doc Documentation things label Jul 12, 2022
@juzhiyuan
Copy link
Member Author

Also, I suggest adding a link to it to the documentation, like https://opentelemetry.io/blog/2022/apisix/

@guitu168
Copy link
Contributor

The documentation should say that if additional_attributes is enabled then additional_attributes[0] needs to be set. We can change the additional_attributes[0] attribute description.

@github-actions
Copy link

This issue has been marked as stale due to 350 days of inactivity. It will be closed in 2 weeks if no further activity occurs. If this issue is still relevant, please simply write any comment. Even if closed, you can still revive the issue at any time or discuss it on the dev@apisix.apache.org list. Thank you for your contributions.

@github-actions github-actions bot added the stale label Jun 27, 2023
@github-actions
Copy link

This issue has been closed due to lack of activity. If you think that is incorrect, or the issue requires additional review, you can revive the issue at any time.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Jul 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation things stale
Projects
None yet
Development

No branches or pull requests

2 participants