[chore] Fix comments and clarify docs on config/configtls (#10441)

#### Description Point out that `config/configtls` also applies to HTTPS --------- Co-authored-by: Alex Boten <[email protected]>
open-telemetry · Jul 4, 2024 · af33ac5 · af33ac5
1 parent fab211d
commit af33ac5
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 7 deletions.
diff --git a/config/configtls/README.md b/config/configtls/README.md
@@ -11,8 +11,9 @@ Note that mutual TLS (mTLS) is also supported.
 By default, TLS is enabled:
 
 - `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).
+  the exporter's HTTPs or gRPC connection. See
+  [grpc.WithInsecure()](https://godoc.org/google.golang.org/grpc#WithInsecure)
+  for gRPC.
 
 As a result, the following parameters are also required:
 

diff --git a/config/configtls/configtls.go b/config/configtls/configtls.go
@@ -86,11 +86,9 @@ type ClientConfig struct {
 
 	// These are config options specific to client connections.
 
-	// In gRPC when set to true, this is used to disable the client transport security.
-	// See https://godoc.org/google.golang.org/grpc#WithInsecure.
-	// In HTTP, this disables verifying the server's certificate chain and host name
-	// (InsecureSkipVerify in the tls Config). Please refer to
-	// https://godoc.org/crypto/tls#Config for more information.
+	// In gRPC and HTTP when set to true, this is used to disable the client transport security.
+	// See https://godoc.org/google.golang.org/grpc#WithInsecure for gRPC.
+	// Please refer to https://godoc.org/crypto/tls#Config for more information.
 	// (optional, default false)
 	Insecure bool `mapstructure:"insecure"`
 	// InsecureSkipVerify will enable TLS but not verify the certificate.