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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-traefik
     5        plugin_name: go.d.plugin
     6        module_name: traefik
     7        monitored_instance:
     8          name: Traefik
     9          link: Traefik
    10          icon_filename: traefik.svg
    11          categories:
    12            - data-collection.web-servers-and-web-proxies
    13        keywords:
    14          - traefik
    15          - proxy
    16          - webproxy
    17        related_resources:
    18          integrations:
    19            list: []
    20        info_provided_to_referring_integrations:
    21          description: ""
    22        most_popular: false
    23      overview:
    24        data_collection:
    25          metrics_description: |
    26            This collector monitors Traefik servers.
    27          method_description: ""
    28        supported_platforms:
    29          include: []
    30          exclude: []
    31        multi_instance: true
    32        additional_permissions:
    33          description: ""
    34        default_behavior:
    35          auto_detection:
    36            description: ""
    37          limits:
    38            description: ""
    39          performance_impact:
    40            description: ""
    41      setup:
    42        prerequisites:
    43          list:
    44            - title: Enable built-in Prometheus exporter
    45              description: |
    46                To enable see [Prometheus exporter](https://doc.traefik.io/traefik/observability/metrics/prometheus/) documentation.
    47        configuration:
    48          file:
    49            name: go.d/traefik.conf
    50          options:
    51            description: |
    52              The following options can be defined globally: update_every, autodetection_retry.
    53            folding:
    54              title: All options
    55              enabled: true
    56            list:
    57              - name: update_every
    58                description: Data collection frequency.
    59                default_value: 1
    60                required: false
    61              - name: autodetection_retry
    62                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    63                default_value: 0
    64                required: false
    65              - name: url
    66                description: Server URL.
    67                default_value: http://127.0.0.1:8082/metrics
    68                required: true
    69              - name: timeout
    70                description: HTTP request timeout.
    71                default_value: 1
    72                required: false
    73              - name: username
    74                description: Username for basic HTTP authentication.
    75                default_value: ""
    76                required: false
    77              - name: password
    78                description: Password for basic HTTP authentication.
    79                default_value: ""
    80                required: false
    81              - name: proxy_url
    82                description: Proxy URL.
    83                default_value: ""
    84                required: false
    85              - name: proxy_username
    86                description: Username for proxy basic HTTP authentication.
    87                default_value: ""
    88                required: false
    89              - name: proxy_password
    90                description: Password for proxy basic HTTP authentication.
    91                default_value: ""
    92                required: false
    93              - name: method
    94                description: HTTP request method.
    95                default_value: GET
    96                required: false
    97              - name: body
    98                description: HTTP request body.
    99                default_value: ""
   100                required: false
   101              - name: headers
   102                description: HTTP request headers.
   103                default_value: ""
   104                required: false
   105              - name: not_follow_redirects
   106                description: Redirect handling policy. Controls whether the client follows redirects.
   107                default_value: false
   108                required: false
   109              - name: tls_skip_verify
   110                description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
   111                default_value: false
   112                required: false
   113              - name: tls_ca
   114                description: Certification authority that the client uses when verifying the server's certificates.
   115                default_value: ""
   116                required: false
   117              - name: tls_cert
   118                description: Client TLS certificate.
   119                default_value: ""
   120                required: false
   121              - name: tls_key
   122                description: Client TLS key.
   123                default_value: ""
   124                required: false
   125          examples:
   126            folding:
   127              title: Config
   128              enabled: true
   129            list:
   130              - name: Basic
   131                description: An example configuration.
   132                config: |
   133                  jobs:
   134                    - name: local
   135                      url: http://127.0.0.1:8082/metrics
   136              - name: Basic HTTP auth
   137                description: Local server with basic HTTP authentication.
   138                config: |
   139                  jobs:
   140                    - name: local
   141                      url: http://127.0.0.1:8082/metrics
   142                      username: foo
   143                      password: bar
   144              - name: Multi-instance
   145                description: |
   146                  > **Note**: When you define multiple jobs, their names must be unique.
   147                  
   148                  Local and remote instances.
   149                config: |
   150                  jobs:
   151                    - name: local
   152                      http://127.0.0.1:8082/metrics
   153                  
   154                    - name: remote
   155                      http://192.0.2.0:8082/metrics
   156      troubleshooting:
   157        problems:
   158          list: []
   159      alerts: []
   160      metrics:
   161        folding:
   162          title: Metrics
   163          enabled: false
   164        description: ""
   165        availability: []
   166        scopes:
   167          - name: entrypoint, protocol
   168            description: These metrics refer to the endpoint.
   169            labels: []
   170            metrics:
   171              - name: traefik.entrypoint_requests
   172                description: Processed HTTP requests
   173                unit: requests/s
   174                chart_type: stacked
   175                dimensions:
   176                  - name: 1xx
   177                  - name: 2xx
   178                  - name: 3xx
   179                  - name: 4xx
   180                  - name: 5xx
   181              - name: traefik.entrypoint_request_duration_average
   182                description: Average HTTP request processing time
   183                unit: milliseconds
   184                chart_type: stacked
   185                dimensions:
   186                  - name: 1xx
   187                  - name: 2xx
   188                  - name: 3xx
   189                  - name: 4xx
   190                  - name: 5xx
   191              - name: traefik.entrypoint_open_connections
   192                description: Open connections
   193                unit: connections
   194                chart_type: stacked
   195                dimensions:
   196                  - name: a dimension per HTTP method