Module 'dns' has no attribute 'immutable'

[vfaergestad]

Versions

NetBox Version: 4.4.10
NetBox DNS Version: 1.4.8
Python Version: 3.12.3

Describe the bug

Sometimes, when interacting with objects that touches the DNS-plugin in some way, I get the following server error:

<class 'AttributeError'>

module 'dns' has no attribute 'immutable'

The request that yielded the error has been various, but here are some examples (will add more as I encounter them):

POST https://netbox-url/plugins/netbox-dns/records/177/edit

The error happens occasionally. Performing the exact same request again often results in no error.

To Reproduce

Unfortunatly, the error is not easy to reproduce, as it happens occasionally and on various requests. I am very open to suggestions on how to create a reproducable case.

Expected result

The requests to always result in success, instead of occasionally as an error.

Actual result

The server error described above. The instance does not have debug enabled, and I cant seem to reproduce the behavious on my test instance.

I am aware that this may be little information to work with, but I am open for suggestions to improve that.

[peteeckel]

Hi @vfaergestad, that's a new one, never seen it before :-)

Let's try to get closer to the source of the issue:

1. Please enable debugging in configuration.py by setting DEBUG to True and restart NetBox
2. Try to reproduce the error (probably a matter of patience) and then provide the full exception stack

You can also do the folllowing:

• Update dnspython to the latest version (the issue is most likely related to dnspython, NetBox DNS does not use that attribute at all).

[peteeckel]

Do you by any chance have eventlet installed in your virtual environment? eventlet is known to cause wierd issues with dnspython.

https://github.com/eventlet/eventlet/issues?q=is%3Aissue%20dnspython%20state%3Aopen

If that's the case and if possible, upgrade eventlet to the latest version as well and see if the problem persists.

[vfaergestad]

Thank you for quick feedback.

dnspython is at version 2.8.0, which is from what I gathered the latest stable release.

eventlet is not installed in the virtual environment.

I will move on to enabling debug and find the stack-traces once I get a go for restarting the production Netbox.

[peteeckel]

The stack traces will be displayed in the GUI when the issue occurs.

If your logging is set up the right way, you should also see them with journalctl -u netbox (YMMV).

[peteeckel]

Did you manage to catch one of the occurrences yet?

I'm pretty sure this is not in the plugin itself, but in some other piece of code that interacts with it ... DEBUG output would help to narrow down the search.

In fact the plugin code doesn't even contain the string 'immutable'.

[peteeckel]

I found something.

module 'dns' has no attribute 'immutable'

Well ... in fact it does:

>>> import dns
>>> dir(dns)
['__all__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__', '__version__', '_asyncbackend', '_features', '_immutable_ctx', '_tls_util', 'asyncbackend', 'dnssectypes', 'edns', 'entropy', 'enum', 'exception', 'flags', 'grange', 'immutable', 'inet', 'ipv4', 'ipv6', 'message', 'name', 'node', 'opcode', 'query', 'quic', 'rcode', 'rdata', 'rdataclass', 'rdataset', 'rdatatype', 'rdtypes', 'renderer', 'rrset', 'serial', 'set', 'tokenizer', 'transaction', 'tsig', 'tsigkeyring', 'ttl', 'version', 'wire', 'xfr', 'zone', 'zonefile', 'zonetypes']

Which leaves some possible explanations, none of which is related to the plugin:

• Your dnspython-Installation is broken.
• Your NetBox environment is broken, pulling dnspython from the wrong environment (global or another venv).
• Something you installed is mangling dnspython, overwriting module code with an older version, which apparently is what some older versions of eventlet (which you don't have installed) do, but possibly some other ill-behaved modules, too.

In any case, the debug output will probably give us a hint where to look.

In the meantime you can try re-installing dnspython, which would at least fix the first cause: /opt/netbox/venv/bin/python3 -m pip install --force dnspython

You could also have a look at the modules installed in your venv and compare them to NetBox' requirements.txt file. Everything not listed there is a possible candidate for the third cause.

[peteeckel]

I will close this issue if there is no further input until the end of the week.

The problem is most likely not related to NetBox DNS and without any further information there is no way to even try to track it down.

[vfaergestad]

I am sorry for little response from me in this issue.

I agree with your reflection on this plugin not being the direct issue. I have not been able to reproduce the bug in any of our test-instances, and there a high bar for enabling debug-mode on our production instance.

I will look at your input and see of I get to the buttom of it, and report here if I do.

Thank you for quick and good response @peteeckel , I appriciate the work you put in to this plugin.

[peteeckel]

Thanks!

If you should find there's an issue with the plugin anyway, please feel free to reopen this. But as I said, it's highly likely that there's something wrong with your venv.