add doc for disabling otel exporter. #897
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 tasks
kullanici0606
force-pushed
the
support-for-disabling-telemetry-exporter
branch
from
ca37d3a to
ee39646
Compare
4 tasks
miparnisari
reviewed
Dec 17, 2024
| @@ -330,7 +330,7 @@ To see the request latency per endpoint of your OpenFGA deployment, you can prov | |||
|
|
|||
| OpenFGA traces can be collected with the [OTLP data format](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md). | |||
|
|
|||
| Tracing is disabled by default, but you can enable this with the `--trace-enabled=true` (`OPENFGA_TRACE_ENABLED=true` environment variable). Traces will be exported by default to address `0.0.0.0:4317`. You can change this address with the `--trace-otlp-endpoint` flag (`OPENFGA_TRACE_OTLP_ENDPOINT` environment variable). | |||
| Tracing is disabled by default, but you can enable this with the `--trace-enabled=true` (`OPENFGA_TRACE_ENABLED=true` environment variable). Traces will be exported by default to address `0.0.0.0:4317`. You can change this address with the `--trace-otlp-endpoint` flag (`OPENFGA_TRACE_OTLP_ENDPOINT` environment variable). Exporter can be disabled by providing `none` as endpoint value. | |||
There was a problem hiding this comment.
Can we add this too?
openfga/openfga#2122 (comment)
Since after I read this PR I struggled to understand what was the use case for this.
There was a problem hiding this comment.
I added it, is it good or should I re-word it?
miparnisari
approved these changes
Dec 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds documentation support for disabling OpenTelemetry GRPC exporter when tracing is enabled.
This is useful for logging trace IDs but not wanting them to export to OTEL collector.
PR to the change: openfga/openfga#2121
References
openfga/openfga#2120
Review Checklist
mainIf you haven't done so yet, we would appreciate it if you could star the OpenFGA repository. :)