Skip to main content

Rapid7 Source

rapid7-logo

The Rapid7 source collects asset and vulnerabilities from Rapid7 InsightVM API and sends it to Sumo Logic. InsightVM provides a fully available, scalable, and efficient way to collect vulnerability data and minimize risk. InsightVM automatically evaluates changes in user's networks, allowing security professionals to better understand and quickly manage the risk posed to their organization.

Data Source‚Äč

Rapid7 source ingests inventory, assessment, and summary details for assets from Assets API and vulnerabilities from Vulnerabilities API.

Metadata Fields‚Äč

Metadata fields will be set, if the integration is configured with the SIEM forward option. See Metadata Fields table below:

Field NameValue
_siemDataTypeInventory
_siemProductInsightVM
_siemVendorRapid7

Setup and Configuration‚Äč

The Rapid7 InsightVM source requires you to provide a region and organizational API key to access the data. Follow the instructions from Rapid7 documentation, to determine the Region and Organizational API key.

States‚Äč

Rapid7 integration Source is a device security platform that discover devices, tracks behavior, detects threats, and takes action to protect your business. When you create an Rapid7 Source, it goes through the following stages:

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

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

Create Rapid7 Source‚Äč

When you create an Rapid7 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 an Rapid7 Source:

  1. In Sumo Logic, select Manage Data > Collection > Collection. 
  2. On the Collection page, click Add Source next to a Hosted Collector.
  3. Search for and select Rapid7.
    rapid7-logo
  4. Enter a Name for the Source. The description is optional.
    rapid7-config-main.png
  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. (Optional) Fields. Click the +Add button 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 Logic that does not exist in the Fields schema it is ignored, known as dropped.
  7. Enter the Region of Rapid7 InsightVM platform.
  8. Enter the API Key for authorization.

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 for the error, 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 indefinitely.ThirdPartyGenericError
FirstPartyGenericNormally due to an error communicating with the internal Sumo Logic APIs.YesThe Source will retry indefinitely.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 of the Source.na
schemaRefJSON ObjectYesUse {"type":"Rapid7"} for Rapid7 Source.not modifiable
sourceTypeStringYesUse Universal for Rapid7 Source.not modifiable

Config Parameters‚Äč

ParameterTypeRequiredDescriptionAccess
nameStringYesType the desired name of the Source and it must be unique per Collector. This value is assigned to the metadata field _source. modifiable
descriptionStringNoType the description of the Source.modifiable
categoryStringNoType the category of the source. This value is assigned to the metadata field _sourceCategory.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
regionStringYesRegion of the Insight platform. Know more about Supported regions.modifiable
apikeyStringYesAPI Key for the account authorization.modifiable

JSON Example‚Äč

{
"api.version": "v1",
"source": {
"config": {
"name": "Rapid7",
"description": "Test Source",
"category": "source_category",
"env": "dev",
"region": "us",
"apiKey": "215c96c6-19a6-48e9-955f-253593xxxxxx"
},
"schemaRef": {
"type": "Rapid7"
},
"sourceType": "Universal"
},
}
Legal
Privacy Statement
Terms of Use

Copyright © 2023 by Sumo Logic, Inc.