Skip to content

Commit 8cce0a7

Browse files
authored
doc: Prometheus SNMP exporter documentation (#854)
JIRA:OSPC-624
1 parent f25aa65 commit 8cce0a7

File tree

4 files changed

+29
-0
lines changed

4 files changed

+29
-0
lines changed

docs/monitoring-info.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,13 @@ The [Prometheus Push Gateway](https://github.com/prometheus/pushgateway) is used
151151
It's not capable of turning Prometheus into a push-based monitoring system and should only be used when there is no other way to collect the desired metrics.
152152
Currently, in Genestack the push gateway is only being used to gather stats from the OVN-Backup CronJob as noted in the [Pushgateway Deployment Doc](prometheus-pushgateway.md).
153153

154+
* ### SNMP Exporter:
155+
The [Prometheus SNMP Exporter](https://github.com/prometheus/snmp_exporter) is
156+
used for gathering SNMP metrics. A default Genestack installation does not make
157+
use of it, so you do not need to install it unless you plan to do additional
158+
configuration beyond Genestack defaults and specifically plan to monitor some
159+
SNMP-enabled devices.
160+
154161
* ### Textfile Collector:
155162
It's possible to gather node/host metrics that aren't exposed by any of the above exporters by utilizing the [Node Exporter Textfile Collector](https://github.com/prometheus/node_exporter?tab=readme-ov-file#textfile-collector).
156163
Currently, in Genestack the textfile-collector is used to collect kernel-taint stats. To view more information about the textfile-collector and how to deploy your own custom exporter view the [Custom Metrics Deployment Doc](prometheus-custom-node-metrics.md).

docs/prometheus-monitoring-overview.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Prometheus makes use of various metric exporters used to collect monitoring data
1919
* Memcached Exporter(Memcached metrics)
2020
* Openstack Exporter(Metrics from various Openstack products)
2121
* Pushgateway (metrics from short-lived jobs)
22+
* SNMP exporter (for monitoring with SNMP)
2223

2324
<figure markdown="span">
2425
![Prometheus Monitoring Diagram](assets/images/prometheus-monitoring.png){ style="filter:drop-shadow(#3c3c3c 0.5rem 0.5rem 10px);" }

docs/prometheus-snmp-exporter.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Prometheus SNMP Exporter
2+
3+
You will not generally need the Prometheus SNMP Exporter unless you have
4+
specific SNMP monitoring needs and take additional steps to configure the
5+
Prometheus SNMP Exporter. The default Genestack configuration doesn't make
6+
immediate use of it without site-specific customization, such as writing an
7+
applicable snmp.conf
8+
9+
Use the Prometheus SNMP exporter for getting metrics from monitoring with SNMP
10+
into Prometheus.
11+
12+
#### Install the Prometheus SNMP Exporter Helm Chart
13+
14+
15+
``` shell
16+
bin/install-chart.sh prometheus-snmp-exporter
17+
```
18+
19+
!!! success
20+
If the installation is successful, you should see the prometheus-snmp-exporter pod running in the prometheus namespace.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,7 @@ nav:
236236
- Openstack Exporter: prometheus-openstack-metrics-exporter.md
237237
- Blackbox Exporter: prometheus-blackbox-exporter.md
238238
- Pushgateway: prometheus-pushgateway.md
239+
- SNMP Exporter: prometheus-snmp-exporter.md
239240
- Custom Node Metrics: prometheus-custom-node-metrics.md
240241
- Alert Manager Examples:
241242
- alertmanager-slack.md

0 commit comments

Comments
 (0)