@cryptotaxi247 / netdata-1
Code Commits Issues Pulls Sessions CI/CD
master
master
yaml 233 lines 7.79 KB
Raw
1 plugin_name: go.d.plugin
2 modules:
3 - meta:
4 id: collector-go.d.plugin-fluentd
5 plugin_name: go.d.plugin
6 module_name: fluentd
7 monitored_instance:
8 name: Fluentd
9 link: https://www.fluentd.org/
10 icon_filename: fluentd.svg
11 categories:
12 - data-collection.applications
13 keywords:
14 - fluentd
15 - logging
16 related_resources:
17 integrations:
18 list: []
19 info_provided_to_referring_integrations:
20 description: ""
21 overview:
22 data_collection:
23 metrics_description: |
24 This collector monitors Fluentd servers.
25 method_description: ""
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 limits:
36 description: ""
37 performance_impact:
38 description: ""
39 setup:
40 prerequisites:
41 list:
42 - title: Enable monitor agent
43 description: |
44 To enable monitor agent, follow the [official documentation](https://docs.fluentd.org/v1.0/articles/monitoring-rest-api).
45 configuration:
46 file:
47 name: go.d/fluentd.conf
48 options:
49 description: |
50 The following options can be defined globally: update_every, autodetection_retry.
51 folding:
52 title: Config options
53 enabled: true
54 list:
55 - name: update_every
56 description: Data collection interval (seconds).
57 default_value: 1
58 required: false
59 group: Collection
60 - name: autodetection_retry
61 description: Autodetection retry interval (seconds). Set 0 to disable.
62 default_value: 0
63 required: false
64 group: Collection
65
66 - name: url
67 description: Target endpoint URL.
68 default_value: http://127.0.0.1:24220
69 required: true
70 group: Target
71 - name: timeout
72 description: HTTP request timeout (seconds).
73 default_value: 1
74 required: false
75 group: Target
76
77 - name: username
78 description: Username for Basic HTTP authentication.
79 default_value: ""
80 required: false
81 group: HTTP Auth
82 - name: password
83 description: Password for Basic HTTP authentication.
84 default_value: ""
85 required: false
86 group: HTTP Auth
87 - name: bearer_token_file
88 description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
89 default_value: ""
90 required: false
91 group: HTTP Auth
92
93 - name: tls_skip_verify
94 description: Skip TLS certificate and hostname verification (insecure).
95 default_value: no
96 required: false
97 group: TLS
98 - name: tls_ca
99 description: Path to CA bundle used to validate the server certificate.
100 default_value: ""
101 required: false
102 group: TLS
103 - name: tls_cert
104 description: Path to client TLS certificate (for mTLS).
105 default_value: ""
106 required: false
107 group: TLS
108 - name: tls_key
109 description: Path to client TLS private key (for mTLS).
110 default_value: ""
111 required: false
112 group: TLS
113
114 - name: proxy_url
115 description: HTTP proxy URL.
116 default_value: ""
117 required: false
118 group: Proxy
119 - name: proxy_username
120 description: Username for proxy Basic HTTP authentication.
121 default_value: ""
122 required: false
123 group: Proxy
124 - name: proxy_password
125 description: Password for proxy Basic HTTP authentication.
126 default_value: ""
127 required: false
128 group: Proxy
129
130 - name: method
131 description: HTTP method to use.
132 default_value: "GET"
133 required: false
134 group: Request
135 - name: body
136 description: Request body (e.g., for POST/PUT).
137 default_value: ""
138 required: false
139 group: Request
140 - name: headers
141 description: "Additional HTTP headers (one per line as key: value)."
142 default_value: ""
143 required: false
144 group: Request
145 - name: not_follow_redirects
146 description: Do not follow HTTP redirects.
147 default_value: no
148 required: false
149 group: Request
150 - name: force_http2
151 description: Force HTTP/2 (including h2c over TCP).
152 default_value: no
153 required: false
154 group: Request
155
156 - name: vnode
157 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).
158 default_value: ""
159 required: false
160 group: Virtual Node
161 examples:
162 folding:
163 title: Config
164 enabled: true
165 list:
166 - name: Basic
167 folding:
168 enabled: false
169 description: A basic example configuration.
170 config: |
171 jobs:
172 - name: local
173 url: http://127.0.0.1:24220
174 - name: HTTP authentication
175 description: Basic HTTP authentication.
176 config: |
177 jobs:
178 - name: local
179 url: http://127.0.0.1:24220
180 username: username
181 password: password
182 - name: HTTPS with self-signed certificate
183 description: Fluentd with enabled HTTPS and self-signed certificate.
184 config: |
185 jobs:
186 - name: local
187 url: https://127.0.0.1:24220
188 tls_skip_verify: yes
189 - name: Multi-instance
190 description: |
191 > **Note**: When you define multiple jobs, their names must be unique.
192
193 Collecting metrics from local and remote instances.
194 config: |
195 jobs:
196 - name: local
197 url: http://127.0.0.1:24220
198
199 - name: remote
200 url: http://192.0.2.1:24220
201 troubleshooting:
202 problems:
203 list: []
204 alerts: []
205 metrics:
206 folding:
207 title: Metrics
208 enabled: false
209 description: ""
210 availability: []
211 scopes:
212 - name: global
213 description: These metrics refer to the entire monitored application.
214 labels: []
215 metrics:
216 - name: fluentd.retry_count
217 description: Plugin Retry Count
218 unit: count
219 chart_type: line
220 dimensions:
221 - name: a dimension per plugin
222 - name: fluentd.buffer_queue_length
223 description: Plugin Buffer Queue Length
224 unit: queue_length
225 chart_type: line
226 dimensions:
227 - name: a dimension per plugin
228 - name: fluentd.buffer_total_queued_size
229 description: Plugin Buffer Total Size
230 unit: queued_size
231 chart_type: line
232 dimensions:
233 - name: a dimension per plugin