Terminal Services sessions

Plugin: windows.plugin Module: PerflibTerminalServices

Overview

Monitor aggregate active and inactive Terminal Services sessions on Windows hosts.

It queries the Terminal Services object from Perflib. These are aggregate Remote Desktop Services session states, not a per-user inventory or a count of TCP connections.

This collector is only supported on the following platforms:

• windows

This collector only supports collecting metrics from a single instance of this integration.

Default Behavior

Auto-Detection

The collector automatically detects the Terminal Services performance object. It does not collect metrics when the object is unavailable on the host.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

Prerequisites

No action required.

Configuration

Options

Option	Description	Default	Required
update every	Data collection frequency.	1	no

via File

The configuration file name for this integration is netdata.conf. Configuration for this specific integration is located in the [plugin:windows:PerflibTerminalServices] section within that file.

The file format is a modified INI syntax. The general structure is:

[section1]
    option1 = some value
    option2 = some other value

[section2]
    option3 = some third value

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config netdata.conf

Examples

There are no configuration examples.

Alerts

There are no alerts configured by default for this integration.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per System

These metrics refer to aggregate Terminal Services session states on the host.

This scope has no labels.

Metrics:

Metric	Description	Dimensions	Unit
terminal_services.sessions	Aggregate Terminal Services sessions. Active sessions have a connected user; inactive sessions are not actively connected.	active, inactive	sessions