---
date_published: 2026-08-13
date_modified: 2026-08-13
canonical_url: https://metricshub.org/community-connectors/connectors/windows.html
---

 [Supported Platforms](../supported-platforms.html)   [Connectors Directory](../connectors-directory.html)

# Windows System

## Description

Gives OS specific information and metrics

[community](tags/community.html) [system](tags/system.html) [windows](tags/windows.html)

[Source](https://github.com/metricshub/community-connectors/tree/main/src/main/connector/system/Windows/Windows.yaml)

## Target

Typical platform: **[Microsoft Windows](platforms/microsoft-windows.html)**

Operating system: **Microsoft Windows**

## Prerequisites

Leverages: **WMI**

Technology and protocols: **WMI/WinRM**

## Examples

### CLI

```batch
metricshub HOSTNAME -t win -c +Windows --wmi -u USER
```

### metricshub.yaml

```yaml
resourceGroups:
  <RESOURCE_GROUP>:
    resources:
      <HOSTNAME-ID>:
        attributes:
          host.name: <HOSTNAME> # Change with actual host name
          host.type: win
        connectors: [ +Windows ] # Optional, to load only this connector
        protocols:
          wmi:
            username: <USERNAME> # Change with actual credentials
            password: <PASSWORD> # Encrypted using metricshub-encrypt
```

## Connector Activation Criteria

The **Windows System** connector will be automatically activated, and its status will be reported as OK if all the below criteria are met:

- The **WMI query** below to the managed host succeeds: 
  
    - Namespace: `root\CIMv2`
    - WQL Query: `SELECT * FROM Win32_OperatingSystem`

## Metrics

| Type | Collected Metrics | Specific Attributes |
| --- | --- | --- |
| **cpu** | - `hw.status{hw.type="cpu", state="present"}` - `system.cpu.time{system.cpu.state="idle"}` - `system.cpu.time{system.cpu.state="system"}` - `system.cpu.time{system.cpu.state="user"}` - `system.cpu.utilization{system.cpu.state="idle"}` - `system.cpu.utilization{system.cpu.state="system"}` - `system.cpu.utilization{system.cpu.state="user"}` | - `id` - `name` - `system.cpu.logical_number` |
| **file_system** | - `system.filesystem.usage{system.filesystem.state="free"}` - `system.filesystem.usage{system.filesystem.state="used"}` - `system.filesystem.utilization{system.filesystem.state="free"}` - `system.filesystem.utilization{system.filesystem.state="used"}` | - `id` - `system.device` - `system.filesystem.type` - `system.filesystem.volumeName` |
| **memory** | - `hw.status{hw.type="memory", state="present"}` - `system.memory.limit` - `system.memory.usage{system.memory.state="cached"}` - `system.memory.usage{system.memory.state="free"}` - `system.memory.usage{system.memory.state="used"}` - `system.memory.utilization{system.memory.state="cached"}` - `system.memory.utilization{system.memory.state="free"}` - `system.memory.utilization{system.memory.state="used"}` | - `id` |
| **network** | - `hw.status{hw.type="network", state="present"}` - `system.network.bandwidth.limit` - `system.network.dropped{network.io.direction="receive"}` - `system.network.dropped{network.io.direction="transmit"}` - `system.network.errors{network.io.direction="receive"}` - `system.network.errors{network.io.direction="transmit"}` - `system.network.io{network.io.direction="receive"}` - `system.network.io{network.io.direction="transmit"}` - `system.network.packets{network.io.direction="receive"}` - `system.network.packets{network.io.direction="transmit"}` | - `id` - `network.interface.name` |
| **paging** | - `system.paging.usage{system.paging.state="free"}` - `system.paging.usage{system.paging.state="used"}` - `system.paging.utilization{system.paging.state="free"}` - `system.paging.utilization{system.paging.state="used"}` | - `id` - `system.device` |
| **paging_activity** | - `system.paging.faults{system.paging.type="major"}` - `system.paging.faults{system.paging.type="minor"}` - `system.paging.operations{system.paging.direction="in"}` - `system.paging.operations{system.paging.direction="out"}` | - `id` |
| **physical_disk** | - `hw.status{hw.type="physical_disk", state="present"}` - `system.disk.io_time` - `system.disk.io{disk.io.direction="read"}` - `system.disk.io{disk.io.direction="write"}` - `system.disk.operation_time{disk.io.direction="read"}` - `system.disk.operation_time{disk.io.direction="write"}` - `system.disk.operations{disk.io.direction="read"}` - `system.disk.operations{disk.io.direction="write"}` | - `id` - `system.device` |
| **system** | - `system.uptime` | - `id` - `name` - `os_version` - `serial_number` - `version` |