Skip to content

Commit

Permalink
[docs] fix inconsistency in TLS docs
Browse files Browse the repository at this point in the history
The otlpexporter and otlphttpexporter README files contained duplicate information about TLS configuration, some of which was incorrect.

Fix open-telemetry#4829
  • Loading branch information
Alex Boten committed Feb 15, 2022
1 parent 8399098 commit 7ce2fb7
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 19 deletions.
14 changes: 1 addition & 13 deletions exporter/otlpexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,7 @@ The following settings are required:
using the gRPC protocol. The valid syntax is described
[here](https://github.com/grpc/grpc/blob/master/doc/naming.md).
If a scheme of `https` is used then client transport security is enabled and overrides the `insecure` setting.

By default, TLS is enabled:

- `tls:`

- `insecure` (default = `false`): whether to enable client transport security for the exporter's connection.

As a result, the following parameters are also required:

- `tls:`

- `cert_file` (no default): path to the TLS cert to use for TLS required connections. Should only be used if `insecure` is set to false.
- `key_file` (no default): path to the TLS key to use for TLS required connections. Should only be used if `insecure` is set to false.
- `tls`: see [TLS Configuration Settings](../../config/configtls/README.md) for the full set of available options.

Example:

Expand Down
7 changes: 1 addition & 6 deletions exporter/otlphttpexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,7 @@ The following settings can be optionally configured:
If this setting is present the `endpoint` setting is ignored for metrics.
- `logs_endpoint` (no default): The target URL to send log data to (e.g.: https://example.com:4318/v1/logs).
If this setting is present the `endpoint` setting is ignored logs.

- `tls:`
- `insecure` (default = false): when set to true disables verifying the server's certificate chain and host name. The connection is still encrypted but server identity is not verified.
- `ca_file` path to the CA cert. For a client this verifies the server certificate. Should only be used if `insecure` is set to false.
- `cert_file` path to the TLS cert to use for TLS required connections. Should only be used if `insecure` is set to false.
- `key_file` path to the TLS key to use for TLS required connections. Should only be used if `insecure` is set to false.
- `tls`: see [TLS Configuration Settings](../../config/configtls/README.md) for the full set of available options.
- `timeout` (default = 30s): HTTP request time limit. For details see https://golang.org/pkg/net/http/#Client
- `read_buffer_size` (default = 0): ReadBufferSize for HTTP client.
- `write_buffer_size` (default = 512 * 1024): WriteBufferSize for HTTP client.
Expand Down

0 comments on commit 7ce2fb7

Please sign in to comment.