Skip to main content

Crowdstrike FDR Source

thumbnail icon

The CrowdStrike Falcon Data Replicator (FDR) Source provides a secure endpoint to ingest Falcon Data Replicator events using the S3 ingestion capability by consumed SQS notifications of new S3 objects. It securely stores the required authentication, scheduling, and state tracking information.

info

The CrowdStrike API documentation is not public and can only be accessed by partners or customers.

This Source is available in the Fed deployment.

Data types

The CrowdStrike FDR integration will ingest Falcon Data Replicator logs.

Prerequisite

You must contact the CrowdStrike support team to enable CrowdStrike FDR. If it's not enabled, your requests will receive HTTP 500 responses.

Authentication

Once CrowdStrike FDR is enabled in the CrowdStrike console, navigate to SupportAPI Clients and Keys. You need to Create new credentials to copy the AWS Access Key IDAWS Secret Access Key, and SQS Queue URL to provide to Sumo Logic when creating your CrowdStrike FDR Source.

States

A CrowdStrike FDR 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 CrowdStrike FDR 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 CrowdStrike.
  5. Collecting. The Source is actively collecting data from CrowdStrike.

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. You can click the text in the Health column, such as Error, to open the issue in Health Events to investigate.

crowdstrike error.png

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

health error generic.png

Create a CrowdStrike FDR Source

When you create a CrowdStrike FDR 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 CrowdStrike FDR Source:

  1. In Sumo Logic, select Manage Data > Collection > Collection
  2. On the Collectors page, click Add Source next to a Hosted Collector.
  3. Select CrowdStrike FDR.
    CrowdStrike FDR icon.png
  4. Enter a Name for the Source. The description is optional.
    /img/send-data/CrowdStrike-FDR-create-input
  5. (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.
  6. Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM. When configured with the Forward to SIEM option no fields are set.
  7. (Optional) Fields. Click the +Add Field link to 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 in the Fields table schema.
    • orange exclamation point.png 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 that does not exist in the Fields schema it is ignored, known as dropped.
  8. AWS Access Key ID: Provide your AWS Access Key ID you copied from CrowdStrike, see the Prerequisite.
  9. AWS Secret Access Key: Provide your AWS Secret Access Key you copied from CrowdStrike, see the Prerequisite.
  10. SQS Queue URL. Provide your SQS Queue URL you copied from CrowdStrike, see the Prerequisite.
  11. S3 Region. Select the S3 Region your data is in, this normally is the same region specified in the SQS Queue.
  12. (Optional) Historical Data Collection. Select the specified time range to ingest only the desired data. By default, it is seven days.
    • By default, all messages are ingested into Sumo Logic without any filtering. However, with the appropriate configuration, customers can ensure that only the desired data within the specified time range is ingested. For instance, if you want to ingest data from the last three days only, then you should configure the source by selecting 3 Days as the value.
    • Crowdstrike FDR will queue up to 7 days worth of data, if it's configured without any consumer ingesting the events. You should be aware that this historical data will be collected only with the C2C integration.
    • Crowdstrike FDR doesn't allow Sumo Logic to pass any parameter to collect data from a specific time range.
  13. Processing Rules for Logs. Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in Create a Processing Rule.
  14. Advanced Options for Logs.
    • Timestamp Parsing. This option is selected by default. If it's deselected, no timestamp information is parsed at all.
    • Time Zone. There are two options for Time Zone. You can use the time zone present in your log files, and then choose an option in case time zone information is missing from a log message. Or, you can have Sumo Logic completely disregard any time zone information present in logs by forcing a time zone. It's very important to have the proper time zone set, no matter which option you choose. If the time zone of logs can't be determined, Sumo Logic assigns logs UTC; if the rest of your logs are from another time zone your search results will be affected.
    • Timestamp Format. By default, Sumo Logic will automatically detect the timestamp format of your logs. However, you can manually specify a timestamp format for a Source. See Timestamps, Time Zones, Time Ranges, and Date Formats for more information.
  15. When you are finished configuring the Source, click Save.

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.

TypeReasonRetriesRetry BehaviorHealth Event Name
ThirdPartyConfigNormally 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 applicableThirdPartyConfigError
ThirdPartyGenericNormally due to an error communicating with the third party service APIs.YesThe Source will retry for up to 90 minutes, after which it quits.ThirdPartyGenericError
FirstPartyGenericNormally due to an error communicating with the internal Sumo Logic APIs.YesThe Source will retry for up to 90 minutes, after which it quits.FirstPartyGenericError

Restarting your Source

If your Source encounters ThirdPartyConfig errors, you can restart it from either the Sumo Logic UI or Sumo Logic API.

UI

To restart your source in the Sumo Logic platform, follow the steps below:

  1. Open the Collection page, and go to Manage Data > Collection > Collection.
  2. Select the source and click the information icon on the right side of the row.
  3. The API usage information popup is displayed. Click the Restart Source button on the bottom left.
    restart-source-button
  4. Click Confirm to send the restart request.
    restart-source-confirm
  5. The bottom left of the platform will provide a notification informing you the request was successful.
    restart-source-initiated

API

To restart your source using the Sumo Management API, follow the instructions below:

  • Method: POST
  • Example endpoint:
    https://api.sumologic.com/api/v1/collectors/{collector_id}/sources/{source_id}/action/restart

Sumo Logic endpoints like api.sumologic.com are different in deployments outside us1. For example, an API endpoint in Europe would begin api.eu.sumologic.com. A service endpoint in us2 (Western U.S.) would begin service.us2.sumologic.com. For more information, see Sumo Logic Endpoints.

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. 

ParameterTypeRequiredDescriptionAccess
configJSON ObjectYesContains the configuration parameters for the Source. 
schemaRefJSON ObjectYesUse {"type":"Crowdstrike FDR"} for a CrowdStrike FDR Source.not modifiable
sourceTypeStringYesUse Universal for a CrowdStrike FDR Source.not modifiable

Config parameters

The following table shows the config parameters for a CrowdStrike FDR Source.

ParameterTypeRequired?DefaultDescriptionAccess
nameStringYesType a desired name of the Source. The name must be unique per Collector. This value is assigned to the metadata field _source.modifiable
descriptionStringNonullType a description of the Source.modifiable
categoryStringNonullType a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details.modifiable
fieldsJSON ObjectNoJSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.modifiable
secretAccessKeyStringYesThe AWS Secret Access Key you got from CrowdStrike.modifiable
SqsQueueURLStringYesThe SQS Queue URL you got from CrowdStrike.modifiable
accessKeyIdStringYesThe AWS Access Key ID you got from CrowdStrike.modifiable
s3RegionStringYesotherThe S3 Region your data is in.modifiable
startTimeIntegerNootherTime range to ingest the desired data.modifiable

JSON example

{
"api.version":"v1",
"source":{
"schemaRef":{
"type":"Crowdstrike FDR"
},
"config":{
"automaticDateParsing":true,
"name":"FDR test",
"forceTimeZone":false,
"description":"Example config",
"secretAccessKey":"********",
"SqsQueueURL":"https://sqs.us-west-1.amazonaws.com/***/***",
"multilineEnabled":false,
"accessKeyId":"********",
"fields":{
"_siemForward":false
},
"category":"Sumo/FDR",
"timestampFormatAutoDetection":false,
"s3Region":"us-west-1",
"startTime": 0
"useAutolineMatching":true
},
"state":{
"state":"Collecting"
},
"sourceType":"Universal"
}
}
Legal
Privacy Statement
Terms of Use

Copyright © 2023 by Sumo Logic, Inc.