diff --git a/README.md b/README.md index 7f8fe30..deebea0 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,31 @@

domino_exporter

A cross-platform utility for exporting HCL Domino statistics to Prometheus. Works on Windows and Linux.
-Tested on:
-1 - Windows Server 2019-2025
-2 - Linux RHEL (requires glibc 2.34)
-3 - Linux DEB (requires glibc 2.34) +Tested on OS:
+   1 - Windows Server 2019-2025
+   2 - Linux RHEL (requires glibc 2.34)
+   3 - Linux DEB (requires glibc 2.34)
+Tested on HCL Domino:
+   1 - HCL Domino 12.0.2
+   2 - HCL Domino 14.0
+   3 - HCL Domino 14.5
+   4 - HCL Domino 14.5.1
## Installation To install, place the executable file in the domino directory (where the nnotes.dll or nnotes.so library is located) and run it. +## What is reflected in the metrics +Statistics are formatted to contain only alphanumeric characters. Other characters are replaced with the _ symbol.
+Example:
+Server.MailBoxes = Server_MailBoxes
+Monitor.Last.EVENT MONITOR.Warning(High) = Monitor_Last_EVENT MONITOR_Warning_High_
+
+Only statistics with a numerical value are included in the metrics; date or text are not included (this is a Prometheus feature).
+Example:
+NO - Server.Task = Cluster Replicator: Idle: [08/01/2026 02:08:41 ZE1]
+NO - Server.ElapsedTime = 00:34:03
+YES - Server.ElapsedTimeDays = 0.023645833333333
+YES - Server.MailBoxes = 1
+ ## Notes.ini By default, domino_exporter runs on port 9100 and updates information every 30 seconds. There are two parameters to change these values:
1 - DOMINO_EXPORTER_PORT - to change the port.