This document applies to Classic/Legacy Integrations. You may continue to use these integration configurations. While no active development is happening for these integrations, we continue to provide Classic/Legacy Integrations in the product. You do not have to move to MSI Integrations. If your support engineer or TSC recommends or you choose to move to MSI Integrations, you can take advantage of the latest features and functionality. For more information, see the MSI Integration documentation in the Integrations Overview.
Update Sumo Logic
to update Sumo Logic
- Generate a Sumo Logic API Access ID/Key pairing specifically for the Validation Platform's use. Refer to the Sumo Logic Documentation for instructions.Sumo Logic may not recognize the
validation.cloudFQDN extension. When you configure your API Access ID/Key in Sumo Logic's admin console, you do not need to specify the domain. - Create a Sumo Logic account with sufficient permissions. Read permissions are required, at minimum.
(Optional) Create a custom field for the event_time field Security Validation uses. The default time in Sumo Logic may be incorrect because it is based on ingest time, not detect time. If you are concerned about this, you can create a new field, such as timestamp, to capture the required info. An example of this is shown in the code below. For additional details, see Sumo Logic's documentation on formatDate.
| formatDate(toLong(timestamp*1000),"MM-dd-yyyy'T'HH:mm:ss'Z'") as event_time
Update the Validation Platform
Prerequisites
Information to gather before you start:
- Identify the Sumo Logic host used to access the Sumo Logic cloud. The host is visible in the URL after logging in to the Sumo Logic web user interface.
- API Access ID/Key.
- Sumo Logic credentials.
Identify the field name mappings for the following (there could be multiple of each, depending on log sources and configuration):
- Source IP
- Destination IP
- Source Port
- Destination Port
- Event Signature ID
- Event Name
- Event Source Host
- Event Time
Configuration
To add the Sumo Logic integration
Go to Settings > Integrations.
- Click Add Integration > Sumo Logic.
- Select the Host.
- Enter the API Access ID and Key.
Review and update the Query to include instance-specific field names.
The default queries can be viewed by clicking Show default query.Expand Advanced options.
(Optional) Update Query time and Delay time.
The Query time is the amount of time (minutes) before and after the query runs that the platform looks for events, while the Delay time is the amount of time (minutes) that the platform waits to run the first query after a Job Action starts. For example, you configure your integration with the following values: Query time = 5, Query interval = 30 seconds, and Delay time = 0. When a Job Actions starts at 12:00:00, the first time the query runs, the platform looks for events from 11:55:00 to 12:00:00. Then 30 seconds later, it looks for events from 11:55:30 to 12:00:30. This interval continues, with the last query looking from 12:00:00 to 12:05:00. If you instead configured the Delay time to equal 10, it would run the same query, but it wouldn't start that query until 12:10:00.If your monitors are set to run more frequently than the query time, this configuration impacts the pass/fail results for AEDA monitors.(Optional) Select Enable query for Host CLI Actions and configure the Query. This query will only be used when you run Host CLI Actions.
If you enable the Host CLI Actions query and use the %HOST_CLI_ACTOR_HOSTNAMES% variable, the platform will substitute the plain hostname and the information from the Alternate Hostname field on the Actor configuration page.(Optional) Select Discover network devices automatically.
Modify the Query Interval and Event Time Adjustment, if necessary.
(Optional) Assign a Name.
(Optional) Choose Yes to save suspicious events.
Click Submit.
Set up Proxy Assignment
If all outbound connections go through a proxy, you may want to set up a proxy definition and assignment for your integration. For information on setting up your proxy rules, see Proxy Rules.
Verify connectivity
To verify connectivity to Sumo Logic
Click Test to verify that:
- The Director can communicate with Sumo Logic using the API access information on the port and protocol specified.
- User credentials are working.