whoisquery

README

Whois domain expiry monitoring with Netdata

This collector module checks the remaining time until a domain is expired.

Metrics

All metrics have "whoisquery." prefix.

Metric	Scope	Dimensions	Units
time_until_expiration	global	expiry	seconds

Configuration

Edit the go.d/whoisquery.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/whoisquery.conf

Needs only source.

Use days_until_expiration_warning and days_until_expiration_critical for each job to indicate the expiry warning and critical days. The default values are 90 for warning, and 30 days for critical.

Here is an example:

update_every: 60

jobs:
  - name: my_site
    source: my_site.com

  - name: my_another_site
    source: my_another_site.com
    days_until_expiration_critical: 20

For all available options and defaults please, see the module's configuration file.

Troubleshooting

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
  

Documentation

Index

• type Charts
• type Config
• type Dims
• type Opts
• type Vars
• type WhoisQuery
  • func New() *WhoisQuery
  • func (wq WhoisQuery) Charts() *Charts
  • func (wq *WhoisQuery) Check() bool
  • func (WhoisQuery) Cleanup()
  • func (wq *WhoisQuery) Collect() map[string]int64
  • func (wq *WhoisQuery) Init() bool

Types

type Charts

type Charts = module.Charts

type Config

type Config struct {
	Source        string
	Timeout       web.Duration `yaml:"timeout"`
	DaysUntilWarn int64        `yaml:"days_until_expiration_warning"`
	DaysUntilCrit int64        `yaml:"days_until_expiration_critical"`
}

type Dims

type Dims = module.Dims

type Opts

type Opts = module.Opts

type Vars

type Vars = module.Vars

type WhoisQuery

type WhoisQuery struct {
	module.Base
	Config `yaml:",inline"`
	// contains filtered or unexported fields
}

func New

func New() *WhoisQuery

func (WhoisQuery) Charts

func (wq WhoisQuery) Charts() *Charts

func (*WhoisQuery) Check

func (wq *WhoisQuery) Check() bool

func (WhoisQuery) Cleanup

func (WhoisQuery) Cleanup()

func (*WhoisQuery) Collect

func (wq *WhoisQuery) Collect() map[string]int64

func (*WhoisQuery) Init

func (wq *WhoisQuery) Init() bool