Skip to content

Commit b107775

Browse files
authored
Merge branch 'main' into JV0812-patch-2
2 parents 3156649 + c93c6ad commit b107775

34 files changed

+224
-231
lines changed
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Scope-Based Variable (Dashboards)
3+
image: https://help.sumologic.com/img/sumo-square.png
4+
keywords:
5+
- dashboard
6+
- scope-based-variable
7+
hide_table_of_contents: true
8+
---
9+
10+
import useBaseUrl from '@docusaurus/useBaseUrl';
11+
12+
We’re excited to introduce a new dashboard variable type: Scope-Based Variables. Scope-Based Variables act as log filters that can be automatically applied to all or selected panels within a dashboard. This helps you to easily filter data across multiple panels without needing to manually edit each panel’s query to accept the variable. [Learn more](/docs/dashboards/filter-template-variables).

docs/alerts/monitors/alert-variables.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Variables must be enclosed by double curly brackets (`{{ }}`). Unresolved variab
3636
| `{{TriggerTimeEnd}}` | The end time of the time range that triggered the monitor in Unix format. For example, `1626190592042`. | ✅| ✅|
3737
| `{{SourceURL}}` | The URL to the configuration or status page of the monitor in Sumo Logic. | ✅| ❌ |
3838
| `{{AlertResponseUrl}}` | When your monitor is triggered, it will generate a URL and provide it as the value of this variable where you can use it to open alert response. | ✅| ❌ |
39+
| `{{AlertResponseId}}` | The unique identifier of the triggered alert. | ✅| ❌ |
3940
| `{{AlertName}}` | Name of the alert that will be displayed on the alert page. | ✅| ✅|
4041
| `{{Playbook}}` | Allows you to access the [playbook content](/docs/alerts/monitors/create-monitor/#step-4-playbook-optional) configured as part of your initial monitor setup. | ✅| ✅|
4142

docs/cloud-soar/automation.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,30 @@ The **Automation** section contains configuration tools for Cloud SOAR's automat
1717

1818
Because Cloud SOAR provides automation functionality to the [Automation Service](/docs/platform-services/automation-service/), many features are identical between Cloud SOAR and the Automation Service. Therefore, for information about the following Cloud SOAR features, see the Automation Service articles:
1919
* [App Central](/docs/platform-services/automation-service/app-central/)
20-
* [Playbooks](/docs/platform-services/automation-service/automation-service-playbooks/)
2120
* [Integrations](/docs/platform-services/automation-service/automation-service-integrations/)
2221
* [Automation bridge](/docs/platform-services/automation-service/automation-service-bridge)
2322
* [Integration framework](/docs/platform-services/automation-service/integration-framework/)
2423
* [Audit logging](/docs/platform-services/automation-service/automation-service-audit-logging)
24+
* [Playbooks](/docs/platform-services/automation-service/automation-service-playbooks/). (For information specific to running playbooks in Cloud SOAR, see [Run playbooks in Cloud SOAR](#run-playbooks-in-cloud-soar) below.)
2525

2626
The following sections describe automation features only used in Cloud SOAR.
2727

28+
## Run playbooks in Cloud SOAR
29+
30+
In Cloud SOAR, playbooks are run from [incidents](/docs/cloud-soar/incidents-triage/#incidents). To run playbooks in Cloud SOAR, perform the following steps:
31+
1. [Create a playbook](/docs/platform-services/automation-service/automation-service-playbooks/#create-a-new-playbook) to use in incident response. When you create the playbook, do the following:
32+
1. Click the **Edit** icon on the **Start** node:<br/><img src={useBaseUrl('img/platform-services/automation-service/start-node.png')} alt="Start node" style={{border:'1px solid gray'}} width="100"/>
33+
1. Ensure that the **Add one or more params as a playbook input** field is left blank: <br/><img src={useBaseUrl('img/platform-services/automation-service/edit-start-node-input.png')} alt="Edit node dialog" style={{border:'1px solid gray'}} width="500"/><br/>Do *not* click the field to show the dropdown menu: <br/><img src={useBaseUrl('img/platform-services/automation-service/start-node-parameters.png')} alt="Types of start node parameters" style={{border:'1px solid gray'}} width="400"/><br/>The other values in the field are used for automation outside of Cloud SOAR:
34+
* **Insight** and **Entity** are for launching a playbook from a Cloud SIEM automation.
35+
* **Alert** is for launching a playbook from a monitor.
36+
* **Parse from JSON** is for launching a playbook from another playbook.
37+
1. Proceed to create the playbook as needed.
38+
1. [Create an incident template](#create-a-new-incident-template) to be assigned to incidents. When you create the template, add the playbook to the template and select **Autorun** to run the playbook when the incident is created, or deselect if you want to manually run the playbook from the incident.<br/><img src={useBaseUrl('img/cloud-soar/new-incident-template-add-playbook.png')} alt="New template" style={{border: '1px solid gray'}} width="700"/>
39+
1. Monitor and run playbooks on [incidents](/docs/cloud-soar/incidents-triage/#incidents):
40+
* Within an incident, select **Operations > Playbooks** to see the playbooks assigned to the incident.
41+
* If playbooks haven't been assigned by an incident template, you can add playbooks by clicking the **+** button.
42+
* To manually run a playbook for the incident, click the **Run** button at the bottom of the screen.<br/><img src={useBaseUrl('img/cloud-soar/playbook-on-incident.png')} alt="Playbook on an incident" style={{border: '1px solid gray'}} width="700"/>
43+
2844
## Incident templates
2945

3046
Incident templates define the way in which incidents will be created for a specific alert, incident type or event. They allow you to define a certain number of incident attributes (for example, incident type, severity, assignment, and any other default or custom incident parameters) that will automatically be set each time an incident is generated, based on the template. This may include type, classification, incident assignment, playbooks, knowledge base articles, or any other incident attribute. Since rules are created for generating incidents based on syslog messages, email, SIEM integrations, or other data sources, it is the incident templates that will define how the initial incident will be created.

docs/cse/administration/create-cse-actions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ import Iframe from 'react-iframe'; 
1010

1111
This topic has instructions for configuring Cloud SIEM actions.
1212

13-
:::warning
14-
In the future, Cloud SIEM actions will be deprecated because comparable behavior is available in the Automation Service. Although Cloud SIEM actions are still supported, we recommend you use the Automation Service to perform actions. For more information, see [Migrate from legacy actions and enrichments to the Automation Service](/docs/cse/automation/automations-in-cloud-siem/#migrate-from-legacy-actions-and-enrichments-to-the-automation-service).
13+
:::tip
14+
The Automation Service is a newer way to perform actions. For more information about how to use the Automation Service instead of Cloud SIEM actions, see [Migrate from legacy actions and enrichments to the Automation Service](/docs/cse/automation/automations-in-cloud-siem/#migrate-from-legacy-actions-and-enrichments-to-the-automation-service).
1515
:::
1616

1717
## About Cloud SIEM actions

docs/cse/automation/automations-in-cloud-siem.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,9 @@ You can switch to the graphical view by clicking **Graph View** in the upper-rig
185185

186186
## Migrate from legacy actions and enrichments to the Automation Service
187187

188-
In the future, [Cloud SIEM Actions](/docs/cse/administration/create-cse-actions/) and the [Insight Enrichment Server](/docs/cse/integrations/insight-enrichment-server/) will be deprecated because comparable behavior is available in the Automation Service. To continue using the same functionality found in the legacy actions and enrichments, [use installed playbooks](#use-installed-playbooks) in the Automation Service, or [replace the legacy actions and enrichments](#replace-legacy-actions-and-enrichments) by adding the corresponding actions to playbooks you create in the Automation Service.
188+
Instead of using [Cloud SIEM Actions](/docs/cse/administration/create-cse-actions/) and the [Insight Enrichment Server](/docs/cse/integrations/insight-enrichment-server/), we recommend you use the Automation Service. The Automation Service is a newer way to perform actions and enrichments.
189+
190+
To continue using the same functionality found in the legacy actions and enrichments, [use installed playbooks](#use-installed-playbooks) in the Automation Service, or [replace the legacy actions and enrichments](#replace-legacy-actions-and-enrichments) by adding the corresponding actions to playbooks you create in the Automation Service.
189191

190192
Migrating to the Automation Service has many benefits over using legacy actions and enrichments. With the Automation Service, you can:
191193
* Run actions in playbooks rather than singly.

docs/cse/integrations/insight-enrichment-server.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1010

1111
The Cloud SIEM Insight Enrichment Server is a component that automatically enriches Cloud SIEM insights.  
1212

13-
:::warning
14-
The Insight Enrichment Server is deprecated. Use the Automation Service instead for enrichments. See [Migrate from legacy actions and enrichments to the Automation Service](/docs/cse/automation/automations-in-cloud-siem/#migrate-from-legacy-actions-and-enrichments-to-the-automation-service).
13+
:::tip
14+
The Automation Service is a newer way to perform enrichment. For more information about how to use the Automation Service instead of the Cloud SIEM Insight Enrichment Server, see [Migrate from legacy actions and enrichments to the Automation Service](/docs/cse/automation/automations-in-cloud-siem/#migrate-from-legacy-actions-and-enrichments-to-the-automation-service).
1515
:::
1616

1717
:::note

docs/dashboards/filter-template-variables.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,21 @@ The web interface autocomplete feature for log search variables has the follow
2121
* It is updated every night for the last 24 hours starting from 10PM PT to the previous day at 10PM PT. 
2222
* Only dashboards that were viewed in the last 3 days are updated.
2323
* Up to 10,000 log values and 1,000 metric values are displayed.
24-
* Values for template variables are based on the time range of the Dashboard.
24+
* Values for template variables (except Scope Based Variable) are based on the time range of the dashboard.
25+
* New panels added to the dashboard will automatically adopt any existing Scope-based Variable to it.
2526

2627
## Show and hide variables option
2728

2829
In the Dashboard top menu bar, click the filter icon to show the variables option. The filter icon allows you to toggle if the variables option is displayed or hidden.<br/><img src={useBaseUrl('/img/dashboards/filter-template-variables/Show-and-Hide-filters.png')} alt="Show and Hide filters" style={{border: '1px solid gray'}} width="400" />
2930

3031
## Create a template variable
3132

32-
There are three types of template variables you can use as a dashboard filter:
33+
There are four types of template variables you can use as a dashboard filter:
3334

3435
* Custom List - a custom set of options
3536
* Metrics Metadata Search - metrics metadata based options 
3637
* Log Search - logs query based options
38+
* Scope-based Variable - define scope variables to automatically apply to all log queries
3739

3840
### Add a Custom List variable
3941

@@ -46,6 +48,7 @@ To add a Custom List variable to a dashboard, do the following:
4648
1. In the **Create Template Variable** panel, enter a unique **Variable Name**. Spaces and special characters, with the exception of an underscore (_), are not allowed in value names.<br/><img src={useBaseUrl('img/dashboards/filter-template-variables/Create-Template-Variable-dialog.png')} style={{border:'1px solid gray'}} alt="Create-Template-Variable-dialog" width="800"/>
4749
1. Select **Custom List** as the **Variable Type**.
4850
1. **List Items** are your variable values. Use a comma separated list for variable options, separating individual options with a comma. For example, `small, medium, large`.
51+
1. (Optional) **Include the option to select all values (\*)** will be selected by default. This includes a wildcard asterisk (\*) in the available options.
4952
1. (Optional) Provide a **Default Value** for the variable.
5053
1. Click **Create Template Variable** to apply the variable to the dashboard. 
5154

@@ -61,6 +64,7 @@ To add a Metrics Metadata Search variable to a dashboard, do the following:
6164
1. Select **Metrics Metadata Search** as the **Variable Type**.
6265
1. The **Fields (key)** is the metadata field you want to use as the filter.
6366
1. (Optional) **Filters** allow you to filter the scope of your data before choosing the field you want to use. Click in the **Filter** input, begin typing, and choose a filter from the pop-up list. A list of valid values appears. Select a value for the filter, and add other filters as needed.
67+
1. (Optional) **Include the option to select all values (\*)** will be selected by default. This includes a wildcard asterisk (\*) in the available options.
6468
1. (Optional) Provide a **Default Value** for the variable.
6569
1. Click **Create Template Variable** to apply the variable to the dashboard.
6670

@@ -76,6 +80,29 @@ To add a Logs Search variable to a dashboard, do the following:
7680
1. Select **Logs Search** as the **Variable Type**.
7781
1. Click in the **Query** field and begin typing your query. Select valid options from the pop-up list as they appear until your query is complete.
7882
1. The **Key** is the metadata field you want to use as the filter. Once a Key is selected the Preview table will show example values based on the query running for the last 15 minutes.
83+
1. (Optional) **Include the option to select all values (\*)** will be selected by default. This includes a wildcard asterisk (\*) in the available options.
84+
1. (Optional) Enter a **Default Value** for the variable.
85+
1. Click **Create Template Variable** to apply the variable to the dashboard.
86+
87+
### Add a Scope-based Variable
88+
89+
With a Scope-based Variable, you can define a variable that automatically applies to all log queries within the scope of the dashboard or panels. By setting a key while creating the scope variable, you can select values to enable simple filtering for the dashboard. Additionally, you can specify which panels the scope variable applies to for more granular control.
90+
91+
:::info
92+
- The fields in the Scope-based Variable are independent of dashboard and panel time range.
93+
- Fields in the Scope-based Variable will also contain the FER field keys.
94+
:::
95+
96+
To add a Scope-based Variable to a dashboard, do the following:
97+
98+
1. In the Dashboard top menu bar, click the filter icon to show the variables option. The filter icon allows you to toggle if the variables option is displayed or hidden.<br/><img src={useBaseUrl('img/dashboards/filter-template-variables/Show-and-Hide-filters.png')} style={{border:'1px solid gray'}} alt="Show-and-Hide-filters" width="250"/>
99+
1. In the Dashboard top menu bar, click the **plus (+) icon**. The **Create Template Variable** panel appears.<br/><img src={useBaseUrl('img/dashboards/filter-template-variables/create-dashboard-filter.png')} style={{border:'1px solid gray'}} alt="create-dashboard-filter" width="800"/>
100+
1. In the **Create Template Variable** panel, enter a unique **Variable Name**. Spaces and special characters, with the exception of an underscore (_), are not allowed in value names.<br/><img src={useBaseUrl('img/dashboards/filter-template-variables/scope-based-variable.png')} style={{border:'1px solid gray'}} alt="scope-based-variable" width="800"/>
101+
1. Select **Scope-based Variable** as the **Variable Type**.
102+
1. The **Filds (key)** is the metadata field you want to use as the filter. Once a Key is selected the Preview table will show example values based on the query running for the last 15 minutes.
103+
1. (Optional) **Display all values available** will be selected by default. If you want to specify any values, deselect this option and enter the required value(s) in section below.
104+
1. (Optional) **Apply filter to all panels in dashboard** will be selected by default. If you want to apply this variable to secleted panel, deselect this option and select the panels from the dropdown. You can also click on <img src={useBaseUrl('img/dashboards/filter-template-variables/preview-the-panels.png')} style={{border:'1px solid gray'}} alt="preview-the-panels" width="30"/> to preview and select the dashboard panel to which you want to apply this variable.
105+
1. (Optional) **Include the option to select all values (\*)** will be selected by default. This includes a wildcard asterisk (\*) in the available options.
79106
1. (Optional) Enter a **Default Value** for the variable.
80107
1. Click **Create Template Variable** to apply the variable to the dashboard.
81108

docs/integrations/amazon-aws/cloudtrail-pci-compliance.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,41 @@
11
---
22
id: cloudtrail-pci-compliance
33
title: PCI Compliance For AWS CloudTrail
4-
description: The Sumo Logic App for Payment Card Industry (PCI) Compliance for AWS CloudTrail App offers dashboards to monitor systems, account and users activity to ensure that login activity and privileged users are within the expected ranges.
4+
description: The Sumo Logic app for Payment Card Industry (PCI) Compliance for AWS CloudTrail app offers dashboards to monitor systems, account and users activity to ensure that login activity and privileged users are within the expected ranges.
55
---
66

77
import useBaseUrl from '@docusaurus/useBaseUrl';
88

99
<img src={useBaseUrl('img/integrations/pci-compliance/pci-logo.png')} alt="Thumbnail icon" width="90"/>
1010

11-
The Sumo Logic App for Payment Card Industry (PCI) Compliance for AWS CloudTrail App offers dashboards to monitor systems, account and users activity to ensure that login activity and privileged users are within the expected ranges. The PCI Compliance for AWS CloudTrail App covers PCI requirements 02, 07, 08 and 10.
11+
The Sumo Logic app for Payment Card Industry (PCI) Compliance for AWS CloudTrail app offers dashboards to monitor systems, account and users activity to ensure that login activity and privileged users are within the expected ranges. The PCI Compliance for AWS CloudTrail app covers PCI requirements 02, 07, 08 and 10.
1212

1313

14+
## Collecting logs for the PCI Compliance for AWS CloudTrail app
1415

15-
## Collecting logs for the PCI Compliance for AWS CloudTrail App
16-
17-
This section provides instructions for collecting logs for the the PCI Compliance for AWS CloudTrail App.
16+
This section provides instructions for collecting logs for the the PCI Compliance for AWS CloudTrail app.
1817

1918
To configure an AWS CloudTrail Source, do the following:
2019
1. [Grant Sumo Logic access](/docs/send-data/hosted-collectors/amazon-aws/grant-access-aws-product) to an Amazon S3 bucket.
2120
2. [Configure CloudTrail](http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html) in your AWS account.
2221
3. Confirm that logs are being delivered to the Amazon S3 bucket.
2322
4. Add an [AWS CloudTrail Source](/docs/send-data/hosted-collectors/amazon-aws/aws-cloudtrail-source) to Sumo Logic.
24-
5. Install the Sumo Logic App for [PCI Compliance for AWS CloudTrail](#installing-the-pci-compliance-for-aws-cloudtrail-app).
23+
5. Install the Sumo Logic app for [PCI Compliance for AWS CloudTrail](#installing-the-pci-compliance-for-aws-cloudtrail-app).
2524

2625

27-
## Installing the PCI Compliance for AWS CloudTrail App
26+
## Installing the PCI Compliance for AWS CloudTrail app
2827

29-
Now that you have set up collection, install the Sumo Logic App for PCI Compliance for AWS CloudTrail to use the preconfigured searches and [dashboards](#viewing-pci-compliance-for-aws-cloudtrail-dashboards) that provide insight into your data.
28+
Now that you have set up collection, install the Sumo Logic app for PCI Compliance for AWS CloudTrail to use the preconfigured searches and [dashboards](#viewing-pci-compliance-for-aws-cloudtrail-dashboards) that provide insight into your data.
3029

31-
import AppInstall from '../../reuse/apps/app-install.md';
30+
import AppInstallV2 from '../../reuse/apps/app-install-v2.md';
3231

33-
<AppInstall/>
32+
<AppInstallV2/>
3433

3534
## Viewing PCI Compliance for AWS CloudTrail Dashboards
3635

37-
The Sumo Logic PCI Compliance for AWS CloudTrail App provides dashboards and sample queries that you can modify for your specific compliance needs.
38-
* Access Monitoring
39-
* Login Activity
40-
* Account and System Monitoring
41-
* Privileged Activity
36+
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
4237

38+
<ViewDashboards/>
4339

4440
### PCI Req 01 - Access Monitoring
4541

0 commit comments

Comments
 (0)