address PR feedback

- set ConvertHeadersToAttributes to false in `createDefaultConfig`
- Adds additional test cases for ReqToLog
- Adds tests for normalized header attribute key

Author: tredman

receiver/webhookeventreceiver/factory.go

@@ -38,11 +38,12 @@ func NewFactory() receiver.Factory {
 // Default configuration for the generic webhook receiver
 func createDefaultConfig() component.Config {
 	return &Config{
-		Path:               defaultPath,
-		HealthPath:         defaultHealthPath,
-		ReadTimeout:        defaultReadTimeout,
-		WriteTimeout:       defaultWriteTimeout,
-		SplitLogsAtNewLine: false,
+		Path:                       defaultPath,
+		HealthPath:                 defaultHealthPath,
+		ReadTimeout:                defaultReadTimeout,
+		WriteTimeout:               defaultWriteTimeout,
+		ConvertHeadersToAttributes: false, // optional, off by default
+		SplitLogsAtNewLine:         false,
 	}
 }
 

receiver/webhookeventreceiver/req_to_log.go

@@ -79,9 +79,13 @@ func appendHeaders(config *Config, scopeLog plog.ScopeLogs, headers http.Header)
 		if k == textproto.CanonicalMIMEHeaderKey(config.RequiredHeader.Key) {
 			continue
 		}
-		// store headers with "header" namespace and normalize key to snake_case
-		normalizedHeader := strings.ReplaceAll(k, "-", "_")
-		normalizedHeader = strings.ToLower(normalizedHeader)
-		scopeLog.Scope().Attributes().PutStr("header."+normalizedHeader, strings.Join(headers.Values(k), ";"))
+		scopeLog.Scope().Attributes().PutStr(headerAttributeKey(k), strings.Join(headers.Values(k), ";"))
 	}
 }
+
+// convert given header to snake_case and add "header" as a namespace prefix
+func headerAttributeKey(header string) string {
+	snakeCaseHeader := strings.ReplaceAll(header, "-", "_")
+	snakeCaseHeader = strings.ToLower(snakeCaseHeader)
+	return "header." + snakeCaseHeader
+}

receiver/webhookeventreceiver/req_to_log_test.go

@@ -136,6 +136,60 @@ func TestReqToLog(t *testing.T) {
 				require.Equal(t, 2, scopeLogsScope.Attributes().Len()) // expect no additional attributes even though headers are set
 			},
 		},
+		{
+			desc:    "ConvertHeadersToAttributes enabled but no headers included",
+			headers: http.Header{},
+			config: &Config{
+				Path:                       defaultPath,
+				HealthPath:                 defaultHealthPath,
+				ReadTimeout:                defaultReadTimeout,
+				WriteTimeout:               defaultWriteTimeout,
+				RequiredHeader:             RequiredHeader{Key: "X-Required-Header", Value: "password"},
+				ConvertHeadersToAttributes: true,
+			},
+			sc: func() *bufio.Scanner {
+				reader := io.NopCloser(bytes.NewReader([]byte("this is a: log")))
+				return bufio.NewScanner(reader)
+			}(),
+			tt: func(t *testing.T, reqLog plog.Logs, reqLen int, _ receiver.Settings) {
+				require.Equal(t, 1, reqLen)
+
+				attributes := reqLog.ResourceLogs().At(0).Resource().Attributes()
+				require.Equal(t, 0, attributes.Len())
+
+				scopeLogsScope := reqLog.ResourceLogs().At(0).ScopeLogs().At(0).Scope()
+				require.Equal(t, 2, scopeLogsScope.Attributes().Len()) // expect no additional attributes even though headers are set
+			},
+		},
+		{
+			desc: "ConvertHeadersToAttributes enabled but only a required header included",
+			headers: http.Header{
+				textproto.CanonicalMIMEHeaderKey("X-Required-Header"): []string{"password"},
+			},
+			config: &Config{
+				Path:                       defaultPath,
+				HealthPath:                 defaultHealthPath,
+				ReadTimeout:                defaultReadTimeout,
+				WriteTimeout:               defaultWriteTimeout,
+				RequiredHeader:             RequiredHeader{Key: "X-Required-Header", Value: "password"},
+				ConvertHeadersToAttributes: true,
+			},
+			sc: func() *bufio.Scanner {
+				reader := io.NopCloser(bytes.NewReader([]byte("this is a: log")))
+				return bufio.NewScanner(reader)
+			}(),
+			tt: func(t *testing.T, reqLog plog.Logs, reqLen int, _ receiver.Settings) {
+				require.Equal(t, 1, reqLen)
+
+				attributes := reqLog.ResourceLogs().At(0).Resource().Attributes()
+				require.Equal(t, 0, attributes.Len())
+
+				scopeLogsScope := reqLog.ResourceLogs().At(0).ScopeLogs().At(0).Scope()
+				require.Equal(t, 2, scopeLogsScope.Attributes().Len()) // expect no additional attributes even though headers are set
+				_, exists := scopeLogsScope.Attributes().Get("header.x_required_header")
+				require.False(t, exists)
+			},
+		},
 		{
 			desc: "Headers added if ConvertHeadersToAttributes enabled",
 			headers: http.Header{
@@ -217,3 +271,11 @@ func TestReqToLog(t *testing.T) {
 		})
 	}
 }
+
+func TestHeaderAttributeKey(t *testing.T) {
+	// Test mix of header values to ensure consistent output
+	require.Equal(t, "header.foo", headerAttributeKey("foo"))
+	require.Equal(t, "header.1", headerAttributeKey("1"))
+	require.Equal(t, "header.content_type", headerAttributeKey("Content-type"))
+	require.Equal(t, "header.unexpected_camel_case_header", headerAttributeKey("UnExPectEd-CaMeL-CaSe-HeAdEr"))
+}