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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-whoisquery
     5        plugin_name: go.d.plugin
     6        module_name: whoisquery
     7        monitored_instance:
     8          name: Domain expiration date
     9          link: ""
    10          icon_filename: globe.svg
    11          categories:
    12            - data-collection.synthetic-checks
    13        keywords:
    14          - whois
    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 monitors the remaining time before the domain expires.
    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/whoisquery.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: source
    61                description: Domain address.
    62                default_value: ""
    63                required: true
    64              - name: days_until_expiration_warning
    65                description: Number of days before the alarm status is warning.
    66                default_value: 30
    67                required: false
    68              - name: days_until_expiration_critical
    69                description: Number of days before the alarm status is critical.
    70                default_value: 15
    71                required: false
    72              - name: timeout
    73                description: The query timeout in seconds.
    74                default_value: 5
    75                required: false
    76          examples:
    77            folding:
    78              title: Config
    79              enabled: true
    80            list:
    81              - name: Basic
    82                description: Basic configuration example
    83                config: |
    84                  jobs:
    85                    - name: my_site
    86                      source: my_site.com
    87              - name: Multi-instance
    88                description: |
    89                  > **Note**: When you define more than one job, their names must be unique.
    90                  
    91                  Check the expiration status of the multiple domains.
    92                config: |
    93                  jobs:
    94                    - name: my_site1
    95                      source: my_site1.com
    96                  
    97                    - name: my_site2
    98                      source: my_site2.com
    99      troubleshooting:
   100        problems:
   101          list: []
   102      alerts:
   103        - name: whoisquery_days_until_expiration
   104          metric: whoisquery.time_until_expiration
   105          info: time until the domain name registration expires
   106          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/whoisquery.conf
   107      metrics:
   108        folding:
   109          title: Metrics
   110          enabled: false
   111        description: ""
   112        availability: []
   113        scopes:
   114          - name: domain
   115            description: These metrics refer to the configured source.
   116            labels:
   117              - name: domain
   118                description: Configured source
   119            metrics:
   120              - name: whoisquery.time_until_expiration
   121                description: Time Until Domain Expiration
   122                unit: seconds
   123                chart_type: line
   124                dimensions:
   125                  - name: expiry