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

Explain how to change the collector in documentation #4611

Closed
RichardJECooke opened this issue Jun 6, 2024 · 8 comments
Closed

Explain how to change the collector in documentation #4611

RichardJECooke opened this issue Jun 6, 2024 · 8 comments
Labels
bug Something isn't working sig:java

Comments

@RichardJECooke
Copy link

RichardJECooke commented Jun 6, 2024

Describe the bug

On this page, https://github.com/open-telemetry/opentelemetry-java-instrumentation?tab=readme-ov-file, you say "By default, the OpenTelemetry Java agent uses OTLP exporter configured to send data to OpenTelemetry collector at http://localhost:4317." and you link three times to the Java documentation at https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config.

But nowhere on that page does it mention how to change the collector or port 4317.

  1. How do we change it?
  2. Please add this to the readme file and the documentation.
@RichardJECooke RichardJECooke added the bug Something isn't working label Jun 6, 2024
@RichardJECooke RichardJECooke changed the title Explain how to change to collector in documentation Explain how to change the collector in documentation Jun 6, 2024
@RichardJECooke
Copy link
Author

Actually how to change 4317 isn't mentioned on the entire site:

https://opentelemetry.io/search/?q=4317

@trask
Copy link
Member

trask commented Jun 6, 2024

hi @RichardJECooke!

are you looking for how to change the OTLP port that the Java agent sends data to?

or are you looking for how to change the OTLP port that the collector listens on?

@RichardJECooke
Copy link
Author

The first one. This documentation I linked to is about starting the Java OpenTelemetry agent.

@trask
Copy link
Member

trask commented Jun 6, 2024

transferring this to the doc repo to see if we can make this easier to find

in the meantime, I believe this is the doc you're looking for: https://opentelemetry.io/docs/languages/java/configuration/#otlp-exporter-span-metric-and-log-exporters

@trask trask transferred this issue from open-telemetry/opentelemetry-java-instrumentation Jun 6, 2024
@cartermp
Copy link
Contributor

cartermp commented Jun 6, 2024

What @trask mentions is correct, that is the Java-specific table for how to change the endpoint for export.

We do technically link to that page here: https://opentelemetry.io/docs/zero-code/java/agent/configuration/#sdk-autoconfiguration

However it's easy to see how it might get lost. One thing we could do is copy over some of the table into this page, or create a header related to exporter configuration and link to the table in the other page. Would that work @RichardJECooke?

@RichardJECooke
Copy link
Author

Thanks.

  1. This page is good! https://opentelemetry.io/docs/languages/java/configuration You need to link to that in the readme. The zero code link you have isn't helpful (and it's silly to link to it twice).
  2. Search works today for 4317. Yesterday it was returning blank results on your site. Weird.
  3. It would be great to mention on the configuration page that the "endpoint" value is an endpoint to a collector. "Collector" isn't mentioned once on that page, though it's a core concept in OpenTelemetry. I was wondering "endpoint to what? what i'm monitoring?"

@jaydeluca
Copy link
Member

The documentation has now been updated and a link has been added to the instrumentation repo readme pointing at the configuration page

@svrnm
Copy link
Member

svrnm commented Jul 10, 2024

Thanks @jaydeluca, sounds like this issue can be closed.

@RichardJECooke if you think your issue has not been addressed by the recent changes, please go ahead and reopen or raise a new issue, thank you once again for bringing this to our attention

@svrnm svrnm closed this as completed Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working sig:java
Projects
None yet
Development

No branches or pull requests

5 participants