github.com/netdata/go.d.plugin@v0.58.1/modules/k8s_kubeproxy/integrations/kubeproxy.md (about) 1 <!--startmeta 2 custom_edit_url: "https://github.com/netdata/go.d.plugin/edit/master/modules/k8s_kubeproxy/README.md" 3 meta_yaml: "https://github.com/netdata/go.d.plugin/edit/master/modules/k8s_kubeproxy/metadata.yaml" 4 sidebar_label: "Kubeproxy" 5 learn_status: "Published" 6 learn_rel_path: "Data Collection/Kubernetes" 7 most_popular: True 8 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" 9 endmeta--> 10 11 # Kubeproxy 12 13 14 <img src="https://netdata.cloud/img/kubernetes.svg" width="150"/> 15 16 17 Plugin: go.d.plugin 18 Module: k8s_kubeproxy 19 20 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> 21 22 ## Overview 23 24 This collector monitors Kubeproxy instances. 25 26 27 28 29 This collector is supported on all platforms. 30 31 This collector supports collecting metrics from multiple instances of this integration, including remote instances. 32 33 34 ### Default Behavior 35 36 #### Auto-Detection 37 38 This integration doesn't support auto-detection. 39 40 #### Limits 41 42 The default configuration for this integration does not impose any limits on data collection. 43 44 #### Performance Impact 45 46 The default configuration for this integration is not expected to impose a significant performance impact on the system. 47 48 49 ## Metrics 50 51 Metrics grouped by *scope*. 52 53 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. 54 55 56 57 ### Per Kubeproxy instance 58 59 These metrics refer to the entire monitored application. 60 61 This scope has no labels. 62 63 Metrics: 64 65 | Metric | Dimensions | Unit | 66 |:------|:----------|:----| 67 | k8s_kubeproxy.kubeproxy_sync_proxy_rules | sync_proxy_rules | events/s | 68 | k8s_kubeproxy.kubeproxy_sync_proxy_rules_latency_microsecond | 0.001, 0.002, 0.004, 0.008, 0.016, 0.032, 0.064, 0.128, 0.256, 0.512, 1.024, 2.048, 4.096, 8.192, 16.384, +Inf | observes/s | 69 | k8s_kubeproxy.kubeproxy_sync_proxy_rules_latency | 0.001, 0.002, 0.004, 0.008, 0.016, 0.032, 0.064, 0.128, 0.256, 0.512, 1.024, 2.048, 4.096, 8.192, 16.384, +Inf | percentage | 70 | k8s_kubeproxy.rest_client_requests_by_code | a dimension per HTTP status code | requests/s | 71 | k8s_kubeproxy.rest_client_requests_by_method | a dimension per HTTP method | requests/s | 72 | k8s_kubeproxy.http_request_duration | 0.5, 0.9, 0.99 | microseconds | 73 74 75 76 ## Alerts 77 78 There are no alerts configured by default for this integration. 79 80 81 ## Setup 82 83 ### Prerequisites 84 85 No action required. 86 87 ### Configuration 88 89 #### File 90 91 The configuration file name for this integration is `go.d/k8s_kubeproxy.conf`. 92 93 94 You can edit the configuration file using the `edit-config` script from the 95 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory). 96 97 ```bash 98 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata 99 sudo ./edit-config go.d/k8s_kubeproxy.conf 100 ``` 101 #### Options 102 103 The following options can be defined globally: update_every, autodetection_retry. 104 105 106 <details><summary>Config options</summary> 107 108 | Name | Description | Default | Required | 109 |:----|:-----------|:-------|:--------:| 110 | update_every | Data collection frequency. | 1 | no | 111 | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | 112 | url | Server URL. | http://127.0.0.1:10249/metrics | yes | 113 | timeout | HTTP request timeout. | 1 | no | 114 | username | Username for basic HTTP authentication. | | no | 115 | password | Password for basic HTTP authentication. | | no | 116 | proxy_url | Proxy URL. | | no | 117 | proxy_username | Username for proxy basic HTTP authentication. | | no | 118 | proxy_password | Password for proxy basic HTTP authentication. | | no | 119 | method | HTTP request method. | GET | no | 120 | body | HTTP request body. | | no | 121 | headers | HTTP request headers. | | no | 122 | not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no | 123 | tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no | 124 | tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no | 125 | tls_cert | Client TLS certificate. | | no | 126 | tls_key | Client TLS key. | | no | 127 128 </details> 129 130 #### Examples 131 132 ##### Basic 133 134 A basic example configuration. 135 136 ```yaml 137 jobs: 138 - name: local 139 url: http://127.0.0.1:10249/metrics 140 141 ``` 142 ##### HTTPS with self-signed certificate 143 144 Do not validate server certificate chain and hostname. 145 146 147 <details><summary>Config</summary> 148 149 ```yaml 150 jobs: 151 - name: local 152 url: https://127.0.0.1:10249/metrics 153 tls_skip_verify: yes 154 155 ``` 156 </details> 157 158 159 160 ## Troubleshooting 161 162 ### Debug Mode 163 164 To troubleshoot issues with the `k8s_kubeproxy` collector, run the `go.d.plugin` with the debug option enabled. The output 165 should give you clues as to why the collector isn't working. 166 167 - Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on 168 your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. 169 170 ```bash 171 cd /usr/libexec/netdata/plugins.d/ 172 ``` 173 174 - Switch to the `netdata` user. 175 176 ```bash 177 sudo -u netdata -s 178 ``` 179 180 - Run the `go.d.plugin` to debug the collector: 181 182 ```bash 183 ./go.d.plugin -d -m k8s_kubeproxy 184 ``` 185 186