@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
yaml 206 lines 6.81 KB
Raw
1 plugin_name: go.d.plugin
2 modules:
3 - meta:
4 plugin_name: go.d.plugin
5 module_name: icecast
6 monitored_instance:
7 name: Icecast
8 link: "https://icecast.org/"
9 categories:
10 - data-collection.applications
11 icon_filename: "icecast.svg"
12 related_resources:
13 integrations:
14 list: []
15 info_provided_to_referring_integrations:
16 description: ""
17 keywords:
18 - icecast
19 - streaming
20 - media
21 overview:
22 data_collection:
23 metrics_description: "This collector monitors Icecast listener counts."
24 method_description: "It uses the Icecast server statistics `status-json.xsl` endpoint to retrieve the metrics."
25 supported_platforms:
26 include: []
27 exclude: []
28 multi_instance: true
29 additional_permissions:
30 description: ""
31 default_behavior:
32 auto_detection:
33 description: By default, it detects Icecast instances running on localhost that are listening on port 8000.
34 limits:
35 description: ""
36 performance_impact:
37 description: ""
38 setup:
39 prerequisites:
40 list:
41 - title: "Icecast minimum version"
42 description: "Needs at least Icecast version >= 2.4.0"
43 configuration:
44 file:
45 name: go.d/icecast.conf
46 options:
47 description: |
48 The following options can be defined globally: update_every, autodetection_retry.
49 folding:
50 title: "Config options"
51 enabled: true
52 list:
53 - name: update_every
54 description: Data collection interval (seconds).
55 default_value: 1
56 required: false
57 group: Collection
58 - name: autodetection_retry
59 description: Autodetection retry interval (seconds). Set 0 to disable.
60 default_value: 0
61 required: false
62 group: Collection
63
64 - name: url
65 description: Target endpoint URL.
66 default_value: http://127.0.0.1:8000
67 required: true
68 group: Target
69 - name: timeout
70 description: HTTP request timeout (seconds).
71 default_value: 1
72 required: false
73 group: Target
74
75 - name: username
76 description: Username for Basic HTTP authentication.
77 default_value: ""
78 required: false
79 group: HTTP Auth
80 - name: password
81 description: Password for Basic HTTP authentication.
82 default_value: ""
83 required: false
84 group: HTTP Auth
85 - name: bearer_token_file
86 description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
87 default_value: ""
88 required: false
89 group: HTTP Auth
90
91 - name: tls_skip_verify
92 description: Skip TLS certificate and hostname verification (insecure).
93 default_value: no
94 required: false
95 group: TLS
96 - name: tls_ca
97 description: Path to CA bundle used to validate the server certificate.
98 default_value: ""
99 required: false
100 group: TLS
101 - name: tls_cert
102 description: Path to client TLS certificate (for mTLS).
103 default_value: ""
104 required: false
105 group: TLS
106 - name: tls_key
107 description: Path to client TLS private key (for mTLS).
108 default_value: ""
109 required: false
110 group: TLS
111
112 - name: proxy_url
113 description: HTTP proxy URL.
114 default_value: ""
115 required: false
116 group: Proxy
117 - name: proxy_username
118 description: Username for proxy Basic HTTP authentication.
119 default_value: ""
120 required: false
121 group: Proxy
122 - name: proxy_password
123 description: Password for proxy Basic HTTP authentication.
124 default_value: ""
125 required: false
126 group: Proxy
127
128 - name: method
129 description: HTTP method to use.
130 default_value: "GET"
131 required: false
132 group: Request
133 - name: body
134 description: Request body (e.g., for POST/PUT).
135 default_value: ""
136 required: false
137 group: Request
138 - name: headers
139 description: "Additional HTTP headers (one per line as key: value)."
140 default_value: ""
141 required: false
142 group: Request
143 - name: not_follow_redirects
144 description: Do not follow HTTP redirects.
145 default_value: no
146 required: false
147 group: Request
148 - name: force_http2
149 description: Force HTTP/2 (including h2c over TCP).
150 default_value: no
151 required: false
152 group: Request
153
154 - name: vnode
155 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).
156 default_value: ""
157 required: false
158 group: Virtual Node
159 examples:
160 folding:
161 enabled: true
162 title: Config
163 list:
164 - name: Basic
165 description: A basic example configuration.
166 folding:
167 enabled: false
168 config: |
169 jobs:
170 - name: local
171 url: http://127.0.0.1:8000
172 - name: Multi-instance
173 description: |
174 > **Note**: When you define multiple jobs, their names must be unique.
175
176 Collecting metrics from local and remote instances.
177 config: |
178 jobs:
179 - name: local
180 url: http://127.0.0.1:8000
181
182 - name: remote
183 url: http://192.0.2.1:8000
184 troubleshooting:
185 problems:
186 list: []
187 alerts: []
188 metrics:
189 folding:
190 title: Metrics
191 enabled: false
192 description: ""
193 availability: []
194 scopes:
195 - name: Icecast source
196 description: "These metrics refer to an icecast source."
197 labels:
198 - name: source
199 description: Source name.
200 metrics:
201 - name: icecast.listeners
202 description: Icecast Listeners
203 unit: "listeners"
204 chart_type: line
205 dimensions:
206 - name: listeners