From 26e62ce0642e728943b7aa6cdbcd687761d3932a Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Wed, 16 Feb 2022 07:19:34 -0800 Subject: [PATCH] [docs] fix inconsistency in TLS docs (#4866) The otlpexporter and otlphttpexporter README files contained duplicate information about TLS configuration, some of which was incorrect. Fix #4829 --- exporter/otlpexporter/README.md | 14 +------------- exporter/otlphttpexporter/README.md | 7 +------ 2 files changed, 2 insertions(+), 19 deletions(-) diff --git a/exporter/otlpexporter/README.md b/exporter/otlpexporter/README.md index 756f2094547..55293aa3e50 100644 --- a/exporter/otlpexporter/README.md +++ b/exporter/otlpexporter/README.md @@ -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: diff --git a/exporter/otlphttpexporter/README.md b/exporter/otlphttpexporter/README.md index af9e9d49898..f7a0e9f02d2 100644 --- a/exporter/otlphttpexporter/README.md +++ b/exporter/otlphttpexporter/README.md @@ -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.