
Telemetry Collection
The Humio Operator can collect usage and cluster information from
LogScale clusters and export it to a remote endpoint. There are
two approaches: a simple setup through the
HumioCluster spec, and an advanced
setup using
HumioTelemetryCollection and
HumioTelemetryExport resources
directly.
Simple Setup
The simplest way to enable telemetry collection is through your
HumioCluster configuration. This
approach automatically creates the required telemetry collection and
export resources.
Setup Steps
Create the Ingest Token Secret
Create a Kubernetes secret containing your telemetry token:
shellkubectl create secret generic telemetry-token-secret \ --from-literal=token="<PROVIDED_INGEST_TOKEN>" \ --namespace=<your-humio-namespace>Configure Telemetry in Your HumioCluster
Add the following telemetry configuration to your HumioCluster spec:
yamlapiVersion: core.humio.com/v1alpha1 kind: HumioCluster metadata: name: your-cluster-name namespace: your-humio-namespace spec: # ... your existing cluster configuration ... # Enable telemetry collection and export telemetryConfig: # Choose a meaningful identifier for your cluster clusterIdentifier: "<your-meaningful-cluster-id>" remoteReport: url: "https://<your-logscale-cluster-url>/api/v1/ingest/hec" token: secretKeyRef: name: "telemetry-token-secret" key: "token" collections: - interval: "1d" include: - "license" # License status and limits - "cluster_info" # Version and node information - "ingestion_metrics" # Daily/weekly/monthly ingest volumes - interval: "1h" include: - "repository_usage" # Per-repository usage statistics
This configuration automatically creates
HumioTelemetryCollection and
HumioTelemetryExport resources
managed by the operator.
Verify Telemetry Collection
After configuring telemetry, verify that collection is running properly:
# Check that telemetry collection is running
kubectl get humiotelemetrycollection -n <your-namespace>
# Check collection status
kubectl describe humiotelemetrycollection <cluster-name>-telemetry -n <your-namespace>
# Check export status
kubectl describe humiotelemetryexport <cluster-name>-telemetry-export -n <your-namespace>Look for successful collection timestamps and export status in the resource descriptions. The status sections will show collection counts, error information, and last successful export times.
HumioTelemetryCollection (Advanced Setup)
For advanced configurations, you can create
HumioTelemetryCollection resources
directly. This approach provides more flexibility for complex telemetry
scenarios such as multiple export destinations.
A HumioTelemetryCollection resource
configures telemetry data collection from a LogScale cluster. It
defines what data to collect, how often to collect it, and provides status
reporting for monitoring collection health.
apiVersion: core.humio.com/v1alpha1
kind: HumioTelemetryCollection
metadata:
name: cluster-telemetry
namespace: logging
spec:
managedClusterName: "example-humiocluster"
clusterIdentifier: "production-cluster-us-west"
collections:
# Daily collection for business metrics
- interval: "1d"
include:
- "license" # License details and limits
- "cluster_info" # Version, node count
- "ingestion_metrics" # Daily/weekly/monthly ingest volumes
# Hourly collection for operational metrics
- interval: "1h"
include:
- "repository_usage" # Per-repository storage and activityAvailable collection types:
license: License type, expiration dates, user limits, and ingestion limitscluster_info: LogScale version, node count, and cluster health informationingestion_metrics: Daily, weekly, and monthly ingestion volumes with storage utilizationrepository_usage: Per-repository ingestion, storage usage, and activity metrics
HumioTelemetryExport
A HumioTelemetryExport resource
defines where to send collected telemetry data. It can export data from
multiple HumioTelemetryCollection
resources to remote endpoints using HTTP Event Collector (HEC) protocol.
apiVersion: core.humio.com/v1alpha1
kind: HumioTelemetryExport
metadata:
name: telemetry-exporter
namespace: logging
spec:
remoteReport:
url: "https://telemetry.example.com/api/v1/ingest/hec"
token:
secretKeyRef:
name: "telemetry-token-secret"
key: "token"
tls:
insecureSkipVerify: false
registeredCollections:
- name: "cluster-telemetry"
namespace: "logging"
sendCollectionErrors: trueMultiple exporters can reference the same collection to send data to different destinations. This enables scenarios such as sending basic operational metrics to external systems while keeping detailed data locally for compliance or security requirements.