Skip to content

Commit

Permalink
NMS-11021: Document DskTableMonitor (#6215)
Browse files Browse the repository at this point in the history
  • Loading branch information
mfuhrmann authored Jun 22, 2023
1 parent 52c9598 commit ed268f2
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/modules/reference/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
** xref:service-assurance/monitors/DhcpMonitor.adoc[]
** xref:service-assurance/monitors/DiskUsageMonitor.adoc[]
** xref:service-assurance/monitors/DnsMonitor.adoc[]
** xref:service-assurance/monitors/DskTableMonitor.adoc[]
** xref:service-assurance/monitors/DNSResolutionMonitor.adoc[]
** xref:service-assurance/monitors/FtpMonitor.adoc[]
** xref:service-assurance/monitors/HostResourceSwRunMonitor.adoc[]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@

= DskTableMonitor

The DskTableMonitor tests the `dskErrorFlag` signaling that the disk or partition is under the minimum required space configured for it.
The monitor expects the value `1` to fail and provides the content of `dskErrorMsg` as event reason.

== Monitor facts

[cols="1,7"]
|===
| Class Name
| `org.opennms.netmgt.poller.monitors.DskTableMonitor`
|===

== Configuration and use

This monitor implements the <<reference:service-assurance/introduction.adoc#ref-service-assurance-monitors-common-parameters, Common Configuration Parameters>>.

== Examples

Note that you must include the `monitor` section for each service in your definition.

[source, xml]
----
<service name="DskTableMonitor" interval="300000" user-defined="false" status="on">
<parameter key="timeout" value="3000" />
<parameter key="retry" value="2" />
</service>
<monitor service="DskTableMonitor" class-name="org.opennms.netmgt.poller.monitors.DskTableMonitor" />
----

0 comments on commit ed268f2

Please sign in to comment.