Job Result and Logging

[mattmiller87]

Environment

• Python version: 3.8
• Nautobot version: 1.4.2
• nautobot-golden-config version: 1.2.0

Proposed Functionality

When viewing completed Golden Config jobs, it would be useful to see the filters used to submit the job. It would be awesome to have clickable links to objects like "site" instead of having the site UUID in the advanced display. Additionally, more debugging logs as a step in the job for addressing issues.

Use Case

In order to re-run a job, or start from a similar place as a previous run job, having the information used to start the job would be very useful before queuing the next. This means that the post run information would contain the filters and would have links to objects used to create the job.
When trying to troubleshoot a failed job, having knowledge of where the job failed with detailed debug logging would give a nautobot admin the ability to identify the issue more quickly.

[itdependsnetworks]

I think there is a job logging gap, so much that I created this issue a while ago nautobot/nautobot#2331

That being said, to respond to your requests:

• it would be useful to see the filters used to submit the job, agreed, but this is based on what Core provides, I would open an issue there.
• Additionally, more debugging logs as a step in the job for addressing issues., this is fairly well logged, but that being said, feel free to add in any PR
• clickable links to objects like "site" instead of having the site UUID, I don't know when we use "site", and if it was more of a general statement, we link back to the object already on both the success and failure, and there should only be a single object per row.

I think this covers all of them, will close out if I don't hear anything.

[mattmiller87]

Thanks for breaking this down and addressing all the parts! I will open the job submission filter question to the core team. I will also look into getting a PR put together around the debugging logs.
Regarding clickable links, this may go to the core team as well. In the job, the logging does this correctly. However, when reviewing the job result in the advanced and additional data tabs, it would be really nice if the objects were links.