mirror/AdGuardDNS
1
0
Fork 0
mirror of https://github.com/AdguardTeam/AdGuardDNS.git synced 2025-12-23 23:38:37 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
AdGuardDNS/doc/configuration.md
Andrey Meshkov c1ba1c877a Sync v2.17.0
2025-11-07 13:47:40 +03:00

49 KiB
Raw Permalink Blame History

AdGuard DNS configuration file

Besides the environment, AdGuard DNS uses a YAML file to store configuration. See file config.dist.yml for a full example of a configuration file with comments.

Contents

Recommended values and notes

Result cache sizes

According to AdGuard DNS usage data:

  • requests for the top 1000 most commonly requested domains account for approximately 85 % of all queries;
  • requests for the top 10 000 most commonly requested domains account for approximately 95 % of all queries;
  • requests for the top 50 000 most commonly requested domains account for approximately 98 % of all queries;
  • requests for the top 100 000 most commonly requested domains account for approximately 99 % of all queries.

But these statistics are only about domain names and do not account for differences in question types (A, AAAA, HTTPS, etc.) or whether a cached record is a question or an answer.

So, for example, if you want to reach 95 % cache-hit rate for a cache that includes a question type in its cache key and also caches questions separately from answers, you'll need to multiply the value from the statistic by 5 or 6.

SO_RCVBUF and SO_SNDBUF on Linux

On Linux OSs the values for these socket options coming from the configuration file (parameters network.so_rcvbuf and network.so_sndbuf) is doubled, and the maximum and minimum values are controlled by the values in /proc/. See man 7 socket:

SO_RCVBUF

[…] The kernel doubles this value (to allow space for bookkeeping overhead) when it is set using setsockopt(2), and this doubled value is returned by getsockopt(2). The default value is set by the /proc/sys/net/core/rmem_default file, and the maximum allowed value is set by the /proc/sys/net/core/rmem_max file. The minimum (doubled) value for this option is 256.

[…]

SO_SNDBUF

[…] The default value is set by the /proc/sys/net/core/wmem_default file, and the maximum allowed value is set by the /proc/sys/net/core/wmem_max file. The minimum (doubled) value for this option is 2048.

The maximum value for these parameters is the maximum value of a 32-bit signed integer (2147483647).

Stream connection limit

Currently, there are the following recommendations for parameters ratelimit.connection_limit.stop and ratelimit.connection_limit.resume:

  • stop should be about 25 % above the current maximum daily number of used TCP sockets. That is, if the instance currently has a maximum of 100 000 TCP sockets in use every day, stop should be set to about 125000.

  • resume should be about 20 % above the current maximum daily number of used TCP sockets. That is, if the instance currently has a maximum of 100 000 TCP sockets in use every day, resume should be set to about 120000.

Note

The number of active stream-connections includes sockets that are in the process of accepting new connections but have not yet accepted one. That means that resume should be greater than the number of bound addresses.

These recommendations are to be revised based on the metrics.

Rate limiting

The ratelimit object has the following properties:

  • refuseany: If true, refuse DNS queries with the ANY (aka *) type.

    Example: true.

  • response_size_estimate: The size of one DNS response for the purposes of rate limiting. If a DNS response is larger than this value, it is counted as several responses.

    Example: 1KB.

  • backoff_period: The time during which to count the number of requests that a client has sent over the RPS.

    Example: 10m.

  • backoff_duration: How long a client that has hit the RPS too often stays in the backoff state.

    Example: 30m.

  • ipv4: The ipv4 configuration object. It has the following fields:

    • count: Requests per configured interval for one subnet for IPv4 addresses. Requests above this are counted in the backoff count.

      Example: 300.

    • interval: The time during which to count the number of requests.

      Example: 10s.

    • ipv4-subnet_key_len: The length of the subnet prefix used to calculate rate limiter bucket keys.

      Example: 24.

  • ipv6: The ipv6 configuration object has the same properties as the ipv4 one above.

  • backoff_count: Maximum number of requests a client can make above the RPS within a backoff_period. When a client exceeds this limit, requests aren't allowed from client's subnet until backoff_duration ends.

    Example: 1000.

  • allowlist: The allowlist configuration object. It has the following fields:

    • list: The array of the allowed IPs or CIDRs.

      Property example:

      'list':
  - '192.168.1.4'
  - '192.175.2.1/16'

    • refresh_interval: How often AdGuard DNS refreshes the dynamic part of its allowlist from the data received from the specified data source, as a human-readable duration.

      Example: 30s.

For example, if backoff_period is 1m, backoff_count is 10, ipv4-count is 5, and ipv4-interval is 1s, a client (meaning all IP addresses within the subnet defined by ipv4-subnet_key_len) that made 15 requests in one second or 6 requests (one above rps) every second for 10 seconds within one minute, the client is blocked for backoff_duration.

Stream connection limit

The connection_limit object has the following properties:

  • enabled: Whether or not the stream-connection limit should be enforced.

    Example: true.

  • stop: The point at which the limiter stops accepting new connections. Once the number of active connections reaches this limit, new connections wait for the number to decrease to or below resume.

    Example: 1000.

  • resume: The point at which the limiter starts accepting new connections again after reaching stop.

    Example: 800.

See also notes on these parameters.

QUIC rate limiting

The quic object has the following properties:

  • enabled: Whether or not the QUIC connections rate limiting should be enforced.

    Example: true.

  • max_streams_per_peer: The maximum number of concurrent streams that a peer is allowed to open.

    Example: 1000.

TCP rate limiting

The tcp object has the following properties:

  • enabled: Whether or not the TCP rate limiting should be enforced.

    Example: true.

  • max_pipeline_count: The maximum number of simultaneously processing TCP messages per one connection.

    Example: 1000.

Cache

The cache object has the following properties:

  • type: The type of cache to use. Can be simple (a simple LRU cache) or ecs (a ECS-aware LRU cache). If set to ecs, ecs_size must be greater than zero.

    Example: simple.

  • size: The total number of items in the cache for hostnames with no ECS support. Must be greater than or equal to zero. If zero, cache is disabled.

    Example: 10000.

  • ecs_size: The total number of items in the cache for hostnames with ECS support.

    Example: 10000.

  • ttl_override: The object describes cache TTL override mechanics. It has the following properties:

    • enabled: If true, the TTL overrides are enabled.

    • min: The minimum duration for TTL for cache items of both caches, with and without ECS support. The recommended value is 60s.

    Property example:

    'ttl_override':
    'enabled': true
    'min': 60s

Upstream

The upstream object has the following properties:

  • servers: The array of the main upstream servers URLs, in the [scheme://]ip:port format and its timeouts for main upstream DNS requests, as a human-readable duration.

    Property example:

    'servers':
  # Regular DNS (over UDP with TCP fallback).
  - address: '8.8.8.8:53'
    timeout: 2s
  # Regular DNS (over TCP).
  - address: 'tcp://1.1.1.1:53'
    timeout: 2s
  # Regular DNS (over UDP).
  - address: 'udp://1.1.1.1:53'
    timeout: 2s

  • fallback: Fallback servers configuration. It has the following properties:

    • servers: The array of the fallback upstream servers URLs, in the [scheme://]ip:port format and its timeouts for upstream DNS requests, as a human-readable duration. These are use used in case a network error occurs while requesting the main upstream server. This property has the same format as upstream-servers above.

      Property example:

      'servers':
  - address: '1.1.1.1:53'
    timeout: 2s
  - address: '[2001:4860:4860::8888]:53'
    timeout: 2s

  • healthcheck: Healthcheck configuration. See below.

Healthcheck

If enabled is true, the upstream healthcheck is enabled. The healthcheck worker probes the main upstreams with an A query for a domain created from domain_template. If there is an error, timeout, or a response different from a NOERROR one then the main upstream is considered down, and all requests are redirected to fallback upstream servers for the time set by backoff_duration. Afterwards, if a worker probe is successful, AdGuard DNS considers the connection to the main upstream as restored, and requests are routed back to it.

  • enabled: If true, the upstream healthcheck is enabled.

    Example: true.

  • interval: How often AdGuard DNS makes upstream healthcheck requests, as a human-readable duration.

    Example: 2s.

  • timeout: Timeout for all outgoing healthcheck requests, as a human-readable duration.

    Example: 1s.

  • backoff_duration: Backoff duration after failed healthcheck request, as a human-readable duration. If the main upstream is down, AdGuardDNS does not return back to using it until this time has passed. The healthcheck is still performed, and each failed check advances the backoff.

    Example: 30s.

  • domain_template: The template for domains used to perform healthcheck queries. If the domain_template contains the string ${RANDOM}, all occurrences of this string are replaced with a random string (currently, a hexadecimal form of a 64-bit integer) on every healthcheck query. Queries must return a NOERROR response.

    Example: ${RANDOM}.neverssl.com.

  • network_override: If not empty, it overrides the upstream's own network type for healthcheck queries.

    Example: tcp.

DNS

The dns object has the following properties:

  • read_timeout: The timeout for any read from a UDP connection or the first read from a TCP/TLS connection, as a human-readable duration. It currently doesn't affect DNSCrypt, QUIC, or HTTPS.

    Example: 2s.

  • tcp_idle_timeout: The timeout for consecutive reads from a TCP/TLS connection, as a human-readable duration. It currently doesn't affect DNSCrypt, QUIC, or HTTPS.

    Example: 30s.

  • write_timeout: The timeout for writing to a UDP or TCP/TLS connection, as a human-readable duration. It currently doesn't affect DNSCrypt, QUIC, or HTTPS.

    Example: 2s.

  • handle_timeout: The timeout for the entire handling of a single query, as a human-readable duration.

    Example: 1s.

  • max_udp_response_size: The maximum size of DNS response over UDP protocol.

    Example: 1024B.

DNSDB

The dnsdb object has the following properties:

  • enabled: If true, the DNSDB memory buffer is enabled.

    Example: true.

  • max_size: The maximum number of records in the in-memory buffer. The record key is a combination of the target hostname from the question and the resource-record type of the question or the answer.

    Example: 500000.

Backend

The backend object has the following properties:

  • timeout: Timeout for all outgoing HTTP requests to the backend, as a human-readable duration. Set to 0s to disable timeouts.

    Example: 10s.

  • refresh_interval: How often AdGuard DNS checks the backend for data updates, as a human-readable duration.

    Example: 1m.

  • full_refresh_interval: How often AdGuard DNS performs a full profile refresh, as a human-readable duration. If PROFILES_CACHE_PATH is set, the profile cache is also saved after a full refresh.

    Example: 24h.

  • full_refresh_retry_interval: How long to wait before attempting a new full profile synchronization after a failure, as a human-readable duration. It is recommended to keep this value greater than refresh_interval.

    Example: 1h.

  • bill_stat_interval: How often AdGuard DNS sends the billing statistics to the backend, as a human-readable duration.

    Example: 1m.

Query log

The query_log object has the following properties:

  • file: The file query log configuration object. It has the following properties:

    • enabled: If true, the JSONL file query logging is enabled.

      Property example:

      'file':
    'enabled': true

GeoIP database

The geoip object has the following properties:

  • host_cache_size: The size of the host lookup cache, in entries.

    Example: 100000.

  • ip_cache_size: The size of the IP lookup cache, in entries.

    Example: 100000.

  • refresh_interval: Interval between the GeoIP database refreshes, as a human-readable duration.

    Example: 5m.

DNS-server check

The check object has the following properties:

  • domains: The domain suffixes to which random IDs are prepended using a hyphen.

    Property example:

    'domains':
  - 'dnscheck.example.com'
  - 'checkdns.example.com'

  • node_location: The location code of this server node.

    Example: ams.

  • ipv4 and ipv6: Arrays of IPv4 or IPv6 addresses with which to respond to A and AAAA queries correspondingly. Generally, those should be the IP addresses of the AdGuard DNS main HTTP API for the DNS server check feature to work properly. In a development setup, that means the localhost addresses.

    Property examples:

    'ipv4':
  - '1.2.3.4'
  - '5.6.7.8'
'ipv6':
  - '1234::cdee'
  - '1234::cdef'

TLS

The tls object has the following properties:

  • enabled: If true, the TLS certificates are used. Otherwise, any object supporting TLS should be configured to not use it.

    Example: true.

  • certificate_groups: The object maps certificate names to the certificate's file path and its private key's file path. The name of each certificate should be unique and should contain no more than 64 characters, which should be a-z, A-Z, 0-9, -, or _.

    Property example:

    'certificate_groups':
    'example-cert':
        'certificate': '/path/to/cert.crt'
        'key': '/path/to/cert.key'

Web API

The optional web object has the following properties:

  • linked_ip: The optional linked IP and dynamic DNS (DDNS, DynDNS) web server configuration. The static content is not served on these addresses.

    See the full description of this API on the HTTP API page.

    Property bind has the same format as non_doh_bind below.

    Property example:

    'linked_ip':
    'bind':
      - 'address': '127.0.0.1:80'
      - 'address': '127.0.0.1:443'
        'certificate_groups':
          - 'name': 'example-cert'

  • safe_browsing: The optional safe browsing block-page web server configurations. Every request is responded with the content from the file to which the block_page property points.

    See the full description of this API on the HTTP API page.

    Property bind has the same format as non_doh_bind below. The addresses should be different from the adult_blocking server, and the same as the ones of the block_host property in the safe_browsing and adult_blocking objects correspondingly.

    While this object is optional, both bind and block_page properties within them are required.

    Property examples:

    'safe_browsing':
  'bind':
    - 'address': '127.0.0.1:80'
    - 'address': '127.0.0.1:443'
      'certificate_groups':
        - 'name': 'example-cert'
  'block_page': '/var/www/block_page.html'

  • adult_blocking: The optional adult block-page web server configuration. The format of the values is the same as in the safe_browsing object above.

  • general_blocking: The optional general block-page web server configuration. The format of the values is the same as in the safe_browsing object above.

  • non_doh_bind: The optional listen addresses and optional TLS configuration for the web service in addition to the ones in the DNS-over-HTTPS handlers. The certificate_groups array has the same format as certificate_groups in a server group's TLS settings. In the special case of GET /robots.txt requests, a special response is served; this response could be overwritten with static content.

    Property example:

    'non_doh_bind':
  - 'address': '127.0.0.1:80'
  - 'address': '127.0.0.1:443'
    'certificate_groups':
      - 'name': 'example-cert'

  • static_content: The optional inline static content mapping. Not served on the linked_ip, safe_browsing and adult_blocking servers. Paths must not duplicate the ones used by the DNS-over-HTTPS server.

    Note

    This field is ignored if WEB_STATIC_DIR_ENABLED is set to 1.

    Inside of the headers map, the header Content-Type is required. The paths are case-sensitive.

    Property example:

    static_content:
    '/favicon.ico':
        content: 'base64content'
        headers:
            'Content-Type':
              - 'image/x-icon'

  • root_redirect_url: The optional URL to which non-DNS and non-Debug HTTP requests are redirected. If not set, AdGuard DNS will respond with a 404 status to all such requests.

    Example: https://adguard-dns.com/.

  • error_404 and error_500: The optional paths to the 404 page and the 500 page HTML files correspondingly. If not set, a simple plain text 404 or 500 page is served.

    Example: /var/www/404.html.

  • timeout: The timeout for server operations, as a human-readable duration.

    Example: 30s.

Safe browsing

The safe_browsing object has the following properties:

  • block_host: The host with which to respond to any requests that match the filter.

    Example: standard-block.dns.adguard.com.

  • cache_size: The size of the response cache, in entries.

    WARNING: CURRENTLY IGNORED! See AGDNS-398.

    Example: 1024.

  • cache_ttl: The TTL of the response cache, as a human-readable duration.

    Example: 1h.

  • url: The URL from which the contents can be updated. The URL must reply with a 200 status code.

    Example: https://example.com/safe_browsing.txt.

  • refresh_interval: How often AdGuard DNS refreshes the filter.

    Example: 1m.

  • refresh_timeout: The timeout for the update operation, as a human-readable duration.

    Example: 1m.

Adult-content blocking

The adult_blocking object has the same properties as the safe_browsing one above.

Filter Lists

TODO(a.garipov): Add the timeout for the blocked-service index refresh. It is currently hardcoded to 3 minutes.

The filters object has the following properties:

  • response_ttl: The default TTL to set for responses to queries for blocked or modified domains, as a human-readable duration. It is used for anonymous users. For users with profiles, the TTL from their profile settings are used.

    Example: 10s.

  • custom_filter_cache_size: The size of the LRU cache of compiled filtering rule engines for profiles with custom filtering rules, in entries. Zero means no caching, which slows down queries.

    Example: 1024.

  • safe_search_cache_size: The size of the LRU cache of the safe-search filtering results. This value applies to both general and YouTube safe-search.

    Example: 1024.

  • refresh_interval: How often AdGuard DNS refreshes the rule-list filters from the filter index, as well as the blocked services list from the blocked list index.

    Example: 1h.

  • refresh_timeout: The timeout for the entire filter update operation, as a human-readable duration. Note that filter rule-list index and each filter rule-list update operations have their own timeouts, see index_refresh_timeout and rule_list_refresh_timeout.

    Example: 5m.

  • index_refresh_timeout: The timeout for the filter rule-list index update operation, as a human-readable duration. See also refresh_timeout for the entire filter update operation.

    Example: 1m.

  • rule_list_refresh_timeout: The timeout for the filter update operation of each rule-list, including the safe-search ones, as a human-readable duration. See also refresh_timeout for the entire filter update operation.

    Example: 1m.

  • max_size: The maximum size of the downloadable content for a rule-list in a human-readable format.

    Example: 256MB.

  • rule_list_cache: Rule lists cache settings. It has the following properties:

    • enabled: If true, use the rule-list filtering result cache. This cache is not used for users' custom rules.

      Example: true.

    • rule_list_cache-size: The size of the LRU cache of the rule-list filtering results.

      Example: 10000.

  • ede_enabled: Shows if Extended DNS Error codes should be added.

    Example: true.

  • sde_enabled: Shows if the experimental Structured DNS Errors feature should be enabled. ede_enabled must be true to enable SDE.

    Example: true.

Filtering groups

The items of the filtering_groups array have the following properties:

  • id: The unique ID of this filtering group.

    Example: default.

  • rule_lists: Filtering rule lists settings. This object has the following properties:

    • enabled: Shows if rule-list filtering should be enforced. If it is set to false, the rest of the settings are ignored.

      Example: true.

    • ids: The array of rule-list IDs used in this filtering group.

      Example: [adguard_dns_default].

  • parental: Parental protection settings. This object has the following properties:

    • enabled: Shows if any kind of parental protection filtering should be enforced at all. If it is set to false, the rest of the settings are ignored.

      Example: true.

    • block_adult: If true, adult content blocking is enabled for this filtering group by default. Requires enabled to also be true.

      Example: true.

    • general_safe_search: If true, general safe search is enabled for this filtering group by default. Requires enabled to also be true.

      Example: true.

    • youtube_safe_search: If true, YouTube safe search is enabled for this filtering group by default. Requires enabled to also be true.

      Example: true.

  • safe_browsing: General safe browsing settings. This object has the following properties:

    • enabled: Shows if the general safe browsing filtering should be enforced. If it is set to false, the rest of the settings are ignored.

      Example: true.

    • block_dangerous_domains: Shows if the dangerous domains filtering should be enforced.

      Example: true.

    • block_newly_registered_domains: Shows if the newly registered domains filtering should be enforced.

      Example: true.

  • block_chrome_prefetch: If true, Chrome prefetch domain queries are blocked for requests using this filtering group, forcing the prefetch proxy into preflight mode.

    Example: true.

  • block_firefox_canary: If true, Firefox canary domain queries are blocked for requests using this filtering group.

    Example: true.

  • private_relay: If true, Apple Private Relay queries are blocked for requests using this filtering group.

    Example: false.

Network interface listeners

Note

The network interface listening works only on Linux with SO_BINDTODEVICE support (2.0.30 and later) and properly setup IP routes. See the section on testing SO_BINDTODEVICE using Docker.

The interface_listeners object has the following properties:

  • channel_buffer_size: The size of the buffers of the channels used to dispatch TCP connections and UDP sessions.

    Example: 1000.

  • list: The mapping of interface-listener IDs to their configuration.

    Property example:

    list:
    'eth0_plain_dns':
        interface: 'eth0'
        port: 53
    'eth0_plain_dns_secondary':
        interface: 'eth0'
        port: 5353

Server groups

The items of the server_groups array have the following properties:

  • name: The unique name of this server group.

    Example: adguard_dns_default.

  • filtering_group: The default filtering group for this server group. It is used for anonymous users.

    Example: default.

  • ddr: The DDR configuration object. See below.

  • tls: The TLS configuration object. See below.

    Note

    The tls object is optional unless the servers array contains at least one item with an encrypted protocol.

  • profiles_enabled: If true, enable recognition of user devices and profiles for this server group.

    Example: true.

  • servers: Server configuration for this filtering group. See below.

DDR

The DDR configuration object. Many of these data duplicate data from objects in the servers array. This was done because there was an opinion that a more restrictive configuration that automatically collected the required data was not self-describing and flexible enough.

  • enabled: Shows if DDR queries are processed. If it is set to false, DDR domain name queries receive an NXDOMAIN response.

    Example: true.

  • device_records: The device ID wildcard to record template mapping. The keys should generally be kept in sync with the device_id_wildcards field of the tls object.

    The values have the following properties:

    • doh_path: The path template for the DoH DDR SVCB records. It is optional, unless https_port below is set.

    • https_port: The optional port to use in DDR responses about the DoH resolver. If it is zero, the DoH resolver address is not included into the answer. A non-zero https_port should not be the same as tls_port below.

    • quic_port: The optional port to use in DDR responses about the DoQ resolver. If it is zero, the DoQ resolver address is not included into the answer.

    • tls_port: The optional port to use in DDR responses about the DoT resolver. If it is zero, the DoT resolver address is not included into the answer. A non-zero tls_port should not be the same as https_port above.

    • ipv4_hints: The optional hints about the IPv4-addresses of the server.

    • ipv6_hints: The optional hints about the IPv6-addresses of the server.

    Property example:

    'device_records':
    '*.d.dns.example.com':
        doh_path: '/dns-query{?dns}'
        https_port: 443
        quic_port: 853
        tls_port: 853
        ipv4_hints:
          - 1.2.3.4
        ipv6_hints:
          - '2001::1234'
    '*.e.dns.example.org':
        doh_path: '/dns-query{?dns}'
        https_port: 10443
        quic_port: 10853
        tls_port: 10853
        ipv4_hints:
          - 5.6.7.8
        ipv6_hints:
          - '2001::5678'

  • public_records: The public domain name to DDR record template mapping. The format of the values is the same as in the device_records above.

TLS

  • certificate_groups: The array of objects with names of the certificates to use for servers with standard encrypted protocols within the group. See certificate_groups.

    Property example:

    'certificate_groups':
  - 'name': 'example-cert'

  • session_keys: The array of file paths from which the each server's TLS session keys are updated. Session ticket key files must contain at least 32 bytes.

    Property example:

    'session_keys':
  - './private/key_1'
  - './private/key_2'

  • device_id_wildcards: The array of domain name wildcards to use to detect clients' device IDs. Use this to prevent conflicts when using certificates for subdomains.

    Property example:

    'device_id_wildcards':
  - '*.d.dns.example.com'

Servers

The items of the servers array have the following properties:

  • name: The unique name of this server.

    Example: default_dns.

  • protocol: The protocol to use on this server. The following values are supported:

    • dns
    • dnscrypt
    • https
    • quic
    • tls

    Example: dns.

  • linked_ip_enabled: If true, use the profiles' linked IPs to detect.

    Default: false.

    Example: true.

  • bind_addresses: The array of ip:port addresses to listen on. If bind_addresses is set, bind_interfaces (see below) should not be set.

    Example: [127.0.0.1:53, 192.168.1.1:53].

  • bind_interfaces: The array of interface listener data. If bind_interfaces is set, bind_addresses (see above) should not be set.

    Property example:

    'bind_interfaces':
  - 'id': 'eth0_plain_dns'
    'subnets':
      - '172.17.0.0/16'
  - 'id': 'eth0_plain_dns_secondary'
    'subnets':
      - '172.17.0.0/16'

  • dnscrypt: The optional DNSCrypt configuration object. It has the following properties:

    • config_path: The path to the DNSCrypt configuration file. See the configuration section of the DNSCrypt module.

      Must not be set if inline is set.

      Example: /etc/dns/dnscrypt.yml

    • inline: The DNSCrypt configuration, inline. See the configuration section of the DNSCrypt module.

      Must not be set if config_path is set.

      Property example:

      'inline':
  'provider_name': '2.dnscrypt-cert.example.org'
  'public_key': 'F11DDBCC4817E543845FDDD4CB881849B64226F3DE397625669D87B919BC4FB0'
  'private_key': '5752095FFA56D963569951AFE70FE1690F378D13D8AD6F8054DFAA100907F8B6F11DDBCC4817E543845FDDD4CB881849B64226F3DE397625669D87B919BC4FB0'
  'resolver_secret': '9E46E79FEB3AB3D45F4EB3EA957DEAF5D9639A0179F1850AFABA7E58F87C74C4'
  'resolver_public': '9327C5E64783E19C339BD6B680A56DB85521CC6E4E0CA5DF5274E2D3CE026C6B'
  'es_version': 1
  'certificate_ttl': 8760h

Connectivity check

The connectivity_check object has the following properties:

  • probe_ipv4: The IPv4 address with port to which a connectivity check is performed.

    Example: 8.8.8.8:53.

  • probe_ipv6: The optional IPv6 address with port to which a connectivity check is performed. This field is required in case of any IPv6 address in bind_addresses.

    Example: [2001:4860:4860::8888]:53.

Network settings

The network object has the following properties:

  • so_rcvbuf: The size of socket receive buffer (SO_RCVBUF), in a human-readable format. Default is zero, which means use the default system settings.

    See also notes on these parameters.

    Example: 1MB.

  • so_sndbuf: The size of socket send buffer (SO_SNDBUF), in a human-readable format. Default is zero, which means use the default system settings.

    See also notes on these parameters.

    Example: 1MB.

Access settings

The access object has the following properties:

Additional metrics information

The additional_metrics_info object is a map of strings with extra information which is exposed by dns_app_additional_info metric.

Map keys must match regular expression ^[a-zA-Z_][a-zA-Z0-9_]*$. See Prometheus documentation on valid labels.

Property example:

'additional_metrics_info':
    'info_key_1': 'info_value_1'
    'info_key_2': 'info_value_2'

The Prometheus metrics key is additional_info. For example:

# HELP dns_app_additional_info A metric with a constant '1' value labeled by additional info provided in configuration
# TYPE dns_app_additional_info gauge
dns_app_additional_info{info_key_1="info_value_1",info_key_2="info_value_2"} 1
Reference in New Issue View Git Blame Copy Permalink