Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support pushing span/trace through to splunk HEC #629

Merged
merged 19 commits into from
Jan 26, 2023
Merged

Support pushing span/trace through to splunk HEC #629

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
66dae1a
Update values.yaml
mr-miles Jan 9, 2023
528f023
Update values.schema.json
mr-miles Jan 9, 2023
6e31e2f
Update _helpers.tpl
mr-miles Jan 9, 2023
4fe2607
Update _otel-collector.tpl
mr-miles Jan 9, 2023
c3a3018
Update _common.tpl
mr-miles Jan 9, 2023
afa155a
Update values.yaml
mr-miles Jan 10, 2023
97abad2
Update _otel-collector.tpl
mr-miles Jan 10, 2023
8a9366b
Update _otel-agent.tpl
mr-miles Jan 10, 2023
f8b664a
Update daemonset.yaml
mr-miles Jan 10, 2023
42bc7b2
Merge branch 'signalfx:main' into traces_hec
mr-miles Jan 10, 2023
f646f61
Update helm-charts/splunk-otel-collector/values.yaml
atoulme Jan 17, 2023
6619fbf
Update helm-charts/splunk-otel-collector/values.yaml
atoulme Jan 17, 2023
32c1bf1
Merge branch 'main' into traces_hec
atoulme Jan 17, 2023
c66828b
Update helm-charts/splunk-otel-collector/templates/config/_otel-colle…
atoulme Jan 17, 2023
5eaa024
Update helm-charts/splunk-otel-collector/templates/config/_otel-colle…
atoulme Jan 17, 2023
0b81353
Merge branch 'signalfx:main' into traces_hec
mr-miles Jan 19, 2023
7e549f2
Update agent config for traces
mr-miles Jan 20, 2023
12e5227
Merge branch 'main' into traces_hec
mr-miles Jan 24, 2023
822d56c
Merge branch 'main' into traces_hec
mr-miles Jan 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions helm-charts/splunk-otel-collector/templates/_helpers.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,13 @@ Whether metrics enabled for Splunk Platform.
{{- and (eq (include "splunk-otel-collector.splunkPlatformEnabled" .) "true") .Values.splunkPlatform.metricsEnabled }}
{{- end -}}

{{/*
Whether traces enabled for Splunk Platform.
*/}}
{{- define "splunk-otel-collector.platformTracesEnabled" -}}
{{- and (eq (include "splunk-otel-collector.splunkPlatformEnabled" .) "true") .Values.splunkPlatform.tracesEnabled }}
{{- end -}}

{{/*
Whether metrics enabled for any destination.
*/}}
Expand All @@ -115,10 +122,10 @@ Whether metrics enabled for any destination.
{{- end -}}

{{/*
Whether traces enabled for any destination. (currently applicable to Splunk Observability only).
Whether traces enabled for any destination.
*/}}
{{- define "splunk-otel-collector.tracesEnabled" -}}
{{- include "splunk-otel-collector.o11yTracesEnabled" . }}
{{- or (eq (include "splunk-otel-collector.o11yTracesEnabled" .) "true") (eq (include "splunk-otel-collector.platformTracesEnabled" .) "true") }}
{{- end -}}

{{/*
Expand Down
38 changes: 37 additions & 1 deletion helm-charts/splunk-otel-collector/templates/config/_common.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ splunk_hec/platform_logs:
{{- end }}

{{/*
Splunk Platform Logs exporter
Splunk Platform Metrics exporter
*/}}
{{- define "splunk-otel-collector.splunkPlatformMetricsExporter" -}}
splunk_hec/platform_metrics:
Expand Down Expand Up @@ -246,6 +246,42 @@ splunk_hec/platform_metrics:
queue_size: {{ .Values.splunkPlatform.sendingQueue.queueSize }}
{{- end }}

{{/*
Splunk Platform Traces exporter
*/}}
{{- define "splunk-otel-collector.splunkPlatformTracesExporter" -}}
splunk_hec/platform_traces:
endpoint: {{ .Values.splunkPlatform.endpoint | quote }}
token: "${SPLUNK_PLATFORM_HEC_TOKEN}"
index: {{ .Values.splunkPlatform.tracesIndex | quote }}
source: {{ .Values.splunkPlatform.source | quote }}
max_connections: {{ .Values.splunkPlatform.maxConnections }}
disable_compression: {{ .Values.splunkPlatform.disableCompression }}
timeout: {{ .Values.splunkPlatform.timeout }}
splunk_app_name: {{ .Chart.Name }}
splunk_app_version: {{ .Chart.Version }}
tls:
insecure_skip_verify: {{ .Values.splunkPlatform.insecureSkipVerify }}
{{- if .Values.splunkPlatform.clientCert }}
cert_file: /otel/etc/splunk_platform_hec_client_cert
{{- end }}
{{- if .Values.splunkPlatform.clientKey }}
key_file: /otel/etc/splunk_platform_hec_client_key
{{- end }}
{{- if .Values.splunkPlatform.caFile }}
ca_file: /otel/etc/splunk_platform_hec_ca_file
{{- end }}
retry_on_failure:
enabled: {{ .Values.splunkPlatform.retryOnFailure.enabled }}
initial_interval: {{ .Values.splunkPlatform.retryOnFailure.initialInterval }}
max_interval: {{ .Values.splunkPlatform.retryOnFailure.maxInterval }}
max_elapsed_time: {{ .Values.splunkPlatform.retryOnFailure.maxElapsedTime }}
sending_queue:
enabled: {{ .Values.splunkPlatform.sendingQueue.enabled }}
num_consumers: {{ .Values.splunkPlatform.sendingQueue.numConsumers }}
queue_size: {{ .Values.splunkPlatform.sendingQueue.queueSize }}
{{- end }}

{{/*
Add Extra Labels
*/}}
Expand Down
16 changes: 15 additions & 1 deletion helm-charts/splunk-otel-collector/templates/config/_otel-agent.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,6 +587,9 @@ exporters:
{{- if (eq (include "splunk-otel-collector.platformMetricsEnabled" .) "true") }}
{{- include "splunk-otel-collector.splunkPlatformMetricsExporter" . | nindent 2 }}
{{- end }}
{{- if (eq (include "splunk-otel-collector.platformTracesEnabled" .) "true") }}
{{- include "splunk-otel-collector.splunkPlatformTracesExporter" . | nindent 2 }}
{{- end }}
{{- end }}

{{- if (eq (include "splunk-otel-collector.splunkO11yEnabled" .) "true") }}
Expand Down Expand Up @@ -698,7 +701,13 @@ service:
{{- if (eq (include "splunk-otel-collector.tracesEnabled" .) "true") }}
# Default traces pipeline.
traces:
receivers: [otlp, jaeger, smartagent/signalfx-forwarder, zipkin]
receivers:
- otlp
- jaeger
{{- if (eq (include "splunk-otel-collector.o11yTracesEnabled" $) "true") }}
- smartagent/signalfx-forwarder
{{- end }}
- zipkin
processors:
- memory_limiter
- k8sattributes
Expand All @@ -712,8 +721,13 @@ service:
{{- if $gatewayEnabled }}
- otlp
{{- else }}
{{- if (eq (include "splunk-otel-collector.o11yTracesEnabled" .) "true") }}
- sapm
{{- end }}
{{- if (eq (include "splunk-otel-collector.platformTracesEnabled" .) "true") }}
- splunk_hec/platform_traces
{{- end }}
{{- end }}
{{- if (eq (include "splunk-otel-collector.o11yMetricsEnabled" $) "true") }}
# For trace/metric correlation.
- signalfx
Expand Down
13 changes: 11 additions & 2 deletions helm-charts/splunk-otel-collector/templates/config/_otel-collector.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,9 @@ exporters:
{{- include "splunk-otel-collector.splunkPlatformMetricsExporter" . | nindent 2 }}
{{- end }}

{{- if (eq (include "splunk-otel-collector.platformTracesEnabled" .) "true") }}
{{- include "splunk-otel-collector.splunkPlatformTracesExporter" . | nindent 2 }}
{{- end }}
service:
telemetry:
metrics:
Expand All @@ -179,7 +182,7 @@ service:
# The default pipelines should not need to be changed. You can add any custom pipeline instead.
# In order to disable a default pipeline just set it to `null` in gateway.config overrides.
pipelines:
{{- if (eq (include "splunk-otel-collector.o11yTracesEnabled" $) "true") }}
{{- if (eq (include "splunk-otel-collector.tracesEnabled" $) "true") }}
# default traces pipeline
traces:
receivers: [otlp, jaeger, zipkin]
Expand All @@ -194,7 +197,13 @@ service:
{{- if .Values.environment }}
- resource/add_environment
{{- end }}
exporters: [sapm]
exporters:
{{- if (eq (include "splunk-otel-collector.o11yTracesEnabled" .) "true") }}
- sapm
{{- end }}
{{- if (eq (include "splunk-otel-collector.platformTracesEnabled" .) "true") }}
- splunk_hec/platform_traces
{{- end }}
Comment on lines +200 to +206
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar changes need to be done in the agent config. The gateway is not enabled by default

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good spot! I updated the agent config (we switched to running in gateway mode hence not spotting it)

{{- end }}

{{- if (eq (include "splunk-otel-collector.metricsEnabled" .) "true") }}
Expand Down
2 changes: 1 addition & 1 deletion helm-charts/splunk-otel-collector/templates/daemonset.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ spec:
{{- end }}
ports:
{{- range $key, $port := $agent.ports }}
{{- if eq true (and (eq (include "splunk-otel-collector.metricsEnabled" $) "true") (has "metrics" $port.enabled_for)) (and (eq (include "splunk-otel-collector.o11yTracesEnabled" $) "true") (has "traces" $port.enabled_for)) (and (eq (include "splunk-otel-collector.logsEnabled" $) "true") (has "logs" $port.enabled_for)) (and (eq (include "splunk-otel-collector.profilingEnabled" $) "true") (has "profiling" $port.enabled_for)) }}
{{- if eq true (and (eq (include "splunk-otel-collector.metricsEnabled" $) "true") (has "metrics" $port.enabled_for)) (and (eq (include "splunk-otel-collector.tracesEnabled" $) "true") (has "traces" $port.enabled_for)) (and (eq (include "splunk-otel-collector.logsEnabled" $) "true") (has "logs" $port.enabled_for)) (and (eq (include "splunk-otel-collector.profilingEnabled" $) "true") (has "profiling" $port.enabled_for)) }}
- name: {{ $key }}
{{- omit $port "enabled_for" | toYaml | trim | nindent 10 }}
{{- end }}
Expand Down
7 changes: 7 additions & 0 deletions helm-charts/splunk-otel-collector/values.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@
"metricsIndex": {
"type": "string"
},
"tracesIndex": {
"type": "string"
},
"source": {
"type": "string"
},
Expand Down Expand Up @@ -81,6 +84,10 @@
"description": "Send Metrics to Splunk Platform",
"type": "boolean"
},
"tracesEnabled": {
"description": "Send Traces to Splunk Platform",
"type": "boolean"
},
"fieldNameConvention": {
"type": "object",
"additionalProperties": false,
Expand Down
5 changes: 4 additions & 1 deletion helm-charts/splunk-otel-collector/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ splunkPlatform:
index: "main"
# Name of the Splunk metric type index targeted. Required when ingesting metrics to Splunk Platform.
metricsIndex: ""
# Name of the Splunk event type index targeted. Required when ingesting traces to Splunk Platform.
tracesIndex: ""
# Optional. Default value for `source` field.
source: "kubernetes"
# Optional. Default value for `sourcetype` field. For container logs, it will
Expand Down Expand Up @@ -67,7 +69,8 @@ splunkPlatform:
logsEnabled: true
# If you enable metrics collection, make sure that `metricsIndex` is provided as well.
metricsEnabled: false

# If you enable traces collection, make sure that `tracesIndex` is provided as well.
tracesEnabled: false
# Field name conventions to use. (Only for those who are migrating from Splunk Connect for Kubernetes helm chart)
fieldNameConvention:
# Boolean for renaming pod metadata fields to match to Splunk Connect for Kubernetes helm chart.
Expand Down