Logging¶

The Symfony framework used in AtoM includes a number of logging options which can be customized based on developer or system administrator needs.

By default, two log files are included in the /log/ directory of AtoM (see where on Github). If you look in this directory, you should see two files: qubit_cli.log and qubit_dev.log. You can view the contents of these log files like so:

less log/qubit_cli.log

A developer or system administrator can customize the output of these logs, depending on what information is needed. In Symfony, the output to these logs is controlled by the settings in the factories.yml file found at /apps/qubit/config/factories.yml (view example on Github here). Factories in Symfony are “core objects needed by the framework during the life of any request. They are configured in the factories.yml configuration file.” The factories.yml file, like several other configuration files in Symfony, is environment-aware - “their interpretation depends on the current symfony environment. These files have different sections that define the configuration should vary for each environment.”

The factories.yml file in AtoM has 4 main environmentally-aware “factories” configurations defined: prod (for production - i.e. index.php in the application), test (which is not used by AtoM), dev (for development and debugging - i.e. qubit_dev.php, when the site is in Debug mode), and all, which are the default settings inherited by the other factories, unless they are more explicitly defined within each and overridden. According to Symfony:

When symfony needs a value from a configuration file, it merges the configuration found in the current environment section with the all configuration. The special all section describes the default configuration for all environments. If the environment section is not defined, symfony falls back to the all configuration.

If you are an administrator and wish to override factories.yml settings, it’s recommended you modify apps/qubit/config/factories.yml.

Example - the debug factories settings:

Here are the default settings for the debug factory in factories.yml:

dev:
  mailer:
    param:
      delivery_strategy: none

  storage:
    class: QubitSessionStorage
    param:
      session_name: symfony

  logger:
    class: sfAggregateLogger
    param:
      level: debug
      loggers:
        sf_file_debug:
          class: sfFileLogger
          param:
            level: warning
            file: %SF_LOG_DIR%/%SF_APP%_%SF_ENVIRONMENT%.log

Note the logger settings parameter nested under the dev factory - these can be altered to change the logging behavior when in Debug mode.

The class parameter has several configuration options - sfAggregateLogger (the default configuration, which can aggregate logging information from multiple sources), sfFileLogger (single source logging information), and sfNoLogger (which will turn off logging - this is the default setting for prod, to keep the site performant). According to Symfony, “If you don’t use the sfAggregateLogger, don’t forget to specify a null value for the loggers parameter.” You can look at the parameter settings on prod for an example.

The level option defines the level of the logger. There are 8 possible values (ordered here from highest priority to lowest):

• EMERG: System is unusable
• ALERT: Immediate action required
• CRIT: Critical conditions
• ERR: Error conditions
• WARNING: Warning conditions
• NOTICE: Normal, but significant
• INFO: Informational
• DEBUG: Debug-level messaging

The lower the level of the setting, the more events will be adding to the log. So if you set level to EMERG, you will only receive log messages about critical failures in which the system is rendered unusable. If you set level to WARNING, you will receive WARNING, ERR, CRIT, ALERT, and EMERG-level messages. Setting level to DEBUG will log all events.

cli:
  logger:
    class: sfFileLogger
    param:
      level: info
      file: %SF_LOG_DIR%/qubit_cli.log

php symfony cc

php symfony log:clear

php symfony log:rotate frontend prod --period=7 --history=10

prod:
 logger:
   class: sfNoLogger
   param:
     level: err
     loggers: ~

 storage:
   class: QubitSessionStorage
   param:
     session_name: symfony

prod:
  logger:
    class: sfFileLogger
    param:
      level: warning
      file: %SF_LOG_DIR%/qubit_prod.log

  storage:
    class: QubitSessionStorage
    param:
      session_name: symfony

Web server logs¶

You might also want to access the error logs from your web server during debugging. If you are using Nginx (our recommended web server), and have followed our Linux install instructions (here), you can view the Nginx error log by typing the following command from your root AtoM directory:

sudo tail -f /var/log/nginx/error.log

If you are using Apache, or another webserver, you may have to search online for information on how to access the error log - it also will depend on the particular configuration of your installation. For most Apache web server installs, the following should work:

sudo tail -f /var/log/apache2/error.log