From 3831b4b7c9d2e5621a1b697c29fbcb3a25e43596 Mon Sep 17 00:00:00 2001 From: aliciascott Date: Fri, 27 Dec 2024 13:30:42 -0700 Subject: [PATCH 1/2] adding Windows support --- .../network_monitoring/network_path/setup.md | 40 +++++++++++++++++-- 1 file changed, 37 insertions(+), 3 deletions(-) diff --git a/content/en/network_monitoring/network_path/setup.md b/content/en/network_monitoring/network_path/setup.md index ea3748670628a..106aa14c86639 100644 --- a/content/en/network_monitoring/network_path/setup.md +++ b/content/en/network_monitoring/network_path/setup.md @@ -32,6 +32,9 @@ Setting up Network Path involves configuring your Linux environment to monitor a ### Monitor individual paths +{{< tabs >}} +{{% tab "Linux" %}} + Manually configure individual paths by specifying the exact endpoint you want to test. This allows you to target specific network routes for monitoring. 1. Enable the `system-probe` traceroute module in `/etc/datadog-agent/system-probe.yaml` by adding the following: @@ -126,8 +129,31 @@ Manually configure individual paths by specifying the exact endpoint you want to 3. Restart the Agent after making these configuration changes to start seeing network paths. +[4]: https://github.com/DataDog/datadog-agent/blob/main/cmd/agent/dist/conf.d/network_path.d/conf.yaml.example + +{{% /tab %}} +{{% tab "Windows" %}} + +**Note**: Windows only supports TCP traceroutes. + +In Windows environments, the Agent uses UDP by default to monitor individual paths. If the protocol is not specified in the configuration, the Agent attempts a UDP traceroute, and any errors are logged. To work around this, ensure the protocol is set to TCP in the following example: + +```yaml +init_config: + min_collection_interval: 60 # in seconds, default 60 seconds +instances: + - hostname: api.datadoghq.eu # endpoint hostname or IP + protocol: TCP + port: 443 # optional port number, default is 80 +``` +{{% /tab %}} +{{< /tabs >}} + ### Network traffic paths (experimental) +{{< tabs >}} +{{% tab "Linux" %}} + **Note**: Network traffic paths is experimental and is not yet stable. Do not deploy network traffic paths widely in a production environment. Configure network traffic paths to allow the Agent to automatically discover and monitor network paths based on actual network traffic, without requiring you to specify endpoints manually. @@ -170,7 +196,15 @@ Configure network traffic paths to allow the Agent to automatically discover and 3. Restart the Agent after making these configuration changes to start seeing network paths. -**Note**: Network path is only supported for Linux environments. +[3]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/config_template.yaml#L1697 + +{{% /tab %}} +{{% tab "Windows" %}} + +For network traffic paths on Windows environments, only detected TCP connections are shown. + +{{% /tab %}} +{{< /tabs >}} ## Further Reading @@ -178,5 +212,5 @@ Configure network traffic paths to allow the Agent to automatically discover and [1]: /network_monitoring/cloud_network_monitoring/setup/ [2]: https://docs.datadoghq.com/agent/configuration/proxy/?tab=linux -[3]: https://github.com/DataDog/datadog-agent/blob/main/pkg/config/config_template.yaml#L1645 -[4]: https://github.com/DataDog/datadog-agent/blob/main/cmd/agent/dist/conf.d/network_path.d/conf.yaml.example + + From 865e7502f0a4e80592265511da188991da39009e Mon Sep 17 00:00:00 2001 From: aliciascott Date: Fri, 27 Dec 2024 13:35:11 -0700 Subject: [PATCH 2/2] adding Agent version --- content/en/network_monitoring/network_path/setup.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/content/en/network_monitoring/network_path/setup.md b/content/en/network_monitoring/network_path/setup.md index 106aa14c86639..606bcf296cab5 100644 --- a/content/en/network_monitoring/network_path/setup.md +++ b/content/en/network_monitoring/network_path/setup.md @@ -23,8 +23,7 @@ Setting up Network Path involves configuring your Linux environment to monitor a ## Prerequisites -- Agent version `7.59` or higher is required. -- [CNM][1] must be enabled. +[CNM][1] must be enabled. **Note**: If your network configuration restricts outbound traffic, follow the setup instructions on the [Agent proxy configuration][2] documentation. @@ -35,6 +34,8 @@ Setting up Network Path involves configuring your Linux environment to monitor a {{< tabs >}} {{% tab "Linux" %}} +Agent `v7.59+` is required. + Manually configure individual paths by specifying the exact endpoint you want to test. This allows you to target specific network routes for monitoring. 1. Enable the `system-probe` traceroute module in `/etc/datadog-agent/system-probe.yaml` by adding the following: @@ -134,6 +135,8 @@ Manually configure individual paths by specifying the exact endpoint you want to {{% /tab %}} {{% tab "Windows" %}} +Agent `v7.61+` is required. + **Note**: Windows only supports TCP traceroutes. In Windows environments, the Agent uses UDP by default to monitor individual paths. If the protocol is not specified in the configuration, the Agent attempts a UDP traceroute, and any errors are logged. To work around this, ensure the protocol is set to TCP in the following example: @@ -154,6 +157,8 @@ instances: {{< tabs >}} {{% tab "Linux" %}} +Agent `v7.59+` is required. + **Note**: Network traffic paths is experimental and is not yet stable. Do not deploy network traffic paths widely in a production environment. Configure network traffic paths to allow the Agent to automatically discover and monitor network paths based on actual network traffic, without requiring you to specify endpoints manually. @@ -201,6 +206,8 @@ Configure network traffic paths to allow the Agent to automatically discover and {{% /tab %}} {{% tab "Windows" %}} +Agent `v7.61+` is required. + For network traffic paths on Windows environments, only detected TCP connections are shown. {{% /tab %}}