When debugging issues in ConfD, one should have a good understanding of what is involved inside and outside of ConfD when the issue is reproduced. Relying on a single tool or a single log file is generally not sufficient. In order to be able to trace a problem to its root cause, one will most likely have to rely on several tools/logs and be able to correlate all of the information. A good understanding of which logs are available, how to configure them and what tools should be used is essential to this effort.
ConfD, just like any other software framework, can be integrated with many different components in a system. While ConfD comes with a great number of features and several components such as the different northbound interfaces, for example, it can also be extended with third-party components, such as the demons running southbound, configuration validators, user authentication mechanisms, HA, etc., rendering the ConfD ecosystem more complex to debug. Troubleshooting problems can easily become exhausting if one doesn’t first understand how ConfD works and second, doesn’t know what tools exist to debug different kinds of issues.
Our previous version of the ConfD Troubleshooting Guide helped the reader understand the available logs that can be configured and the different commands that can be used to gather relevant information. This great guide has seen a major update now due to the addition of several new features that make ConfD debugging easier.
You can see how ConfD has evolved over the past few years in terms of new features being added to provide more insight to the developer such as the Progress Trace feature, the preflight check command that helps identify potential configuration issues with ConfD, the new log files one can configure, as well as other new features.
With this in mind, we have created a new version of the guide to provide you with an overview of all the possible tools you can use to debug different problems. It is not meant to go deeper into each log or command option or API, but it is a great way to find pointers to what can be used for debugging all in one single document.
The ConfD Troubleshooting Guide starts with a list of all the possible log files you can configure and use, along with a short description. Once you are aware of what exists, you can consult the ConfD User Guide for more details. The guide then goes into the different tools that help the user check the state of ConfD, verify the callbacks ConfD depends on, collect debug information, yanger, and other important tools.
A large portion of the guide is dedicated to debugging user-written code, timeouts, and locks related issues, and more. An application logging framework is also introduced in this guide.
Lastly, a section is dedicated to how to be productive working with the ConfD Support team. Providing self-contained examples is discussed as one great way of reaching a resolution faster.
We hope you take full advantage of the ConfD Troubleshooting Guide to help you troubleshoot and debug your ConfD applications in your quest for network programmability.
>>Get your copy now