From c70e7674a559e5db3e44cb4338578d4ccc87c0e4 Mon Sep 17 00:00:00 2001 From: Ben Reedy Date: Tue, 20 Aug 2019 22:26:43 +1000 Subject: [PATCH] Add logon collector documentation --- README.md | 1 + docs/collector.logon.md | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+) create mode 100644 docs/collector.logon.md diff --git a/README.md b/README.md index 863b527e..6ff36fa6 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ Name | Description | Enabled by default [hyperv](docs/collector.hyperv.md) | Hyper-V hosts | [iis](docs/collector.iis.md) | IIS sites and applications | [logical_disk](docs/collector.logical_disk.md) | Logical disks, disk I/O | ✓ +[logon](docs/collector.logon.md) | User logon sessions | [memory](docs/collector.memory.md) | Memory usage metrics | [msmq](docs/collector.msmq.md) | MSMQ queues | [mssql](docs/collector.mssql.md) | [SQL Server Performance Objects](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/use-sql-server-objects#SQLServerPOs) metrics | diff --git a/docs/collector.logon.md b/docs/collector.logon.md new file mode 100644 index 00000000..ca6f9d98 --- /dev/null +++ b/docs/collector.logon.md @@ -0,0 +1,34 @@ +# logon collector + +The logon collector exposes metrics detailing the active user logon sessions. + +||| +-|- +Metric name prefix | `logon` +Classes | [`Win32_LogonSession`](https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-logonsession) +Enabled by default? | No + +## Flags + +None + +## Metrics + +Name | Description | Type | Labels +-----|-------------|------|------- +`wmi_logon_logon_type` | Number of active user logon sessions | gauge | status + +### Example metric +Query the total number of interactive logon sessions +``` +wmi_logon_logon_type{status="interactive"} +``` + +## Useful queries +Query the total number of local and remote (I.E. Terminal Services) interactive sessions. +``` +wmi_logon_logon_type{status=~"interactive|remoteinteractive"} +``` + +## Alerting examples +_This collector does not yet have alerting examples, we would appreciate your help adding them!_