docs: cosmetic readme fixes

This commit is contained in:
s3lph 2023-06-15 15:16:44 +02:00
parent b7bee02227
commit b640c50e0a

View file

@ -92,39 +92,39 @@ The following metrics are exposed at the `/metrics` HTTP endpoint:
```prometheus
# HELP dnssec_cds_count Number of CDS records present in the zone
# TYPE dnssec_cds_count gauge
dnssec_cds_count{parent="ch.",tld="ch.",zone="example.org."} 1
dnssec_cds_count{parent="me.",tld="me.",zone="example.com."} 1
dnssec_cds_count{parent="example.com.",tld="me.",zone="subdomain.example.com."} 1
dnssec_cds_count{parent="org.",tld="org.",zone="example.org."} 1
dnssec_cds_count{parent="com.",tld="com.",zone="example.com."} 1
dnssec_cds_count{parent="example.com.",tld="com.",zone="subdomain.example.com."} 1
# HELP dnssec_cds_ds_match 1 if the CDS and DS records match, 0 otherwise
# TYPE dnssec_cds_ds_match gauge
dnssec_cds_ds_match{parent="ch.",tld="ch.",zone="example.org."} 0
dnssec_cds_ds_match{parent="me.",tld="me.",zone="example.com."} 1
dnssec_cds_ds_match{parent="example.com.",tld="me.",zone="subdomain.example.com."} 1
dnssec_cds_ds_match{parent="org.",tld="org.",zone="example.org."} 0
dnssec_cds_ds_match{parent="com.",tld="com.",zone="example.com."} 1
dnssec_cds_ds_match{parent="example.com.",tld="com.",zone="subdomain.example.com."} 1
# HELP dnssec_cds_rcode RCode of the CDS record answer
# TYPE dnssec_cds_rcode gauge
dnssec_cds_rcode{parent="ch.",tld="ch.",zone="example.org."} 0
dnssec_cds_rcode{parent="me.",tld="me.",zone="example.com."} 0
dnssec_cds_rcode{parent="example.com.",tld="me.",zone="subdomain.example.com."} 0
dnssec_cds_rcode{parent="org.",tld="org.",zone="example.org."} 0
dnssec_cds_rcode{parent="com.",tld="com.",zone="example.com."} 0
dnssec_cds_rcode{parent="example.com.",tld="com.",zone="subdomain.example.com."} 0
# HELP dnssec_ds_count Number of DS record is present in the parent zone
# TYPE dnssec_ds_count gauge
dnssec_ds_count{parent="ch.",tld="ch.",zone="example.org."} 1
dnssec_ds_count{parent="me.",tld="me.",zone="example.com."} 1
dnssec_ds_count{parent="example.com.",tld="me.",zone="subdomain.example.com."} 1
dnssec_ds_count{parent="org.",tld="org.",zone="example.org."} 1
dnssec_ds_count{parent="com.",tld="com.",zone="example.com."} 1
dnssec_ds_count{parent="example.com.",tld="com.",zone="subdomain.example.com."} 1
# HELP dnssec_ds_rcode RCode of the DS record answer
# TYPE dnssec_ds_rcode gauge
dnssec_ds_rcode{parent="ch.",tld="ch.",zone="example.org."} 0
dnssec_ds_rcode{parent="me.",tld="me.",zone="example.com."} 0
dnssec_ds_rcode{parent="example.com.",tld="me.",zone="subdomain.example.com."} 0
dnssec_ds_rcode{parent="org.",tld="org.",zone="example.org."} 0
dnssec_ds_rcode{parent="com.",tld="com.",zone="example.com."} 0
dnssec_ds_rcode{parent="example.com.",tld="com.",zone="subdomain.example.com."} 0
# HELP dnssec_signature_ok 1 if the DNSSEC signature is present and valid, 0 otherwise
# TYPE dnssec_signature_ok gauge
dnssec_signature_ok{parent="ch.",tld="ch.",zone="example.org."} 1
dnssec_signature_ok{parent="me.",tld="me.",zone="example.com."} 1
dnssec_signature_ok{parent="example.com.",tld="me.",zone="subdomain.example.com."} 1
dnssec_signature_ok{parent="org.",tld="org.",zone="example.org."} 1
dnssec_signature_ok{parent="com.",tld="com.",zone="example.com."} 1
dnssec_signature_ok{parent="example.com.",tld="com.",zone="subdomain.example.com."} 1
# HELP dnssec_signature_rcode RCode of the DNS query
# TYPE dnssec_signature_rcode gauge
dnssec_signature_rcode{parent="ch.",tld="ch.",zone="example.org."} 0
dnssec_signature_rcode{parent="me.",tld="me.",zone="example.com."} 0
dnssec_signature_rcode{parent="example.com.",tld="me.",zone="subdomain.example.com."} 0
dnssec_signature_rcode{parent="org.",tld="org.",zone="example.org."} 0
dnssec_signature_rcode{parent="com.",tld="com.",zone="example.com."} 0
dnssec_signature_rcode{parent="example.com.",tld="com.",zone="subdomain.example.com."} 0
```
The two metrics that are probably the most important are: