@cryptotaxi247 / netdata-1
Code Commits Issues Pulls Sessions CI/CD
master
master
yaml 232 lines 7.65 KB
Raw
1 plugin_name: go.d.plugin
2 modules:
3 - meta:
4 id: collector-go.d.plugin-squid
5 plugin_name: go.d.plugin
6 module_name: squid
7 monitored_instance:
8 name: Squid
9 link: "https://www.squid-cache.org/"
10 categories:
11 - data-collection.web-servers-and-proxies
12 icon_filename: "squid.png"
13 related_resources:
14 integrations:
15 list: []
16 info_provided_to_referring_integrations:
17 description: ""
18 keywords:
19 - squid
20 - web delivery
21 - squid caching proxy
22 overview:
23 data_collection:
24 metrics_description: |
25 This collector monitors statistics about the Squid Clients and Servers, like bandwidth and requests.
26 method_description: "It collects metrics from the `squid-internal-mgr/counters` endpoint."
27 supported_platforms:
28 include: []
29 exclude: []
30 multi_instance: true
31 additional_permissions:
32 description: ""
33 default_behavior:
34 auto_detection:
35 description: |
36 By default, it detects Squid instances running on localhost that are listening on port 3128.
37 On startup, it tries to collect metrics from:
38
39 - https://127.0.0.1:3128
40 limits:
41 description: ""
42 performance_impact:
43 description: ""
44 setup:
45 prerequisites:
46 list: []
47 configuration:
48 file:
49 name: "go.d/squid.conf"
50 options:
51 description: |
52 The following options can be defined globally: update_every, autodetection_retry.
53 folding:
54 title: "Config options"
55 enabled: true
56 list:
57 - name: update_every
58 description: Data collection interval (seconds).
59 default_value: 1
60 required: false
61 group: Collection
62 - name: autodetection_retry
63 description: Autodetection retry interval (seconds). Set 0 to disable.
64 default_value: 0
65 required: false
66 group: Collection
67
68 - name: url
69 description: Target endpoint URL.
70 default_value: http://127.0.0.1:3128
71 required: true
72 group: Target
73 - name: timeout
74 description: HTTP request timeout (seconds).
75 default_value: 1
76 required: false
77 group: Target
78
79 - name: username
80 description: Username for Basic HTTP authentication.
81 default_value: ""
82 required: false
83 group: HTTP Auth
84 - name: password
85 description: Password for Basic HTTP authentication.
86 default_value: ""
87 required: false
88 group: HTTP Auth
89 - name: bearer_token_file
90 description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
91 default_value: ""
92 required: false
93 group: HTTP Auth
94
95 - name: tls_skip_verify
96 description: Skip TLS certificate and hostname verification (insecure).
97 default_value: no
98 required: false
99 group: TLS
100 - name: tls_ca
101 description: Path to CA bundle used to validate the server certificate.
102 default_value: ""
103 required: false
104 group: TLS
105 - name: tls_cert
106 description: Path to client TLS certificate (for mTLS).
107 default_value: ""
108 required: false
109 group: TLS
110 - name: tls_key
111 description: Path to client TLS private key (for mTLS).
112 default_value: ""
113 required: false
114 group: TLS
115
116 - name: proxy_url
117 description: HTTP proxy URL.
118 default_value: ""
119 required: false
120 group: Proxy
121 - name: proxy_username
122 description: Username for proxy Basic HTTP authentication.
123 default_value: ""
124 required: false
125 group: Proxy
126 - name: proxy_password
127 description: Password for proxy Basic HTTP authentication.
128 default_value: ""
129 required: false
130 group: Proxy
131
132 - name: method
133 description: HTTP method to use.
134 default_value: "GET"
135 required: false
136 group: Request
137 - name: body
138 description: Request body (e.g., for POST/PUT).
139 default_value: ""
140 required: false
141 group: Request
142 - name: headers
143 description: "Additional HTTP headers (one per line as key: value)."
144 default_value: ""
145 required: false
146 group: Request
147 - name: not_follow_redirects
148 description: Do not follow HTTP redirects.
149 default_value: no
150 required: false
151 group: Request
152 - name: force_http2
153 description: Force HTTP/2 (including h2c over TCP).
154 default_value: no
155 required: false
156 group: Request
157
158 - name: vnode
159 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).
160 default_value: ""
161 required: false
162 group: Virtual Node
163 examples:
164 folding:
165 enabled: true
166 title: Config
167 list:
168 - name: Basic
169 description: A basic example configuration.
170 folding:
171 enabled: false
172 config: |
173 jobs:
174 - name: local
175 url: http://127.0.0.1:3128
176 - name: Multi-instance
177 description: |
178 > **Note**: When you define multiple jobs, their names must be unique.
179
180 Collecting metrics from local and remote instances.
181 config: |
182 jobs:
183 - name: local
184 url: http://127.0.0.1:3128
185
186 - name: remote
187 url: http://192.0.2.1:3128
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: Squid instance
200 description: "These metrics refer to each monitored Squid instance."
201 labels: []
202 metrics:
203 - name: squid.clients_net
204 description: Squid Client Bandwidth
205 unit: "kilobits/s"
206 chart_type: area
207 dimensions:
208 - name: in
209 - name: out
210 - name: hits
211 - name: squid.clients_requests
212 description: Squid Client Requests
213 unit: "requests/s"
214 chart_type: line
215 dimensions:
216 - name: requests
217 - name: hits
218 - name: errors
219 - name: squid.servers_net
220 description: Squid Server Bandwidth
221 unit: "kilobits/s"
222 chart_type: area
223 dimensions:
224 - name: in
225 - name: out
226 - name: squid.servers_requests
227 description: Squid Server Requests
228 unit: "requests/s"
229 chart_type: line
230 dimensions:
231 - name: requests
232 - name: errors