@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
md 123 lines 3.29 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/proc.plugin/integrations/inter_process_communication.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/proc.plugin/metadata.yaml"
4 sidebar_label: "Inter Process Communication"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Collectors/Operating Systems"
7 keywords: ['ipc', 'semaphores', 'shared memory']
8 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9 endmeta-->
10
11 # Inter Process Communication
12
13
14 <img src="https://netdata.cloud/img/network-wired.svg" width="150"/>
15
16
17 Plugin: proc.plugin
18 Module: ipc
19
20 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
22 ## Overview
23
24 IPC stands for Inter-Process Communication. It is a mechanism which allows processes to communicate with each
25 other and synchronize their actions.
26
27 This collector exposes information about:
28
29 - Message Queues: This allows messages to be exchanged between processes. It's a more flexible method that
30 allows messages to be placed onto a queue and read at a later time.
31
32 - Shared Memory: This method allows for the fastest form of IPC because processes can exchange data by
33 reading/writing into shared memory segments.
34
35 - Semaphores: They are used to synchronize the operations performed by independent processes. So, if multiple
36 processes are trying to access a single shared resource, semaphores can ensure that only one process
37 accesses the resource at a given time.
38
39
40
41
42 This collector is supported on all platforms.
43
44 This collector only supports collecting metrics from a single instance of this integration.
45
46
47 ### Default Behavior
48
49 #### Auto-Detection
50
51 This integration doesn't support auto-detection.
52
53 #### Limits
54
55 The default configuration for this integration does not impose any limits on data collection.
56
57 #### Performance Impact
58
59 The default configuration for this integration is not expected to impose a significant performance impact on the system.
60
61 ## Setup
62
63
64 ### Prerequisites
65
66 No action required.
67
68 ### Configuration
69
70 #### Options
71
72
73
74 There are no configuration options.
75
76
77
78 #### via File
79
80 There is no configuration file.
81
82 ##### Examples
83 There are no configuration examples.
84
85
86
87 ## Alerts
88
89
90 The following alerts are available:
91
92 | Alert name | On metric | Description |
93 |:------------|:----------|:------------|
94 | [ semaphores_used ](https://github.com/netdata/netdata/blob/master/src/health/health.d/ipc.conf) | system.ipc_semaphores | IPC semaphore utilization |
95 | [ semaphore_arrays_used ](https://github.com/netdata/netdata/blob/master/src/health/health.d/ipc.conf) | system.ipc_semaphore_arrays | IPC semaphore arrays utilization |
96
97
98 ## Metrics
99
100 Metrics grouped by *scope*.
101
102 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
103
104
105
106 ### Per Inter Process Communication instance
107
108
109
110 This scope has no labels.
111
112 Metrics:
113
114 | Metric | Dimensions | Unit |
115 |:------|:----------|:----|
116 | system.ipc_semaphores | semaphores | semaphores |
117 | system.ipc_semaphore_arrays | arrays | arrays |
118 | system.message_queue_message | a dimension per queue | messages |
119 | system.message_queue_bytes | a dimension per queue | bytes |
120 | system.shared_memory_segments | segments | segments |
121 | system.shared_memory_bytes | bytes | bytes |
122
123