DataBee App For Splunk
OVERVIEW
- The DataBee Application for Splunk sends alerts and notable events to DataBee platform via an HTTP connector.
REQUIREMENTS
COMPATIBILITY MATRIX
- Splunk version: 9.4.x, 9.3.x, 9.2.x, 9.1.x
- Python version: Python3
- OS Support: Independent
- Browser Support: Independent
RECOMMENDED SYSTEM CONFIGURATION
RELEASE NOTES
Version 1.0.0
- Added the DataBee alert action to send alerts and notable events to the DataBee platform.
- Added Historical Triggered Alerts dashboard to send triggered alerts to the DataBee platform.
INSTALLATION
DataBee App For Splunk can be installed through the UI as shown below. Alternatively, .tar
or .spl
file can also be extracted directly into $SPLUNK_HOME/etc/apps/folder.
- Log in to Splunk Web and navigate to Apps > Manage Apps.
- Click
Install app from file
.
- Click
Choose file
and select the DataBee App For Splunk
installation file.
- Click on
Upload
.
- Restart Splunk if prompted.
TOPOLOGY AND SETTING UP SPLUNK ENVIRONMENT
This App can be set up in two ways:
- Standalone Mode
- Install the DataBee App For Splunk.
- Follow all the steps mentioned in
App Setup
section to configure the App.
- Distributed Environment
- Install the DataBee App For Splunk on the Search Head and Heavy Forwarder.
- Follow the steps #1 and #2 from
App Setup
section on Heavy Forwarder.
- Cloud Environment
- Install the DataBee App For Splunk on Search Head.
- Install the DataBee App For Splunk on IDM instance and configure it. (For the IDM instance Splunk support team will help) Or Setup the DataBee App For Splunk on the On-Premise Heavy Forwarder.
CONFIGURATION
Configure DataBee App For Splunk
App Setup
- Configure the account from which the data needs to be sent. Detailed steps and information for Account Configuration can be found in
Account
section.
- Users can also configure settings corresponding to the
Proxy
or Logging
in their respective sections.
Account
To configure the Account,
- Navigate to the
Configuration
.
- Provide the mentioned details as per the below table and click on
Add
.
DataBee App Account parameters |
Mandatory or Optional |
Description |
Account name |
Mandatory |
Enter a unique name for this account. |
Endpoint URL |
Mandatory |
Enter the Endpoint URL for this account. |
Tenant ID |
Mandatory |
Enter the Tenant ID for this account. |
Datasource ID |
Mandatory |
Enter the Datasource ID for this account. |
API Key |
Mandatory |
Enter the API Key for this account. |
Alert Actions |
Mandatory |
Select alert actions which needs to be triggered for this account. |
Proxy
To configure the Proxy,
- Navigate to the
Configuration
.
- Click on the
Proxy
tab.
- Provide your Proxy credential and Click on
Save
.
Proxy Parameters |
Mandatory or Optional |
Description |
Enable |
Optional |
To enable the proxy |
Proxy Type |
Optional |
Type of the Proxy. Available options are http and socks5. Default is http. |
Host |
Optional |
Host or IP of the proxy server |
Port |
Optional |
Port for proxy server |
Username |
Optional |
Username of the proxy server |
Password |
Optional |
Password of the proxy server |
Logging
To configure the Logging,
- Navigate to the
Configuration
.
- Click on the
Logging
tab.
- Select the log level from the dropdown and click on
Save
. By default, the log level is set to 'INFO'.
Dashboards
- Historical Triggered Alerts:
- This dashboard provides details for triggered alerts.
- Historical Triggered Alerts Panels:
- All the Triggered Alerts
- All Event Details
Alert Actions
This application contains the following alert actions:
- ta_databee_post_alerts_http_connector
- Description : To post the triggered alerts and notable events to DataBee.
- Parameters :
- global_account: Select the DataBee account for which you want to post data.
TROUBLESHOOTING
General Checks
- To troubleshoot DataBee App For Splunk, check
$SPLUNK_HOME/var/log/Splunk/ta_databee_*.log
or user can search index="_internal" source=*ta_databee_*.log*
query to see all the logs in UI. Also, user can use index="_internal" source=*ta_databee_*.log* ERROR
query to see ERROR logs in the Splunk UI.
- Note that all log files of this App will be generated in
$SPLUNK_HOME/var/log/Splunk/
directory.
- App icons are not showing up: The App does not require a restart after installation for all functionalities to work. However, the icons will be visible after one Splunk restart post installation.
Dashboards
- Historical Triggered Alerts:
- If dashboard panels are not populating data, it is possible that none of the Saved Searche has triggered yet, or else according to the provided parameters of App, Severity, Alert and Triggered Time might not have any triggered alerts.
BINARY FILE DECLARATION
SUPPORT
- Support Offered: Yes
- Support Details:
UNINSTALL & CLEANUP STEPS
- Remove $SPLUNK_HOME/etc/apps/DataBeeAppForSplunk
- Remove $SPLUNK_HOME/var/log/Splunk/ta_databee_.log*.
- To reflect the cleanup changes in the UI, restart the Splunk Enterprise instance.
©2025 Comcast Technology Solutions