diff --git a/cid-redirects.json b/cid-redirects.json index 0999f3473b..32c9260a87 100644 --- a/cid-redirects.json +++ b/cid-redirects.json @@ -1628,6 +1628,7 @@ "/cid/10163": "/docs/cse/administration", "/cid/10264": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/gmail-tracelogs-source", "/cid/12321": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/lastpass-source", + "/cid/10231": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sumo-logic-sample-data-source", "/cid/10164": "/docs/alerts/scheduled-searches/schedule-search", "/cid/10165": "/docs/integrations/cloud-security-monitoring-analytics", "/cid/10166": "/docs/cse/records-signals-entities-insights/configure-entity-lookup-table", diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sumo-logic-sample-data-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sumo-logic-sample-data-source.md new file mode 100644 index 0000000000..12d4dea0c0 --- /dev/null +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sumo-logic-sample-data-source.md @@ -0,0 +1,91 @@ +--- +id: sumo-logic-sample-data-source +title: Sumo Logic Sample Data Source +sidebar_label: Sumo Logic Sample Data +keywords: + - sumo-logic-sample-data + - cloud-to-cloud +description: Learn how to collect audit reporting events from Sumo Logic Sample Data platform. +--- +import CodeBlock from '@theme/CodeBlock'; +import ExampleJSON from '/files/c2c/sumo-logic-sample-data/example.json'; +import MyComponentSource from '!!raw-loader!/files/c2c/sumo-logic-sample-data/example.json'; +import TerraformExample from '!!raw-loader!/files/c2c/sumo-logic-sample-data/example.tf'; +import useBaseUrl from '@docusaurus/useBaseUrl'; + + + + + +

Beta

+ +thumbnail icon + +Sumo Logic Sample Data source is designed for ingesting logs and metrics into Sumo Logic for the OpenTelemetry demo application. The data source is engineered to provide a continuous stream of data that simulates a specific scenario, highlighting latency spikes across various services. + +## Data collected + +| Name | Description | +| :--- | :--- | +| Initial Data | The source ingests data from 6 hours in the past and 6 hours into the future. | +| Regular Ingestion | Every 6 hours, the source ingests an additional 6 hours of future-dated data to ensure dashboards are always populated. | +| Latency Spike Simulation | The data demonstrate a scenario showcasing latency spikes, aiding in performance analysis and debugging. | + + +## Setup + +### Source configuration + +When you create a Sumo Logic Sample Data 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 the Sumo Logic Sample Data Source: +1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**. +1. On the collectors page, click **Add Source** next to a Hosted Collector. +1. Search for and select **Sumo Logic Sample Data** icon. +1. Enter a **Name** to display for the source in the Sumo Logic web application. 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](/img/reuse/green-check-circle.png) A green circle with a check mark is shown when the field exists in the Fields table schema. + * ![orange exclamation point.png](/img/reuse/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, 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. +1. In **CID (Account Number)**, enter your CID account number collected from the Sumo Logic Sample Data platfrorm. +1. In **API Secret**, enter your API Secret ID collected from the Sumo Logic Sample Data platfrorm. +1. **Data Type** You have the option to choose the type of ingestion. Default is `OTEL` for the OpenTelemetry demo application. +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":"DataGen"}` | 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"}` | +| dataType | String | Yes | `OTEL` | Type of supported sample data. | | + +### JSON example + +{MyComponentSource} + +Download example + +### Terraform example + +{TerraformExample} + +Download example + +## FAQ + +:::info +Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources. +::: diff --git a/sidebars.ts b/sidebars.ts index 6aac2d9827..27374a946c 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -318,6 +318,7 @@ module.exports = { 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/slack-source', 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/snowflake-sql-api-source', 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/sophos-central-source', + //'send-data/hosted-collectors/cloud-to-cloud-integration-framework/sumo-logic-sample-data-source', 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/symantec-endpoint-security-source', 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/symantec-web-security-service-source', 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/tenable-source', diff --git a/static/files/c2c/sumo-logic-sample-data/example.json b/static/files/c2c/sumo-logic-sample-data/example.json new file mode 100644 index 0000000000..b9037a9ee7 --- /dev/null +++ b/static/files/c2c/sumo-logic-sample-data/example.json @@ -0,0 +1,14 @@ +{ + "api.version": "v1", + "source": { + "schemaRef": { + "type": "DataGen" + }, + "config": { + "name": "datagen_source", + "category": "datagen_category", + "dataType":"OTEL" + }, + "sourceType": "Universal" + } +} \ No newline at end of file diff --git a/static/files/c2c/sumo-logic-sample-data/example.tf b/static/files/c2c/sumo-logic-sample-data/example.tf new file mode 100644 index 0000000000..fcccb57f64 --- /dev/null +++ b/static/files/c2c/sumo-logic-sample-data/example.tf @@ -0,0 +1,16 @@ +resource "sumologic_cloud_to_cloud_source" "sumo-logic-sample-data-source" { + collector_id = sumologic_collector.collector.id + schema_ref = { + type = "DataGen" + } + config = jsonencode({ + "name": "datagen_source", + "category": "datagen_category", + "dataType": "OTEL" + }) +} + +resource "sumologic_collector" "collector" { + name = "my-collector" + description = "Just testing this" +} \ No newline at end of file diff --git a/static/img/send-data/sumo-logic-sample-data.png b/static/img/send-data/sumo-logic-sample-data.png new file mode 100644 index 0000000000..dd8aba2908 Binary files /dev/null and b/static/img/send-data/sumo-logic-sample-data.png differ