nd_log - playbook-side logging#283
Open
allenrobel wants to merge 8 commits into
Open
Conversation
Local-only module that emits a Python logging record under the `nd` parent logger, configured via the existing `ND_LOGGING_CONFIG` environment variable. Useful for correlating playbook task execution with the `nd.*` records emitted internally by other cisco.nd modules. - plugins/modules/nd_log.py: NDLog class with severity dispatch (CRITICAL/DEBUG/ERROR/INFO/WARNING); uses setup_logging() from common/log.py; supports check_mode. - tests/unit/modules/test_nd_log.py: 9 tests covering init defaults, missing-msg ValueError, parametrized severity dispatch via caplog, and default-vs-explicit DEBUG equivalence. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
allenrobel
requested review from
akinross,
anvitha-jain,
gmicol,
lhercot,
mikewiebe,
mtarking,
sajagana,
samiib and
shrsr
as code owners
allenrobel
changed the title
There was a problem hiding this comment.
Pull request overview
This PR adds a new local-only Ansible module (cisco.nd.nd_log) to emit playbook-side log records under the nd.* logger hierarchy, enabling correlation between playbook execution and the collection’s internal logging.
Changes:
- Introduces
plugins/modules/nd_log.pymodule withmsg+severityparameters andsupports_check_mode=True. - Adds unit tests validating initialization defaults, missing
msgbehavior, and severity-to-log-level dispatch. - Adds an (empty)
tests/unit/modules/__init__.pyto satisfy test package structure rules.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| plugins/modules/nd_log.py | New nd_log module implementation and Ansible docs/examples. |
| tests/unit/modules/test_nd_log.py | Unit tests for NDLog initialization and logging behavior. |
| tests/unit/modules/init.py | Empty init file to establish the unit-test package. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
allenrobel
changed the title
akinross
reviewed
May 21, 2026
samiib
reviewed
May 21, 2026
Co-authored-by: Akini Ross <akinross@cisco.com>
Co-authored-by: Akini Ross <akinross@cisco.com>
Co-authored-by: Samita B <samitab@cisco.com>
Per Samita’s comments.
Address review feedback on PR #283: the NDLog class coupled to the Ansible params dict and carried unreachable `is None` checks (the argument spec's `required`/`default` guarantee those values are never None). Replace it with a module-level `log_message(severity, msg)` helper that `main()` calls directly. - Drop the 5-branch if/elif in favor of getattr dispatch, safe because the argspec `choices` constraint guarantees a valid Logger method. - Rename logger nd.NDLog -> nd.nd_log to match the module name. - Unit tests: keep the mock-free severity-dispatch test retargeted to log_message(); drop the three tests covering the removed constructor and the unreachable ValueError paths. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Address review feedback on PR #283: the nd_version task in the EXAMPLES block used the param-style invocation (host/username/password as module args) plus delegate_to: localhost, while the nd_log tasks did not. The delegate_to is also misleading for cisco.nd modules, which run on the control node by virtue of the httpapi connection plugin regardless. Drop the inline credentials and delegate_to from the nd_version task so all three example tasks are plain module calls that take their connection from inventory/play vars. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
gmicol
approved these changes
May 22, 2026
akinross
approved these changes
May 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issue(s)
N/A
Proposed Changes
cisco.nd.nd_logmodule: emits a Pythonloggingrecord under thendparent logger so playbook activity can be correlated with thend.*records emitted internally by other modules in this collection.ND_LOGGING_CONFIGenv var consumed bycommon/log.py(parent loggernd,setup_logging()helper).cisco.dcnm.dcnm_login shape and argument surface (msg,severitywith choicesCRITICAL/DEBUG/ERROR/INFO/WARNING, defaultDEBUG).supports_check_mode=True— deliberate deviation from dcnm_log parity; logging is a safe side effect during--checkruns.setup_logging(): a malformed/missingND_LOGGING_CONFIGfile callsmodule.fail_jsonrather than silently swallowing the error.tests/unit/modules/covering init defaults, missing-msgValueError, parametrized severity dispatch viacaplog, and default-vs-explicit DEBUG equivalence. Newtests/unit/modules/__init__.pyis empty (sanityempty-initrule).Test Notes
python -m pytest tests/unit/modules/test_nd_log.py -v— 9/9 pass.black --check,isort --check,pylint,mypy— clean (only the standard Ansible-module advisories that also appear onnd_version.py).ansible-doc cisco.nd.nd_logrenders correctly.changed=0; record appended to/tmp/nd.logper the configuredND_LOGGING_CONFIG.Cisco Nexus Dashboard Version
4.2 (module does not call ND APIs; tested against the 4.2 lab for parity with the rest of the collection).
Related ND API Resource Category
Checklist
🤖 Generated with Claude Code