-
Notifications
You must be signed in to change notification settings - Fork 73
Add SentinelOne Data Lake event streaming guide #423
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
bcmmbaga
wants to merge
1
commit into
main
Choose a base branch
from
sentinelone-log-streaming
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file added
BIN
+75 KB
...to-guides/activity-event-streaming/sentinelone-data-lake/api-key-generation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+131 KB
...ow-to-guides/activity-event-streaming/sentinelone-data-lake/custom-template.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+108 KB
...w-to-guides/activity-event-streaming/sentinelone-data-lake/general-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+155 KB
...to-guides/activity-event-streaming/sentinelone-data-lake/verify-integration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
77 changes: 77 additions & 0 deletions
77
src/pages/how-to/stream-activity-to-sentinelone-data-lake.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
# Stream Network Activity to SentinelOne Singularity Data Lake | ||
|
||
[SentinelOne Singularity Data Lake](https://www.sentinelone.com/platform/data-lake/) provides a centralized repository for storing and analyzing security data across your organization. By streaming NetBird network activity events to SentinelOne Data Lake, you can correlate network connectivity events with endpoint security data for comprehensive threat detection and investigation. | ||
|
||
This integration leverages NetBird's Generic HTTP streaming capability with SentinelOne Singularity Data Lake-specific configurations to ensure seamless data ingestion into your Data Lake environment. | ||
|
||
<Note> | ||
This feature is only available in the cloud version of NetBird. | ||
</Note> | ||
|
||
## Prerequisites | ||
|
||
Before you start creating and configuring a SentinelOne Singularity Data Lake event streaming integration, ensure that you have the following: | ||
- A SentinelOne account with Singularity Data Lake access and appropriate permissions | ||
- Administrative access to create API keys in your SentinelOne console | ||
|
||
## Create a SentinelOne API Token | ||
|
||
- Log in to your SentinelOne Management Console and navigate to **Visibility** from the left menu | ||
- Click on your user email dropdown in the top right toolbar and select **API Keys** | ||
- Under the **Log Access Keys** section, click **Add Key** dropdown menu and select **Add Write Key** | ||
- A new API key will be created with access to write logs to Data Lake | ||
- Click **Copy to Clipboard** and store this token securely. You will need this token when configuring the integration in NetBird. | ||
|
||
<p> | ||
<img src="/docs-static/img/how-to-guides/activity-event-streaming/sentinelone-data-lake/api-key-generation.png" alt="API Key Generation" className="imagewrapper-big"/> | ||
</p> | ||
|
||
## Get the HEC Ingestion URL | ||
|
||
Navigate to `https://<your-tenant>.sentinelone.net/docs/en/http-event-collector--hec-.html#http-event-collector--hec-` (replace `<your-tenant>` with your actual SentinelOne tenant) | ||
to find and copy the HTTP Event Collector base URL from the documentation page. The URL format will be `https://ingest.<region>.sentinelone.net` where `<region>` is your deployment region. | ||
|
||
## Create an Integration in NetBird | ||
|
||
- Navigate to the **Integrations** tab in the NetBird dashboard and select **Event Streaming** | ||
- Find the **Generic HTTP** option and click **Connect Generic HTTP** | ||
- Configure the endpoint URL by entering the full HEC endpoint URL: `https://ingest.<region>.sentinelone.net/services/collector/event` | ||
- Select **Bearer Token** for authentication and provide the API token you created earlier | ||
|
||
<p> | ||
<img src="/docs-static/img/how-to-guides/activity-event-streaming/sentinelone-data-lake/general-settings.png" alt="General Settings Configuration" className="imagewrapper-big"/> | ||
</p> | ||
|
||
- Enable the custom body template and use the following template optimized for SentinelOne Singularity Data Lake: | ||
|
||
```json | ||
{ | ||
"id": "{{.ID}}", | ||
"time": "{{.Timestamp.UnixNano}}", | ||
bcmmbaga marked this conversation as resolved.
Show resolved
Hide resolved
|
||
"event": "{{.Message}}", | ||
"initiator_id": "{{.InitiatorID}}", | ||
"target_id": "{{.TargetID}}", | ||
"host": "netbird", | ||
"source": "netbird", | ||
"sourcetype": "json", | ||
"fields": "{{.Meta}}" | ||
} | ||
``` | ||
|
||
<p> | ||
<img src="/docs-static/img/how-to-guides/activity-event-streaming/sentinelone-data-lake/custom-template.png" alt="Custom Template Configuration" className="imagewrapper-big"/> | ||
</p> | ||
|
||
## Verify the Integration | ||
|
||
After configuring the SentinelOne Singularity Data Lake integration in NetBird, you can verify that the integration is working correctly by checking the SentinelOne Singularity Data Lake for incoming events. If the integration is successful, you should see test events from NetBird in your Data Lake. | ||
|
||
- Navigate to **Data Lake** > **Search** > **New Search** in your SentinelOne console | ||
- Select to search **All Data** and filter for recent events with source **netbird** | ||
- Verify the test events appear with the expected structure | ||
|
||
<p> | ||
<img src="/docs-static/img/how-to-guides/activity-event-streaming/sentinelone-data-lake/verify-integration.png" alt="Verify Integration" className="imagewrapper-big"/> | ||
</p> | ||
|
||
The integration is now set up and ready to stream network activity events to SentinelOne Singularity Data Lake. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.