1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
plugin_name: python.d.plugin
modules:
- meta:
plugin_name: python.d.plugin
module_name: puppet
monitored_instance:
name: Puppet
link: "https://www.puppet.com/"
categories:
- data-collection.ci-cd-systems
icon_filename: "puppet.svg"
related_resources:
integrations:
list: []
info_provided_to_referring_integrations:
description: ""
keywords:
- puppet
- jvm heap
most_popular: false
overview:
data_collection:
metrics_description: |
This collector monitors Puppet metrics about JVM Heap, Non-Heap, CPU usage and file descriptors.'
method_description: |
It uses Puppet's metrics API endpoint to gather the metrics.
supported_platforms:
include: []
exclude: []
multi_instance: true
additional_permissions:
description: ""
default_behavior:
auto_detection:
description: By default, this collector will use `https://fqdn.example.com:8140` as the URL to look for metrics.
limits:
description: ""
performance_impact:
description: ""
setup:
prerequisites:
list: []
configuration:
file:
name: "python.d/puppet.conf"
options:
description: |
This particular collector does not need further configuration to work if permissions are satisfied, but you can always customize it's data collection behavior.
There are 2 sections:
* Global variables
* One or more JOBS that can define multiple different instances to monitor.
The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
> Notes:
> - Exact Fully Qualified Domain Name of the node should be used.
> - Usually Puppet Server/DB startup time is VERY long. So, there should be quite reasonable retry count.
> - A secured PuppetDB config may require a client certificate. This does not apply to the default PuppetDB configuration though.
folding:
title: "Config options"
enabled: true
list:
- name: url
description: HTTP or HTTPS URL, exact Fully Qualified Domain Name of the node should be used.
default_value: https://fqdn.example.com:8081
required: true
- name: tls_verify
description: Control HTTPS server certificate verification.
default_value: "False"
required: false
- name: tls_ca_file
description: Optional CA (bundle) file to use
default_value: ""
required: false
- name: tls_cert_file
description: Optional client certificate file
default_value: ""
required: false
- name: tls_key_file
description: Optional client key file
default_value: ""
required: false
- name: update_every
description: Sets the default data collection frequency.
default_value: 30
required: false
- name: priority
description: Controls the order of charts at the netdata dashboard.
default_value: 60000
required: false
- name: autodetection_retry
description: Sets the job re-check interval in seconds.
default_value: 0
required: false
- name: penalty
description: Indicates whether to apply penalty to update_every in case of failures.
default_value: yes
required: false
- name: name
description: >
Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
default_value: ""
required: false
examples:
folding:
enabled: true
title: "Config"
list:
- name: Basic
description: A basic example configuration
folding:
enabled: false
config: |
puppetserver:
url: 'https://fqdn.example.com:8140'
autodetection_retry: 1
- name: TLS Certificate
description: An example using a TLS certificate
config: |
puppetdb:
url: 'https://fqdn.example.com:8081'
tls_cert_file: /path/to/client.crt
tls_key_file: /path/to/client.key
autodetection_retry: 1
- name: Multi-instance
description: |
> **Note**: When you define multiple jobs, their names must be unique.
Collecting metrics from local and remote instances.
config: |
puppetserver1:
url: 'https://fqdn.example.com:8140'
autodetection_retry: 1
puppetserver2:
url: 'https://fqdn.example2.com:8140'
autodetection_retry: 1
troubleshooting:
problems:
list: []
alerts: []
metrics:
folding:
title: Metrics
enabled: false
description: ""
availability: []
scopes:
- name: global
description: "These metrics refer to the entire monitored application."
labels: []
metrics:
- name: puppet.jvm
description: JVM Heap
unit: "MiB"
chart_type: area
dimensions:
- name: committed
- name: used
- name: puppet.jvm
description: JVM Non-Heap
unit: "MiB"
chart_type: area
dimensions:
- name: committed
- name: used
- name: puppet.cpu
description: CPU usage
unit: "percentage"
chart_type: stacked
dimensions:
- name: execution
- name: GC
- name: puppet.fdopen
description: File Descriptors
unit: "descriptors"
chart_type: line
dimensions:
- name: used
|
