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

Update README.md #10622

Closed
Closed

Conversation

paragniist
Copy link
Contributor

Updated README.md doc with OSHI jar configuration.

Updated README.md doc with OSHI jar configuration.
@paragniist paragniist requested a review from a team February 21, 2024 12:58
@github-actions github-actions bot requested a review from theletterf February 21, 2024 12:58
@zeitlinger
Copy link
Member

Updated README.md doc with OSHI jar configuration.

what is this needed for?

@paragniist
Copy link
Contributor Author

@zeitlinger

Resolves #1566
Add documentation for how to use the oshi instrumentation and process to setup adding oshi jar to system class path.

@zeitlinger
Copy link
Member

@zeitlinger

Resolves #1566 Add documentation for how to use the oshi instrumentation and process to setup adding oshi jar to system class path.

thanks - then I think it should go to https://github.com/open-telemetry/opentelemetry.io/tree/0b1a80f6ca8628ff6ffc62e64e5618579290b219/content/en/docs/languages/java where we're moving all user facing docs to

@laurit
Copy link
Contributor

laurit commented Feb 21, 2024

@paragniist you already have #10372 open for this, please close one of these PRs.
In #10372 (comment) I mean that you should be adding this to https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/oshi/README.md not the top level readme. I also pointed out some other shortcoming of the content. In my opinion you could get a much better result if you'd drop the chatgpt generate content and just write the instructions yourself. These instructions pretty much only need to say that download oshi-core jar and place it on the classpath so that agent could load classes from it with system class loader.

@theletterf
Copy link
Member

As Lauri says, let's continue on the other PR. This info doesn't belong to the general README. We can close this one.

@breedx-splk breedx-splk added the documentation Improvements or additions to documentation label Feb 22, 2024
@laurit laurit added the needs author feedback Waiting for additional feedback from the author label Feb 22, 2024
@paragniist
Copy link
Contributor Author

As per above input closing this PR. As there is #10372 is open for same!

@paragniist paragniist closed this Feb 22, 2024
@github-actions github-actions bot removed the needs author feedback Waiting for additional feedback from the author label Feb 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants