Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/monitoring-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,13 @@ The [Prometheus Push Gateway](https://github.com/prometheus/pushgateway) is used
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.
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).

* ### SNMP Exporter:
The [Prometheus SNMP Exporter](https://github.com/prometheus/snmp_exporter) is
used for gathering SNMP metrics. A default Genestack installation does not make
use of it, so you do not need to install it unless you plan to do additional
configuration beyond Genestack defaults and specifically plan to monitor some
SNMP-enabled devices.

* ### Textfile Collector:
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).
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).
Expand Down
1 change: 1 addition & 0 deletions docs/prometheus-monitoring-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Prometheus makes use of various metric exporters used to collect monitoring data
* Memcached Exporter(Memcached metrics)
* Openstack Exporter(Metrics from various Openstack products)
* Pushgateway (metrics from short-lived jobs)
* SNMP exporter (for monitoring with SNMP)

<figure markdown="span">
![Prometheus Monitoring Diagram](assets/images/prometheus-monitoring.png){ style="filter:drop-shadow(#3c3c3c 0.5rem 0.5rem 10px);" }
Expand Down
20 changes: 20 additions & 0 deletions docs/prometheus-snmp-exporter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Prometheus SNMP Exporter

You will not generally need the Prometheus SNMP Exporter unless you have
specific SNMP monitoring needs and take additional steps to configure the
Prometheus SNMP Exporter. The default Genestack configuration doesn't make
immediate use of it without site-specific customization, such as writing an
applicable snmp.conf

Use the Prometheus SNMP exporter for getting metrics from monitoring with SNMP
into Prometheus.

#### Install the Prometheus SNMP Exporter Helm Chart


``` shell
bin/install-chart.sh prometheus-snmp-exporter
```

!!! success
If the installation is successful, you should see the prometheus-snmp-exporter pod running in the prometheus namespace.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,7 @@ nav:
- Openstack Exporter: prometheus-openstack-metrics-exporter.md
- Blackbox Exporter: prometheus-blackbox-exporter.md
- Pushgateway: prometheus-pushgateway.md
- SNMP Exporter: prometheus-snmp-exporter.md
- Custom Node Metrics: prometheus-custom-node-metrics.md
- Alert Manager Examples:
- alertmanager-slack.md
Expand Down
Loading