diff --git a/blog-service/2025-10-09-collection.md b/blog-service/2025-10-09-collection.md new file mode 100644 index 0000000000..668cb6393a --- /dev/null +++ b/blog-service/2025-10-09-collection.md @@ -0,0 +1,12 @@ +--- +title: Databricks Audit Source (Collection) +image: https://help.sumologic.com/img/sumo-square.png +keywords: + - c2c + - databricks-audit-source +hide_table_of_contents: true +--- + +import useBaseUrl from '@docusaurus/useBaseUrl'; + +We're excited to announce the release of our new cloud-to-cloud source for Databricks Audit. This source securely collects audit logs from the Databricks platform and sends them to Sumo Logic for streamlined analysis. [Learn more](/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/databricks-audit-source). diff --git a/cid-redirects.json b/cid-redirects.json index b753c5ff7c..4d0facc58e 100644 --- a/cid-redirects.json +++ b/cid-redirects.json @@ -2948,6 +2948,7 @@ "/docs/integrations/microsoft-azure/microsoft-defender-for-identity/": "/docs/integrations/microsoft-azure/azure-security-microsoft-defender-for-identity", "/cid/1112": "/docs/integrations/saas-cloud/carbon-black-inventory/", "/cid/1111": "/docs/integrations/microsoft-azure/azure-open-ai", + "/cid/1113": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/databricks-audit-source/", "/Cloud_SIEM_Enterprise": "/docs/cse", "/Cloud_SIEM_Enterprise/Administration": "/docs/cse/administration", "/Cloud_SIEM_Enterprise/Administration/Cloud_SIEM_Enterprise_Feature_Update_(2022)": "/docs/cse/administration", diff --git a/docs/integrations/product-list/product-list-a-l.md b/docs/integrations/product-list/product-list-a-l.md index a1d903b174..f9bd88393f 100644 --- a/docs/integrations/product-list/product-list-a-l.md +++ b/docs/integrations/product-list/product-list-a-l.md @@ -186,6 +186,7 @@ For descriptions of the different types of integrations Sumo Logic offers, see [ | :-- | :-- | :-- | | Thumbnail icon | [DarkOwl](https://www.darkowl.com/) | Automation integration: [DarkOwl](/docs/platform-services/automation-service/app-central/integrations/darkowl/) | | Thumbnail icon | [Darktrace](https://darktrace.com/) | Automation integration: [Darktrace](/docs/platform-services/automation-service/app-central/integrations/darktrace/)
Cloud SIEM integration: [Darktrace](https://github.com/SumoLogic/cloud-siem-content-catalog/blob/master/vendors/91f4544f-6118-4bdc-8b30-01f045d20e4c.md) | +| Thumbnail icon | [Databricks](https://www.databricks.com/) | Collector: [Databricks Audit Source](/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/databricks-audit-source/) | | Thumbnail icon | [Datadog](https://www.datadoghq.com/) | App: [Datadog](/docs/integrations/saas-cloud/datadog/)
Webhook: [Webhook Connection for Datadog](/docs/alerts/webhook-connections/datadog/) | | Thumbnail icon | [Dataminr](https://www.dataminr.com/) | Cloud SIEM integration: [Dataminr](https://github.com/SumoLogic/cloud-siem-content-catalog/blob/master/vendors/0019f757-3674-4688-9d6c-063366cfcfa9.md)
Partner integration: [Dataminr Pulse for Sumo Logic](https://github.com/SumoLogic/sumologic-public-partner-apps/tree/master/DataminrPulse) | | Thumbnail icon | [Datto](https://www.datto.com/) | Automated integration: [Datto RMM](/docs/platform-services/automation-service/app-central/integrations/datto-rmm/)
Cloud SIEM integration: [Datto](https://github.com/SumoLogic/cloud-siem-content-catalog/blob/master/vendors/1E4721C4-DC98-456D-B0DF-80365924683A.md) | diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/databricks-audit-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/databricks-audit-source.md new file mode 100644 index 0000000000..402aefb998 --- /dev/null +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/databricks-audit-source.md @@ -0,0 +1,109 @@ +--- +id: databricks-audit-source +title: Databricks Audit Source +sidebar_label: Databricks Audit +tags: + - cloud-to-cloud + - databricks-audit-logs +description: Learn how to collect Databricks Audit logs and send them to Sumo Logic for monitoring, auditing, and compliance. +--- + +import ForwardToSiem from '/docs/reuse/forward-to-siem.md'; +import useBaseUrl from '@docusaurus/useBaseUrl'; + +icon + +The Sumo Logic source for Databricks enables you to collect audit logs from Databricks into Sumo Logic. This integration helps you to capture structured records of user and system activities within the Databricks workspace, including SQL queries, job executions, cluster events, and workspace changes. These logs facilitate auditing, security monitoring, and regulatory compliance. + +## Data collected + +| Polling Interval | Data | +| :--- | :--- | +| 5 minutes | [Audit Logs](https://docs.databricks.com/api/workspace/statementexecution/executestatement) | + +## Setup + +### Vendor configuration + +The Databricks Audit source requires you to provide the Databricks Audit Base URL (API Gateway URL), Warehouse ID, Client ID, and Client Secret to configure the source. Follow the below steps to generate the required values: + +#### Base URL + +Follow the below steps to get the Base URL for user configuration: +1. [Sign in](https://accounts.cloud.databricks.com/login?tuuid=ee23ab7a-a2b9-4512-8973-fc787eb3c01e) to your **Databricks** workspace. +2. The Base URL is visible in your browser’s address bar after login. For example, `https://YOUR-INSTANCE.databricks.com`. + +#### Warehouse ID + +The Warehouse ID is required to query Databricks SQL and fetch audit logs. Follow the below steps to get the Warehouse ID for user configuration: +1. [Sign in](https://accounts.cloud.databricks.com/login?tuuid=ee23ab7a-a2b9-4512-8973-fc787eb3c01e) to your **Databricks** workspace. +2. Navigate to **SQL Warehouses** in the sidebar. +3. Click the warehouse name you want to use. +4. On the warehouse **details page**, select the **Properties** tab. +5. Locate and copy the **Warehouse ID**. For example, `bd4dc8ef7e54782c`. + +#### Client ID and Client Secret + +To generate the Client ID and Client Secret, refer to the [Create an OAuth Secret](https://docs.databricks.com/aws/en/dev-tools/auth/oauth-m2m?language=Environment#-step-1-create-an-oauth-secret) section. + +### Source configuration + +When you create a Databricks Audit 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 and Source](/docs/send-data/hosted-collectors/configure-hosted-collector). + +To configure Databricks Audit Source: +1. [**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic main menu select **Data Management**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**.
[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. +1. On the Collectors page, click **Add Source** next to a Hosted Collector. +1. Search for and select the **Databricks Audit** icon. +1. Enter a **Name** to display for the Source in Sumo Logic. The description is optional. +1. (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`. +1. (Optional) **Fields**. Click the **+Add Field** link to define the fields you want to associate. Each field needs a name (key) and value. + * green check circle.png A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema. + * orange exclamation point.png An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, you'll see an option to automatically add or enable the nonexistent fields to the Fields table schema. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped. +1. Enter the [Base URL](#base-url) of your account. +1. Enter the [Warehouse ID](#warehouse-id) collected from the [vendor configuration](#vendor-configuration] to fetch audit logs. +1. Enter the [Client ID and Client Secret](#client-id-and-client-secret) collected from the [vendor configuration](#vendor-configuration] to authorize access to your Databricks resources. +1. The **Polling Interval** is set for 5 minutes by default. You can adjust it based on your needs. +1. When you are finished configuring the Source, click **Save**. + +## JSON schema + +Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See [Use JSON to Configure Sources](/docs/send-data/use-json-configure-sources) for details.  + +| Parameter | Type | Value | Required | Description | +|:--|:--|:--|:--|:--| +| schemaRef | JSON Object | `{"type":"Databricks Audit Logs"}` | Yes | Define the specific schema type. | +| sourceType | String | `"Universal"` | Yes | Type of source. | +| config | JSON Object | [Configuration object](#configuration-object) | Yes | Source type specific values. | + +### Configuration Object + +| Parameter | Type | Required | Default | Description | Example | +|:--|:--|:--|:--|:--|:--| +| name | String | Yes | `null` | Type a desired name of the source. The name must be unique per Collector. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_source`. | `"mySource"` | +| description | String | No | `null` | Type a description of the source. | `"Testing source"` +| category | String | No | `null` | Type a category of the source. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_sourceCategory`. See [best practices](/docs/send-data/best-practices) for details. | `"mySource/test"` +| fields | JSON Object | No | `null` | JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field `_siemForward` to enable forwarding to SIEM.|`{"_siemForward": false, "fieldA": "valueA"}` | +| baseURL | String | Yes | `null` | Base URL of the Databricks workspace. For example, `https://.databricks.com`. | | +| warehouseID | String | Yes | `null` | Unique identifier of the SQL Warehouse within the Databricks workspace, used to query and fetch audit logs. For example, `bd4dc8ef7e54782c`. | | +| clientID | String | Yes | `null` | Client ID of the account. | | +| clientSecret | String | Yes | `null` | Client Secret of the account | | +| pollingIntervalMin | Integer | No | 5 minutes | Time interval after which the source will check for new data.
Minimum: 5 minutes
Maximum: 24 hours | | + +### JSON example + +```json reference +https://github.com/SumoLogic/sumologic-documentation/blob/main/static/files/c2c/databricks-audit/example.json +``` + +### Terraform example + +```sh reference +https://github.com/SumoLogic/sumologic-documentation/blob/main/static/files/c2c/databricks-audit/example.tf +``` + + +## FAQ + +:::info +Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources. +::: diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/index.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/index.md index f523f51abe..d26a145f79 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/index.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/index.md @@ -272,7 +272,13 @@ In this section, we'll introduce the following concepts:
- Thumbnail icon

Digital Guardian

 + icon

Databricks Audit

 +

Track user and system activities to support governance and compliance using Databricks Audit logs.

+
+
+
+
+ Thumbnail icon

Digital Guardian

Learn how to collect export data from the Digital Guardian and send it to Sumo Logic.

diff --git a/sidebars.ts b/sidebars.ts index a8bdb37dea..44f8f0dd17 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -463,6 +463,7 @@ module.exports = { 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/cyberark-source', 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/cyberark-audit-source', 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/cybereason-source', + 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/databricks-audit-source', 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/digital-guardian-source', 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/docusign-source', 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/dropbox-source', diff --git a/static/files/c2c/databricks-audit/example.json b/static/files/c2c/databricks-audit/example.json new file mode 100644 index 0000000000..fdd1bc459c --- /dev/null +++ b/static/files/c2c/databricks-audit/example.json @@ -0,0 +1,17 @@ +{ + "api.version": "v1", + "source": { + "config": { + "name": "Databricks Audit Logs", + "baseURL": "https://.databricks.com", + "warehouseId": "bf7gs36gfr54392c", + "clientId": "bf7gs36gfs-r54392c-lkdsdas", + "clientSecret": "wdwxxxxxqwedwedxxxxxqewdxxxxxxqwedxxxx", + "pollingInterval": "5m" + }, + "schemaRef": { + "type": "Databricks Audit Logs" + }, + "sourceType": "Universal" + } +} \ No newline at end of file diff --git a/static/files/c2c/databricks-audit/example.tf b/static/files/c2c/databricks-audit/example.tf new file mode 100644 index 0000000000..2ca68d53d2 --- /dev/null +++ b/static/files/c2c/databricks-audit/example.tf @@ -0,0 +1,18 @@ +resource "sumologic_cloud_to_cloud_source" "databricks-audit-source" { + collector_id = sumologic_collector.collector.id + schema_ref = { + type = "Databricks Audit Source" + } + config = jsonencode({ + "name": "Databricks Audit Logs", + "baseURL": "https://.databricks.com", + "warehouseId": "bf7gs36gfr54392c", + "clientId": "bf7gs36gfs-r54392c-lkdsdas", + "clientSecret": "wdwxxxxxqwedwedxxxxxqewdxxxxxxqwedxxxx", + "pollingInterval": "5m" + }) +} +resource "sumologic_collector" "collector" { + name = "my-collector" + description = "Just testing this" +} \ No newline at end of file diff --git a/static/img/collector/databricks-icon.png b/static/img/collector/databricks-icon.png new file mode 100644 index 0000000000..d6cf3940e6 Binary files /dev/null and b/static/img/collector/databricks-icon.png differ