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

Common doc between the Java agent and the OTel starter #4758

Closed
jeanbisutti opened this issue Jun 27, 2024 · 5 comments · Fixed by #4811
Closed

Common doc between the Java agent and the OTel starter #4758

jeanbisutti opened this issue Jun 27, 2024 · 5 comments · Fixed by #4811
Assignees
Labels

Comments

@jeanbisutti
Copy link
Member

The Java agent documentation contains a section about the the capture of the HTTP request and response headers.

The OTel starter will also probably have these features in the next release.

We'd like to avoid duplicating documentation.

How proceed?

  1. Can we reuse a documentation snippet in different pages? How to do this?
  2. Should we create a page about the same configuration, and reference this page in the Java agent and OTel starter documentations?

cc @zeitlinger

@svrnm
Copy link
Member

svrnm commented Jun 27, 2024

  1. Yes, there are different options to do that, we can look into them the moment we know what exactly needs to be duplicated
  2. That would be my preferred option, to be honest. I am wondering, is this a feature of the agent, of the instrumentation libraries or where does this come from? Depending on that we can find the right place to document it.

@jeanbisutti
Copy link
Member Author

@svrnm See #4804 with the agent and starter contents duplicated

@zeitlinger
Copy link
Member

@svrnm See #4804 with the agent and starter contents duplicated

this pr doesn't duplicate - but those settings in the pr apply to the starter as well

@jeanbisutti
Copy link
Member Author

To clarify, #4804 updates the Java agent doc and the same HTTP instrumentation configuration doc should be documented for the OTel starter after the next starter release.

@jeanbisutti
Copy link
Member Author

In #4847, we have explained that some agent properties also work with the OTel starter. We can perhaps go ahead with #4847 before finding a better solution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants