Skip to content

Commit 5c82e8d

Browse files
committed
Update Sysndig source doc
1 parent b6b18f9 commit 5c82e8d

File tree

3 files changed

+35
-24
lines changed

3 files changed

+35
-24
lines changed

docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sysdig-secure-source.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,16 @@ To configure a Sysdig Secure Source:
7171
1. **Base URL**. Enter the [Sysdig Secure platform](#base-url) Base URL. For example, `https://api.us2.sysdig.com`.
7272
1. **Bearer Token**. Enter the Sysdig Secure API token collected from the [Sysdig Secure](#bearer-token) platform. For example, `t3fPdsbxxxxxxxxxp4D6hbi4`.
7373
1. (Optional) **Filters**. Click the **+Add** button to define the filters you want to associate. Each filter needs a **Field Name** (key) and **Field Value** (value). For key-value pairs, the length is set to 256 characters and the API accepts a maximum length of 1024 characters for the filter.
74+
1. (Optional) The **Polling Interval** is set for 24 hours by default. You can adjust it upto 168 hours based on your needs.
7475
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).
7576
1. When you are finished configuring the Source, click **Save**.
7677

78+
:::info
79+
Each detailed log will be broken down into two logs, one for packages and one for vulnerabilities based on the size of the messages. These broken down packages and vulnerabilities logs will be tied with `resultId`, `resourceId`, `assetType`, `metadata`, and `stage` seperately and this newly created object will be sent to Sumo Logic.
80+
- `resultId` and `resourceId` will be collected from the **Runtime Result API**.
81+
- `assetType`, `metadata`, and `stage` will be collected from the **Result API**.
82+
:::
83+
7784
## JSON schema
7885

7986
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. 
@@ -95,6 +102,7 @@ Sources can be configured using UTF-8 encoded JSON files with the Collector Ma
95102
| baseURL | String | Yes | `null` | The Sysdig base URL of your region. | `https://api.us2.sysdig.com` |
96103
| apiToken | String | Yes | `null` | The API token of your Sysdig account. | `t3fPdsbxxxxxxxxxp4D6hbi4` |
97104
| 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. | |
105+
| pollingIntervalRuntimeResultHrs | String | Yes | `24 Hours` | This sets how often the source checks for data. <br/>**Default**: 24 hours<br/>**Minimum**: 24 hours<br/>**Maximum**: 168 hours | |
98106

99107
### JSON example
100108

static/files/c2c/sysdig-secure/example.json

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,20 @@
22
"api.version": "v1",
33
"source": {
44
"config": {
5-
"name": "Sysdig",
6-
"baseURL": "https://us2.app.sysdig.com",
7-
"bearerToken": "wdwxxxxxqwedwedxxxxxqewdxxxxxxqwedxxxx",
8-
"scope": [
9-
{
10-
"fieldName": "Field",
11-
"fieldValue": "Value"
12-
}
13-
]
5+
"name": "Sysdig Secure",
6+
"baseURL": "https://us2.app.sysdig.com",
7+
"bearerToken": "wdwxxxxxqwedwedxxxxxqewdxxxxxxqwedxxxx",
8+
"scopeFilters": [
9+
{
10+
"fieldName": "Field",
11+
"fieldValue": "Value"
12+
}
13+
],
14+
"pollingIntervalRuntimeResultHrs": "24h"
1415
},
15-
"schemaRef": {
16-
"type": "Sysdig"
17-
},
18-
"sourceType": "Universal"
19-
}}
16+
"schemaRef": {
17+
"type": "Sysdig"
18+
},
19+
"sourceType": "Universal"
20+
}
21+
}

static/files/c2c/sysdig-secure/example.tf

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,17 @@ resource "sumologic_cloud_to_cloud_source" "sysdig-secure-source" {
44
type = "Sysdig"
55
}
66
config = jsonencode({
7-
"name": "Sysdig",
8-
"baseURL": "https://us2.app.sysdig.com",
9-
"bearerToken": "wdwxxxxxqwedwedxxxxxqewdxxxxxxqwedxxxx",
10-
"scope": [
11-
{
12-
"fieldName": "Field",
13-
"fieldValue": "Value"
14-
}
15-
]
16-
})
7+
"name": "Sysdig Secure",
8+
"baseURL": "https://us2.app.sysdig.com",
9+
"bearerToken": "wdwxxxxxqwedwedxxxxxqewdxxxxxxqwedxxxx",
10+
"scopeFilters": [
11+
{
12+
"fieldName": "Field",
13+
"fieldValue": "Value"
14+
}
15+
],
16+
"pollingIntervalRuntimeResultHrs": "24h"
17+
}),
1718
}
1819
resource "sumologic_collector" "collector" {
1920
name = "my-collector"

0 commit comments

Comments
 (0)