Highlighting that TLS is not supported by the OTel Jaeger exporter #7588
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
Signed-off-by: Paolo Patierno <[email protected]>
PaulRMellor
reviewed
Nov 7, 2022
Comment on lines
+41
to
+43
| WARNING: the OpenTelemetry specification doesn't define any https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md[SDK environment variables^] for enabling TLS on the Jaeger exporter used by default on the Kafka components. | ||
| It means that you cannot enable TLS encryption on the gRPC port of your Jaeger backend, otherwise the exporter will not be able to connect. | ||
| If you are using the Jaeger operator to deploy the Jaeger instance, set the `collector.grpc.tls.enabled: false` property under the `spec.allInOne.options` in the `Jaeger` custom resource. |
There was a problem hiding this comment.
Suggested change
| WARNING: the OpenTelemetry specification doesn't define any https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md[SDK environment variables^] for enabling TLS on the Jaeger exporter used by default on the Kafka components. | |
| It means that you cannot enable TLS encryption on the gRPC port of your Jaeger backend, otherwise the exporter will not be able to connect. | |
| If you are using the Jaeger operator to deploy the Jaeger instance, set the `collector.grpc.tls.enabled: false` property under the `spec.allInOne.options` in the `Jaeger` custom resource. | |
| WARNING: The Kafka Bridge uses the Jaeger exporter by default. | |
| SDK environment variables for enabling TLS are not defined in the exporter specification. | |
| This means that you cannot enable TLS encryption on the gRPC port of your Jaeger endpoint. | |
| If you do, the exporter cannot connect. | |
| If you are using the Jaeger operator to deploy the Jaeger instance, set the `collector.grpc.tls.enabled` property to `false` under `spec.allInOne.options` in the `Jaeger` custom resource. |
There was a problem hiding this comment.
Can we add the two links as additional resources at the end of the sections?
[role="_additional-resources"]
.Additional resources
- {otel-sdk-env-vars}
- {otel-oltp-en-vars}
Comment on lines
+45
to
+46
| NOTE: when using the `otlp` exporter, it is possible to use specific https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md[OTLP environment variables^] to enable TLS. | ||
| This way, you can enable TLS on the Jaeger backend OTLP endpoint. |
There was a problem hiding this comment.
Suggested change
| NOTE: when using the `otlp` exporter, it is possible to use specific https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md[OTLP environment variables^] to enable TLS. | |
| This way, you can enable TLS on the Jaeger backend OTLP endpoint. | |
| NOTE: You can use OTLP environment variables to configure the `otlp` exporter. | |
| For example, you can use the environment variables to enable TLS on the Jaeger OTLP endpoint. |
|
@PaulRMellor thanks for the review but we are going to close this because of #7592 |
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.
Type of change
Description
This PR is about documenting that it's not possible to enable TLS on the Jaeger exporter in order to connect to a Jaeger instance with TLS enabled on the gRPC port.
That's related to this OpenTelemetry upstream issue.
Checklist