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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-k8s_kubelet
     5        plugin_name: go.d.plugin
     6        module_name: k8s_kubelet
     7        monitored_instance:
     8          name: Kubelet
     9          link: https://kubernetes.io/docs/concepts/overview/components/#kubelet
    10          icon_filename: kubernetes.svg
    11          categories:
    12            - data-collection.kubernetes
    13        keywords:
    14          - kubelet
    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 Kubelet 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_kubelet.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:10255/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:10255/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: http://127.0.0.1:10250/metrics
   144                      tls_skip_verify: yes
   145      troubleshooting:
   146        problems:
   147          list: []
   148      alerts:
   149        - name: kubelet_node_config_error
   150          metric: k8s_kubelet.kubelet_node_config_error
   151          info: "the node is experiencing a configuration-related error (0: false, 1: true)"
   152          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/kubelet.conf
   153        - name: kubelet_token_requests
   154          metric: k8s_kubelet.kubelet_token_requests
   155          info: "number of failed Token() requests to the alternate token source"
   156          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/kubelet.conf
   157        - name: kubelet_token_requests
   158          metric: k8s_kubelet.kubelet_token_requests
   159          info: "number of failed Token() requests to the alternate token source"
   160          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/kubelet.conf
   161        - name: kubelet_operations_error
   162          metric: k8s_kubelet.kubelet_operations_errors
   163          info: number of Docker or runtime operation errors
   164          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/kubelet.conf
   165        - name: kubelet_operations_error
   166          metric: k8s_kubelet.kubelet_operations_errors
   167          info: number of Docker or runtime operation errors
   168          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/kubelet.conf
   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: k8s_kubelet.apiserver_audit_requests_rejected
   181                description: API Server Audit Requests
   182                unit: requests/s
   183                chart_type: line
   184                dimensions:
   185                  - name: rejected
   186              - name: k8s_kubelet.apiserver_storage_data_key_generation_failures
   187                description: API Server Failed Data Encryption Key(DEK) Generation Operations
   188                unit: events/s
   189                chart_type: line
   190                dimensions:
   191                  - name: failures
   192              - name: k8s_kubelet.apiserver_storage_data_key_generation_latencies
   193                description: API Server Latencies Of Data Encryption Key(DEK) Generation Operations
   194                unit: observes/s
   195                chart_type: stacked
   196                dimensions:
   197                  - name: 5_µs
   198                  - name: 10_µs
   199                  - name: 20_µs
   200                  - name: 40_µs
   201                  - name: 80_µs
   202                  - name: 160_µs
   203                  - name: 320_µs
   204                  - name: 640_µs
   205                  - name: 1280_µs
   206                  - name: 2560_µs
   207                  - name: 5120_µs
   208                  - name: 10240_µs
   209                  - name: 20480_µs
   210                  - name: 40960_µs
   211                  - name: +Inf
   212              - name: k8s_kubelet.apiserver_storage_data_key_generation_latencies_percent
   213                description: API Server Latencies Of Data Encryption Key(DEK) Generation Operations Percentage
   214                unit: percentage
   215                chart_type: stacked
   216                dimensions:
   217                  - name: 5_µs
   218                  - name: 10_µs
   219                  - name: 20_µs
   220                  - name: 40_µs
   221                  - name: 80_µs
   222                  - name: 160_µs
   223                  - name: 320_µs
   224                  - name: 640_µs
   225                  - name: 1280_µs
   226                  - name: 2560_µs
   227                  - name: 5120_µs
   228                  - name: 10240_µs
   229                  - name: 20480_µs
   230                  - name: 40960_µs
   231                  - name: +Inf
   232              - name: k8s_kubelet.apiserver_storage_envelope_transformation_cache_misses
   233                description: API Server Storage Envelope Transformation Cache Misses
   234                unit: events/s
   235                chart_type: line
   236                dimensions:
   237                  - name: cache misses
   238              - name: k8s_kubelet.kubelet_containers_running
   239                description: Number Of Containers Currently Running
   240                unit: running_containers
   241                chart_type: line
   242                dimensions:
   243                  - name: total
   244              - name: k8s_kubelet.kubelet_pods_running
   245                description: Number Of Pods Currently Running
   246                unit: running_pods
   247                chart_type: line
   248                dimensions:
   249                  - name: total
   250              - name: k8s_kubelet.kubelet_pods_log_filesystem_used_bytes
   251                description: Bytes Used By The Pod Logs On The Filesystem
   252                unit: B
   253                chart_type: stacked
   254                dimensions:
   255                  - name: a dimension per namespace and pod
   256              - name: k8s_kubelet.kubelet_runtime_operations
   257                description: Runtime Operations By Type
   258                unit: operations/s
   259                chart_type: stacked
   260                dimensions:
   261                  - name: a dimension per operation type
   262              - name: k8s_kubelet.kubelet_runtime_operations_errors
   263                description: Runtime Operations Errors By Type
   264                unit: errors/s
   265                chart_type: stacked
   266                dimensions:
   267                  - name: a dimension per operation type
   268              - name: k8s_kubelet.kubelet_docker_operations
   269                description: Docker Operations By Type
   270                unit: operations/s
   271                chart_type: stacked
   272                dimensions:
   273                  - name: a dimension per operation type
   274              - name: k8s_kubelet.kubelet_docker_operations_errors
   275                description: Docker Operations Errors By Type
   276                unit: errors/s
   277                chart_type: stacked
   278                dimensions:
   279                  - name: a dimension per operation type
   280              - name: k8s_kubelet.kubelet_node_config_error
   281                description: Node Configuration-Related Error
   282                unit: bool
   283                chart_type: line
   284                dimensions:
   285                  - name: experiencing_error
   286              - name: k8s_kubelet.kubelet_pleg_relist_interval_microseconds
   287                description: PLEG Relisting Interval Summary
   288                unit: microseconds
   289                chart_type: stacked
   290                dimensions:
   291                  - name: "0.5"
   292                  - name: "0.9"
   293                  - name: "0.99"
   294              - name: k8s_kubelet.kubelet_pleg_relist_latency_microseconds
   295                description: PLEG Relisting Latency Summary
   296                unit: microseconds
   297                chart_type: stacked
   298                dimensions:
   299                  - name: "0.5"
   300                  - name: "0.9"
   301                  - name: "0.99"
   302              - name: k8s_kubelet.kubelet_token_requests
   303                description: Token() Requests To The Alternate Token Source
   304                unit: token_requests/s
   305                chart_type: line
   306                dimensions:
   307                  - name: total
   308                  - name: failed
   309              - name: k8s_kubelet.rest_client_requests_by_code
   310                description: HTTP Requests By Status Code
   311                unit: requests/s
   312                chart_type: stacked
   313                dimensions:
   314                  - name: a dimension per HTTP status code
   315              - name: k8s_kubelet.rest_client_requests_by_method
   316                description: HTTP Requests By Status Method
   317                unit: requests/s
   318                chart_type: stacked
   319                dimensions:
   320                  - name: a dimension per HTTP method
   321          - name: volume manager
   322            description: These metrics refer to the Volume Manager.
   323            labels: []
   324            metrics:
   325              - name: k8s_kubelet.volume_manager_total_volumes
   326                description: Volume Manager State Of The World
   327                unit: state
   328                chart_type: line
   329                dimensions:
   330                  - name: actual
   331                  - name: desired