Last updated
Last updated
S3 API calls can generate JSON events that many webhook target applications can receive as a stream of events and use them for auditing and analysis purposes. Such applications (see Splunk example below) should be configured to accept the events stream and provide it with an authentication token.
Enabling an audit webhook comes instead of the BucketLogging
S3 APIs and follows a similar best-effort nature. The purpose of these audit logs is to give an idea of the nature of traffic.
Note: In the event of a disconnection from the webhook application, or if the S3 clusters' internal events buffer fills up, events will get thrown away. It is advised to monitor the external webhook target application's availability.
Command: weka s3 cluster audit-webhook enable
Use the following command line to enable an audit webhook for the S3 cluster:
weka s3 cluster audit-webhook enable <--endpoint endpoint> <--auth-token auth-token>
Parameters in Command Line
Command: weka s3 cluster audit-webhook disable
Use this command to disable the audit webhook.
Command: weka s3 cluster audit-webhook show
Use this command to view the audit webhook configuration.
Setting up an HTTP Event Collector (HEC)
Make sure to copy the created token for later use.
Now you can search the index you've created in Splunk and see this event.
As a cluster admin, run the following CLI command to enable the audit webhook:
Follow the steps in . Since the S3 event stream is provided in JSON format, choose _json
as the data source type.
Follow the steps in to create a token that Weka will use to access the Splunk as HTTP webhook. You can create a new index or use an existing one for easy discovery/monitor/query.
To make sure the configuration works, send a test event as suggested .
Name
Type
Value
Limitations
Mandatory
Default
endpoint
String
The webhook endpoint
None
Yes
auth-token
Boolean
The authentication token obtained from the webhook service
None
Yes
This page describes how to set up an HTTP webhook for S3 audit purposes.