-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[NDMII-3557] Create VPN Monitoring docs #30803
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Pierre-L42
wants to merge
19
commits into
master
Choose a base branch
from
pierre.lin/add-vpn-monitoring-docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+187
−3
Open
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
910dfcc
Create VPN Monitoring docs
Pierre-L42 602530a
Add content
Pierre-L42 ed4b7bd
Fix tab
Pierre-L42 cd9b831
Fix spaces
Pierre-L42 ac12a3b
Fix warnings
Pierre-L42 06deaf5
Fix warnings
Pierre-L42 64280d9
Update content/en/network_monitoring/devices/vpn_monitoring.md
Pierre-L42 0dcebec
Update content/en/network_monitoring/devices/vpn_monitoring.md
Pierre-L42 08b62f2
Update content/en/network_monitoring/devices/vpn_monitoring.md
Pierre-L42 1a0ab09
Update content/en/network_monitoring/devices/vpn_monitoring.md
Pierre-L42 2f98a8c
Update content/en/network_monitoring/devices/vpn_monitoring.md
Pierre-L42 e3fce2d
Update content/en/network_monitoring/devices/vpn_monitoring.md
Pierre-L42 0ef0b9b
Update content/en/network_monitoring/devices/vpn_monitoring.md
Pierre-L42 e0e098e
Update content/en/network_monitoring/devices/vpn_monitoring.md
Pierre-L42 ab2f777
Add tics to metrics
Pierre-L42 e53140a
Add section in Setup page
Pierre-L42 d4f2475
Add highlights to config
Pierre-L42 a5dcabe
Fix yaml code blocks
Pierre-L42 4e7e7aa
adjusting table, command and links
aliciascott File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
175 changes: 175 additions & 0 deletions
175
content/en/network_monitoring/devices/vpn_monitoring.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,175 @@ | ||
--- | ||
title: VPN Monitoring | ||
description: Get started with monitoring your devices VPN tunnels. | ||
further_reading: | ||
- link: "https://www.datadoghq.com/knowledge-center/network-monitoring/snmp-monitoring/" | ||
tag: "Knowledge Center" | ||
text: "SNMP Monitoring Overview" | ||
- link: "https://www.datadoghq.com/blog/monitor-snmp-with-datadog/" | ||
tag: "Blog" | ||
text: "Monitor SNMP with Datadog" | ||
--- | ||
|
||
## Overview | ||
|
||
VPN monitoring provides visibility into your devices' VPN tunnels within Network Device Monitoring (NDM). This feature allows you to keep track of critical data and metrics to examine the health of your VPN tunnels. | ||
|
||
When configured, the SNMP check collects VPN tunnel data from your devices. This can be configured for [individual][4] as well as [Autodiscovered][5] devices. | ||
|
||
## Prerequisites | ||
|
||
Agent version `7.70` or higher. | ||
### Limitations | ||
|
||
- Support is limited to Cisco IPsec VPN tunnels. | ||
|
||
## Configuration | ||
|
||
1. Install or upgrade the [Datadog Agent][1] to v7.70+. | ||
|
||
2. Edit the `snmp.d/conf.yaml` file in the `conf.d/` folder at the root of your [Agent's configuration directory][2] for individual devices, or the [`datadog.yaml`][3] Agent configuration file for Autodiscovery. | ||
|
||
{{< tabs >}} | ||
{{% tab "Individual" %}} | ||
|
||
To enable VPN monitoring to all _manually_ configured devices, add the `collect_vpn` configuration in the `init_config` section: | ||
|
||
{{< highlight yaml "hl_lines=4" >}} | ||
init_config: | ||
loader: core | ||
use_device_id_as_hostname: true | ||
collect_vpn: true # (default false) enable collecting VPN tunnel data | ||
instances: | ||
- ip_address: '1.2.3.4' | ||
community_string: 'sample-string' | ||
tags: | ||
- 'key1:val1' | ||
- 'key2:val2' | ||
Pierre-L42 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
{{< /highlight >}} | ||
|
||
Or, apply the `collect_vpn` configuration _per_ instance: | ||
|
||
{{< highlight yaml "hl_lines=10" >}} | ||
init_config: | ||
loader: core | ||
use_device_id_as_hostname: true | ||
instances: | ||
- ip_address: '1.2.3.4' | ||
community_string: 'sample-string' | ||
tags: | ||
- 'key1:val1' | ||
- 'key2:val2' | ||
collect_vpn: true # (default false) enable collecting VPN tunnel data | ||
Pierre-L42 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
{{< /highlight >}} | ||
|
||
{{% /tab %}} | ||
|
||
{{% tab "Autodiscovery" %}} | ||
|
||
To enable VPN monitoring to all _Autodiscovery_ subnets, add the `collect_vpn` configuration under the `network_devices.autodiscovery` section: | ||
|
||
{{< highlight yaml "hl_lines=7" >}} | ||
network_devices: | ||
autodiscovery: | ||
workers: 100 | ||
discovery_interval: 3600 | ||
loader: core | ||
use_device_id_as_hostname: true | ||
collect_vpn: true # (default false) enable collecting VPN tunnel data | ||
configs: | ||
- network_address: 10.10.0.0/24 | ||
loader: core | ||
snmp_version: 2 | ||
port: 161 | ||
community_string: '***' | ||
tags: | ||
- "key1:val1" | ||
- "key2:val2" | ||
{{< /highlight >}} | ||
|
||
{{% /tab %}} | ||
{{< /tabs >}} | ||
|
||
## Viewing VPN tunnels | ||
|
||
To view VPN tunnels in the UI: | ||
|
||
1. Select a monitored device in NDM that has VPN tunnels. | ||
2. Click on the **VPN Tunnels** tab in the device's side panel. | ||
|
||
### Metrics collected | ||
|
||
The following metrics are made available after enabling VPN monitoring: | ||
|
||
<table style="width: 100%;"> | ||
<thead> | ||
<tr> | ||
<th style="width: 40%;">Metric Name</th> | ||
<th style="width: 65%;">Description</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr> | ||
<td><code>snmp.cipSecTunActiveTime</code></td> | ||
<td>The duration the tunnel has been active in hundredths of seconds.</td> | ||
</tr> | ||
<tr> | ||
<td><code>snmp.cipSecTunHcInOctets</code></td> | ||
<td>The number of octets received by the tunnel.</td> | ||
</tr> | ||
<tr> | ||
<td><code>snmp.cipSecTunHcOutOctets</code></td> | ||
<td>The number of octets sent by the tunnel.</td> | ||
</tr> | ||
<tr> | ||
<td><code>snmp.cipSecTunInPkts</code></td> | ||
<td>The number of packets received by the tunnel.</td> | ||
</tr> | ||
<tr> | ||
<td><code>snmp.cipSecTunOutPkts</code></td> | ||
<td>The number of packets sent by the tunnel.</td> | ||
</tr> | ||
<tr> | ||
<td><code>snmp.cipSecTunInAuthFails</code></td> | ||
<td>The number of inbound authentications that ended in failure for the tunnel.</td> | ||
</tr> | ||
<tr> | ||
<td><code>snmp.cipSecTunOutAuthFails</code></td> | ||
<td>The number of outbound authentications that ended in failure for the tunnel.</td> | ||
</tr> | ||
<tr> | ||
<td><code>snmp.cipSecTunInDecryptFails</code></td> | ||
<td>The number of inbound decryptions that ended in failure for the tunnel.</td> | ||
</tr> | ||
<tr> | ||
<td><code>snmp.cipSecTunOutEncryptFails</code></td> | ||
<td>The number of outbound encryptions that ended in failure for the tunnel.</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
|
||
## Troubleshooting | ||
|
||
If you experience issues using VPN monitoring, use the following troubleshooting guidelines. If you need further assistance, contact [Datadog support][6]. | ||
|
||
### VPN tunnels not displayed | ||
|
||
The VPN tunnel data is collected with SNMP. If VPN tunnels are missing on a device, ensure the following: | ||
|
||
- Datadog Agent version 7.70 or later is installed. | ||
- Verify the device exposes the relevant VPN tunnel data with SNMP by running the following command: | ||
|
||
```shell | ||
sudo -u dd-agent datadog-agent snmp walk <DEVICE_IP> 1.3.6.1.4.1.9.9.171.1.3.2 | ||
``` | ||
|
||
## Further Reading | ||
|
||
{{< partial name="whats-next/whats-next.html" >}} | ||
|
||
[1]: /agent | ||
[2]: /agent/configuration/agent-configuration-files/#agent-configuration-directory | ||
[3]: /agent/configuration/agent-configuration-files/?tab=agentv6v7#agent-main-configuration-file | ||
[4]: /network_monitoring/devices/vpn_monitoring/?tab=individual#configuration | ||
[5]: /network_monitoring/devices/vpn_monitoring/?tab=autodiscovery#configuration | ||
[6]: /help |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.