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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-dockerhub
     5        plugin_name: go.d.plugin
     6        module_name: dockerhub
     7        monitored_instance:
     8          name: Docker Hub repository
     9          link: https://hub.docker.com/
    10          icon_filename: docker.svg
    11          categories:
    12            - data-collection.containers-and-vms # FIXME
    13        keywords:
    14          - dockerhub
    15        related_resources:
    16          integrations:
    17            list: []
    18        info_provided_to_referring_integrations:
    19          description: ""
    20        most_popular: false
    21      overview:
    22        data_collection:
    23          metrics_description: |
    24            This collector keeps track of DockerHub repositories statistics such as the number of stars, pulls, current status, and more.
    25          method_description: ""
    26        supported_platforms:
    27          include: []
    28          exclude: []
    29        multi_instance: true
    30        additional_permissions:
    31          description: ""
    32        default_behavior:
    33          auto_detection:
    34            description: ""
    35          limits:
    36            description: ""
    37          performance_impact:
    38            description: ""
    39      setup:
    40        prerequisites:
    41          list: []
    42        configuration:
    43          file:
    44            name: go.d/dockerhub.conf
    45          options:
    46            description: |
    47              The following options can be defined globally: update_every, autodetection_retry.
    48            folding:
    49              title: Config options
    50              enabled: true
    51            list:
    52              - name: update_every
    53                description: Data collection frequency.
    54                default_value: 1
    55                required: false
    56              - name: autodetection_retry
    57                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    58                default_value: 0
    59                required: false
    60              - name: url
    61                description: DockerHub URL.
    62                default_value: https://hub.docker.com/v2/repositories
    63                required: true
    64              - name: repositories
    65                description: List of repositories to monitor.
    66                default_value: ""
    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: dockerhub
   136                      repositories:
   137                        - 'user1/name1'
   138                        - 'user2/name2'
   139                        - 'user3/name3'
   140      troubleshooting:
   141        problems:
   142          list: []
   143      alerts: []
   144      metrics:
   145        folding:
   146          title: Metrics
   147          enabled: false
   148        description: ""
   149        availability: []
   150        scopes:
   151          - name: global
   152            description: These metrics refer to the entire monitored application.
   153            labels: []
   154            metrics:
   155              - name: dockerhub.pulls_sum
   156                description: Pulls Summary
   157                unit: pulls
   158                chart_type: line
   159                dimensions:
   160                  - name: sum
   161              - name: dockerhub.pulls
   162                description: Pulls
   163                unit: pulls
   164                chart_type: stacked
   165                dimensions:
   166                  - name: a dimension per repository
   167              - name: dockerhub.pulls_rate
   168                description: Pulls Rate
   169                unit: pulls/s
   170                chart_type: stacked
   171                dimensions:
   172                  - name: a dimension per repository
   173              - name: dockerhub.stars
   174                description: Stars
   175                unit: stars
   176                chart_type: stacked
   177                dimensions:
   178                  - name: a dimension per repository
   179              - name: dockerhub.status
   180                description: Current Status
   181                unit: status
   182                chart_type: line
   183                dimensions:
   184                  - name: a dimension per repository
   185              - name: dockerhub.last_updated
   186                description: Time Since Last Updated
   187                unit: seconds
   188                chart_type: line
   189                dimensions:
   190                  - name: a dimension per repository