@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
yaml 162 lines 5.19 KB
Raw
1 plugin_name: go.d.plugin
2 modules:
3 - meta:
4 id: collector-go.d.plugin-gearman
5 plugin_name: go.d.plugin
6 module_name: gearman
7 monitored_instance:
8 name: Gearman
9 link: https://gearman.org/
10 categories:
11 - data-collection.applications
12 icon_filename: "gearman.png"
13 related_resources:
14 integrations:
15 list: []
16 info_provided_to_referring_integrations:
17 description: ""
18 keywords:
19 - gearman
20 overview:
21 data_collection:
22 metrics_description: |
23 Monitors jobs activity, priority and available workers. It collects summary and function-specific statistics.
24 method_description: |
25 This collector connects to a Gearman instance via TCP socket and executes the following commands:
26
27 - status
28 - priority-status
29 supported_platforms:
30 include: []
31 exclude: []
32 multi_instance: true
33 additional_permissions:
34 description: ""
35 default_behavior:
36 auto_detection:
37 description: |
38 By default, it detects Gearman instances running on localhost that are listening on port 4730.
39 limits:
40 description: ""
41 performance_impact:
42 description: ""
43 setup:
44 prerequisites:
45 list: []
46 configuration:
47 file:
48 name: go.d/gearman.conf
49 options:
50 description: |
51 The following options can be defined globally: update_every, autodetection_retry.
52 folding:
53 title: Config options
54 enabled: true
55 list:
56 - name: update_every
57 description: Data collection interval (seconds).
58 default_value: 1
59 required: false
60 group: Collection
61 - name: autodetection_retry
62 description: Autodetection retry interval (seconds). Set 0 to disable.
63 default_value: 0
64 required: false
65 group: Collection
66
67 - name: address
68 description: Gearman server address (`IP:PORT`).
69 default_value: 127.0.0.1:11211
70 required: true
71 group: Target
72 - name: timeout
73 description: Connection, read, write, and name resolution timeout (seconds).
74 default_value: 1
75 required: false
76 group: Target
77
78 - name: vnode
79 description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes).
80 default_value: ""
81 required: false
82 group: Virtual Node
83 examples:
84 folding:
85 title: Config
86 enabled: true
87 list:
88 - name: Basic
89 description: A basic example configuration.
90 config: |
91 jobs:
92 - name: local
93 address: 127.0.0.1:4730
94 - name: Multi-instance
95 description: |
96 > **Note**: When you define multiple jobs, their names must be unique.
97
98 Collecting metrics from local and remote instances.
99 config: |
100 jobs:
101 - name: local
102 address: 127.0.0.1:4730
103
104 - name: remote
105 address: 203.0.113.0:4730
106 troubleshooting:
107 problems:
108 list: []
109 alerts: []
110 metrics:
111 folding:
112 title: Metrics
113 enabled: false
114 description: ""
115 availability: []
116 scopes:
117 - name: global
118 description: "These metrics refer to the entire monitored application."
119 labels: []
120 metrics:
121 - name: gearman.queued_jobs_activity
122 description: Jobs Activity
123 unit: "jobs"
124 chart_type: stacked
125 dimensions:
126 - name: running
127 - name: waiting
128 - name: gearman.queued_jobs_priority
129 description: Jobs Priority
130 unit: "jobs"
131 chart_type: stacked
132 dimensions:
133 - name: high
134 - name: normal
135 - name: low
136 - name: global
137 description: "These metrics refer to the Function (task)."
138 labels:
139 - name: function_name
140 description: Function name.
141 metrics:
142 - name: gearman.function_queued_jobs_activity
143 description: Function Jobs Activity
144 unit: "jobs"
145 chart_type: stacked
146 dimensions:
147 - name: running
148 - name: waiting
149 - name: gearman.function_queued_jobs_priority
150 description: Function Jobs Priority
151 unit: "jobs"
152 chart_type: stacked
153 dimensions:
154 - name: high
155 - name: normal
156 - name: low
157 - name: gearman.function_workers
158 description: Function Workers
159 unit: "workers"
160 chart_type: line
161 dimensions:
162 - name: available