Druva Source
The Druva source provides the ability to analyze and fetch event logs from the Druva inSync API and sends it to Sumo Logic. The Druva inSync backs up endpoint data and cloud applications, such as Microsoft Office 365 and Salesforce. It also provides archiving, data compliance monitoring, legal hold management, monitoring, and detection tools to discover ransomware and eDiscovery.
This integration accesses the Druva inSync API to retrieve audit events. API documents can be found here.
Prerequisites
Before you begin setting up Druva source, you must meet the following requirements:
- An administrator account is required for Druva inSync Cloud.
- Enable the Export Events option. To know the steps, see the Configure Druva inSync section.
- Obtain access tokens by authentication.
Configure Druva inSync to export events
You must be a Druva inSync Cloud administrator to enable the option to export events and define the Events API settings.
To get the event logs, follow the steps to enable the Export Events:
- Log in to the Druva inSync Management Console with inSync Cloud account or inSync GovCloud account.
- On the inSync Management Console menu bar, click icon > Settings. The Settings page appears.
- Click the inSync APIs tab.
- In the Events API settings area, click Edit. The Edit Events API Settings window appears.
- Select the Export Events checkbox.
- Click in the Categories to export box and select the events that you want to export from inSync.
- In the Syslog facility field, type a value between 1 and 23 to assign a Syslog facility ID for inSync events. The default value is 23.
- Click Save.
Authentication
Druva supports OAuth 2.0-based authentication for incoming requests. Every use of Druva APIs requires authentication to ensure that only authorized users can interact with Druva APIs.
All requests to Druva APIs are authenticated using OAuth 2.0 access tokens which you receive in exchange of every authorization grant request you make. The OAuth token will expire after 30 minutes for Data Governance Cloud and 15 minutes for Data Governance GovCloud.
The Druva Source requires you to provide a Client ID, Client Secret Key, Base URL. To get these, follow the instructions from Create and Manage Druva API Credentials.
Data Sources
The Druva Source consumes event logs from the Data Governance Cloud or Data Governance GovCloud and sends it to Sumo Logic.
States
A Druva Source tracks errors, reports its health, and start-up progress. You’re informed, in real-time, if the Source is having trouble connecting, if there's an error requiring user action, or if it is healthy and collecting by utilizing Health Events.
A Druva Source goes through the following states when created:
- Pending. Once the Source is submitted, it is validated, stored, and placed in a Pending state.
- Started. A collection task is created on the Hosted Collector.
- Initialized. The task configuration is complete in Sumo Logic.
- Authenticated. The Source is successfully authenticated with Druva.
- Collecting. The Source is actively collecting data from Druva.
If the Source has any issues during any one of these states, it is placed in an Error state.
When you delete the Source, it is placed in a Stopping state. When it has successfully stopped, it is deleted from your Hosted Collector.
On the Collection page, the Health and Status for Sources is displayed. Use Health Events to investigate issues with collection. You can click the text in the Health column, such as Error, to open the issue in Health Events to investigate.
Setup and configuration Source
When you create a Druva Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector.
To configure a Druva Source:
- In Sumo Logic, select Manage Data > Collection > Collection.
- On the Collectors page, click Add Source next to a Hosted Collector.
- Select Druva icon.
- Enter a Name to display for the Source in the Sumo Logic web application. The description is optional.
- (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called
_sourceCategory
. - (Optional) Fields. Click the +Add to define the fields you want to associate. Each field needs a name (key) and value.
- A green circle with a check mark is shown when the field exists in the Fields table schema.
- An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped.
- Base URL. Choose the base url from the drop-down menu as per your requirements — Data Governance Cloud and Data GovernanceGov Cloud.
- Client ID. Enter your Client ID. To get Client ID, follow the instructions from Create and Manage Druva API Credentials.
- Secret Key. Enter your Secret Key. To get Secret Key, follow the instructions from Create and Manage Druva API Credentials.
- When you are finished configuring the Source, click Save.
Error types
When Sumo Logic detects an issue, it is tracked by Health Events. The following table shows three possible error types. It tells the reason for the error, if the source attempts to retry, and the name of the event log in the Health Event Index.
Type | Reason | Retries | Retry Behavior | Health Event Name |
---|---|---|---|---|
ThirdPartyConfig | Normally due to an invalid configuration. You'll need to review your Source configuration and make an update. | No retries are attempted until the Source is updated. | Not applicable | ThirdPartyConfigError |
ThirdPartyGeneric | Normally due to an error communicating with the third-party service APIs. | Yes | The Source will retry indefinitely. | ThirdPartyGenericError |
FirstPartyGeneric | Normally due to an error communicating with the internal Sumo Logic APIs. | Yes | The Source will retry indefinitely. | FirstPartyGenericError |
JSON configuration
Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See How to use JSON to configure Sources for details.
Parameter | Type | Required | Description | Access |
---|---|---|---|---|
config | JSON Object | Yes | Contains the configuration-parameters of the Source. | na |
schemaRef | JSON Object | Yes | Use {"type":"Druva"} for Druva Source. | not modifiable |
sourceType | String | Yes | Use Universal for Druva Source. | not modifiable |
Config Parameters
Parameter | Type | Required | Description | Access |
---|---|---|---|---|
name | String | Yes | Type the desired name of the Source and it must be unique per Collector. This value is assigned to the metadata field _source . | modifiable |
description | String | No | Type the description of the Source. | modifiable |
category | String | No | Type the category of the source. This value is assigned to the metadata field _sourceCategory . | modifiable |
fields | JSON Object | No | JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM. | modifiable |
baseURL | String | Yes | The base URL from which the customer wants to retrieve event data. | modifiable |
clientID | String | Yes | Client ID key of an application. | modifiable |
secretKey | String | Secret key of an application | modifiable |
JSON Example
{
"api.version": "v1",
"source": {
"config": {
"name": "Druva",
"description": "test_description",
"category": "source_category",
"baseURL": "https://apis.druva.com",
"clientID": "testclientid",
"secretKey": "*********",
"fields":{
"_siemForward":false
}
},
"schemaRef": {
"type": "Druva"
},
"sourceType": "Universal"
}
}