Skip to content

Commit

Permalink
Add logon collector documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
breed808 committed Aug 21, 2019
1 parent d3e3835 commit c70e767
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
34 changes: 34 additions & 0 deletions docs/collector.logon.md
Original file line number Diff line number Diff line change
@@ -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!_

0 comments on commit c70e767

Please sign in to comment.