Move event streaming to public docs (#125)

This commit is contained in:
pascal-fischer
2024-01-25 15:31:02 +01:00
committed by GitHub
parent 710c2dbd63
commit 09b5f417cd
6 changed files with 35 additions and 39 deletions

View File

@@ -1,39 +0,0 @@
# Introduction
This document provides step-by-step instructions and best practices for setting up NetBird activity event streaming integrations to different third-party services.
## Datadog
Before you start creating and configuring a Datadog event-streaming integration, ensure that you have the following:
- A Datadog account with the permissions to create and manage API keys. If you don't have the required permissions, ask your Datadog administrator to grant them to you.
#### Step 1: Create a Datdog API key
- Navigate to the [API Keys](https://app.datadoghq.eu/organization-settings/api-keys) page
- Click `+ New Key` at the top
- Give it a descriptive name like `NetBird Event Streaming`
- Click `Create Key`
- Copy the key. You will need this key when configuring an integration in NetBird.
#### Step 2: Create an event-streaming integration in NetBird
Use the NetBird API to create the integration. For this you can use the following cURL command with updated parameters:
- `platform`: A string representing the platform name. For Datadog use `datadog`.
- `config.api_url`: The URL of the Datadog HTTP API endpoint. This URL differs based on the region. To find the correct URL, refer to the [Datadog documentation](https://docs.datadoghq.com/api/latest/logs/#send-logs).
- `config.api_key`: The API key for the Datadog HTTP API endpoint. This key can be created in the [Datadog Console](https://app.datadoghq.com/organization-settings/api-keys).
- `enabled`: A flag to enable/disable the integration.
```shell
curl --request POST \
--url https://api.netbird.io/api/integrations/event-streaming \
--header 'Accept: application/json' \
--header 'Authorization: Token <PAT>' \
--header 'Content-Type: application/json' \
--data '{
"platform": "datadog",
"config": {
"api_url": "https://http-intake.logs.datadoghq.eu/api/v2/logs",
"api_key": "<API_KEY>"
},
"enabled": true
}'
```
>For further management of your event-streaming integration refer to the [event streaming API documentation](api.md).

Binary file not shown.

After

Width:  |  Height:  |  Size: 179 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 121 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 264 KiB

View File

@@ -55,6 +55,7 @@ export const docsNavigation = [
{ title: 'Route traffic to private networks', href: '/how-to/routing-traffic-to-private-networks' },
{ title: 'Manage DNS in your network', href: '/how-to/manage-dns-in-your-network' },
{ title: 'Monitor system and network activity', href: '/how-to/monitor-system-and-network-activity' },
{ title: 'Activity event streaming', href: '/how-to/activity-event-streaming' },
{ title: 'Access NetBird API', href: '/how-to/access-netbird-public-api' },
{ title: 'Examples', href: '/how-to/examples' },
{ title: 'CLI', href: '/how-to/cli' },

View File

@@ -0,0 +1,34 @@
# Stream Activity Events to Third-Party Platforms
This document provides step-by-step instructions and best practices for setting up NetBird activity event streaming integrations to different third-party platforms.
<Note>
This feature is only available in the cloud version of NetBird.
</Note>
## Datadog
Before you start creating and configuring a Datadog event-streaming integration, ensure that you have the following:
- A Datadog account with the permissions to create and manage API keys. If you don't have the required permissions, ask your Datadog administrator to grant them to you.
### Step 1: Create a Datdog API key
- Navigate to the [API Keys](https://app.datadoghq.eu/organization-settings/api-keys) page
- Click `+ New Key` at the top
- Give it a descriptive name like `NetBird Event Streaming`
- Click `Create Key`
- Copy the key. You will need this key when configuring an integration in NetBird.
### Step 2: Create an event-streaming integration in NetBird
- Navigate to the [Integrations &raquo; Event Streaming](https://preview.netbird.io/integrations) tab in the NetBird dashboard
<p>
<img src="/docs-static/img/how-to-guides/event-streaming-integration.png" alt="event-streaming-integration" className="imagewrapper"/>
</p>
- Enable and configure the Datadog integration
- First select the region of your Datadog account (for more details see [Datadog Documentation](https://docs.datadoghq.com/getting_started/site/))
<p>
<img src="/docs-static/img/how-to-guides/datadog-region-select.png" alt="datadog-region-select" className="imagewrapper" width="400" style={{ display: 'block', marginLeft: 'auto', marginRight: 'auto' }} />
</p>
- Then enter the API key you created in [Step 1](#step-1-create-a-datdog-api-key) and click `Connect`
<p>
<img src="/docs-static/img/how-to-guides/datadog-api-key.png" alt="datadog-api-key" className="imagewrapper" width="400" style={{ display: 'block', marginLeft: 'auto', marginRight: 'auto' }} />
</p>