Plugin dev and logging

[dainok]

Hello,

I'm developing a complex plugin and I'm stuck on a error: it happens when I load a specific page. Seems that the Python stacktrace is hidden, and I get only a NoReverseMatch:

<class 'django.urls.exceptions.NoReverseMatch'>

'netdoc' is not a registered namespace

Python version: 3.8.10
NetBox version: 3.3.2-dev

Any chance to get the full stacktrace from a plugin error?
Thank you

[candlerb]

Set EMAIL and ADMINS in configuration.py. The backtrace should be sent by E-mail to the ADMINS. Alternatively, if you set DEBUG=True in configuration.py, you should get an interactive backtrace in your browser.

(This works for normal Netbox, but I've not checked either option with a broken plugin)

[dainok]

Hello @candlerb thank you for your answer. I turned DEBUG on, and now I can see the stack trace in the web page, but it's limited to the "is not a registered namespace" exception. I also enabled EMAIL and ADMIN, but I can see no email (I'm using localhost which I manually tested and it works).

[candlerb]

It's ADMINS not ADMIN.

[dainok]

Sorry, I wrote ADMIN but I configured ADMINS:

ADMINS = [
    ('Andrea', 'root'),
]

[candlerb]

Check your MTA logs to see what happened to it.

[dainok]

There is no connection to the MTA. tcpdump shows no packages to port 25.

[candlerb]

OK, then maybe the exception is happening before the code which catches it and turns it into an E-mail. (What happens if you put a raise RuntimeError("foo") inside some code that normally works?)

The error message appears to be coming from Django innards. Some possible clues here:
https://stackoverflow.com/questions/41883254/django-is-not-a-registered-namespace

Otherwise sorry, I can't help any more than that.

[dainok]

Same result (I mean no TCP connection on port 25).
I added the command raise RuntimeError("foo") to a view that is normally working.
In the web page I can read 'netdoc' is not a registered namespace inside 'plugins'. If I run "makemigrations", I can read RuntimeError: foo.

[candlerb]

What's the actual URL shown in the browser URL bar when this error appears?

My guess is it's when you do a multi-select delete, you get a confirmation page listing the things about to be deleted - and possibly it's trying to turn them into hyperlinks, and is failing. Like this (/tenancy/contacts/delete/):

In this table, the contact name and group name are hyperlinks.

If you can reproduce this with a minimal plugin that does nothing else, then it might be a bug in the Netbox plugin framework.

[candlerb]

Incidentally, why are you using a non-release branch of Netbox? You should be using 'master', which will give you v3.3.4 currently.

There is no support for upgrading between unreleased versions of Netbox, and any attempts to do so may result in your database getting into an inconsistent state.

[dainok]

The URL is correct (http://localhost:8000/plugins/netdoc/credentials/delete/) and also the post is. I'm surely missing something in my code.

I'm trying to figure out how the plugin is loaded. Can you point me in the right direction? I see something in extras/plugin.

[candlerb]

Sorry, I don't know the internals of plugin loading.

If my theory is correct, the error occurs while rendering netbox/templates/generic/bulk_delete.html. You could try removing this section:

    <div class="table-responsive">
      {% render_table table 'inc/table.html' %}
    </div>

and see if the problem goes away. If so, that at least gives you a clue as to what's going on, and if you wish you can investigate further into netbox/templates/inc/table.html

I'm afraid I don't know if this problem is with Netbox itself not correctly supporting bulk deletions from plugins, or with the way your plugin is written. As I say, if you can boil this down to the absolute minimal plugin that demonstrates the issue, then I expect one of the developers can make a call.

[dainok]

Thank you for the suggestion and for the support. I'm working on it

[dainok]

I found the line causing the issue: default_return_url

class CredentialBulkDeleteView(generic.BulkDeleteView):
    queryset = models.Credential.objects.all()
    table = tables.CredentialTable
    default_return_url = 'netdoc:credential_list'
    filterset = filtersets.CredentialFilterSet

The I missed "plugins", the right line is:

    default_return_url = 'plugins:netdoc:credential_list'

For some reason netbox is hiding the exceptions so it wasn't easy to find what was going on.

[jeremystretch]

For some reason netbox is hiding the exceptions so it wasn't easy to find what was going on.

As @candlerb points out above, NetBox isn't hiding anything. The exception is reported per the error message, and stack traces are emailed (or you can enable debugging).

[dainok]

Thank you @jeremystretch. My mistake, I was referring to my netbox setup not netbox itself. As you can read from the thread, I wasn't able to get stacktrace via browser or via email. Again, it probably happens because of my setup, but I didn't get why.