github.com/netdata/go.d.plugin@v0.58.1/modules/k8s_kubeproxy/metadata.yaml (about)

     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.kubernetes
    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        info_provided_to_referring_integrations:
    23          description: ""
    24        most_popular: true
    25      overview:
    26        data_collection:
    27          metrics_description: |
    28            This collector monitors Kubeproxy instances.
    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        configuration:
    47          file:
    48            name: go.d/k8s_kubeproxy.conf
    49          options:
    50            description: |
    51              The following options can be defined globally: update_every, autodetection_retry.
    52            folding:
    53              title: Config options
    54              enabled: true
    55            list:
    56              - name: update_every
    57                description: Data collection frequency.
    58                default_value: 1
    59                required: false
    60              - name: autodetection_retry
    61                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    62                default_value: 0
    63                required: false
    64              - name: url
    65                description: Server URL.
    66                default_value: http://127.0.0.1:10249/metrics
    67                required: true
    68              - name: timeout
    69                description: HTTP request timeout.
    70                default_value: 1
    71                required: false
    72              - name: username
    73                description: Username for basic HTTP authentication.
    74                default_value: ""
    75                required: false
    76              - name: password
    77                description: Password for basic HTTP authentication.
    78                default_value: ""
    79                required: false
    80              - name: proxy_url
    81                description: Proxy URL.
    82                default_value: ""
    83                required: false
    84              - name: proxy_username
    85                description: Username for proxy basic HTTP authentication.
    86                default_value: ""
    87                required: false
    88              - name: proxy_password
    89                description: Password for proxy basic HTTP authentication.
    90                default_value: ""
    91                required: false
    92              - name: method
    93                description: HTTP request method.
    94                default_value: GET
    95                required: false
    96              - name: body
    97                description: HTTP request body.
    98                default_value: ""
    99                required: false
   100              - name: headers
   101                description: HTTP request headers.
   102                default_value: ""
   103                required: false
   104              - name: not_follow_redirects
   105                description: Redirect handling policy. Controls whether the client follows redirects.
   106                default_value: no
   107                required: false
   108              - name: tls_skip_verify
   109                description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
   110                default_value: no
   111                required: false
   112              - name: tls_ca
   113                description: Certification authority that the client uses when verifying the server's certificates.
   114                default_value: ""
   115                required: false
   116              - name: tls_cert
   117                description: Client TLS certificate.
   118                default_value: ""
   119                required: false
   120              - name: tls_key
   121                description: Client TLS key.
   122                default_value: ""
   123                required: false
   124          examples:
   125            folding:
   126              title: Config
   127              enabled: true
   128            list:
   129              - name: Basic
   130                folding:
   131                  enabled: false
   132                description: A basic example configuration.
   133                config: |
   134                  jobs:
   135                    - name: local
   136                      url: http://127.0.0.1:10249/metrics
   137              - name: HTTPS with self-signed certificate
   138                description: |
   139                  Do not validate server certificate chain and hostname.
   140                config: |
   141                  jobs:
   142                    - name: local
   143                      url: https://127.0.0.1:10249/metrics
   144                      tls_skip_verify: yes
   145      troubleshooting:
   146        problems:
   147          list: []
   148      alerts: []
   149      metrics:
   150        folding:
   151          title: Metrics
   152          enabled: false
   153        description: ""
   154        availability: []
   155        scopes:
   156          - name: global
   157            description: These metrics refer to the entire monitored application.
   158            labels: []
   159            metrics:
   160              - name: k8s_kubeproxy.kubeproxy_sync_proxy_rules
   161                description: Sync Proxy Rules
   162                unit: events/s
   163                chart_type: line
   164                dimensions:
   165                  - name: sync_proxy_rules
   166              - name: k8s_kubeproxy.kubeproxy_sync_proxy_rules_latency_microsecond
   167                description: Sync Proxy Rules Latency
   168                unit: observes/s
   169                chart_type: stacked
   170                dimensions:
   171                  - name: "0.001"
   172                  - name: "0.002"
   173                  - name: "0.004"
   174                  - name: "0.008"
   175                  - name: "0.016"
   176                  - name: "0.032"
   177                  - name: "0.064"
   178                  - name: "0.128"
   179                  - name: "0.256"
   180                  - name: "0.512"
   181                  - name: "1.024"
   182                  - name: "2.048"
   183                  - name: "4.096"
   184                  - name: "8.192"
   185                  - name: "16.384"
   186                  - name: +Inf
   187              - name: k8s_kubeproxy.kubeproxy_sync_proxy_rules_latency
   188                description: Sync Proxy Rules Latency Percentage
   189                unit: percentage
   190                chart_type: stacked
   191                dimensions:
   192                  - name: "0.001"
   193                  - name: "0.002"
   194                  - name: "0.004"
   195                  - name: "0.008"
   196                  - name: "0.016"
   197                  - name: "0.032"
   198                  - name: "0.064"
   199                  - name: "0.128"
   200                  - name: "0.256"
   201                  - name: "0.512"
   202                  - name: "1.024"
   203                  - name: "2.048"
   204                  - name: "4.096"
   205                  - name: "8.192"
   206                  - name: "16.384"
   207                  - name: +Inf
   208              - name: k8s_kubeproxy.rest_client_requests_by_code
   209                description: HTTP Requests By Status Code
   210                unit: requests/s
   211                chart_type: stacked
   212                dimensions:
   213                  - name: a dimension per HTTP status code
   214              - name: k8s_kubeproxy.rest_client_requests_by_method
   215                description: HTTP Requests By Status Method
   216                unit: requests/s
   217                chart_type: stacked
   218                dimensions:
   219                  - name: a dimension per HTTP method
   220              - name: k8s_kubeproxy.http_request_duration
   221                description: HTTP Requests Duration
   222                unit: microseconds
   223                chart_type: stacked
   224                dimensions:
   225                  - name: "0.5"
   226                  - name: "0.9"
   227                  - name: "0.99"