Skip to main content
Sumo Logic

CSE AWS EC2 Inventory Source

The CSE AWS EC2 Inventory Source provides a secure endpoint to receive event data from the EC2 describe instances API. It securely stores the required authentication, scheduling, and state tracking information.

For information on how inventory data is used in Cloud SIEM Enterprise, see View Entities and Activity Scores.

States

A CSE AWS EC2 Inventory Source tracks errors, reports its health, and start-up progress. You’re informed, in real-time, if the Source is having trouble connecting, if there's an error requiring user action, or if it is healthy and collecting by utilizing Health Events.

A CSE AWS EC2 Inventory Source goes through the following states when created:

  1. Pending: Once the Source is submitted it is validated, stored, and placed in a Pending state.
  2. Started: A collection task is created on the Hosted Collector.
  3. Initialized: The task configuration is complete in Sumo Logic.
  4. Authenticated: The Source successfully authenticated with AWS EC2 Inventory.
  5. Collecting: The Source is actively collecting data from AWS EC2 Inventory.

If the Source has any issues during any one of these states it is placed in an Error state.

When you delete the Source it is placed in a Stopping state, when it has successfully stopped it is deleted from your Hosted Collector.

On the Collection page, the Health and Status for Sources is displayed. Use Health Events to investigate issues with collection.

Health and Status columns.png

Hover your mouse over the status icon to view a tooltip with details on the detected issue.

error status.png

Create a CSE AWS EC2 Inventory Source

When you create a CSE AWS EC2 Inventory 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.

To configure a CSE AWS EC2 Inventory Source:

  1. In the Sumo Logic web app, select Manage Data > Collection > Collection
  1. In the Collectors page, click Add Source next to a Hosted Collector.
  1. Select AWS EC2 Inventory.
    EC2 inventory icon.png
  1. Enter a Name to display for the Source in the Sumo web application. The description is optional.
    AWS EC2 input pane.png
  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.
  2. Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM Enterprise. When configured with the Forward to SIEM option the following metadata fields are set:
Field Name Value
_siemVendor AWS
_siemProduct AWS EC2 Inventory
_dataType Inventory
  1. (Optional) Fields. Click the +Add link to add custom log metadata Fields.
    • Define the fields you want to associate, each field needs a name (key) and value. 
      • green check circle.png A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
      • orange exclamation point.png An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo that does not exist in the Fields schema or is disabled it is ignored, known as dropped.
  2. AWS Access Key and AWS Secret Key. Provide the IAM User access key ID and secret key you want to use to authenticate collection requests.

  3. Regions. Provide a list of AWS regions to query EC2 instances, such as us-east-2.

  4. (Optional) The Polling Interval is set for 600 minutes by default, you can adjust it based on your needs.

  5. When you are finished configuring the Source click Submit.

Error types

When Sumo Logic detects an issue it is tracked by Health Events. The following table shows the three possible error types, the reason the error would occur, if the Source attempts to retry, and the name of the event log in the Health Event Index.

Type Reason Retries Retry Behavior Health Event Name
ThirdPartyConfig Normally due to an invalid configuration. You'll need to review your Source configuration and make an update. No retries are attempted until the Source is updated. Not applicable ThirdPartyConfigError
ThirdPartyGeneric Normally due to an error communicating with the third party service APIs. Yes The Source will retry for up to 90 minutes, after which retries will be attempted every 60 minutes. ThirdPartyGenericError
FirstPartyGeneric Normally due to an error communicating with the internal Sumo Logic APIs. Yes The Source will retry for up to 90 minutes, after which retries will be attempted every 60 minutes. FirstPartyGenericError

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 for details. 

Parameter Type Required? Description Access
config JSON Object Yes Contains the configuration parameters for the Source.  
schemaRef JSON Object Yes Use {"type":"CSE AWS EC2 Inventory"}. not modifiable
sourceType String Yes Use Universal. not modifiable

The following table shows the config parameters.

Parameter Type Required Default Description Access
name String Yes   Type a desired name of the Source. The name must be unique per Collector. This value is assigned to the metadata field _source. modifiable
description String No null Type a description of the Source. modifiable
category String No null Type a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details. modifiable
fields JSON
Object
No   JSON map of key-value fields (metadata) to apply to the Collector or Source.

Use the boolean field _siemForward to enable forwarding to SIEM.
modifiable
regions String array Yes   Provide a list of AWS regions to query EC2 instances, such as us-east-2. Use ["all"] to support all regions. modifiable
access_key String Yes   Provide the IAM User access key ID you want to use to authenticate collection requests. modifiable
secret_key String Yes   Provide the Secret Key you want to use to authenticate collection requests. modifiable
polling_interval Integer No 600 The minutes in between checks for new data. modifiable

CSE AWS EC2 Inventory Source JSON example:

{
  "api.version":"v1",
  "source":{
    "config":{
      "name":"AWS Inventory",
      "access_key":"********",
      "polling_interval":600,
      "regions":["all"],
      "secret_key":"********",
      "fields":{
        "_siemForward":true
      },
      "category":"aws/inventory"
    },
    "state":{
      "state":"Collecting"
    },
    "schemaRef":{
      "type":"CSE AWS EC2 Inventory"
    },
    "sourceType":"Universal"
  }
}