Update TLS configuration for http/grpc clients (#1461)

Signed-off-by: Bogdan Drutu <[email protected]>
dynatrace-oss-contrib · Jul 30, 2020 · 1f0b2f0 · 1f0b2f0
1 parent 4896d31
commit 1f0b2f0
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 19 deletions.
diff --git a/exporter/jaegerexporter/README.md b/exporter/jaegerexporter/README.md
@@ -10,13 +10,18 @@ https://github.com/grpc/grpc/blob/master/doc/naming.md
 
 The following settings can be optionally configured:
 
-- `cert_pem_file`: certificate file for TLS credentials of gRPC client. Should
-only be used if `insecure` is set to false.
-- `insecure` (default = false): whether to disable client transport security for the exporter's gRPC
-connection. See [grpc.WithInsecure()](https://godoc.org/google.golang.org/grpc#WithInsecure).
-- `keepalive`: keepalive parameters for client gRPC. See
+- `insecure` (default = false): whether to enable client transport security for
+  the exporter's gRPC connection. See
+  [grpc.WithInsecure()](https://godoc.org/google.golang.org/grpc#WithInsecure).
+- `ca_file` path to the CA cert. For a client this verifies the server certificate. Should
+  only be used if `insecure` is set to true.
+- `cert_file` path to the TLS cert to use for TLS required connections. Should
+  only be used if `insecure` is set to true.
+- `key_file` path to the TLS key to use for TLS required connections. Should
+  only be used if `insecure` is set to true.
+- `keepalive` keepalive parameters for client gRPC. See
 [grpc.WithKeepaliveParams()](https://godoc.org/google.golang.org/grpc#WithKeepaliveParams).
-- `server_name_override`: If set to a non empty string, it will override the virtual host name 
+- `server_name_override` If set to a non-empty string, it will override the virtual host name 
 of authority (e.g. :authority header field) in requests (typically used for testing).
 - `balancer_name`(default = pick_first): Sets the balancer in grpclb_policy to discover the servers.
 See [grpc loadbalancing example](https://github.com/grpc/grpc-go/blob/master/examples/features/load_balancing/README.md).

diff --git a/exporter/opencensusexporter/README.md b/exporter/opencensusexporter/README.md
@@ -11,15 +11,19 @@ The following settings are required:
 
 The following settings can be optionally configured:
 
-- `cert_pem_file`: certificate file for TLS credentials of gRPC client. Should
-  only be used if `secure` is set to true.
-- `compression` (default = gzip): compression key for supported compression
-  types within collector. Currently the only supported mode is `gzip`.
-- `headers`: the headers associated with gRPC requests.
 - `insecure` (default = false): whether to enable client transport security for
   the exporter's gRPC connection. See
   [grpc.WithInsecure()](https://godoc.org/google.golang.org/grpc#WithInsecure).
-- `keepalive`: keepalive parameters for client gRPC. See
+- `ca_file` path to the CA cert. For a client this verifies the server certificate. Should
+  only be used if `insecure` is set to true.
+- `cert_file` path to the TLS cert to use for TLS required connections. Should
+  only be used if `insecure` is set to true.
+- `key_file` path to the TLS key to use for TLS required connections. Should
+  only be used if `insecure` is set to true.
+- `compression` (default = gzip): compression key for supported compression
+  types within collector. Currently the only supported mode is `gzip`.
+- `headers` the headers associated with gRPC requests.
+- `keepalive` keepalive parameters for client gRPC. See
   [grpc.WithKeepaliveParams()](https://godoc.org/google.golang.org/grpc#WithKeepaliveParams).
 - `num_workers` (default = 2): number of workers that send the gRPC requests.
   Optional.

diff --git a/exporter/otlpexporter/README.md b/exporter/otlpexporter/README.md
@@ -11,19 +11,22 @@ The following settings are required:
 
 The following settings can be optionally configured:
 
-- `cert_pem_file`: certificate file for TLS credentials of gRPC client. Should
-  only be used if `insecure` is set to `false`.
-- `compression`: compression key for supported compression types within
-  collector. Currently the only supported mode is `gzip`.
-- `headers`: the headers associated with gRPC requests.
 - `insecure` (default = false): whether to enable client transport security for
   the exporter's gRPC connection. See
   [grpc.WithInsecure()](https://godoc.org/google.golang.org/grpc#WithInsecure).
-- `keepalive`: keepalive parameters for client gRPC. See
+- `ca_file` path to the CA cert. For a client this verifies the server certificate. Should
+  only be used if `insecure` is set to true.
+- `cert_file` path to the TLS cert to use for TLS required connections. Should
+  only be used if `insecure` is set to true.
+- `key_file` path to the TLS key to use for TLS required connections. Should
+  only be used if `insecure` is set to true.
+- `compression` compression key for supported compression types within the collector. Currently, the only supported mode is `gzip`.
+- `headers` the headers associated with gRPC requests.
+- `keepalive` keepalive parameters for client gRPC. See
   [grpc.WithKeepaliveParams()](https://godoc.org/google.golang.org/grpc#WithKeepaliveParams).
 - `reconnection_delay`: time period between each reconnection performed by the
   exporter.
-- `insecure`: whether to enable client transport security for the exporter's
+- `insecure` whether to enable client transport security for the exporter's
   gRPC connection. See
   [grpc.WithInsecure()](https://godoc.org/google.golang.org/grpc#WithInsecure).
 - `balancer_name`(default = pick_first): Sets the balancer in grpclb_policy to discover the servers.

diff --git a/exporter/zipkinexporter/README.md b/exporter/zipkinexporter/README.md
@@ -9,6 +9,14 @@ The following settings are required:
 
 The following settings can be optionally configured:
 
+- `insecure` (default = false): whether to enable client transport security for
+  the exporter's connection.
+- `ca_file` path to the CA cert. For a client this verifies the server certificate. Should
+  only be used if `insecure` is set to true.
+- `cert_file` path to the TLS cert to use for TLS required connections. Should
+  only be used if `insecure` is set to true.
+- `key_file` path to the TLS key to use for TLS required connections. Should
+  only be used if `insecure` is set to true.
 - `defaultservicename` (default = <missing service name>): What to name services missing this information.
 - `timeout` (default = 5s): How long to wait until the connection is close.
 - `read_buffer_size` (default = 0): ReadBufferSize for HTTP client.