Domain expiration date icon

Domain expiration date

Domain expiration date

Plugin: go.d.plugin Module: whoisquery

Overview

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.

Default Behavior

Auto-Detection

This integration doesn’t support auto-detection.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

Prerequisites

No action required.

Configuration

File

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 config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/whoisquery.conf

Options

The following options can be defined globally: update_every, autodetection_retry.

Name Description Default Required
update_every Data collection frequency. 1 False
autodetection_retry Recheck interval in seconds. Zero means no recheck will be scheduled. 0 False
source Domain address. True
days_until_expiration_warning Number of days before the alarm status is warning. 30 False
days_until_expiration_critical Number of days before the alarm status is critical. 15 False
timeout The query timeout in seconds. 5 False

Examples

Basic

Basic configuration example

jobs:
  - name: my_site
    source: my_site.com

Multi-instance

Note: When you define more than one job, their names must be unique.

Check the expiration status of the multiple domains.

jobs:
  - name: my_site1
    source: my_site1.com

  - name: my_site2
    source: my_site2.com

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per domain

These metrics refer to the configured source.

Labels:

Label Description
domain Configured source

Metrics:

Metric Dimensions Unit
whoisquery.time_until_expiration expiry seconds

Alerts

The following alerts are available:

Alert name On metric Description
whoisquery_days_until_expiration whoisquery.time_until_expiration time until the domain name registration expires

Troubleshooting

Debug Mode

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].

    cd /usr/libexec/netdata/plugins.d/
    
  • Switch to the netdata user.

    sudo -u netdata -s
    
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m whoisquery
    

Get Netdata

Sign up for free

Want to see a demonstration of Netdata for multiple use cases?

Go to Live Demo