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

Quickstart Tutorial + Fix endpoint handling #74

Merged
merged 4 commits into from
Apr 21, 2023
Merged

Conversation

mariomac
Copy link
Contributor

@mariomac mariomac commented Apr 20, 2023

Created a quickstart tutorial.

During the development of the tutorial, I realized that we were incorrectly handling the OTEL_EXPORTER_OTLP_ENDPOINT variable, mostly due to a wrong interpretation of the library documentation from my side.

The OTEL_EXPORTER_OTLP_ENDPOINT must be a complete URL including the schema and any optional path, and we were just treating it as a host:port.

This required to change some tests, and might break some scripts we already have for local testing.

@mariomac mariomac added bug Something isn't working documentation Improvements or additions to documentation breaking-change labels Apr 20, 2023
@mariomac mariomac requested a review from grcevski April 20, 2023 15:46
Copy link
Contributor

@grcevski grcevski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! Awesome tutorial. I just had one question.

LGTM!

export GRAFANA_REGION="prod-eu-west-0"

export OTEL_EXPORTER_OTLP_ENDPOINT="https://otlp-gateway-${GRAFANA_REGION}.grafana.net/otlp"
export OTEL_EXPORTER_OTLP_PROTOCOL="http/protobuf"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to add explicit support for protobuf for the protocol to work, or it's somehow handled automatically? I thought we might need to use the oltptracegrpc?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh good question, let me double-check and remove it.

@mariomac mariomac merged commit a9de2e3 into grafana:main Apr 21, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants