github.com/netdata/go.d.plugin@v0.58.1/modules/whoisquery/integrations/domain_expiration_date.md (about)

     1  <!--startmeta
     2  custom_edit_url: "https://github.com/netdata/go.d.plugin/edit/master/modules/whoisquery/README.md"
     3  meta_yaml: "https://github.com/netdata/go.d.plugin/edit/master/modules/whoisquery/metadata.yaml"
     4  sidebar_label: "Domain expiration date"
     5  learn_status: "Published"
     6  learn_rel_path: "Data Collection/Synthetic Checks"
     7  most_popular: False
     8  message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
     9  endmeta-->
    10  
    11  # Domain expiration date
    12  
    13  
    14  <img src="https://netdata.cloud/img/globe.svg" width="150"/>
    15  
    16  
    17  Plugin: go.d.plugin
    18  Module: whoisquery
    19  
    20  <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
    21  
    22  ## Overview
    23  
    24  This collector monitors the remaining time before the domain expires.
    25  
    26  
    27  
    28  
    29  This collector is supported on all platforms.
    30  
    31  This collector supports collecting metrics from multiple instances of this integration, including remote instances.
    32  
    33  
    34  ### Default Behavior
    35  
    36  #### Auto-Detection
    37  
    38  This integration doesn't support auto-detection.
    39  
    40  #### Limits
    41  
    42  The default configuration for this integration does not impose any limits on data collection.
    43  
    44  #### Performance Impact
    45  
    46  The default configuration for this integration is not expected to impose a significant performance impact on the system.
    47  
    48  
    49  ## Metrics
    50  
    51  Metrics grouped by *scope*.
    52  
    53  The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
    54  
    55  
    56  
    57  ### Per domain
    58  
    59  These metrics refer to the configured source.
    60  
    61  Labels:
    62  
    63  | Label      | Description     |
    64  |:-----------|:----------------|
    65  | domain | Configured source |
    66  
    67  Metrics:
    68  
    69  | Metric | Dimensions | Unit |
    70  |:------|:----------|:----|
    71  | whoisquery.time_until_expiration | expiry | seconds |
    72  
    73  
    74  
    75  ## Alerts
    76  
    77  
    78  The following alerts are available:
    79  
    80  | Alert name  | On metric | Description |
    81  |:------------|:----------|:------------|
    82  | [ whoisquery_days_until_expiration ](https://github.com/netdata/netdata/blob/master/health/health.d/whoisquery.conf) | whoisquery.time_until_expiration | time until the domain name registration expires |
    83  
    84  
    85  ## Setup
    86  
    87  ### Prerequisites
    88  
    89  No action required.
    90  
    91  ### Configuration
    92  
    93  #### File
    94  
    95  The configuration file name for this integration is `go.d/whoisquery.conf`.
    96  
    97  
    98  You can edit the configuration file using the `edit-config` script from the
    99  Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory).
   100  
   101  ```bash
   102  cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
   103  sudo ./edit-config go.d/whoisquery.conf
   104  ```
   105  #### Options
   106  
   107  The following options can be defined globally: update_every, autodetection_retry.
   108  
   109  
   110  <details><summary>Config options</summary>
   111  
   112  | Name | Description | Default | Required |
   113  |:----|:-----------|:-------|:--------:|
   114  | update_every | Data collection frequency. | 1 | no |
   115  | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
   116  | source | Domain address. |  | yes |
   117  | days_until_expiration_warning | Number of days before the alarm status is warning. | 30 | no |
   118  | days_until_expiration_critical | Number of days before the alarm status is critical. | 15 | no |
   119  | timeout | The query timeout in seconds. | 5 | no |
   120  
   121  </details>
   122  
   123  #### Examples
   124  
   125  ##### Basic
   126  
   127  Basic configuration example
   128  
   129  <details><summary>Config</summary>
   130  
   131  ```yaml
   132  jobs:
   133    - name: my_site
   134      source: my_site.com
   135  
   136  ```
   137  </details>
   138  
   139  ##### Multi-instance
   140  
   141  > **Note**: When you define more than one job, their names must be unique.
   142  
   143  Check the expiration status of the multiple domains.
   144  
   145  
   146  <details><summary>Config</summary>
   147  
   148  ```yaml
   149  jobs:
   150    - name: my_site1
   151      source: my_site1.com
   152  
   153    - name: my_site2
   154      source: my_site2.com
   155  
   156  ```
   157  </details>
   158  
   159  
   160  
   161  ## Troubleshooting
   162  
   163  ### Debug Mode
   164  
   165  To troubleshoot issues with the `whoisquery` collector, run the `go.d.plugin` with the debug option enabled. The output
   166  should give you clues as to why the collector isn't working.
   167  
   168  - Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
   169    your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
   170  
   171    ```bash
   172    cd /usr/libexec/netdata/plugins.d/
   173    ```
   174  
   175  - Switch to the `netdata` user.
   176  
   177    ```bash
   178    sudo -u netdata -s
   179    ```
   180  
   181  - Run the `go.d.plugin` to debug the collector:
   182  
   183    ```bash
   184    ./go.d.plugin -d -m whoisquery
   185    ```
   186  
   187