diff --git a/misc/event-streaming/event-streaming.md b/misc/event-streaming/event-streaming.md deleted file mode 100644 index 56742fed..00000000 --- a/misc/event-streaming/event-streaming.md +++ /dev/null @@ -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 ' \ - --header 'Content-Type: application/json' \ - --data '{ - "platform": "datadog", - "config": { - "api_url": "https://http-intake.logs.datadoghq.eu/api/v2/logs", - "api_key": "" - }, - "enabled": true -}' -``` - ->For further management of your event-streaming integration refer to the [event streaming API documentation](api.md). \ No newline at end of file diff --git a/public/docs-static/img/how-to-guides/datadog-api-key.png b/public/docs-static/img/how-to-guides/datadog-api-key.png new file mode 100644 index 00000000..7337b8d8 Binary files /dev/null and b/public/docs-static/img/how-to-guides/datadog-api-key.png differ diff --git a/public/docs-static/img/how-to-guides/datadog-region-select.png b/public/docs-static/img/how-to-guides/datadog-region-select.png new file mode 100644 index 00000000..2d2acc3e Binary files /dev/null and b/public/docs-static/img/how-to-guides/datadog-region-select.png differ diff --git a/public/docs-static/img/how-to-guides/event-streaming-integration.png b/public/docs-static/img/how-to-guides/event-streaming-integration.png new file mode 100644 index 00000000..5d021ada Binary files /dev/null and b/public/docs-static/img/how-to-guides/event-streaming-integration.png differ diff --git a/src/components/NavigationDocs.jsx b/src/components/NavigationDocs.jsx index ec8a0891..397bb5b7 100644 --- a/src/components/NavigationDocs.jsx +++ b/src/components/NavigationDocs.jsx @@ -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' }, diff --git a/src/pages/how-to/activity-event-streaming.mdx b/src/pages/how-to/activity-event-streaming.mdx new file mode 100644 index 00000000..3f05e6fa --- /dev/null +++ b/src/pages/how-to/activity-event-streaming.mdx @@ -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. + + + This feature is only available in the cloud version of NetBird. + + +## 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 » Event Streaming](https://preview.netbird.io/integrations) tab in the NetBird dashboard +

+ event-streaming-integration +

+ +- 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/)) +

+ datadog-region-select +

+ - Then enter the API key you created in [Step 1](#step-1-create-a-datdog-api-key) and click `Connect` +

+ datadog-api-key +

\ No newline at end of file