[extension/headersetter] unexport Header struct (open-telemetry#40542)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: atoulme

.chloggen/unexport_header.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: breaking
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: headersetterextension
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Unexport Header
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [40542]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [api]

extension/headerssetterextension/extension.go

@@ -19,7 +19,7 @@ import (
 	"github.com/open-telemetry/opentelemetry-collector-contrib/extension/headerssetterextension/internal/source"
 )
 
-type Header struct {
+type header struct {
 	action action.Action
 	source source.Source
 }
@@ -34,7 +34,7 @@ type headerSetterExtension struct {
 	component.StartFunc
 	component.ShutdownFunc
 
-	headers []Header
+	headers []header
 }
 
 // PerRPCCredentials implements extensionauth.GRPCClient.
@@ -55,50 +55,50 @@ func newHeadersSetterExtension(cfg *Config, logger *zap.Logger) (*headerSetterEx
 		return nil, errors.New("extension configuration is not provided")
 	}
 
-	headers := make([]Header, 0, len(cfg.HeadersConfig))
-	for _, header := range cfg.HeadersConfig {
+	headers := make([]header, 0, len(cfg.HeadersConfig))
+	for _, h := range cfg.HeadersConfig {
 		var s source.Source
 		switch {
-		case header.Value != nil:
+		case h.Value != nil:
 			s = &source.StaticSource{
-				Value: *header.Value,
+				Value: *h.Value,
 			}
-		case header.FromAttribute != nil:
+		case h.FromAttribute != nil:
 			defaultValue := ""
-			if header.DefaultValue != nil {
-				defaultValue = string(*header.DefaultValue)
+			if h.DefaultValue != nil {
+				defaultValue = string(*h.DefaultValue)
 			}
 			s = &source.AttributeSource{
-				Key:          *header.FromAttribute,
+				Key:          *h.FromAttribute,
 				DefaultValue: defaultValue,
 			}
-		case header.FromContext != nil:
+		case h.FromContext != nil:
 			defaultValue := ""
-			if header.DefaultValue != nil {
-				defaultValue = string(*header.DefaultValue)
+			if h.DefaultValue != nil {
+				defaultValue = string(*h.DefaultValue)
 			}
 			s = &source.ContextSource{
-				Key:          *header.FromContext,
+				Key:          *h.FromContext,
 				DefaultValue: defaultValue,
 			}
 		}
 
 		var a action.Action
-		switch header.Action {
+		switch h.Action {
 		case INSERT:
-			a = action.Insert{Key: *header.Key}
+			a = action.Insert{Key: *h.Key}
 		case UPSERT:
-			a = action.Upsert{Key: *header.Key}
+			a = action.Upsert{Key: *h.Key}
 		case UPDATE:
-			a = action.Update{Key: *header.Key}
+			a = action.Update{Key: *h.Key}
 		case DELETE:
-			a = action.Delete{Key: *header.Key}
+			a = action.Delete{Key: *h.Key}
 		default:
-			a = action.Upsert{Key: *header.Key}
+			a = action.Upsert{Key: *h.Key}
 			logger.Warn("The action was not provided, using 'upsert'." +
 				" In future versions, we'll require this to be explicitly set")
 		}
-		headers = append(headers, Header{action: a, source: s})
+		headers = append(headers, header{action: a, source: s})
 	}
 
 	return &headerSetterExtension{headers: headers}, nil
@@ -107,7 +107,7 @@ func newHeadersSetterExtension(cfg *Config, logger *zap.Logger) (*headerSetterEx
 // headersPerRPC is a gRPC credentials.PerRPCCredentials implementation sets
 // headers with values extracted from provided sources.
 type headersPerRPC struct {
-	headers []Header
+	headers []header
 }
 
 // GetRequestMetadata returns the request metadata to be used with the RPC.
@@ -137,7 +137,7 @@ func (h *headersPerRPC) RequireTransportSecurity() bool {
 // values extracted from configured sources.
 type headersRoundTripper struct {
 	base    http.RoundTripper
-	headers []Header
+	headers []header
 }
 
 // RoundTrip copies the original request and sets headers of the new requests

extension/headerssetterextension/extension_test.go

@@ -90,7 +90,7 @@ func TestPerRPCCredentials(t *testing.T) {
 
 var (
 	mrt           = &mockRoundTripper{}
-	header        = "header_name"
+	headername    = "header_name"
 	anotherHeader = "another_header_name"
 	tests         = []struct {
 		cfg             *Config
@@ -101,7 +101,7 @@ var (
 			cfg: &Config{
 				HeadersConfig: []HeaderConfig{
 					{
-						Key:         &header,
+						Key:         &headername,
 						Action:      INSERT,
 						FromContext: stringp("tenant"),
 					},
@@ -118,7 +118,7 @@ var (
 			cfg: &Config{
 				HeadersConfig: []HeaderConfig{
 					{
-						Key:    &header,
+						Key:    &headername,
 						Action: INSERT,
 						Value:  stringp("config value"),
 					},
@@ -132,7 +132,7 @@ var (
 			cfg: &Config{
 				HeadersConfig: []HeaderConfig{
 					{
-						Key:         &header,
+						Key:         &headername,
 						Action:      INSERT,
 						FromContext: stringp("tenant"),
 					},
@@ -155,7 +155,7 @@ var (
 			cfg: &Config{
 				HeadersConfig: []HeaderConfig{
 					{
-						Key:         &header,
+						Key:         &headername,
 						Action:      INSERT,
 						FromContext: stringp(""),
 					},
@@ -169,7 +169,7 @@ var (
 			cfg: &Config{
 				HeadersConfig: []HeaderConfig{
 					{
-						Key:    &header,
+						Key:    &headername,
 						Action: INSERT,
 						Value:  stringp(""),
 					},
@@ -183,7 +183,7 @@ var (
 			cfg: &Config{
 				HeadersConfig: []HeaderConfig{
 					{
-						Key:         &header,
+						Key:         &headername,
 						Action:      INSERT,
 						FromContext: stringp("tenant"),
 					},
@@ -206,7 +206,7 @@ var (
 			cfg: &Config{
 				HeadersConfig: []HeaderConfig{
 					{
-						Key:         &header,
+						Key:         &headername,
 						Action:      INSERT,
 						FromContext: stringp("tenant_"),
 					},
@@ -223,7 +223,7 @@ var (
 			cfg: &Config{
 				HeadersConfig: []HeaderConfig{
 					{
-						Key:          &header,
+						Key:          &headername,
 						Action:       INSERT,
 						FromContext:  stringp("tenant"),
 						DefaultValue: opaquep("default_tenant"),
@@ -241,7 +241,7 @@ var (
 			cfg: &Config{
 				HeadersConfig: []HeaderConfig{
 					{
-						Key:          &header,
+						Key:          &headername,
 						Action:       INSERT,
 						FromContext:  stringp("tenant"),
 						DefaultValue: opaquep("default_tenant"),