Is it possible to generate normal logs in custom scripts?

[emr-arvig]

I cannot generate any regular stdout log messages to the console from the run method or any other method in custom scripts.

We have a number of scripts that get quite complex, and I would like to log them so we are able to see them by tailing the logs of our kubernetes pods. It has caused many hours of troubleshooting and headache.

I have copied a logging config into my docker file. Here it is:

 LOGGING = {                                                                                                                                                                                                                                                                                                                         'version': 1,
      'disable_existing_loggers': False,
      'formatters': {
          'standard': {
              'format': '%(asctime)s [ %(filename)s:%(lineno)d ] [%(levelname)-8s] %(name)s: %(message)s'
          },
      },
      'handlers': {
          'console': {
              'level': 'DEBUG',
              'class': 'logging.StreamHandler',
              'formatter': 'standard'
          },
      },
      'loggers': {
          'django': {
              'handlers': ['console'],
              'level': 'INFO',
              'propagate': True,
          },
          'customScripts': {
              'handlers': ['console'],
              'level': 'DEBUG',
              'propagate': True,
          },
          'netbox': {
              'handlers': ['console'],
              'level': 'DEBUG',
              'propagate': True,
          },
          'netbox.scripts': {
              'handlers': ['console'],
              'level': 'DEBUG',
              'propagate': False,
          },
      }
  }

I created a new Test script just to see if I could get logging to work.

With the logging configuration, I can get logs on the module level of the file, or in the global scope, but I cannot get any logging to happen in any of the methods on the script class

Here is my TestScript class:

  from extras.scripts import Script
  import sys
  import logging

  logger = logging.getLogger("customScripts")
  netbox_logger = logging.getLogger("netbox")
  django_logger = logging.getLogger("django")
  script_logger = logging.getLogger("scripts.TestScript")
  base_scripts_logger = logging.getLogger("netbox.scripts")
  script_logger_alt = logging.getLogger("TestScript")
  long_logger = logging.getLogger("netbox.scripts.TestScript")

  logger.info("THE SCRIPT HAS BEEN LOADED")
  netbox_logger.info("THE SCRIPT HAS BEEN LOADED (nb logger)")
  django_logger.info("THE SCRIPT HAS BEEN LOADED (django logger)")
  script_logger.info("THE SCRIPT HAS BEEN LOADED (script logger)")
  base_scripts_logger.info("THE SCRIPT HAS BEEN LOADED (base script logger)")
  script_logger_alt.info("THE SCRIPT HAS BEEN LOADED (alt script logger)")
  long_logger.info("THE SCRIPT HAS BEEN LOADED (long script logger)")


  class TestScript(Script):
      """Testing to see if Logging Works"""

      class Meta:
          """Meta information."""

          name = "Test Script"
          description = "Test Script"


      def log_a_thing(self, message):
          logger.info("Here is the message we have receieved %s", message)

      def run(self, data, commit):
          logger.info("THE SCRIPT HAS BEEN RUN (default logger!)")
          netbox_logger.info("THE SCRIPT HAS BEEN RUN (nb logger)")
          django_logger.info("THE SCRIPT HAS BEEN RUN (django logger)")
          script_logger.info("THE SCRIPT HAS BEEN RUN (script logger)")
          base_scripts_logger.info("THE SCRIPT HAS BEEN RUN (base script logger)")
          script_logger_alt.info("THE SCRIPT HAS BEEN RUN (alt script logger)")
          long_logger.info("THE SCRIPT HAS BEEN RUN (long script logger)")
          self.log_a_thing("THING")
          self.log_success("Test Script Ran OK")

You can see the logs on the module level, but never when you run the script via the run method:

2025-02-11 21:53:24,758 [ __init__.py:83 ] [DEBUG   ] netbox.config: No previous configuration found in database; proceeding with default values
2025-02-11 21:53:24,758 [ __init__.py:29 ] [DEBUG   ] netbox.config: Initialized configuration
2025-02-11 21:53:24,766 [ TestScript.py:13 ] [INFO    ] customScripts: THE SCRIPT HAS BEEN LOADED
2025-02-11 21:53:24,767 [ TestScript.py:14 ] [INFO    ] netbox: THE SCRIPT HAS BEEN LOADED (nb logger)
2025-02-11 21:53:24,767 [ TestScript.py:15 ] [INFO    ] django: THE SCRIPT HAS BEEN LOADED (django logger)
2025-02-11 21:53:24,767 [ TestScript.py:17 ] [INFO    ] netbox.scripts: THE SCRIPT HAS BEEN LOADED (base script logger)
2025-02-11 21:53:24,767 [ TestScript.py:19 ] [INFO    ] netbox.scripts.TestScript: THE SCRIPT HAS BEEN LOADED (long script logger)

Is there any way to get this to work?

[aascedu]

Hello, I had successed in printing Tenants name during the execution of a script here is how I did it :
In the global scope I added this:

logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)

then in the run method:

    def run(self, data, commit):
        tenant = data['tenant']
        logger.info(f"{tenant.name}")