Skip to content

Add gauges for DNS connection status in DNSCheck #25271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
POIFischbacherM wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add gauges for DNS connection status in DNSCheck #25271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9e2c639
Add gauges for DNS connection status in DNSCheck
POIFischbacherM Sep 18, 2026
e4898ec
Add metrics for DNS connection status in tests
POIFischbacherM Sep 18, 2026
2df8172
Add changelog entry for DNS check connection status metrics
POIFischbacherM Sep 18, 2026
a6df327
removed duplicate gauge send
POIFischbacherM Sep 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions dns_check/changelog.d/25271.added
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added metrics for connection dns_check status.
6 changes: 6 additions & 0 deletions dns_check/datadog_checks/dns_check/dns_check.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,4 +123,10 @@ def _get_tags(self):

def report_as_service_check(self, status, msg=None):
tags = self._get_tags()
if status != AgentCheck.OK:
self.gauge("dns.can_connect", 0, tags=tags)
self.gauge("dns.cant_connect", 1, tags=tags)
else:
self.gauge("dns.can_connect", 1, tags=tags)
self.gauge("dns.cant_connect", 0, tags=tags)
self.service_check(self.SERVICE_CHECK_NAME, status, tags=tags, message=msg)
2 changes: 2 additions & 0 deletions dns_check/metadata.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
metric_name,metric_type,interval,unit_name,per_unit_name,description,orientation,integration,short_name,curated_metric
dns.response_time,gauge,,second,,"The response time for DNS query for a given record, tagged by hostname, e.g. 'hostname:example.com'.",-1,dns,dns resp time,
dns.can_connect,gauge,,,"","Indicates if the DNS check can connect to the DNS server (1 for yes, 0 for no).",0,dns,dns can connect,
dns.cant_connect,gauge,,,"","Indicates if the DNS check cannot connect to the DNS server (1 for yes, 0 for no).",0,dns,dns cant connect,
2 changes: 2 additions & 0 deletions dns_check/tests/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,7 @@

def _test_check(aggregator):
aggregator.assert_metric('dns.response_time')
aggregator.assert_metric('dns.can_connect')
aggregator.assert_metric('dns.cant_connect')
aggregator.assert_all_metrics_covered()
aggregator.assert_metrics_using_metadata(get_metadata_metrics())
6 changes: 6 additions & 0 deletions dns_check/tests/test_dns_check.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ def test_success(mocked_query, mocked_time, aggregator, instance, tags):
integration.check({})
aggregator.assert_service_check(DNSCheck.SERVICE_CHECK_NAME, status=DNSCheck.OK, tags=tags, count=1)
aggregator.assert_metric('dns.response_time', tags=tags, count=1, value=1)
aggregator.assert_metric('dns.can_connect', tags=tags, count=1, value=1)
aggregator.assert_metric('dns.cant_connect', tags=tags, count=1, value=0)

# Assert coverage for this check on this instance
aggregator.assert_all_metrics_covered()
Expand All @@ -79,6 +81,8 @@ def test_success_nxdomain(mocked_query, mocked_time, aggregator):
tags = ['instance:nxdomain', 'nameserver:127.0.0.1', 'resolved_hostname:www.example.org', 'record_type:NXDOMAIN']
aggregator.assert_service_check(DNSCheck.SERVICE_CHECK_NAME, status=DNSCheck.OK, tags=tags, count=1)
aggregator.assert_metric('dns.response_time', tags=tags, count=1, value=1)
aggregator.assert_metric('dns.can_connect', tags=tags, count=1, value=1)
aggregator.assert_metric('dns.cant_connect', tags=tags, count=1, value=0)

# Assert coverage for this check on this instance
aggregator.assert_all_metrics_covered()
Expand All @@ -100,6 +104,8 @@ def test_default_timeout(mocked_query, mocked_time, aggregator):
count=1,
message="DNS resolution of www.example.org timed out",
)
aggregator.assert_metric('dns.can_connect', tags=tags, count=1, value=0)
aggregator.assert_metric('dns.cant_connect', tags=tags, count=1, value=1)

# Assert coverage for this check on this instance
aggregator.assert_all_metrics_covered()
Expand Down
Loading