@cryptotaxi247 / netdata-1
Code Commits Issues Pulls Sessions CI/CD
master
master
yaml 229 lines 7.66 KB
Raw
1 plugin_name: go.d.plugin
2 modules:
3 - meta:
4 id: collector-go.d.plugin-puppet
5 plugin_name: go.d.plugin
6 module_name: puppet
7 monitored_instance:
8 name: Puppet
9 link: "https://www.puppet.com/"
10 categories:
11 - data-collection.cloud-and-devops
12 icon_filename: "puppet.svg"
13 related_resources:
14 integrations:
15 list: []
16 info_provided_to_referring_integrations:
17 description: ""
18 keywords:
19 - puppet
20 overview:
21 data_collection:
22 metrics_description: |
23 This collector monitors Puppet metrics, including JVM heap and non-heap memory, CPU usage, and file descriptors.
24 method_description: |
25 It uses Puppet's metrics API endpoint [/status/v1/services](https://www.puppet.com/docs/puppetserver/5.3/status-api/v1/services.html) to gather the metrics.
26 supported_platforms:
27 include: []
28 exclude: []
29 multi_instance: true
30 additional_permissions:
31 description: ""
32 default_behavior:
33 auto_detection:
34 description: |
35 By default, it detects Puppet instances running on localhost that are listening on port 8140.
36 On startup, it tries to collect metrics from:
37
38 - https://127.0.0.1:8140
39 limits:
40 description: ""
41 performance_impact:
42 description: ""
43 setup:
44 prerequisites:
45 list: []
46 configuration:
47 file:
48 name: "go.d/puppet.conf"
49 options:
50 description: |
51 The following options can be defined globally: update_every, autodetection_retry.
52 folding:
53 title: ""
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: url
68 description: Target endpoint URL.
69 default_value: https://127.0.0.1:8140
70 required: true
71 group: Target
72 - name: timeout
73 description: HTTP request timeout (seconds).
74 default_value: 1
75 required: false
76 group: Target
77
78 - name: username
79 description: Username for Basic HTTP authentication.
80 default_value: ""
81 required: false
82 group: HTTP Auth
83 - name: password
84 description: Password for Basic HTTP authentication.
85 default_value: ""
86 required: false
87 group: HTTP Auth
88 - name: bearer_token_file
89 description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
90 default_value: ""
91 required: false
92 group: HTTP Auth
93
94 - name: tls_skip_verify
95 description: Skip TLS certificate and hostname verification (insecure).
96 default_value: no
97 required: false
98 group: TLS
99 - name: tls_ca
100 description: Path to CA bundle used to validate the server certificate.
101 default_value: ""
102 required: false
103 group: TLS
104 - name: tls_cert
105 description: Path to client TLS certificate (for mTLS).
106 default_value: ""
107 required: false
108 group: TLS
109 - name: tls_key
110 description: Path to client TLS private key (for mTLS).
111 default_value: ""
112 required: false
113 group: TLS
114
115 - name: proxy_url
116 description: HTTP proxy URL.
117 default_value: ""
118 required: false
119 group: Proxy
120 - name: proxy_username
121 description: Username for proxy Basic HTTP authentication.
122 default_value: ""
123 required: false
124 group: Proxy
125 - name: proxy_password
126 description: Password for proxy Basic HTTP authentication.
127 default_value: ""
128 required: false
129 group: Proxy
130
131 - name: method
132 description: HTTP method to use.
133 default_value: "GET"
134 required: false
135 group: Request
136 - name: body
137 description: Request body (e.g., for POST/PUT).
138 default_value: ""
139 required: false
140 group: Request
141 - name: headers
142 description: "Additional HTTP headers (one per line as key: value)."
143 default_value: ""
144 required: false
145 group: Request
146 - name: not_follow_redirects
147 description: Do not follow HTTP redirects.
148 default_value: no
149 required: false
150 group: Request
151 - name: force_http2
152 description: Force HTTP/2 (including h2c over TCP).
153 default_value: no
154 required: false
155 group: Request
156
157 - name: vnode
158 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).
159 default_value: ""
160 required: false
161 group: Virtual Node
162 examples:
163 folding:
164 enabled: true
165 title: "Config"
166 list:
167 - name: Basic with self-signed certificate
168 description: Puppet with self-signed TLS certificate.
169 config: |
170 jobs:
171 - name: local
172 url: https://127.0.0.1:8140
173 tls_skip_verify: yes
174 - name: Multi-instance
175 description: |
176 > **Note**: When you define multiple jobs, their names must be unique.
177
178 Collecting metrics from local and remote instances.
179 config: |
180 jobs:
181 - name: local
182 url: https://127.0.0.1:8140
183 tls_skip_verify: yes
184
185 - name: remote
186 url: https://192.0.2.1:8140
187 tls_skip_verify: yes
188 troubleshooting:
189 problems:
190 list: []
191 alerts: []
192 metrics:
193 folding:
194 title: Metrics
195 enabled: false
196 description: ""
197 availability: []
198 scopes:
199 - name: global
200 description: "These metrics refer to the entire monitored application."
201 labels: []
202 metrics:
203 - name: puppet.jvm_heap
204 description: JVM Heap
205 unit: "MiB"
206 chart_type: area
207 dimensions:
208 - name: committed
209 - name: used
210 - name: puppet.jvm_nonheap
211 description: JVM Non-Heap
212 unit: "MiB"
213 chart_type: area
214 dimensions:
215 - name: committed
216 - name: used
217 - name: puppet.cpu
218 description: CPU usage
219 unit: "percentage"
220 chart_type: stacked
221 dimensions:
222 - name: execution
223 - name: GC
224 - name: puppet.fdopen
225 description: File Descriptors
226 unit: "descriptors"
227 chart_type: line
228 dimensions:
229 - name: used