Skip to content

Commit 2074bc5

Browse files
committed
fix: re-add metrics section
1 parent df8e73e commit 2074bc5

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ This exporter does not output Nagios check results as Prometheus metrics; it is
3939
- [Configuration File](#configuration-file)
4040
- [CLI](#cli)
4141
- [Nagios Core 3/4 support](#nagios-core-34-support)
42+
- [Metrics](#metrics)
4243
- [Grafana](#grafana)
4344
- [Troubleshooting](#troubleshooting)
4445
- [NagiosXI](#nagiosxi)
@@ -150,6 +151,44 @@ Example usage:
150151

151152
Note that this flag nullifies all others. It cannot be used in conjunction with the Nagios XI API.
152153

154+
## Metrics
155+
156+
<details close>
157+
158+
<summary>Click to expand metrics</summary>
159+
160+
| Metric Name | Description | Type |
161+
|:--------------------------------:|:----------------------------------------------------:|:---------:|
162+
| `nagios_build_info` | Nagios exporter build information | gauge |
163+
| `nagios_host_checks_execution` | Host check execution | histogram |
164+
| `nagios_host_checks_latency` | Host check latency | histogram |
165+
| `nagios_host_checks_minutes` | Host checks over time | histogram |
166+
| `nagios_host_checks_performance_seconds` | Host checks performance | gauge |
167+
| `nagios_hosts_acknowledges_total` | Amount of host problems acknowledged | gauge |
168+
| `nagios_hosts_checked_total` | Amount of hosts checked | gauge |
169+
| `nagios_hosts_downtime_total` | Amount of hosts in downtime | gauge |
170+
| `nagios_hosts_status_total` | Amount of hosts in different states | gauge |
171+
| `nagios_hosts_total` | Amount of hosts present in configuration | gauge |
172+
| `nagios_service_checks_execution` | Service check execution | histogram |
173+
| `nagios_service_checks_latency` | Service check latency | histogram |
174+
| `nagios_service_checks_minutes` | Service checks over time | histogram |
175+
| `nagios_service_checks_performance_seconds` | Service checks performance | gauge |
176+
| `nagios_services_acknowledges_total` | Amount of service problems acknowledged | gauge |
177+
| `nagios_services_checked_total` | Amount of services checked | gauge |
178+
| `nagios_services_downtime_total` | Amount of services in downtime | gauge |
179+
| `nagios_services_status_total` | Amount of services in different states | gauge |
180+
| `nagios_services_total` | Amount of services present in configuration | gauge |
181+
| `nagios_up` | Whether Nagios can be reached | gauge |
182+
| `nagios_update_available_info` | NagiosXI update is available (optional metric!) | gauge |
183+
| `nagios_users_privileges_total` | Amount of admin or regular users | gauge |
184+
| `nagios_users_status_total` | Amount of disabled or enabled users | gauge |
185+
| `nagios_users_total` | Amount of users present on the system | gauge |
186+
| `nagios_version_info` | Nagios version information | gauge |
187+
188+
`nagios_update_available_info` is optional because the user may not want their Nagios server scraping the external version webpage every `scrape_interval`.
189+
190+
</details>
191+
153192
## Grafana
154193

155194
Import the [dashboard](grafana/dashboard.json) template ([instructions](https://grafana.com/docs/grafana/v9.0/dashboards/export-import/#import-dashboard)).

0 commit comments

Comments
 (0)