github.com/netdata/go.d.plugin@v0.58.1/modules/haproxy/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-haproxy 5 plugin_name: go.d.plugin 6 module_name: haproxy 7 monitored_instance: 8 name: HAProxy 9 link: https://www.haproxy.org/ 10 icon_filename: haproxy.svg 11 categories: 12 - data-collection.web-servers-and-web-proxies 13 keywords: 14 - haproxy 15 - web 16 - webserver 17 - http 18 - proxy 19 related_resources: 20 integrations: 21 list: [] 22 info_provided_to_referring_integrations: 23 description: "" 24 most_popular: false 25 overview: 26 data_collection: 27 metrics_description: | 28 This collector monitors HAProxy servers. 29 method_description: "" 30 supported_platforms: 31 include: [] 32 exclude: [] 33 multi_instance: true 34 additional_permissions: 35 description: "" 36 default_behavior: 37 auto_detection: 38 description: "" 39 limits: 40 description: "" 41 performance_impact: 42 description: "" 43 setup: 44 prerequisites: 45 list: 46 - title: Enable PROMEX addon. 47 description: | 48 To enable PROMEX addon, follow the [official documentation](https://github.com/haproxy/haproxy/tree/master/addons/promex). 49 configuration: 50 file: 51 name: go.d/haproxy.conf 52 options: 53 description: | 54 The following options can be defined globally: update_every, autodetection_retry. 55 folding: 56 title: Config options 57 enabled: true 58 list: 59 - name: update_every 60 description: Data collection frequency. 61 default_value: 1 62 required: false 63 - name: autodetection_retry 64 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 65 default_value: 0 66 required: false 67 - name: url 68 description: Server URL. 69 default_value: http://127.0.0.1 70 required: true 71 - name: timeout 72 description: HTTP request timeout. 73 default_value: 1 74 required: false 75 - name: username 76 description: Username for basic HTTP authentication. 77 default_value: "" 78 required: false 79 - name: password 80 description: Password for basic HTTP authentication. 81 default_value: "" 82 required: false 83 - name: proxy_url 84 description: Proxy URL. 85 default_value: "" 86 required: false 87 - name: proxy_username 88 description: Username for proxy basic HTTP authentication. 89 default_value: "" 90 required: false 91 - name: proxy_password 92 description: Password for proxy basic HTTP authentication. 93 default_value: "" 94 required: false 95 - name: method 96 description: HTTP request method. 97 default_value: GET 98 required: false 99 - name: body 100 description: HTTP request body. 101 default_value: "" 102 required: false 103 - name: headers 104 description: HTTP request headers. 105 default_value: "" 106 required: false 107 - name: not_follow_redirects 108 description: Redirect handling policy. Controls whether the client follows redirects. 109 default_value: false 110 required: false 111 - name: tls_skip_verify 112 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 113 default_value: false 114 required: false 115 - name: tls_ca 116 description: Certification authority that the client uses when verifying the server's certificates. 117 default_value: "" 118 required: false 119 - name: tls_cert 120 description: Client TLS certificate. 121 default_value: "" 122 required: false 123 - name: tls_key 124 description: Client TLS key. 125 default_value: "" 126 required: false 127 examples: 128 folding: 129 title: Config 130 enabled: true 131 list: 132 - name: Basic 133 description: A basic example configuration. 134 config: | 135 jobs: 136 - name: local 137 url: http://127.0.0.1:8404/metrics 138 - name: HTTP authentication 139 description: Basic HTTP authentication. 140 config: | 141 jobs: 142 - name: local 143 url: http://127.0.0.1:8404/metrics 144 username: username 145 password: password 146 - name: HTTPS with self-signed certificate 147 description: NGINX Plus with enabled HTTPS and self-signed certificate. 148 config: | 149 jobs: 150 - name: local 151 url: https://127.0.0.1:8404/metrics 152 tls_skip_verify: yes 153 - name: Multi-instance 154 description: | 155 > **Note**: When you define multiple jobs, their names must be unique. 156 157 Collecting metrics from local and remote instances. 158 config: | 159 jobs: 160 - name: local 161 url: http://127.0.0.1:8404/metrics 162 163 - name: remote 164 url: http://192.0.2.1:8404/metrics 165 troubleshooting: 166 problems: 167 list: [] 168 alerts: [] 169 metrics: 170 folding: 171 title: Metrics 172 enabled: false 173 description: "" 174 availability: [] 175 scopes: 176 - name: global 177 description: These metrics refer to the entire monitored application. 178 labels: [] 179 metrics: 180 - name: haproxy.backend_current_sessions 181 description: Current number of active sessions 182 unit: sessions 183 chart_type: line 184 dimensions: 185 - name: a dimension per proxy 186 - name: haproxy.backend_sessions 187 description: Sessions rate 188 unit: sessions/s 189 chart_type: line 190 dimensions: 191 - name: a dimension per proxy 192 - name: haproxy.backend_response_time_average 193 description: Average response time for last 1024 successful connections 194 unit: milliseconds 195 chart_type: line 196 dimensions: 197 - name: a dimension per proxy 198 - name: haproxy.backend_queue_time_average 199 description: Average queue time for last 1024 successful connections 200 unit: milliseconds 201 chart_type: line 202 dimensions: 203 - name: a dimension per proxy 204 - name: haproxy.backend_current_queue 205 description: Current number of queued requests 206 unit: requests 207 chart_type: line 208 dimensions: 209 - name: a dimension per proxy 210 - name: proxy 211 description: These metrics refer to the Proxy. 212 labels: [] 213 metrics: 214 - name: haproxy.backend_http_responses 215 description: HTTP responses by code class 216 unit: responses/s 217 chart_type: stacked 218 dimensions: 219 - name: 1xx 220 - name: 2xx 221 - name: 3xx 222 - name: 4xx 223 - name: 5xx 224 - name: other 225 - name: haproxy.backend_network_io 226 description: Network traffic 227 unit: bytes/s 228 chart_type: area 229 dimensions: 230 - name: in 231 - name: out