Regenerate integrations docs (#19177)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Dec 10, 2024 at 03:49 UTC
882e3b70dec034d393846b962783468afc23cef5
4 files changed
+129
-2
src/collectors/COLLECTORS.md
+2
@@ -1169,6 +1169,8 @@ If you don't see the app/service you'd like to monitor in this list:
1169
1170
- [Processor](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/processor.md)
1171
1172
+- [Semaphore statistics](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/semaphore_statistics.md)
1173
+
1174
- [System statistics](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/system_statistics.md)
1175
1176
- [System thermal zone](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/system_thermal_zone.md)
src/collectors/windows.plugin/integrations/memory_statistics.md
+1
-1
@@ -60,7 +60,7 @@ The scope defines the instance that the metric belongs to. An instance is unique
60
61
### Per Memory statistics instance
62
63
-These metrics refer to the entire monitored instance
63
+These metrics refer to the entire system.
64
65
This scope has no labels.
66
src/collectors/windows.plugin/integrations/semaphore_statistics.md
new
+125
@@ -0,0 +1,125 @@
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/Windows Systems"
7
+most_popular: False
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
+
57
+## Metrics
58
+
59
+Metrics grouped by *scope*.
60
+
61
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
62
+
63
+
64
+
65
+### Per Semaphore statistics instance
66
+
67
+These metrics refer to the entire system.
68
+
69
+This scope has no labels.
70
+
71
+Metrics:
72
+
73
+| Metric | Dimensions | Unit |
74
+|:------|:----------|:----|
75
+| system.ipc_semaphores | semaphores | semaphores |
76
+
77
+
78
+
79
+## Alerts
80
+
81
+There are no alerts configured by default for this integration.
82
+
83
+
84
+## Setup
85
+
86
+### Prerequisites
87
+
88
+No action required.
89
+
90
+### Configuration
91
+
92
+#### File
93
+
94
+The configuration file name for this integration is `netdata.conf`.
95
+Configuration for this specific integration is located in the `[plugin:windows]` section within that file.
96
+
97
+The file format is a modified INI syntax. The general structure is:
98
+
99
+```ini
100
+[section1]
101
+ option1 = some value
102
+ option2 = some other value
103
+
104
+[section2]
105
+ option3 = some third value
106
+```
107
+You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the
108
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
109
+
110
+```bash
111
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
112
+sudo ./edit-config netdata.conf
113
+```
114
+#### Options
115
+
116
+
117
+
118
+| Name | Description | Default | Required |
119
+|:----|:-----------|:-------|:--------:|
120
+| PerflibObjects | An option to enable or disable the data collection. | yes | no |
121
+
122
+#### Examples
123
+There are no configuration examples.
124
+
125
+
src/collectors/windows.plugin/integrations/system_statistics.md
+1
-1
@@ -60,7 +60,7 @@ The scope defines the instance that the metric belongs to. An instance is unique
60
61
### Per System statistics instance
62
63
-These metrics refer to the entire monitored instance.
63
+These metrics refer to the entire system.
64
65
This scope has no labels.
66