-
Notifications
You must be signed in to change notification settings - Fork 228
Akamai CPC doc creation #5352
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Akamai CPC doc creation #5352
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
75ed684
Akamai CPC C2C docs
JV0812 f4055cb
minor fix
JV0812 d064689
minor fix (Priyansh Comments)
JV0812 3b0b1ae
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
JV0812 9226e9e
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
JV0812 071b8df
C2C details added to the product list
JV0812 7bad8c1
Merge branch 'akamai-c2c-doc-creation' of https://github.com/SumoLogi…
JV0812 a78fc45
Merge branch 'main' into akamai-c2c-doc-creation
priyansh-sumo 0429f1b
Rename 2025-05-09-collection.md to 2025-05-16-collection.md
JV0812 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| title: Akamai CPC Source (Collection) | ||
| image: https://help.sumologic.com/img/sumo-square.png | ||
| keywords: | ||
| - c2c | ||
| - akamai-cpc-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 Akamai CPC. This source aims to collect CPC-Configs, CPC-Alerts, and CPC-Alert Details data from the Akamai platform and send them to Sumo Logic for streamlined analysis. [Learn more](/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/akamai-cpc-source). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
110 changes: 110 additions & 0 deletions
110
...ata/hosted-collectors/cloud-to-cloud-integration-framework/akamai-cpc-source.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| --- | ||
| id: akamai-cpc-source | ||
| title: Akamai CPC Source | ||
| sidebar_label: Akamai CPC | ||
| tags: | ||
| - cloud-to-cloud | ||
| - akamai-cpc | ||
| description: Learn how to fetch CPC-Configs, CPC-Alerts, and CPC-Alert Details from the Akamai platform and send it to Sumo Logic. | ||
| --- | ||
|
|
||
| import CodeBlock from '@theme/CodeBlock'; | ||
| import ExampleJSON from '/files/c2c/akamai-cpc/example.json'; | ||
| import MyComponentSource from '!!raw-loader!/files/c2c/akamai-cpc/example.json'; | ||
| import TerraformExample from '!!raw-loader!/files/c2c/akamai-cpc/example.tf'; | ||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| <img src={useBaseUrl('img/integrations/saas-cloud/akamai.svg')} alt="Thumbnail icon" width="90"/> | ||
|
|
||
| Akamai Client-Side Protection and Compliance (CPC) is a security solution designed to monitor and protect against client-side threats such as JavaScript-based data skimming and formjacking. It provides visibility into third-party script behavior and enforces security policies to ensure compliance with data protection standards. | ||
|
|
||
| ## Data collected | ||
|
|
||
| | Polling Interval | Data | | ||
| | :--- | :--- | | ||
| | 12 hours | CPC-Configs | | ||
| | 5 minutes | CPC-Alerts | | ||
|
|
||
| ## Setup | ||
|
|
||
| ### Vendor configuration | ||
|
|
||
| You'll need a **Host Name**, **Client Token**, **Client Secret**, and **Access Token**. To generate these, follow these steps: | ||
|
|
||
| - **Host Name**. The Akamai API base URL used to sending authenticated requests. | ||
| - Refer to the [Akamai Documentation](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials) to generate **Client Token**, **Client Secret**, and **Access Token**. | ||
|
|
||
| ### Source configuration | ||
|
|
||
| When you create an Akamai CPC 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](/docs/send-data/hosted-collectors/configure-hosted-collector). | ||
|
|
||
| To configure an Akamai CPC Source: | ||
| 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**. | ||
| 1. On the Collection page, click **Add Source** next to a Hosted Collector. | ||
| 1. Search for and select **Akamai CPC**. | ||
| 1. Enter a **Name** for the Source. 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. | ||
| *  A green circle with a checkmark 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 (i.e., dropped). | ||
| 1. **Client Token**. Enter the Client token value collected from the Akamai platform. | ||
| 1. **Client Secret**. Enter the Client secret value collected from the Akamai platform. | ||
| 1. **Access Token**. Enter the Access token value collected from the Akamai platform. | ||
| 1. **API Host Name**. Enter the API Host Name value collected from the Akamai platform. | ||
| 1. (Optional) **Collect Alert Logs**. Select this checkbox to collect the alert logs from the Akamai platform. | ||
| 1. (Optional) **Supported Severity Level**. Select the severity of the alert logs from the dropdown. | ||
| 1. (Optional) **Supported Alert Type**. Select the type of alerts from the dropdown. | ||
| 1. (Optional) **Supported Alert Status**. Select the status of the alerts from the dropdown. | ||
| 1. (Optional) **Collect Alert Details**. Select this checkbox to collect the alert details from the Akamai platform. | ||
| 1. The **CPC Configs Polling Interval** is set to 12 hours by default, you can adjust it based on your needs. | ||
| 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). | ||
| 1. When you are finished configuring the Source, click **Save**. | ||
|
|
||
| ## 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](/docs/send-data/use-json-configure-sources) for details. | ||
JV0812 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| | Parameter | Type | Value | Required | Description | | ||
| |:--|:--|:--|:--|:--| | ||
| | schemaRef | JSON Object | `{"type":"Akamai CPC"}` | 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"}` | | ||
| | clientToken | String | Yes | `null` | A unique identifier used to authenticate API requests. | | | ||
| | clientSecret | String | Yes | `null` | User account secret which will be used in authentication. | | | ||
| | accessToken | String | Yes | `null` | Token granting access to the Akamai CPC API on behalf of a client. | | | ||
| | akamaiHostName | String | Yes | `null` | The base URL of the Akamai API endpoint used to interact with CPC services. | | | ||
| | collectAlertsLogs | Boolean | No | `null` | Specify if we need to collect the alert logs. | | | ||
| | severityLevel | String Array | No | `null` | Specify the alert logs severity | | | ||
| | alertType | String Array | No | `null` | Specify the type of alerts. | | | ||
| | alertStatus | String Array | No | `null` | Specify the status of the alerts. | | | ||
| | pollingIntervalAlertsMin | Integer | No | `5 minutes` | Time interval (in minutes) after which the source will check for new data.<br/>**Minimum**: 5 minutes<br/>**Maximum**: 60 minutes | | | ||
| | collectAlertDetails | Boolean | No | `false` | Specify if we need to collect the alert details. | | | ||
| | pollingIntervalCPCConfigsHrs | Integer | Yes | `12 hours` | Time interval (in minutes) after which the source will check for new data.<br/>**Minimum**: 1 hour<br/>**Maximum**: 24 hours | | | ||
|
|
||
|
|
||
| ### JSON example | ||
|
|
||
| <CodeBlock language="json">{MyComponentSource}</CodeBlock> | ||
|
|
||
| <a href="/files/c2c/akamai-cpc/example.json" target="_blank">Download example</a> | ||
|
|
||
| ### Terraform example | ||
|
|
||
| <CodeBlock language="json">{TerraformExample}</CodeBlock> | ||
|
|
||
| <a href="/files/c2c/akamai-cpc/example.tf" target="_blank">Download example</a> | ||
|
|
||
| ## FAQ | ||
|
|
||
| :::info | ||
| Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources. | ||
| ::: | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| { | ||
| "api.version": "v1", | ||
| "source": { | ||
| "config": { | ||
| "name": "c2c-Akamai CPC", | ||
| "clientToken":"akab-ctfkqxxxxxxa3quph-xxxxxx", | ||
| "clientSecret":"IyVVIdYgBfxxxxxbToZMGGaxxxxxxxxxxM", | ||
| "accessToken":"akabxxxxxx4ke52-xxxxxxxx5efol", | ||
| "hostName":"abcde-efgx-xxxxxx.net", | ||
| "collectAlertsLogs": true, | ||
| "pollingIntervalAlertsMin": 5, | ||
| "collectAlertDetails": true, | ||
| "severityLevel": [ | ||
| "HIGH", | ||
| "MEDIUM" | ||
| ], | ||
| "alertType": [ | ||
| "SUSPICIOUS_SCRIPT_ACTIVITY_EG_CPC_ALERT" | ||
| ], | ||
| "alertStatus": [ | ||
| "OPEN" | ||
| ], | ||
| "pollingIntervalCPCConfigsHrs":12 | ||
| }, | ||
| "schemaRef": { | ||
| "type": "Akamai CPC" | ||
| }, | ||
| "sourceType": "Universal" | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| resource "sumologic_cloud_to_cloud_source" "akamai-cpc-source" { | ||
| collector_id = sumologic_collector.collector.id | ||
| schema_ref = { | ||
| type = "Akamai CPC" | ||
| } | ||
| config = jsonencode({ | ||
| "name": "c2c-Akamai CPC", | ||
| "clientToken":"akab-ctfkqxxxxxxa3quph-xxxxxx", | ||
| "clientSecret":"IyVVIdYgBfxxxxxbToZMGGaxxxxxxxxxxM", | ||
| "accessToken":"akabxxxxxx4ke52-xxxxxxxx5efol", | ||
| "hostName":"abcde-efgx-xxxxxx.net", | ||
| "collectAlertsLogs": true, | ||
| "pollingIntervalAlertsMin": 5, | ||
| "collectAlertDetails": true, | ||
| "severityLevel": [ | ||
| "HIGH", | ||
| "MEDIUM" | ||
| ], | ||
| "alertType": [ | ||
| "SUSPICIOUS_SCRIPT_ACTIVITY_EG_CPC_ALERT" | ||
| ], | ||
| "alertStatus": [ | ||
| "OPEN" | ||
| ], | ||
| "pollingIntervalCPCConfigsHrs":12 | ||
| }) | ||
| } | ||
| resource "sumologic_collector" "collector" { | ||
| name = "my-collector" | ||
| description = "Just testing this" | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.