Storing ClickHouse Cloud Audit logs into Splunk
Splunk is a data analytics and monitoring platform.
This add-on allows users to store the ClickHouse Cloud audit logs into Splunk. It uses ClickHouse Cloud API to download the audit logs.
This add-on contains only a modular input, no additional UI are provided with this add-on.
Installation
For Splunk Enterprise
Download the ClickHouse Cloud Audit Add-on for Splunk from Splunkbase.
![Download from Splunkbase](/docs/assets/images/splunk_001-56c3793293d9ee34aef8360a00c12a34.png)
In Splunk Enterprise, navigate to Apps -> Manage. Then click on Install app from file.
![Manage apps](/docs/assets/images/splunk_002-4d9e1dbaee70dacc3f568d7bc80d9c13.png)
Select the archived file downloaded from Splunkbase and click on Upload.
![Manage apps](/docs/assets/images/splunk_003-6b3fa649846d43334b73061adf38ab6b.png)
If everything goes fine, you should now see the ClickHouse Audit logs application installed. If not, consult the Splunkd logs for any errors.
Modular input configuration
To configure the modular input, you'll first need information from your ClickHouse Cloud deployment:
- The organization ID
- An admin API Key
Getting information from ClickHouse Cloud
Log in to the ClickHouse Cloud console.
Navigate to your Organization -> Organization details. There you can copy the Organization ID.
![Manage apps](/docs/assets/images/splunk_004-26c1764c29db1107d6a5e48639a2dae3.png)
Then, navigate to API Keys from the left-end menu.
![Manage apps](/docs/assets/images/splunk_005-14bda8d3a823d0afa6275ee2364a08d8.png)
Create an API Key, give a meaningful name and select Admin
privileges. Click on Generate API Key.
![Manage apps](/docs/assets/images/splunk_006-6b9e7a28df9ec42f56929094b1c29ef0.png)
Save the API Key and secret in a safe place.
![Manage apps](/docs/assets/images/splunk_007-72ad6e2bd52d90cc3a09917f8858de3e.png)
Configure data input in Splunk
Back in Splunk, navigate to Settings -> Data inputs.
![Manage apps](/docs/assets/images/splunk_008-e4331eb5a653651446b2c35ef22a363f.png)
Select the ClickHouse Cloud Audit Logs data input.
![Manage apps](/docs/assets/images/splunk_009-53214aee3a695e3bb07b9ddb01ffccc1.png)
Click "New" to configure a new instance of the data input.
![Manage apps](/docs/assets/images/splunk_010-1dc6d750d3ea7327ac7bfb0e24d9e0b6.png)
Once you have entered all the information, click Next.
![Manage apps](/docs/assets/images/splunk_011-9d83a01ee4d5577285eabf9c0ae839ee.png)
The input is configured, you can start browsing the audit logs.
Usage
The modular input stores data in Splunk. To view the data, you can use the general search view in Splunk.
![Manage apps](/docs/assets/images/splunk_012-f14c7e085a798b7e189c0346d6b2bce2.png)