sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-08-25 09:11:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from code review

Browse Source 
Co-authored-by: Misha Bragin <bangvalo@gmail.com>
This commit is contained in:
pascal-fischer
2024-01-04 17:12:46 +01:00
committed by GitHub
parent 0c7e94d749
commit bf2ad8000b
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
misc/event-streaming/event-streaming.md
View File

@@ -1,23 +1,23 @@
# Introduction
Welcome to our comprehensive guide on configuring NetBird event-streaming to third-party services. This document provides step-by-step instructions and best practices for setting up streaming integrations to different third-party services.
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:
- User account with admin permissions: You must have a Datadog account with the admin permissions to create and manage API keys. If you don't have the required permissions, ask your workspace administrator to grant them to you.
- 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 an API key
#### 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`
#### Step 2: Create an event-streaming integration
- 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`.
- `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).
- `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).
- `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
@@ -36,4 +36,4 @@ curl --request POST \
}'
```
>For further management of your event-streaming integration refer to the [API Documentation](api.md).
>For further management of your event-streaming integration refer to the [event streaming API documentation](api.md).