Skip to content

Commit

Permalink
Fix links to SNMP architecture images (#8150)
Browse files Browse the repository at this point in the history
  • Loading branch information
florimondmanca authored Dec 7, 2020
1 parent 674adda commit 414b2f8
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions docs/developer/architecture/snmp.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Here's an overview of what this integration involves:

The diagram below shows how these components interact for a typical VM-based setup (single Agent on a host). For Datadog Cluster Agent (DCA) deployments, see [Cluster Agent Integration](#cluster-agent-integration).

![](../../assets/images/snmp-architecture.png)
![](../assets/images/snmp-architecture.png)

## Python Check

Expand Down Expand Up @@ -108,7 +108,7 @@ snmp_listener:
For Kubernetes environments, the [Cluster Agent](https://docs.datadoghq.com/agent/cluster_agent/) can be configured to use the SNMP Agent auto-discovery (via snmp listener) logic as a source of [Cluster checks](https://docs.datadoghq.com/agent/cluster_agent/clusterchecks/).
![](../../assets/images/snmp-architecture-cluster-agent.png)
![](../assets/images/snmp-architecture-cluster-agent.png)
The Datadog Cluster Agent (DCA) uses the `snmp_listener` config (Agent auto-discovery) to listen for IP ranges, then schedules snmp check instances to be run by one or more normal Datadog Agents.

Expand Down Expand Up @@ -139,7 +139,7 @@ helm install datadog-monitoring --set datadog.apiKey=<YOUR_API_KEY> -f cluster-a
## ref: https://app.datadoghq.com/account/settings#agent/kubernetes
#
apiKey: <DATADOG_API_KEY>
## @param clusterName - string - optional
## Set a unique cluster name to allow scoping hosts and Cluster Checks easily
## The name must be unique and must be dot-separated tokens where a token can be up to 40 characters with the following restrictions:
Expand All @@ -150,23 +150,23 @@ helm install datadog-monitoring --set datadog.apiKey=<YOUR_API_KEY> -f cluster-a
## https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters#Cluster.FIELDS.name
#
clusterName: my-snmp-cluster
## @param clusterChecks - object - required
## Enable the Cluster Checks feature on both the cluster-agents and the daemonset
## ref: https://docs.datadoghq.com/agent/autodiscovery/clusterchecks/
## Autodiscovery via Kube Service annotations is automatically enabled
#
clusterChecks:
enabled: true
## @param tags - list of key:value elements - optional
## List of tags to attach to every metric, event and service check collected by this Agent.
##
## Learn more about tagging: https://docs.datadoghq.com/tagging/
#
tags:
- 'env:test-snmp-cluster-agent'
## @param clusterAgent - object - required
## This is the Datadog Cluster Agent implementation that handles cluster-wide
## metrics more cleanly, separates concerns for better rbac, and implements
Expand All @@ -178,7 +178,7 @@ helm install datadog-monitoring --set datadog.apiKey=<YOUR_API_KEY> -f cluster-a
## Set this to true to enable Datadog Cluster Agent
#
enabled: true
## @param confd - list of objects - optional
## Provide additional cluster check configurations
## Each key will become a file in /conf.d
Expand Down Expand Up @@ -207,73 +207,73 @@ helm install datadog-monitoring --set datadog.apiKey=<YOUR_API_KEY> -f cluster-a
## The IP address of the device to monitor.
#
ip_address: "%%host%%"
## @param port - integer - optional - default: 161
## Default SNMP port.
#
port: "%%port%%"
## @param snmp_version - integer - optional - default: 2
## If you are using SNMP v1 set snmp_version to 1 (required)
## If you are using SNMP v3 set snmp_version to 3 (required)
#
snmp_version: "%%extra_version%%"
## @param timeout - integer - optional - default: 5
## Amount of second before timing out.
#
timeout: "%%extra_timeout%%"
## @param retries - integer - optional - default: 5
## Amount of retries before failure.
#
retries: "%%extra_retries%%"
## @param community_string - string - optional
## Only useful for SNMP v1 & v2.
#
community_string: "%%extra_community%%"
## @param user - string - optional
## USERNAME to connect to your SNMP devices.
#
user: "%%extra_user%%"
## @param authKey - string - optional
## Authentication key to use with your Authentication type.
#
authKey: "%%extra_auth_key%%"
## @param authProtocol - string - optional
## Authentication type to use when connecting to your SNMP devices.
## It can be one of: MD5, SHA, SHA224, SHA256, SHA384, SHA512.
## Default to MD5 when `authKey` is specified.
#
authProtocol: "%%extra_auth_protocol%%"
## @param privKey - string - optional
## Privacy type key to use with your Privacy type.
#
privKey: "%%extra_priv_key%%"
## @param privProtocol - string - optional
## Privacy type to use when connecting to your SNMP devices.
## It can be one of: DES, 3DES, AES, AES192, AES256, AES192C, AES256C.
## Default to DES when `privKey` is specified.
#
privProtocol: "%%extra_priv_protocol%%"
## @param context_engine_id - string - optional
## ID of your context engine; typically unneeded.
## (optional SNMP v3-only parameter)
#
context_engine_id: "%%extra_context_engine_id%%"
## @param context_name - string - optional
## Name of your context (optional SNMP v3-only parameter).
#
context_name: "%%extra_context_name%%"
## @param tags - list of key:value element - optional
## List of tags to attach to every metric, event and service check emitted by this integration.
##
Expand All @@ -283,8 +283,8 @@ helm install datadog-monitoring --set datadog.apiKey=<YOUR_API_KEY> -f cluster-a
# The autodiscovery subnet the device is part of.
# Used by Agent autodiscovery to pass subnet name.
- "autodiscovery_subnet:%%extra_autodiscovery_subnet%%"
## @param datadog-cluster.yaml - object - optional
## Specify custom contents for the datadog cluster agent config (datadog-cluster.yaml).
#
Expand Down

0 comments on commit 414b2f8

Please sign in to comment.