| 1 | <!--startmeta |
| 2 | custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/apps.plugin/integrations/windows_services.md" |
| 3 | meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/apps.plugin/metadata.yaml" |
| 4 | sidebar_label: "Windows Services" |
| 5 | learn_status: "Published" |
| 6 | learn_rel_path: "Collecting Metrics/Collectors/Operating Systems" |
| 7 | keywords: ['windows', 'services', 'processes', 'os', 'host monitoring'] |
| 8 | message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" |
| 9 | endmeta--> |
| 10 | |
| 11 | # Windows Services |
| 12 | |
| 13 | |
| 14 | <img src="https://netdata.cloud/img/windows.svg" width="150"/> |
| 15 | |
| 16 | |
| 17 | Plugin: apps.plugin |
| 18 | Module: services |
| 19 | |
| 20 | <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> |
| 21 | |
| 22 | ## Overview |
| 23 | |
| 24 | This integration monitors resource utilization grouped by Windows Service. |
| 25 | |
| 26 | It auto-discovers running Windows services via the Service Control Manager and groups each service's process tree to aggregate CPU, memory, I/O, and other metrics per service. Processes not belonging to any service are grouped under 'not-services'. |
| 27 | |
| 28 | This collector is only supported on the following platforms: |
| 29 | |
| 30 | - windows |
| 31 | |
| 32 | This collector supports collecting metrics from multiple instances of this integration, including remote instances. |
| 33 | |
| 34 | |
| 35 | ### Default Behavior |
| 36 | |
| 37 | #### Auto-Detection |
| 38 | |
| 39 | All running Windows services are automatically discovered. No configuration is needed. |
| 40 | |
| 41 | #### Limits |
| 42 | |
| 43 | The default configuration for this integration does not impose any limits on data collection. |
| 44 | |
| 45 | #### Performance Impact |
| 46 | |
| 47 | No additional SCM query overhead. The service list is already queried by apps.plugin for process naming. Per-iteration work involves walking parent chains to assign service names. |
| 48 | |
| 49 | ## Setup |
| 50 | |
| 51 | |
| 52 | ### Prerequisites |
| 53 | |
| 54 | No action required. |
| 55 | |
| 56 | ### Configuration |
| 57 | |
| 58 | #### Options |
| 59 | |
| 60 | Service charts are enabled by default. Use the `without-services` (or `no-services`) command line option to disable them. |
| 61 | |
| 62 | |
| 63 | |
| 64 | #### via File |
| 65 | |
| 66 | There is no configuration file. |
| 67 | |
| 68 | ##### Examples |
| 69 | There are no configuration examples. |
| 70 | |
| 71 | |
| 72 | |
| 73 | ## Alerts |
| 74 | |
| 75 | There are no alerts configured by default for this integration. |
| 76 | |
| 77 | |
| 78 | ## Metrics |
| 79 | |
| 80 | Metrics grouped by *scope*. |
| 81 | |
| 82 | The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. |
| 83 | |
| 84 | |
| 85 | |
| 86 | ### Per windows service |
| 87 | |
| 88 | These metrics refer to the Windows Service. |
| 89 | |
| 90 | Labels: |
| 91 | |
| 92 | | Label | Description | |
| 93 | |:-----------|:----------------| |
| 94 | | service | The display name of the Windows service. | |
| 95 | |
| 96 | Metrics: |
| 97 | |
| 98 | | Metric | Dimensions | Unit | windows | |
| 99 | |:------|:----------|:----|:---:| |
| 100 | | service.cpu_utilization | user, system | percentage | • | |
| 101 | | service.mem_usage | rss | MiB | • | |
| 102 | | service.vmem_usage | vmem | MiB | • | |
| 103 | | service.mem_page_faults | minor | pgfaults/s | • | |
| 104 | | service.swap_usage | swap | MiB | • | |
| 105 | | service.disk_logical_io | reads, writes | KiB/s | • | |
| 106 | | service.fds_open | handles | fds | • | |
| 107 | | service.processes | processes | processes | • | |
| 108 | | service.threads | threads | threads | • | |
| 109 | | service.uptime | uptime | seconds | • | |
| 110 | | service.uptime_summary | min, avg, max | seconds | • | |
| 111 | |
| 112 |