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.

Sign up for GitHub

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

Highlighting that TLS is not supported by the OTel Jaeger exporter #7588

Closed
wants to merge 1 commit into from
Closed

Highlighting that TLS is not supported by the OTel Jaeger exporter #7588

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions documentation/modules/tracing/ref-tracing-environment-variables.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ If you are using another tracing implementation, xref:proc-enabling-tracing-type

|===

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.
Comment on lines +41 to +43
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

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}


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.
Comment on lines +45 to +46
Copy link
Contributor

Choose a reason for hiding this comment

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

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.


.OpenTracing environment variables
[cols="2m,1,2",options="header"]
|===
Expand Down