MetricsHub
Documentation 0.9.02

 Back to the list of connectors[1]

WindowsOS

Description

Gives OS specific information and metrics

Target

Typical platform: N/A

Operating system: Microsoft Windows

Prerequisites

Leverages: WMI

Technology and protocols: WMI/WinRM

Examples

CLI

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

metricshub.yaml

resourceGroups:
  <RESOURCE_GROUP>:
    resources:
      <HOSTNAME-ID>:
        attributes:
          host.name: <HOSTNAME> # Change with actual host name
          host.type: win
        selectConnectors: [ 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 WindowsOS 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.filesystem.device
  • system.filesystem.type
  • system.filesystem.volumeName
memory
  • hw.status{hw.type="memory", state="present"}
  • system.memory.usage{system.memory.usage="cached"}
  • system.memory.usage{system.memory.usage="free"}
  • system.memory.usage{system.memory.usage="used"}
  • system.memory.utilization{system.memory.usage="cached"}
  • system.memory.utilization{system.memory.usage="free"}
  • system.memory.utilization{system.memory.usage="used"}
  • id
  • system.memory.limit
network
  • hw.status{hw.type="network", state="present"}
  • 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
paging
  • system.paging.faults{system.paging.type="hard"}
  • system.paging.faults{system.paging.type="soft"}
  • system.paging.operations{system.paging.direction="in"}
  • system.paging.operations{system.paging.direction="out"}
  • 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
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
service
  • system.service.status{state="Continue Pending|Pause Pending|Paused|Running|Start Pending|Stop Pending|Stopped|Unknown"}
  • description
  • id
monitoring observability opentelemetry otel
Links:
  • [1] ../metricshub-connector-reference.html
No results.