master
md 132 lines 3.31 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/semaphore_statistics.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
4 sidebar_label: "Semaphore statistics"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Collectors/Operating Systems"
7 keywords: ['ipc', 'semaphores']
8 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9 endmeta-->
10
11 # Semaphore statistics
12
13
14 <img src="https://netdata.cloud/img/windows.svg" width="150"/>
15
16
17 Plugin: windows.plugin
18 Module: PerflibObjects
19
20 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
22 ## Overview
23
24 Inter-Process Communication (IPC) enables different processes to communicate and coordinate with each other. This collector monitors IPC semaphores, which are synchronization tools that:
25
26 - Control access to shared resources (like files, memory, or devices).
27 - Ensure only one process can access a resource at a time.
28 - Prevent conflicts between competing processes.
29
30
31 It queries for the 'Objects' object from Perflib in order to gather the metrics.
32
33
34 This collector is only supported on the following platforms:
35
36 - windows
37
38 This collector only supports collecting metrics from a single instance of this integration.
39
40
41 ### Default Behavior
42
43 #### Auto-Detection
44
45 The collector automatically detects all of the metrics, no further configuration is required.
46
47
48 #### Limits
49
50 The default configuration for this integration does not impose any limits on data collection.
51
52 #### Performance Impact
53
54 The default configuration for this integration is not expected to impose a significant performance impact on the system.
55
56 ## Setup
57
58
59 ### Prerequisites
60
61 No action required.
62
63 ### Configuration
64
65 #### Options
66
67
68
69
70
71 | Option | Description | Default | Required |
72 |:-----|:------------|:--------|:---------:|
73 | update every | Data collection frequency. | 1 | no |
74
75
76
77
78 #### via File
79
80 The configuration file name for this integration is `netdata.conf`.
81 Configuration for this specific integration is located in the `[plugin:windows:PerflibObjects]` section within that file.
82
83 The file format is a modified INI syntax. The general structure is:
84
85 ```ini
86 [section1]
87 option1 = some value
88 option2 = some other value
89
90 [section2]
91 option3 = some third value
92 ```
93 You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
94 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
95
96 ```bash
97 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
98 sudo ./edit-config netdata.conf
99 ```
100
101 ##### Examples
102 There are no configuration examples.
103
104
105
106 ## Alerts
107
108 There are no alerts configured by default for this integration.
109
110
111 ## Metrics
112
113 Metrics grouped by *scope*.
114
115 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
116
117
118
119 ### Per System
120
121 These metrics refer to the entire system.
122
123 This scope has no labels.
124
125 Metrics:
126
127 | Metric | Dimensions | Unit |
128 |:------|:----------|:----|
129 | system.ipc_semaphores | semaphores | semaphores |
130 | system.ipc_mutexes | mutexes | mutexes |
131
132