Sending USM Anywhere Notifications to Datadog

Role Availability Read-Only Investigator Analyst Manager

From USM Anywhere, you can send an alarm or event notification to your Datadog event console so that team members are alerted. This facilitates communication and collaboration within the same messaging tool that your organization uses for infrastructure monitoring. When you have this integration configured in USM Anywhere, you can create orchestration rules to automatically send these notifications when an event Any traffic or data exchange detected by LevelBlue products through a sensor or external devices such as a firewall. or alarm Alarms provide notification of an event or sequence of events that require attention or investigation. matches the rule criteria.

Edition: The Notification integrations are available in the Standard and Premium editions of USM Anywhere.

See the Affordable pricing to fit every budget page for more information about the features and support provided by each of the USM Anywhere editions.

Note: While direct integration with USM Anywhere is the easiest and most straightforward way to send messages to your Datadog environment from USM Anywhere, you can use the Amazon SNS messaging service as an alternative. In this case, you create the API key in Datadog and then set up the integration in the Lambda function that you created in AWS to support USM Anywhere messaging. S ee Sending Notifications Through Amazon SNS and Set Up a Datadog Events Integration Through Amazon SNS for more information.

Datadog provides a mechanism to create API keys as a way to post data from external sources into Datadog events. All requests to the Datadog API must be authenticated. Requests that write data require reporting access and require an API key. You must first create this API key to configure the integration with USM Anywhere.

To create the API key for Datadog

  1. Log in to your Datadog account and go to https://app.datadoghq.com/account/settings#api.

  2. For the New API key, enter a name for the key and click Create API key.

    Make sure to copy the generated key value and store it in a secured location.

  3. (Amazon SNS Only.) For the New application key, click Create Application key and copy the generated value.

    Note: This key is not used for a direct integration with USM Anywhere. However, if you plan to use the Amazon SNS messaging service for a custom integration, any requests that read data require full access and an application key.

After you have generated and copied the API key for your Datadog environment, you can configure USM Anywhere for Datadog notifications. After this configuration is in place, any orchestration rules set up for Datadog notification will send the triggered notification to your Datadog events.

To configure the connection between Datadog events and USM Anywhere

  1. In the USM Anywhere web UI, go to Settings > Notifications.
  2. In the left navigation panel, click Datadog.
  3. In the Datadog API key field, paste the key value that you generated in the Datadog API tool.

    Specify the Datadog API key in USM Anywhere

  4. Click Save Credentials.

Create an orchestration rule to match new alarms or events and trigger a notification to Datadog events. You can use an existing alarm or event with the desired characteristics to easily set the matching conditions for the rule.

To create an orchestration rule to trigger a Datadog notification

  1. Go to Activity > Alarms or Activity > Events.
  2. Click the alarm or event to open the details.

  3. Click Create Rule and select Create Notification Rule.

    Create a notification rule from the alarm details

  4. You have already suggested property values to create a matching condition, but if you want to add new property values, click Add Condition.

    Note: If the field is related to the name of a country, you should use the country code defined by the ISO 3166.

    Note: The Sources or Destinations field needs to match the universally unique identifier (UUID) of the event or alarm. You can use the Source Name or Destination Name field instead.

    Important: Instead of using the equals and equals, case insensitive operators for array fields, LevelBlue recommends the use of the in or contains operators.

    Note: If you need to add a property value that maps with a property key, you need to know the mapping of the field. See Determining the Mapping of a Field for more information.

  5. (Optional.) Click Add Group to group your conditions.

    Note: See Operators in the Orchestration Rules for more information.

  6. In the Occurrences text box, enter the number of event occurrences that you want to produce a match on the conditional expression to trigger the rule.

    You can enter the number of occurrences or use the arrows to scroll the value up or down. You can enter a number between 1 and 100.

    7. Note: The current rule box shows you the syntax of your rule, and the rule verification box reviews that syntax before saving the rule.

  7. Click Next.

    Rules Verifications Dialog Box

    Important: A dialog box opens if there are warning messages. Click Cancel to review the warning messages, or click Accept to continue creating the rule.

  8. Enter a name for the rule.
  9. (Optional.) Enter a description for identifying this rule.
  10. For Notification Method, select the Slack option.

  11. Enter the Slack Alert Username.

    The username must be a valid team member for the Slack channel.

    Set options to launch the Slack notification for the orchestration rule

  12. In the Length text box, specify the timespan that you want to use to identify a match for multiple occurrences. Enter the number in the text box, and then use the drop-down menu to select a value of seconds, minutes, or hours.

    This duration identifies the amount of time that transpires from the beginning to the end of the occurrence. If the number of occurrences is not met within this period, the rule is not a match.

    13. Note: Your defined length and occurrences function together to specify the number of occurrences within a time period that will produce a match for the rule. For example, you can define a rule to trigger an alarm Alarms provide notification of an event or sequence of events that require attention or investigation. for an unauthorized access An incident-type categorization that may be a precursor to other actions or stages of an attack. attempt when a failed SSH Program to securely log into another computer over a network, execute commands in a remote machine, and move files from one machine to another through Secure Copy (SCP). login Log in (verb): Process in which an individual gains access to a computer system after providing sufficient credentials to authenticate their unique identity. Login (noun): User credentials, typically a username and matching password. occurs three times within a five-minute window.

  13. Click Save.

    The created rule displays in the list of rules. You can see it from Settings > Rules > Orchestration Rules. See Orchestration Rules for more information.

    14. Important: It takes a few minutes for an orchestration rule to become active.

  14. For Notification Method, select the Datadog option.
  15. Set the Datadog Priority.

    Set options to launch the Datadog notification for the orchestration rule

  16. At the bottom of the dialog box, set the rule condition parameters to specify the criteria for a matching alarm or event to trigger the rule.

    Set the matching conditions for triggering the rule

    • This section provides suggested property/value pairs from the selected alarm or event that you can use as conditions for the rule. Click the icon to delete the items that you do not want to include in the matching conditions. You can also add other conditions that are not suggested.
    • If you create the rule from the Rules page, you must use the Add Condition and Add Group functions to define the property/value pairs that you want to use as conditions for the rule.
    • At the bottom of the dialog box, click More to display the optional multiple occurrence and window-length parameters.

    Select an operator and add one or more conditions to form the conditional expression. You can include a condition group to evaluate a subset of conditions. The Current Rule pane displays the constructed expression in standard syntax. The box displays a red border if the expression is syntactically invalid as currently specified. A valid expression is required to save the rule definition.

    Select the operator used to determine the match for multiple conditions:

    • AND: Match all conditions.
    • OR: Match any one condition.
    • AND NOT: Exclude items matching all conditions after the first.
    • OR NOT: Include all items that do not match any conditions after the first.

    Click Add Condition to add a condition. For each condition, specify the field name, evaluator, and value. If the evaluation returns true for the condition, it is a match.

    Click Add Group to add a condition group. A new group includes a condition and its own operator used to match the conditions within the group. You can nest condition groups.

    Specify the number of event or alarm occurrences that produce a match on the conditional expression to trigger the rule. The default value is 1. You can enter the number of occurrences or use the arrow to scroll the value up or down.

    USM Anywhere uses this in conjunction with the Length option to specify the number of occurrences within a time period that will trigger the rule. For example, you can define a rule to trigger for an unauthorized access attempt when a failed SSH Program to securely log into another computer over a network, execute commands in a remote machine, and move files from one machine to another through Secure Copy (SCP). login occurs three times within a five-minute window.

    Specify the length of the window to identify a match for multiple occurrences. Enter the number and choose a time unit value of seconds, minutes, or hours. This time period identifies the amount of time that transpires from the first occurrence to the last occurrence. If the number of occurrences is not met within this period, the rule does not trigger.

  17. Click Save Rule.

If you prefer to use Amazon SNS to forward notifications to your Datadog Events, you can add the API key to the Lambda function in your AWS account.

Important: For this integration type, you do not add the Datadog API key in USM Anywhere. When you create the orchestration rule, you select the Amazon SNS notification method.

Before you can complete this integration, you must have an SNS topic and a Lambda Function for USM Anywhere notifications set up in your AWS account (see Set Up an Amazon SNS Topic) and a Datadog API key (see Create a Datadog API Key).

To integrate USM Anywhere notifications with Datadog Events through Amazon SNS

  1. In the Lambda function code, paste this code and replace [INSERT_DATADOG_API_KEY] and [INSERT_DATADOG_APPLICATION_KEY] with your Datadog keys.

    Configure the AWS Lambda function to handle USM Anywhere notifications for Datadog

    You can also modify the Datadog fields and adapt them to your environment, similar to the following:

    alert_type = "info"
default_priority = "normal"
default_tags = ["environment:test", "security"]
send_payload = True
  2. Use the default Role setting (Create a new role from templates) and specify the Role name as lambda_basic_execution.

    Set the role and timeout settings for handling USM Anywhere notifications

  3. Expand the Advanced settings and set the Timeout to 10 seconds.
  4. Click Next.
  5. Click Create function.

To check the integration with Datadog

  1. Go to your Lambda function, click Monitoring, and verify that the Invocation Count graph shows some data.

  2. Click View logs in CloudWatch and open the last entry.

    You should see entries similar to the following:

    Verify the Datadog integration in your AWS SNS configuration

  3. Go to the Datadog event URL and check that you see the USM Anywhere alarm in the Datadog console.