splunk_exporter

Monitor a Splunk instance

❓ Howto

You will need a configuration file, follow splunk_exporter_example.yml format.

./splunk_exporter --help

🧪 Example run

You need docker compose installed, a bash helper is provided to start the exporter and the whole test bench as a docker compose environment.

cd deploy/
bash run.sh

To stop it:

docker compose down

👷 Contribute

After doing some changes, possible to re-deploy splunk_exporter with the following command

docker compose up -d --build splunk_exporter

🛠️ Configuration

Splunk exporter needs to access management APIs See an example configuration file in splunk_exporter_example.yml.

📏 metrics

All metrics are Gauge.

from API

Prefix	Labels	Description
splunk_exporter_index_	index_name	Numerical data coming from data/indexes endpoint.
splunk_exporter_indexer_throughput_bytes_per_seconds	None	Average data throughput in indexer
splunk_exporter_metric_	Dimensions returned by Splunk	Export from metric indexes
splunk_exporter_health_splunkd	name	Health status from local splunkd
splunk_exporter_health_deployment	instance_id, name	Health status from deployment

🧑‍🔬 Testing

go test -v ./...

✨ Roadmap

Item	Status
Metrics indexes	✅ Done
Indexes metrics	🕰️ Ongoing
Savedsearches metrics	🔜 Next
System metrics	❓ Not planned yet
Ingestion pipeline	❓ Not planned yet