From bf2ad8000b3d9910108874e078babdab7125d860 Mon Sep 17 00:00:00 2001 From: pascal-fischer <32096965+pascal-fischer@users.noreply.github.com> Date: Thu, 4 Jan 2024 17:12:46 +0100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Misha Bragin --- misc/event-streaming/event-streaming.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/misc/event-streaming/event-streaming.md b/misc/event-streaming/event-streaming.md index df5978a7..56742fed 100644 --- a/misc/event-streaming/event-streaming.md +++ b/misc/event-streaming/event-streaming.md @@ -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). \ No newline at end of file +>For further management of your event-streaming integration refer to the [event streaming API documentation](api.md). \ No newline at end of file