Plugins and logging

[ryanmerolle]

Related Issue: #461

New Behavior

• Default logging enabled with a variable defined in the netbox.env
• Added plugins.py example file.

Contrast to Current Behavior

• Logging is not a default out of the box behavior. I am suggesting we add this in.
• A plugins wiki page exists, but adding a file example in the repo that works if uncommented, is ideal.

Discussion: Benefits and Drawbacks

• We have taken the stance, with good reason, have such examples in the only in the wiki, but whether in the wiki or the repo, users will ask for support on the feature even though its not a netbox-docker specific item.
• Adding logging is likely a useful behavior for all whether production or non-production deployments.
• Maybe we should add this plugins config to extras.py so people can set a plugins.py without worrying about it being overwritten by the repo on a git pull.

Changes to the Wiki

• Update Plugins wiki page to reference the new file.
• Add a Logging wiki page.

Proposed Release Note Entry

• Added logging as a default feature to netbox-docker. See Logging wiki page for more info.
• Added plugins.py example file.

Double Check

• I have read the comments and followed the PR template.
• I have explained my PR according to the information in the comments.
• My PR targets the develop branch.

[ryanmerolle]

@cimnine let me know your thoughts and I can adjust and remove the draft tag. I would love to get this in the next release.

[cimnine]

I don't like that the logging.py file is not all commented-in as well. Because I believe that NetBox Docker should initially ship a NetBox that is – regarding defaults – as close to the upstream as we can. What do you think?

[ryanmerolle]

I am happy to comment it out. It is good enough that a working example is included.

Any idea what is up with the 3 blocking checks? They have been waiting for status to be reported for some time now. Maybe my new commit will get it going.

[ryanmerolle]

Let me know if you want me to remove or comment out the ENV var for logging level as well.

[cimnine]

Let me know if you want me to remove or comment out the ENV var for logging level as well.

I'd go with removing it, as it will otherwise confuse users who change it that it's having no effect at all.