Configuring DNS Observer jobs
Using the DNS Observer, you can query internal DNS server performance, and use the returned information on response times and service addresses to create topologies within the topology service. The DNS Observer supports forward and reverse job types, with 'recurse' or 'no recurse' options.
Before you begin
Ensure you have the DNS access details to hand, such as DNS server, address types and port numbers.
Tip: The relationship types can be customized with line color, width and pattern functions. For more information, see the Creating custom relationship type styles topic.
Enabling access to the URL routes
To access the URL routes for the topology Swagger documentation, see the Enabling access to URL routes topic.
About this task
The DNS Observer provides DNS query services and topological insight into how a specified DNS server is performing forward (name-to-IP address) or reverse (IP address-to-name) lookups. Query results include a list of addresses, information on how long it takes the DNS server to resolve a lookup, and, optionally (with the maximum number of recursive calls set at 200) how the DNS server is recursively resolving a given name or IP address.
Note: The DNS observer models the resources based on the DNS lookup record. A separate set of resources will be created for IPv4 and IPv6 discovery of the same domain name.
You define and start the following jobs.
Reverse lookup job
A transient (one-off) Load job that loads all requested DNS reverse (IP address-to-name) lookup topology data.
By default, Load jobs are one-off, transient jobs that upload all of the requested topology data as soon as they are triggered.
You can also run these jobs (again) from the Observer UI, or schedule them to run at set times when configuring them.
Forward lookup job
A transient (one-off) Load job that loads all requested DNS forward (name-to-IP address) lookup topology data.
Procedure
Define or edit the following parameters, then click Run job to save and run the job.
Encryption requirement: For more information, see the Configuring observer jobs security topic.
Reverse lookup job parameters
| Parameter | Action | Details |
|---|---|---|
| Unique ID | Enter a unique name for the job | Required |
| IP address | Enter the host or internet name to look up | Required |
| Server | Specify the DNS server | Required |
| Port | Specify the UDP DNS port | Optional |
| Address type | Specify either IPV4 or IPV6. |
Optional |
| Recursive query | Toggle True or False | Optional. If set to True, the maximum number of calls is set at 200. |
| Access scope | Enter text to provide a scope for the resources. Access scope can help map alerts to resources when resources in different scopes share the same parameters, such as matchTokens. | Optional. Tip: You can define access scope for locations, project names, namespaces, etc. |
| Generate debug support file | Set this parameter to 'True' in order to capture the output of the next scheduled job run as a file. This file will be stored with an observer's log files and can be used to debug observer issues, for example at the request of your designated support team, or while using a test environment. For one-off jobs (that is, Load jobs), this parameter reverts to 'False' after the next completed run. To examine the output produced, you can load the generated debug file using the File Observer. | Optional |
| Observer job description | Enter additional information to describe the job | Optional |
| Job schedule | Specify when the job runs | Optional. Load jobs only. |
Forward lookup job parameters
| Parameter | Action | Details |
|---|---|---|
| Unique ID | Enter a unique name for the job | Required |
| Domain name | Specify a domain | Required |
| Address Types | Specify the address types to be observed | Required. Select either IPv4 or IPv6. |
| Server | Specify the DNS server | Required |
| Port | Specify the UDP DNS port | Optional |
| Address type | Specify either IPV4 or IPV6. |
Optional |
| Recursive query | Toggle True or False | Optional. If set to True, the maximum number of calls is set at 200. |
| Access scope | Enter text to provide a scope for the resources. Access scope can help map alerts to resources when resources in different scopes share the same parameters, such as matchTokens. | Optional. Tip: You can define access scope for locations, project names, namespaces, etc. |
| Generate debug support file | Set this parameter to 'True' in order to capture the output of the next scheduled job run as a file. This file will be stored with an observer's log files and can be used to debug observer issues, for example at the request of your designated support team, or while using a test environment. For one-off jobs (that is, Load jobs), this parameter reverts to 'False' after the next completed run. To examine the output produced, you can load the generated debug file using the File Observer. | Optional |
| Observer job description | Enter additional information to describe the job | Optional |
| Job schedule | Specify when the job runs | Optional. Load jobs only. |