|
| 1 | +--- |
| 2 | +id: sysdig-secure-source |
| 3 | +title: Sysdig Secure Source |
| 4 | +sidebar_label: Sysdig Secure |
| 5 | +tags: |
| 6 | + - cloud-to-cloud |
| 7 | + - sysdig-secure |
| 8 | +description: The Sysdig Secure Source aims to collect the complete scan results produced by the scanner from Sysdig API and send them to Sumologic. |
| 9 | +--- |
| 10 | + |
| 11 | +import CodeBlock from '@theme/CodeBlock'; |
| 12 | +import ExampleJSON from '/files/c2c/sysdig-secure/example.json'; |
| 13 | +import MyComponentSource from '!!raw-loader!/files/c2c/sysdig-secure/example.json'; |
| 14 | +import TerraformExample from '!!raw-loader!/files/c2c/sysdig-secure/example.tf'; |
| 15 | +import ForwardToSiem from '/docs/reuse/forward-to-siem.md'; |
| 16 | +import useBaseUrl from '@docusaurus/useBaseUrl'; |
| 17 | + |
| 18 | +<img src={useBaseUrl('img/integrations/misc/sysdig-logo.png')} alt="icon" width="125"/> |
| 19 | + |
| 20 | +Sysdig Secure is a security platform that helps monitor and protect cloud-native environments, especially those using mordern containers and Kubernetes. It helps organizations detect, prevent, and respond to security threats while ensuring compliance in real-time. |
| 21 | + |
| 22 | +## Data collected |
| 23 | + |
| 24 | +| Polling Interval | Data | Description | |
| 25 | +| :--- | :--- | :--- | |
| 26 | +| 24 hours | Runtime Scan Result | Provides a list of runtime scan results discovered by the runtime scanner. | |
| 27 | +| 5 minutes | Full Scan Result | Provides the full scan details of the provided scan result ID. | |
| 28 | + |
| 29 | +## Setup |
| 30 | + |
| 31 | +### Vendor configuration |
| 32 | + |
| 33 | +The Sysdig Secure Source supports API token-based authentication and requires you to provide the Sysdig Secure Base URL and API token to access the data. |
| 34 | + |
| 35 | +#### Base URL |
| 36 | + |
| 37 | +The **Base URL** is the Sysdig Secure domain URL that corresponds to the region in which the account is created. For example, `https:<hostname>`. |
| 38 | + |
| 39 | +#### Bearer token |
| 40 | + |
| 41 | +The **Bearer Token** is the API security token used to authenticate with Sysdig HTTP API. |
| 42 | + |
| 43 | +Follow the steps below to retrieve the Sysdig API token: |
| 44 | + |
| 45 | +1. Log in to **Sysdig Secure** and then select **Settings** from the user menu. |
| 46 | +1. Click **User Profile** to view the **Sysdig Secure API** token in the UI. |
| 47 | +1. Copy the token or click the **Reset Token** button to generate a new one. |
| 48 | + |
| 49 | +:::info |
| 50 | +When a token is reset, the previously issued token will immediately become invalid. |
| 51 | +::: |
| 52 | + |
| 53 | +### Source configuration |
| 54 | + |
| 55 | +When you create a Sysdig Secure 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). |
| 56 | + |
| 57 | +To configure a Sysdig Secure Source: |
| 58 | +1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <br/>[**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**. |
| 59 | +1. On the Collection page, click **Add Source** next to a Hosted Collector. |
| 60 | +1. Search for and select **Sysdig Secure**. |
| 61 | +1. Enter a **Name** for the Source. The description is optional. |
| 62 | +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`. |
| 63 | +1. (Optional) **Fields**. Click the **+Add** button to define the fields you want to associate. Each field needs a name (key) and value. |
| 64 | + *  A green circle with a check mark is shown when the field exists in the Fields table schema. |
| 65 | + *  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 is ignored, known as dropped. |
| 66 | +1. **Base URL**. Enter the [Sysdig Secure platform](#base-url) Base URL. For example, `https://eu1.app.sysdig.com`. |
| 67 | +1. **Bearer Token**. Enter the Sysdig Secure API token collected from the [Sysdig Secure platform](#bearer-token). For example, `t3fPdsbxxxxxxxxxp4D6hbi4`. |
| 68 | +1. (Optional) **Processing Rules for Logs**. Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in [Create a Processing Rule](/docs/send-data/collection/processing-rules/create-processing-rule). |
| 69 | +1. When you are finished configuring the Source, click **Save**. |
| 70 | + |
| 71 | +## JSON schema |
| 72 | + |
| 73 | +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. |
| 74 | + |
| 75 | +| Parameter | Type | Value | Required | Description | |
| 76 | +|:--|:--|:--|:--|:--| |
| 77 | +| schemaRef | JSON Object | `{“type”: “Sysdig Secure”}` | Yes | Define the specific schema type. | |
| 78 | +| sourceType | String | `"Universal"` | Yes | Type of source. | |
| 79 | +| config | JSON Object | [Configuration object](#configuration-object) | Yes | Source type specific values. | |
| 80 | + |
| 81 | +### Configuration Object |
| 82 | + |
| 83 | +| Parameter | Type | Required | Default | Description | Example | |
| 84 | +|:--|:--|:--|:--|:--|:--| |
| 85 | +| 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"` | |
| 86 | +| description | String | No | `null` | Type a description of the source. | `"Testing source"` | |
| 87 | +| 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"` | |
| 88 | +| 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"}` | |
| 89 | +| baseURL | String | Yes | `null` | The Sysdig base URL of your region. | `https://api.us2.sysdig.com` | |
| 90 | +| apiToken | String | Yes | `null` | The API Token of your Sysdig account. | `t3fPdsbxxxxxxxxxp4D6hbi4` | |
| 91 | +| filters | Array | No | `null` | An array of key-value pairs to filter the data. For key-value pairs, the length is set to 256 characters and the API accepts a maximum length of 1024 characters for the filter. | | |
| 92 | + |
| 93 | +### JSON example |
| 94 | + |
| 95 | +<CodeBlock language="json">{MyComponentSource}</CodeBlock> |
| 96 | + |
| 97 | +<a href="/files/c2c/sysdig-secure/example.json" target="_blank">Download example</a> |
| 98 | + |
| 99 | +### Terraform example |
| 100 | + |
| 101 | +<CodeBlock language="json">{TerraformExample}</CodeBlock> |
| 102 | + |
| 103 | +<a href="/files/c2c/sysdig-secure/example.tf" target="_blank">Download example</a> |
| 104 | + |
| 105 | +## FAQ |
| 106 | + |
| 107 | +:::info |
| 108 | +Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources. |
| 109 | +::: |
0 commit comments