fix: set source name and category in the FluentD output for events

CHANGELOG.md

@@ -13,9 +13,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+- fix: set source name and category in the FluentD output for events [#2222][#2222]
 - docs: FluentD buffer size configuration [#2232][#2232]
 
 [#2232]: https://github.com/SumoLogic/sumologic-kubernetes-collection/pull/2232
+[#2222]: https://github.com/SumoLogic/sumologic-kubernetes-collection/pull/2222
 [Unreleased]: https://github.com/SumoLogic/sumologic-kubernetes-collection/compare/v2.6.0...main
 
 ## [v2.7.0][v2.7.0]

deploy/docs/Installation_with_Helm.md

@@ -90,6 +90,7 @@ The following parameter is optional, but we recommend setting it.
 
 - __sumologic.clusterName__ - An identifier for your Kubernetes cluster.
   This is the name you will see for the cluster in Sumo Logic. Default is `kubernetes`.
+  Whitespaces in the cluster name will be replaced with dashes.
 
 To install the chart, first add the `sumologic` private repo:
 

deploy/docs/existingPrometheusDoc.md

@@ -58,6 +58,7 @@ The following parameter is optional, but we recommend setting it.
 
 - __sumologic.clusterName__ - An identifier for your Kubernetes cluster.
   This is the name you will see for the cluster in Sumo Logic. Default is `kubernetes`.
+  Whitespaces in the cluster name will be replaced with dashes.
 
 To install the chart, first add the `sumologic` private repo:
 

deploy/docs/standAlonePrometheus.md

@@ -43,7 +43,7 @@ If you are installing the collection in a cluster that requires proxying outboun
 
 The following parameter is optional, but we recommend setting it.
 
-- __sumologic.clusterName__ - An identifier for your Kubernetes cluster. This is the name you will see for the cluster in Sumo Logic. Default is `kubernetes`.
+- __sumologic.clusterName__ - An identifier for your Kubernetes cluster. This is the name you will see for the cluster in Sumo Logic. Default is `kubernetes`. Whitespaces in the cluster name will be replaced with dashes.
 
 To install the chart, first add the `sumologic` private repo:
 

deploy/helm/sumologic/conf/events/events.conf

@@ -50,6 +50,8 @@
     @id sumologic.endpoint.events
     sumo_client {{ include "sumologic.sumo_client" . | quote }}
     endpoint "#{ENV['SUMO_ENDPOINT_DEFAULT_EVENTS_SOURCE']}"
+    source_name {{ .Values.fluentd.events.sourceName }}
+    source_category {{ .Values.fluentd.events.source_category | default (printf "%s/%s"  (include "sumologic.clusterNameReplaceSpaceWithDash" .) (.Values.fluentd.events.sourceName ))}}
     data_type logs
     disable_cookies true
     verify_ssl {{ .Values.fluentd.verifySsl | quote }}

deploy/helm/sumologic/templates/_helpers.tpl

@@ -903,9 +903,6 @@ Example usage:
 resource "sumologic_http_source" "{{ .Name }}" {
     name         = local.{{ .Name }}
     collector_id = sumologic_collector.collector.id
-    {{- if $source.category }}
-    category     = {{ if $ctx.fluentd.events.sourceCategory }}{{ $ctx.fluentd.events.sourceCategory | quote }}{{- else}}{{ "\"${var.cluster_name}/${local.default_events_source}\"" }}{{- end}}
-    {{- end }}
     {{- if $source.properties }}
     {{- range $fkey, $fvalue := $source.properties }}
     {{- include "terraform.generate-object" (dict "Name" $fkey "Value" $fvalue "KeyLength" (include "terraform.max-key-length" $source.properties) "Indent" 2) -}}

deploy/helm/sumologic/values.yaml

@@ -171,7 +171,6 @@ sumologic:
         default:
           name: events
           config-name: endpoint-events
-          category: true
       traces:
         default:
           name: traces
@@ -909,8 +908,10 @@ fluentd:
     ## Override output section for events. Leave empty for the default output section
     overrideOutputConf: |-
 
+    ## Source name for the Events source. Default: "events"
+    sourceName: "events"
     ## Source category for the Events source. Default: "{clusterName}/events"
-    sourceCategory: ""
+    # sourceCategory: "kubernetes/events"
     ## Override Kubernetes resource types you want to get events for from different Kubernetes
     ## API versions. The key represents the name of the resource type and the value represents
     ## the API version.

tests/helm/events/static/apiServerUrl.output.yaml

@@ -43,6 +43,8 @@ data:
         @id sumologic.endpoint.events
         sumo_client "k8s_%CURRENT_CHART_VERSION%"
         endpoint "#{ENV['SUMO_ENDPOINT_DEFAULT_EVENTS_SOURCE']}"
+        source_name events
+        source_category kubernetes/events
         data_type logs
         disable_cookies true
         verify_ssl "true"

tests/helm/events/static/apiServerUrl_null.output.yaml

@@ -42,6 +42,8 @@ data:
         @id sumologic.endpoint.events
         sumo_client "k8s_%CURRENT_CHART_VERSION%"
         endpoint "#{ENV['SUMO_ENDPOINT_DEFAULT_EVENTS_SOURCE']}"
+        source_name events
+        source_category kubernetes/events
         data_type logs
         disable_cookies true
         verify_ssl "true"

tests/helm/events/static/default.output.yaml

@@ -42,6 +42,8 @@ data:
         @id sumologic.endpoint.events
         sumo_client "k8s_%CURRENT_CHART_VERSION%"
         endpoint "#{ENV['SUMO_ENDPOINT_DEFAULT_EVENTS_SOURCE']}"
+        source_name events
+        source_category kubernetes/events
         data_type logs
         disable_cookies true
         verify_ssl "true"

tests/helm/events/static/watchResourceEventsOverrides.output.yaml

@@ -50,6 +50,8 @@ data:
         @id sumologic.endpoint.events
         sumo_client "k8s_%CURRENT_CHART_VERSION%"
         endpoint "#{ENV['SUMO_ENDPOINT_DEFAULT_EVENTS_SOURCE']}"
+        source_name events
+        source_category kubernetes/events
         data_type logs
         disable_cookies true
         verify_ssl "true"

tests/helm/events/static/watchResourceEventsOverrides_apiServerUrl.output.yaml

@@ -52,6 +52,8 @@ data:
         @id sumologic.endpoint.events
         sumo_client "k8s_%CURRENT_CHART_VERSION%"
         endpoint "#{ENV['SUMO_ENDPOINT_DEFAULT_EVENTS_SOURCE']}"
+        source_name events
+        source_category kubernetes/events
         data_type logs
         disable_cookies true
         verify_ssl "true"

tests/helm/terraform/static/all_fields.output.yaml

@@ -166,7 +166,6 @@ data:
     resource "sumologic_http_source" "default_events_source" {
         name         = local.default_events_source
         collector_id = sumologic_collector.collector.id
-        category     = "${var.cluster_name}/${local.default_events_source}"
     }
 
     resource "sumologic_http_source" "default_logs_source" {

tests/helm/terraform/static/collector_fields.output.yaml

@@ -167,7 +167,6 @@ data:
     resource "sumologic_http_source" "default_events_source" {
         name         = local.default_events_source
         collector_id = sumologic_collector.collector.id
-        category     = "${var.cluster_name}/${local.default_events_source}"
     }
 
     resource "sumologic_http_source" "default_logs_source" {

tests/helm/terraform/static/default.output.yaml

@@ -165,7 +165,6 @@ data:
     resource "sumologic_http_source" "default_events_source" {
         name         = local.default_events_source
         collector_id = sumologic_collector.collector.id
-        category     = "${var.cluster_name}/${local.default_events_source}"
     }
 
     resource "sumologic_http_source" "default_logs_source" {

tests/helm/terraform/static/disable_default_metrics.output.yaml

@@ -164,7 +164,6 @@ data:
     resource "sumologic_http_source" "default_events_source" {
         name         = local.default_events_source
         collector_id = sumologic_collector.collector.id
-        category     = "${var.cluster_name}/${local.default_events_source}"
     }
 
     resource "sumologic_http_source" "default_logs_source" {

tests/helm/terraform/static/strip_extrapolation.output.yaml

@@ -166,7 +166,6 @@ data:
     resource "sumologic_http_source" "default_events_source" {
         name         = local.default_events_source
         collector_id = sumologic_collector.collector.id
-        category     = "${var.cluster_name}/${local.default_events_source}"
     }
 
     resource "sumologic_http_source" "default_logs_source" {

tests/integration/helm_default_installation_test.go

@@ -32,6 +32,7 @@ func Test_Helm_Default_FluentD_Metadata(t *testing.T) {
 		tickDuration            = 3 * time.Second
 		waitDuration            = 5 * time.Minute
 		logsGeneratorCount uint = 1000
+		expectedEventCount uint = 100
 	)
 	expectedMetrics := internal.DefaultExpectedMetrics
 
@@ -356,5 +357,20 @@ func Test_Helm_Default_FluentD_Metadata(t *testing.T) {
 		Teardown(stepfuncs.KubectlDeleteNamespaceOpt(internal.LogsGeneratorNamespace)).
 		Feature()
 
-	testenv.Test(t, featInstall, featMetrics, featLogs)
+	featEvents := features.New("events").
+		Assess("events present", stepfuncs.WaitUntilExpectedLogsPresent(
+			expectedEventCount,
+			map[string]string{
+				"_sourceName":     "events",
+				"_sourceCategory": fmt.Sprintf("%s/events", internal.ClusterName),
+			},
+			internal.ReceiverMockNamespace,
+			internal.ReceiverMockServiceName,
+			internal.ReceiverMockServicePort,
+			waitDuration,
+			tickDuration,
+		)).
+		Feature()
+
+	testenv.Test(t, featInstall, featMetrics, featLogs, featEvents)
 }

tests/integration/internal/constants.go

@@ -15,6 +15,10 @@ const (
 
 	YamlPathReceiverMock = "yamls/receiver-mock.yaml"
 
+	// default cluster name in Helm chart Config
+	// TODO: read this from values.yaml used for the test directly
+	ClusterName = "kubernetes"
+
 	ReceiverMockServicePort = 3000
 	ReceiverMockServiceName = "receiver-mock"
 	ReceiverMockNamespace   = "receiver-mock"