How to enable debug logging?

[hostingnuggets]

Hello,

I am trying to debug why the LDAP authentication is not working and do not see any useful log information in the containers themselves. So I was wondering how can I enable debug loggin?

I did not find any environment variable to set or anything in the documentation... Any ideas?

Thanks

[timrabl]

Just set DEBUG=True in your env/netbox.env.

netbox-docker/configuration/configuration.py

Lines 153 to 156 in 39c7de4

	# Set to True to enable server debugging. WARNING: Debugging introduces a substantial performance penalty and may reveal
	# sensitive information about your installation. Only enable debugging while performing testing.
	# Never enable debugging on a production system.
	DEBUG = _environ_get_and_map('DEBUG', 'False', _AS_BOOL)

[hostingnuggets]

Thanks you @timrabl, I did that and restarted all the containers with a docker-compose down and up again but when inspecting the container logs with docker logs -f netbox-docker_netbox_1 I don't see any more information than usual. Or where exactly is the debug information outputted?

[timrabl]

In my case, the netbox container logs (as it should) to /proc/self/fd/2, so the equivalent /dev/stderr or more known as standard error. This then ends up in the docker container logs.

Test 1:

Lets simulate a unreachable LDAP server by changing the LDAP Host in env/netbox.env:

user@srv01 % docker-compose down && docker-compose up -d && docker-compose logs -f netbox netbox-worker | grep -i ldap
netbox_1               | Caught LDAPError while authenticating trst: SERVER_DOWN({'result': -1, 'desc': "Can't contact LDAP server", 'errno': 11, 'ctrls': [], 'info': 'Resource temporarily unavailable'})

-> It logs as expected to the container logs.

Test 2:

Lets simulate invalid bind user credentials by changing bind user credentials in env/netbox.env:

user@srv01 % docker-compose down && docker-compose up -d && docker-compose logs -f netbox netbox-worker | grep -i ldap
netbox_1               | Caught LDAPError while authenticating trst: INVALID_CREDENTIALS({'msgtype': 97, 'msgid': 1, 'result': 49, 'desc': 'Invalid credentials', 'ctrls': [], 'info': '80090308: LdapErr: DSID-0C090447, comment: AcceptSecurityContext error, data 52e, v3839'})

-> It logs as expected to the container logs.

The only difference I can think of could be the LOGLEVEL variable, which I set to "debug".
As far as I know, it is not loaded automatically, this must first be activated here by uncommenting the commented-out line.

netbox-docker/configuration/logging.py

Line 6 in 676ca79

# LOGLEVEL = environ.get('LOGLEVEL', 'INFO')

The logging.py must of course be adjusted in the container or be in the container via bind mount or custom image.

[1-cameron]

@hostingnuggets Did you manage to resolve this? I'm having the same issue - container logs not being any more verbose despite enabling debug logging.

[mongrelion]

I just managed to get netbox into debugging mode by adding this environment variable to my docker-compose file:

DEBUG=True

Now I even get the stack trace in the browser when something goes wrong.