Skip to content

honeydbio/splunk_ta_honeydb

Repository files navigation

Splunk TA for HoneyDB

This Splunk App pulls bad host and sensor data form the HoneyDB API.

Install

Place this app on your search head under $SPLUNK_HOME/etc/apps/ Create the index on your indexer, see Create Indexes section below for instructions.

In order for the app to pull data from HoneyDB you must add your API keys to the configuration. There are two files used to configure the app:

  • bin/honeydb.json
  • default/inputs.conf

At minimum, and recommended, you only need to add your HoneyDB API ID and API Key to bin/honeydb.json.

Configuration file: bin/honeydb.json

{
    "X-HoneyDb-ApiId": "<your key ID>",
    "X-HoneyDb-ApiKey": "<your secret key>",
    "subscription": "<your subscription plan>"
}

Create Indexes

Create indexes.conf on your indexer with the default index name "honeydb" Below is the sample of index:

[honeydb]
homePath   = $SPLUNK_DB/honeydb/db
coldPath   = $SPLUNK_DB/honeydb/colddb 
thawedPath = $SPLUNK_DB/honeydb/thaweddb
#1 day retention 
frozenTimePeriodInSecs = 86400
#14 day retention
#frozenTimePeriodInSecs = 1209600

**NOTE: If you change the index name, make sure you update default/inputs.conf to reflect the new index name, e.g. index = <new index name >

Viewing data in Splunk

sourcetype="honeydb_badhosts"

sourcetype="honeydb_sensor_data"

If you changed index name or sourcetype, please modify the above query accordingly.

Troubleshooting

  • You can view Splunk app error messages by querying index=_internal source="*splunk/honeydb.log" or index=_internal source = *splunkd.log

Dashboards

  1. Select splunk_ta_honeydb app in the Splunk UI. Go to Dashboards and click on HoneyDB BadHosts or HoneyDB Events.

Bad Hosts

HoneyDB Bad Hosts

Sensor Data (Events)

HoneyDB Sensor Data

About

HoneyDB Splunk App!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published