Project: Netdata (Observability and Analysis / Observability)
File: domain_expiration_date.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/whoisquery/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/whoisquery/metadata.yaml" sidebar_label: "Domain expiration date" learn_status: "Published" learnrelpath: "Collecting Metrics/Synthetic Checks" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/globe.svg" width="150"/> Plugin: go.d.plugin Module: whoisquery <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> This collector monitors the remaining time before the domain expires. This collector is supported on all platforms. This collector supports collecting metrics from multiple instances of this integration, including remote instances. This integration doesn't support auto-detection. The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the configured source. Labels: | Label | Description | |:--|:-| | domain | Configured source | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | whoisquery.timeuntilexpiration | expiry | seconds | The following alerts are available: | Alert name | On metric | Description | |:|:-|:| | | whoisquery.timeuntilexpiration | time until the domain name registration expires | No action required. The configuration file name for this integration is `go.d/whoisquery.conf`. You can edit the configuration file using the `edit-config` script from the Netdata . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/whoisquery.conf ``` The following options can be defined globally: updateevery, autodetectionretry. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | update_every | Data collection frequency. | 1 | no | | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | | source | Domain address. | | yes | | daysuntilexpiration_warning | Number of days before the alarm status is warning. | 30 | no | | daysuntilexpiration_critical | Number of days before the alarm status is critical. | 15 | no | | timeout | The query timeout in seconds. | 5 | no | </details> Basic configuration example <details><summary>Config</summary> ```yaml jobs: name: my_site source: my_site.com ``` </details> Note: When you define more than one job, their names must be unique. Check the expiration status of the multiple domains. <details><summary>Config</summary> ```yaml jobs: name: my_site1 source: my_site1.com name: my_site2 source: my_site2.com ``` </details> To troubleshoot issues with the `whoisquery` collector, run the `go.d.plugin` with the debug option enabled. The output should give you clues as to why the collector isn't working. Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m whoisquery ```