[Page feedback]: Add example of configuring receivers for TLS

[jcranfordbeyondtrust]

URL

https://opentelemetry.io/docs/collector/configuration/#setting-up-certificates

Description

Include example of how to configure receivers for TLS.

I see examples for exporters but not receivers.

[tiffany76]

Thanks for raising these issues, @jcranfordbeyondtrust! We appreciate the detailed and constructive feedback.

@open-telemetry/collector-approvers, PTAL. Thanks.

[jpkrohling]

Here's the Collector documentation page with this:

https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md#server-configuration

We have this in the documentation page from this report:

  otlp/jaeger:
    endpoint: jaeger-server:4317
    tls:
      cert_file: cert.pem
      key_file: cert-key.pem

The counterpart on the receiver side would be this:

  otlp:
    protocols:
      grpc:
        endpoint: 0.0.0.0:4317
        tls:
          cert_file: cert.pem
          key_file: cert-key.pem
      http:
        endpoint: 0.0.0.0:4318

[tiffany76]

Thanks, @jpkrohling! To spell out the solution to this issue, we should add this text:

tls:
  cert_file: cert.pem
  key_file: cert-key.pem

just after line 292 on the Collector Configuration page.

[pratik-mahalle]

@tiffany76 Is this issue still open?

[tiffany76]

Hi @pratik-mahalle, thanks for your interest. This issue is resolved and therefore closed. Please take a look through our open issues if you'd like to contribute.