Report is showing no results and status "Errored"

[josephbadow]

Hello there,

I am running Netbox (v3.1.6) in docker. I am aware that there is a separate respository for docker related topics. Since my request is about reports I thought this repository is the proper place. If that'st not the case, please accept my apology :)

Now let me explain what I want to achieve: I created a custom field for devices that holds a date. This date shows the end of the service contract for the device. Now I am trying to create a report that checks the custom field and compares it to the current date, resulting in a list of devices and the end of their service contract.

I already have a report file with logic that works afaik. (When I remove all NetBox related variables and give Support_service a hard coded value my if/else loops work as intended)

from datetime import datetime, date, timedelta
from dcim.choices import DeviceStatusChoices
from dcim.models import Device
from extras.reports import Report

class Device_ServiceContract_StatusReport(Report):
    description = "Show devices and their service contracts."

    def test_service_contract(self):

        # Get current date
        today = date.today().strftime("%Y-%m-%d")

        # Convert current date into date object
        today_date = datetime.strptime(today, "%Y-%m-%d").date()

        # Check if device has a service contract
        # Cycle through all devices
        for device in Device.objects.filter(status=DeviceStatusChoices.STATUS_ACTIVE):
            
            # Define custom field "Support_service"
            Support_service = device.cf.get("Support_service")

            # check if Support_service has a value
            if (len(Support_service) > 0):

                # Convert string value to date
                Support_service_date = datetime.strptime(Support_service, "%Y-%m-%d").date()

                # Calculate the current delta between today and the service expiration in days
                time_delta = (Support_service_date - today_date).days

                # check if the service is valid for more then 365 days
                if (time_delta > 365):
                    # Output NetBox "success"
                    self.log_success(device, "Service contract valid for more then 12 month.")
                    print("Service contract valid for more then 12 month.")
                
                # service is expiring in 365 or less days, could also be expired
                else:
                    # check if the service is expiring within 365 days but not yet expired
                    if (time_delta > 0):
                        # Output Netbox "warning"
                        self.log_warning(device, "Service contract valid for less then 12 month.")
                        print("Service contract valid for less then 12 month.")

                    # service is already expired
                    else:
                        # Output Netbox "failure"
                        self.log_failure(device, "Service contract already expired.")
                        print("Service contract already expired.")

            # Support_service has no value
            else:
                # Output Netbox "info"
                self.log_info(device, "Device has no service contract.")
                print("Device has no service contract.")

I also checked the netbox shell to make sure that my custom field is working as expected.

bash-5.1$ /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py nbshell
🧬 loaded config '/etc/netbox/config/configuration.py'
🧬 loaded config '/etc/netbox/config/admin_notification.py'
🧬 loaded config '/etc/netbox/config/email-secrets.py'
🧬 loaded config '/etc/netbox/config/email.py'
🧬 loaded config '/etc/netbox/config/extra.py'
🧬 loaded config '/etc/netbox/config/logging.py'
🧬 loaded config '/etc/netbox/config/plugins.py'
### NetBox interactive shell (770a0373d091)
### Python 3.9.5 | Django 3.2.11 | NetBox 3.1.6
### lsmodels() will show available models. Use help(<model>) for more info.
>>> for device in Device.objects.filter(status="active"):
...     print(device.name,device.cf.get("Support_service"))
...
DNS-ESX-01 2023-02-24
DNS-ESX-02 None

I currently have two devices in NetBox as you can see above. Given the current date my if/else loop should output:

• DNS-ESX-01 "Service contract valid for more then 12 month."
• DNS-ESX-02 "Device has no service contract."

The report is available in the Web interface. Running it from the Web shows Status "Errored" and an empty report result.

Running it from the CLI only shows "Finished"

bash-5.1$ /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py runreport /etc/netbox/reports/service-expiration.py
🧬 loaded config '/etc/netbox/config/configuration.py'
🧬 loaded config '/etc/netbox/config/admin_notification.py'
🧬 loaded config '/etc/netbox/config/email-secrets.py'
🧬 loaded config '/etc/netbox/config/email.py'
🧬 loaded config '/etc/netbox/config/extra.py'
🧬 loaded config '/etc/netbox/config/logging.py'
🧬 loaded config '/etc/netbox/config/plugins.py'
[12:39:41] Finished

Regardless how I run it, docker-compose logs -f is empty of any errors. I only see the my access requests on the web server.

netbox-docker-netbox-1               | 10.10.0.83 - - [02/Feb/2022:13:53:38 +0100] "GET /extras/reports/service-expiration.Device_ServiceContract_StatusReport/ HTTP/1.1" 200 125351 "https://netbox.local/extras/reports/" "Mozilla/5.0 (Windows NT 10.0; Win64; x64;rv:96.0) Gecko/20100101 Firefox/96.0"
netbox-docker-netbox-1               | 10.10.0.83 - - [02/Feb/2022:13:53:38 +0100] "GET /static/netbox_touch-icon-180.png HTTP/1.1" 2004054 "https://netbox.local/extras/reports/service-expiration.Device_ServiceContract_StatusReport/" "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:96.0) Gecko/20100101 Firefox/96.0"
netbox-docker-netbox-1               | 2022/02/02 13:53:38 [info] 17#22 *58 recv(15, 7FE2917B5C18, 2048, 0) failed (104: Connection reset by peer)
netbox-docker-netbox-1               | 10.10.0.83 - - [02/Feb/2022:13:53:39 +0100] "GET /extras/reports/results/11/ HTTP/1.1" 200 125369 "https://netbox.local/extras/reports/service-expiration.Device_ServiceContract_StatusReport/" "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:96.0) Gecko/20100101 Firefox/96.0"
netbox-docker-netbox-1               | 10.10.0.83 - - [02/Feb/2022:13:53:39 +0100] "GET /static/netbox_touch-icon-180.png HTTP/1.1" 2004054 "https://netbox.local/extras/reports/results/11/" "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:96.0) Gecko/20100101 Firefox/96.0"
netbox-docker-netbox-1               | 2022/02/02 13:53:39 [info] 17#22 *59 recv(15, 7FE2917B5C18, 2048, 0) failed (104: Connection reset by peer)

So this is my current status, now of to the questions:

1. Do you see any obvious errors?
2. How can I enable more output from the script to find my errors?

Your help is greatly appreciated!

[josephbadow]

Thanks to Kim in slack I was able to figure out the problem. My netbox-worker container had no access to the report file. Of course it was a docker related problem 🙈