From bbebea773e167a20364692a41a9c16f49945998a Mon Sep 17 00:00:00 2001 From: patrickhuie19 Date: Wed, 22 Nov 2023 09:30:31 -0500 Subject: [PATCH] feature/tracing-credentials: minor docs refactoring --- core/config/docs/core.toml | 2 +- core/config/toml/types.go | 2 +- docs/CONFIG.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/core/config/docs/core.toml b/core/config/docs/core.toml index dafce15c08d..79801c2c52b 100644 --- a/core/config/docs/core.toml +++ b/core/config/docs/core.toml @@ -592,7 +592,7 @@ CollectorTarget = 'localhost:4317' # Example NodeID = 'NodeID' # Example # SamplingRatio is the ratio of traces to sample for this node. SamplingRatio = 1.0 # Example -# Mode is a string value. 'tls' or 'unencrypted' are the only values allowed. If set to 'unencrypted', TLSCertPath can be unset, meaning traces will be sent over plaintext to the collector. +# Mode is a string value. `tls` or `unencrypted` are the only values allowed. If set to `unencrypted`, `TLSCertPath` can be unset, meaning traces will be sent over plaintext to the collector. Mode = 'tls' # Default # TLSCertPath is the file path to the TLS certificate used for secure communication with an OTEL Tracing Collector. TLSCertPath = '/path/to/cert.pem' # Example diff --git a/core/config/toml/types.go b/core/config/toml/types.go index 27c21fcaf1f..31076c1f1de 100644 --- a/core/config/toml/types.go +++ b/core/config/toml/types.go @@ -1546,7 +1546,7 @@ func isValidURI(uri string) bool { return isValidLocalURI(uri) } -// Validates uri is a valid local URI +// isValidLocalURI returns true if uri is a valid local URI // External URIs (e.g. http://) are not valid local URIs, and will return false. func isValidLocalURI(uri string) bool { parts := strings.Split(uri, ":") diff --git a/docs/CONFIG.md b/docs/CONFIG.md index ad1ff896709..63c20bdf4a5 100644 --- a/docs/CONFIG.md +++ b/docs/CONFIG.md @@ -1631,7 +1631,7 @@ SamplingRatio is the ratio of traces to sample for this node. ```toml Mode = 'tls' # Default ``` -Mode is a string value. 'tls' or 'unencrypted' are the only values allowed. If set to 'unencrypted', TLSCertPath can be unset, meaning traces will be sent over plaintext to the collector. +Mode is a string value. `tls` or `unencrypted` are the only values allowed. If set to `unencrypted`, `TLSCertPath` can be unset, meaning traces will be sent over plaintext to the collector. ### TLSCertPath ```toml