| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-k8s_kubeproxy |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: k8s_kubeproxy |
| 7 | monitored_instance: |
| 8 | name: Kubeproxy |
| 9 | link: https://kubernetes.io/docs/concepts/overview/components/#kube-proxy |
| 10 | icon_filename: kubernetes.svg |
| 11 | categories: |
| 12 | - data-collection.containers-and-vms |
| 13 | keywords: |
| 14 | - kubeproxy |
| 15 | - kubernetes |
| 16 | - k8s |
| 17 | related_resources: |
| 18 | integrations: |
| 19 | list: |
| 20 | - plugin_name: apps.plugin |
| 21 | module_name: apps |
| 22 | - plugin_name: go.d.plugin |
| 23 | module_name: k8s_state |
| 24 | - plugin_name: go.d.plugin |
| 25 | module_name: k8s_apiserver |
| 26 | - plugin_name: go.d.plugin |
| 27 | module_name: k8s_kubelet |
| 28 | - plugin_name: cgroups.plugin |
| 29 | module_name: /sys/fs/cgroup |
| 30 | monitored_instance_name: "Kubernetes Containers" |
| 31 | - plugin_name: go.d.plugin |
| 32 | module_name: coredns |
| 33 | info_provided_to_referring_integrations: |
| 34 | description: "" |
| 35 | overview: |
| 36 | data_collection: |
| 37 | metrics_description: | |
| 38 | This collector monitors Kubeproxy instances. |
| 39 | method_description: "" |
| 40 | supported_platforms: |
| 41 | include: [] |
| 42 | exclude: [] |
| 43 | multi_instance: true |
| 44 | additional_permissions: |
| 45 | description: "" |
| 46 | default_behavior: |
| 47 | auto_detection: |
| 48 | description: "" |
| 49 | limits: |
| 50 | description: "" |
| 51 | performance_impact: |
| 52 | description: "" |
| 53 | setup: |
| 54 | prerequisites: |
| 55 | list: [] |
| 56 | configuration: |
| 57 | file: |
| 58 | name: go.d/k8s_kubeproxy.conf |
| 59 | options: |
| 60 | description: | |
| 61 | The following options can be defined globally: update_every, autodetection_retry. |
| 62 | folding: |
| 63 | title: Config options |
| 64 | enabled: true |
| 65 | list: |
| 66 | - name: update_every |
| 67 | description: Data collection interval (seconds). |
| 68 | default_value: 1 |
| 69 | required: false |
| 70 | group: Collection |
| 71 | - name: autodetection_retry |
| 72 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 73 | default_value: 0 |
| 74 | required: false |
| 75 | group: Collection |
| 76 | |
| 77 | - name: url |
| 78 | description: Target endpoint URL. |
| 79 | default_value: http://127.0.0.1:10249/metrics |
| 80 | required: true |
| 81 | group: Target |
| 82 | - name: timeout |
| 83 | description: HTTP request timeout (seconds). |
| 84 | default_value: 1 |
| 85 | required: false |
| 86 | group: Target |
| 87 | |
| 88 | - name: username |
| 89 | description: Username for Basic HTTP authentication. |
| 90 | default_value: "" |
| 91 | required: false |
| 92 | group: HTTP Auth |
| 93 | - name: password |
| 94 | description: Password for Basic HTTP authentication. |
| 95 | default_value: "" |
| 96 | required: false |
| 97 | group: HTTP Auth |
| 98 | - name: bearer_token_file |
| 99 | description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)." |
| 100 | default_value: "" |
| 101 | required: false |
| 102 | group: HTTP Auth |
| 103 | |
| 104 | - name: tls_skip_verify |
| 105 | description: Skip TLS certificate and hostname verification (insecure). |
| 106 | default_value: no |
| 107 | required: false |
| 108 | group: TLS |
| 109 | - name: tls_ca |
| 110 | description: Path to CA bundle used to validate the server certificate. |
| 111 | default_value: "" |
| 112 | required: false |
| 113 | group: TLS |
| 114 | - name: tls_cert |
| 115 | description: Path to client TLS certificate (for mTLS). |
| 116 | default_value: "" |
| 117 | required: false |
| 118 | group: TLS |
| 119 | - name: tls_key |
| 120 | description: Path to client TLS private key (for mTLS). |
| 121 | default_value: "" |
| 122 | required: false |
| 123 | group: TLS |
| 124 | |
| 125 | - name: proxy_url |
| 126 | description: HTTP proxy URL. |
| 127 | default_value: "" |
| 128 | required: false |
| 129 | group: Proxy |
| 130 | - name: proxy_username |
| 131 | description: Username for proxy Basic HTTP authentication. |
| 132 | default_value: "" |
| 133 | required: false |
| 134 | group: Proxy |
| 135 | - name: proxy_password |
| 136 | description: Password for proxy Basic HTTP authentication. |
| 137 | default_value: "" |
| 138 | required: false |
| 139 | group: Proxy |
| 140 | |
| 141 | - name: method |
| 142 | description: HTTP method to use. |
| 143 | default_value: "GET" |
| 144 | required: false |
| 145 | group: Request |
| 146 | - name: body |
| 147 | description: Request body (e.g., for POST/PUT). |
| 148 | default_value: "" |
| 149 | required: false |
| 150 | group: Request |
| 151 | - name: headers |
| 152 | description: "Additional HTTP headers (one per line as key: value)." |
| 153 | default_value: "" |
| 154 | required: false |
| 155 | group: Request |
| 156 | - name: not_follow_redirects |
| 157 | description: Do not follow HTTP redirects. |
| 158 | default_value: no |
| 159 | required: false |
| 160 | group: Request |
| 161 | - name: force_http2 |
| 162 | description: Force HTTP/2 (including h2c over TCP). |
| 163 | default_value: no |
| 164 | required: false |
| 165 | group: Request |
| 166 | |
| 167 | - name: vnode |
| 168 | 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). |
| 169 | default_value: "" |
| 170 | required: false |
| 171 | group: Virtual Node |
| 172 | examples: |
| 173 | folding: |
| 174 | title: Config |
| 175 | enabled: true |
| 176 | list: |
| 177 | - name: Basic |
| 178 | folding: |
| 179 | enabled: false |
| 180 | description: A basic example configuration. |
| 181 | config: | |
| 182 | jobs: |
| 183 | - name: local |
| 184 | url: http://127.0.0.1:10249/metrics |
| 185 | - name: HTTPS with self-signed certificate |
| 186 | description: | |
| 187 | Do not validate server certificate chain and hostname. |
| 188 | config: | |
| 189 | jobs: |
| 190 | - name: local |
| 191 | url: https://127.0.0.1:10249/metrics |
| 192 | tls_skip_verify: yes |
| 193 | troubleshooting: |
| 194 | problems: |
| 195 | list: [] |
| 196 | alerts: [] |
| 197 | metrics: |
| 198 | folding: |
| 199 | title: Metrics |
| 200 | enabled: false |
| 201 | description: "" |
| 202 | availability: [] |
| 203 | scopes: |
| 204 | - name: global |
| 205 | description: These metrics refer to the entire monitored application. |
| 206 | labels: [] |
| 207 | metrics: |
| 208 | - name: k8s_kubeproxy.kubeproxy_sync_proxy_rules |
| 209 | description: Sync Proxy Rules |
| 210 | unit: events/s |
| 211 | chart_type: line |
| 212 | dimensions: |
| 213 | - name: sync_proxy_rules |
| 214 | - name: k8s_kubeproxy.kubeproxy_sync_proxy_rules_latency_microsecond |
| 215 | description: Sync Proxy Rules Latency |
| 216 | unit: observes/s |
| 217 | chart_type: stacked |
| 218 | dimensions: |
| 219 | - name: "0.001" |
| 220 | - name: "0.002" |
| 221 | - name: "0.004" |
| 222 | - name: "0.008" |
| 223 | - name: "0.016" |
| 224 | - name: "0.032" |
| 225 | - name: "0.064" |
| 226 | - name: "0.128" |
| 227 | - name: "0.256" |
| 228 | - name: "0.512" |
| 229 | - name: "1.024" |
| 230 | - name: "2.048" |
| 231 | - name: "4.096" |
| 232 | - name: "8.192" |
| 233 | - name: "16.384" |
| 234 | - name: +Inf |
| 235 | - name: k8s_kubeproxy.kubeproxy_sync_proxy_rules_latency |
| 236 | description: Sync Proxy Rules Latency Percentage |
| 237 | unit: percentage |
| 238 | chart_type: stacked |
| 239 | dimensions: |
| 240 | - name: "0.001" |
| 241 | - name: "0.002" |
| 242 | - name: "0.004" |
| 243 | - name: "0.008" |
| 244 | - name: "0.016" |
| 245 | - name: "0.032" |
| 246 | - name: "0.064" |
| 247 | - name: "0.128" |
| 248 | - name: "0.256" |
| 249 | - name: "0.512" |
| 250 | - name: "1.024" |
| 251 | - name: "2.048" |
| 252 | - name: "4.096" |
| 253 | - name: "8.192" |
| 254 | - name: "16.384" |
| 255 | - name: +Inf |
| 256 | - name: k8s_kubeproxy.rest_client_requests_by_code |
| 257 | description: HTTP Requests By Status Code |
| 258 | unit: requests/s |
| 259 | chart_type: stacked |
| 260 | dimensions: |
| 261 | - name: a dimension per HTTP status code |
| 262 | - name: k8s_kubeproxy.rest_client_requests_by_method |
| 263 | description: HTTP Requests By Status Method |
| 264 | unit: requests/s |
| 265 | chart_type: stacked |
| 266 | dimensions: |
| 267 | - name: a dimension per HTTP method |
| 268 | - name: k8s_kubeproxy.http_request_duration |
| 269 | description: HTTP Requests Duration |
| 270 | unit: microseconds |
| 271 | chart_type: stacked |
| 272 | dimensions: |
| 273 | - name: "0.5" |
| 274 | - name: "0.9" |
| 275 | - name: "0.99" |