@cryptotaxi247 / netdata-1
Code Commits Issues Pulls Sessions CI/CD
master
master
yaml 138 lines 4.4 KB
Raw
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-testing
13 keywords:
14 - whois
15 related_resources:
16 integrations:
17 list: []
18 info_provided_to_referring_integrations:
19 description: ""
20 overview:
21 data_collection:
22 metrics_description: |
23 This collector monitors the remaining time before the domain expires.
24 method_description: ""
25 supported_platforms:
26 include: []
27 exclude: []
28 multi_instance: true
29 additional_permissions:
30 description: ""
31 default_behavior:
32 auto_detection:
33 description: ""
34 limits:
35 description: ""
36 performance_impact:
37 description: ""
38 setup:
39 prerequisites:
40 list: []
41 configuration:
42 file:
43 name: go.d/whoisquery.conf
44 options:
45 description: |
46 The following options can be defined globally: update_every, autodetection_retry.
47 folding:
48 title: Config options
49 enabled: true
50 list:
51 - name: update_every
52 description: Data collection frequency.
53 default_value: 60
54 required: false
55 group: Collection
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 group: Collection
61
62 - name: source
63 description: Domain address.
64 default_value: ""
65 required: true
66 group: Target
67 - name: timeout
68 description: The query timeout in seconds.
69 default_value: 5
70 required: false
71 group: Target
72
73 - name: days_until_expiration_warning
74 description: Number of days before the alarm status is warning.
75 default_value: 30
76 required: false
77 group: Customization
78 - name: days_until_expiration_critical
79 description: Number of days before the alarm status is critical.
80 default_value: 15
81 required: false
82 group: Customization
83
84 - name: vnode
85 description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes).
86 default_value: ""
87 required: false
88 group: Virtual Node
89 examples:
90 folding:
91 title: Config
92 enabled: true
93 list:
94 - name: Basic
95 description: Basic configuration example
96 config: |
97 jobs:
98 - name: my_site
99 source: my_site.com
100 - name: Multi-instance
101 description: |
102 > **Note**: When you define more than one job, their names must be unique.
103
104 Check the expiration status of the multiple domains.
105 config: |
106 jobs:
107 - name: my_site1
108 source: my_site1.com
109
110 - name: my_site2
111 source: my_site2.com
112 troubleshooting:
113 problems:
114 list: []
115 alerts:
116 - name: whoisquery_days_until_expiration
117 metric: whoisquery.time_until_expiration
118 info: time until the domain name registration expires
119 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/whoisquery.conf
120 metrics:
121 folding:
122 title: Metrics
123 enabled: false
124 description: ""
125 availability: []
126 scopes:
127 - name: domain
128 description: These metrics refer to the configured source.
129 labels:
130 - name: domain
131 description: Configured source
132 metrics:
133 - name: whoisquery.time_until_expiration
134 description: Time Until Domain Expiration
135 unit: seconds
136 chart_type: line
137 dimensions:
138 - name: expiry