Monitor Resilio with Splunk
Feature availability
Splunk integration is available in Resilio 6.0 and newer.
You can monitor your Resilio deployment with Splunk using the resilio_reporting modular input app.
Prerequisites
Monitoring your Resilio deployment with Splunk requires:
- An existing Splunk instance that can reach the Resilio Management Console API over HTTPS.
- API feature enabled in your Resilio license.
- The
resilio_reportingapp package.
Set up Splunk integration
To monitor your Resilio deployment with Splunk:
- Download and extract the
resilio_reportingapp package. -
Copy the entire
resilio_reportingapp folder to the Splunk apps directory.- Linux:
/opt/splunk/etc/apps/resilio_reporting/ - Windows:
C:\Program Files\Splunk\etc\apps\resilio_reporting\
- Linux:
-
Generate API token or enable JWT authentication via OAuth2 using Okta or Microsoft Entra ID:
Important
Use only one input stanza at a time. If both
[resilio_reporting://api_token]and[resilio_reporting://oauth]are enabled, events will be duplicated.API token
Important
The API token must be tied to an administrator account with Super Administrator permissions to ensure access to audit logs. Note that this token can be used to access all Management Console's API endpoints, so it should be kept secure.
- In the Management Console, select Settings > API.
- Click + Create new token.
- Enter description, select an administrator account that will be tied to this token, then click Save.
- Copy the token value and use it in the next step.
JWT authentication via OAuth2
Setup integration with your identity provider to enable JWT authentication via OAuth2:
- Okta - Management Console integration with Okta
- Microsoft Entra ID - Management Console integration with Microsoft Entra ID
-
Create
localfolder andinputs.conffile in it.- Linux:
/opt/splunk/etc/apps/resilio_reporting/local/inputs.conf - Windows:
C:\Program Files\Splunk\etc\apps\resilio_reporting\local\inputs.conf
- Linux:
-
Open
local/inputs.conf, copy configuration specific to your authentication method, and provide your Management Console URL along with authentication details.API token authentication
JWT authentication via OAuth2
[resilio_reporting://oauth] base_url = https://<YOUR_RESILIO_SERVER_HOST>:8446 oauth_token_url = https://<YOUR_IDP_HOST>/oauth2/token client_id = <YOUR_CLIENT_ID> client_secret = <YOUR_CLIENT_SECRET> scope = <YOUR_SCOPE> views = audit_logs_view,events_logs_view,file_events_view query_limit = 10000 tls_verify = true interval = 60 -
Proceed with setting up your data input stream.
Configuration parameters reference
| Parameter | Description |
|---|---|
base_urlMandatory |
Replace with your Management Console address. |
api_tokenConditional |
Replace with your API token if using token authentication. Required when using token authentication. |
oauth_token_urlConditional |
OAuth2 token endpoint URL used with client_credentials flow. Required when using OAuth2 authentication. |
client_idConditional |
OAuth2 client identifier for your identity provider application. Required when using OAuth2 authentication. |
client_secretConditional |
OAuth2 client secret for your identity provider application. Required when using OAuth2 authentication. |
tls_verifyMandatory |
Must be true in production unless you configure trust for an internal CA. |
ca_certOptional |
Path to a custom CA bundle (PEM) on the Splunk host. If set, it takes precedence over tls_verify. |
viewsOptional |
Comma-separated list of views to collect. Default: audit_logs_view,events_logs_view,file_events_view. |
query_limitOptional |
Maximum rows per request. Default: 10000.Note: 10000 is also the maximum allowed value. |
intervalOptional |
Collection interval in seconds. Default: 60. |
scopeOptional |
Optional OAuth2 scope. |
tls_verify
Keep tls_verify=true in production. If the server uses an internal or self-signed CA, configure ca_cert instead of disabling TLS verification.
Data collection and troubleshooting
- The app collects:
audit_logs_view- System and Agent management audit logs.events_logs_view- System events log.file_events_view- File transfer and file management events.
- The app defines the
resilioindex by default. - Collection checkpoints (last
SeqId) are stored per view in Splunk checkpoints, so collection resumes after restart without duplicates.
Search collected data:
index=resilio sourcetype IN (resilio:audit_logs_view, resilio:events_logs_view, resilio:file_events_view)
Search input errors: