Splunk OpenTelemetry Collector for Kubernetes installation¶

Splunk OpenTelemetry Collector for Kubernetes is not required for SC4SNMP installation. However, Splunk OpenTelemetry Collector for Kubernetes sends logs and metrics from a k8s cluster to a Splunk instance, which makes SC4SNMP easier to debug. You can do the same using the microk8s kubectl logs command on instances you are interested in, but if you are not proficient in Kubernetes, Splunk OpenTelemetry Collector for Kubernetes is recommended.

The following steps are sufficient for a Splunk OpenTelemetry Collector installation for the SC4SNMP project with Splunk Enterprise/Enterprise Cloud. In order to learn more about Splunk OpenTelemetry Collector, visit Splunk OpenTelemetry Collector.

Offline installation¶

For offline installation instructions see Splunk OpenTelemetry Collector for Kubernetes offline installation.

Add Splunk OpenTelemetry Collector repository to HELM¶

microk8s helm3 repo add splunk-otel-collector-chart https://signalfx.github.io/splunk-otel-collector-chart

Install Splunk OpenTelemetry Collector with HELM for a Splunk Platform¶

In order to run Splunk OpenTelemetry Collector on your environment, replace <> variables based on the following description:

microk8s helm3 upgrade --install sck \
  --set="clusterName=<cluster_name>" \
  --set="splunkPlatform.endpoint=<splunk_endpoint>" \
  --set="splunkPlatform.insecureSkipVerify=<insecure_skip_verify>" \
  --set="splunkPlatform.token=<splunk_token>" \
  --set="logsEngine=otel" \
  --set="splunkPlatform.metricsEnabled=true" \
  --set="splunkPlatform.metricsIndex=em_metrics" \
  --set="splunkPlatform.index=em_logs" \
  splunk-otel-collector-chart/splunk-otel-collector

Variables description¶

Placeholder	Description	Example
splunk_endpoint	host address of splunk instance	https://endpoint.example.com:8088/services/collector
insecure_skip_verify	is insecure ssl allowed	false
splunk_token	Splunk HTTP Event Collector token	450a69af-16a9-4f87-9628-c26f04ad3785
cluster_name	name of the cluster	my-cluster

See the following example of a correctly filled up command:

microk8s helm3 upgrade --install sck \
  --set="clusterName=my-cluster" \
  --set="splunkPlatform.endpoint=https://endpoint.example.com/services/collector" \
  --set="splunkPlatform.insecureSkipVerify=false" \
  --set="splunkPlatform.token=4d22911c-18d9-4706-ae7b-dd1b976ca6f7" \
  --set="splunkPlatform.metricsEnabled=true" \
  --set="splunkPlatform.metricsIndex=em_metrics" \
  --set="splunkPlatform.index=em_logs" \
  splunk-otel-collector-chart/splunk-otel-collector

Install Splunk OpenTelemetry Collector with HELM for Splunk Observability for Kubernetes¶

To run Splunk OpenTelemetry Collector on your environment, replace the <> variables based on the following description:

microk8s helm3 upgrade --install sck
--set="clusterName=<cluster_name>"
--set="splunkObservability.realm=<realm>"
--set="splunkObservability.accessToken=<token>"
--set="splunkObservability.ingestUrl=<ingest_url>"
--set="splunkObservability.apiUrl=<api_url>"
--set="splunkObservability.metricsEnabled=true"
--set="splunkObservability.tracesEnabled=false"
--set="splunkObservability.logsEnabled=false"
splunk-otel-collector-chart/splunk-otel-collector

Variables description¶

Placeholder	Description	Example
cluster_name	name of the cluster	my_cluster
realm	Realm obtained from the Splunk Observability Cloud environment	us0
token	Token obtained from the Splunk Observability Cloud environment	BCwaJ_Ands4Xh7Nrg
ingest_url	Ingest URL from the Splunk Observability Cloud environment	https://ingest..signalfx.com
api_url	API URL from the Splunk Observability Cloud environment	https://api..signalfx.com

See the following example of a correctly filled up command:

microk8s helm3 upgrade --install sck
--set="clusterName=my_cluster"
--set="splunkObservability.realm=us0"
--set="splunkObservability.accessToken=BCwaJ_Ands4Xh7Nrg"
--set="splunkObservability.ingestUrl=https://ingest..signalfx.com"
--set="splunkObservability.apiUrl=https://api..signalfx.com"
--set="splunkObservability.metricsEnabled=true"
--set="splunkObservability.tracesEnabled=false"
--set="splunkObservability.logsEnabled=false"
splunk-otel-collector-chart/splunk-otel-collector