Setting the log level for an Edge component

Edge for Private Cloud v4.19.01

By default, Edge components use a logging level of INFO. However, you can set the logging level for each Edge component. For example, you might want to set it to DEBUG for the Message Processor, or to ERROR for the Management Server.

The available log levels include:

  • ALL
  • DEBUG
  • ERROR
  • FATAL
  • INFO
  • OFF
  • TRACE
  • WARN

To set the log level for a component, edit the component's properties file to set a token, then restart the component:

  • For the Edge UI, the tokens are conf_logger_settings_application_log_level and conf_logger_settings_play_log_level. Set them to the same value.
  • For all other Edge components, the token is conf_system_log.level

To set the log level for the Edge UI component:

  1. Open /opt/apigee/customer/application/ui.properties in an editor. If the file does not exist, create it.
  2. Set the following properties in ui.properties to the desired log level. For example, to set it to DEBUG: 
    conf_logger_settings_application_log_level=DEBUG
conf_logger_settings_play_log_level=DEBUG
  3. Save the file.
  4. Ensure the properties file is owned by the "apigee" user: 
    chown apigee:apigee /opt/apigee/customer/application/ui.properties
  5. Restart the Edge UI: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

To set the log level for other components:

  1. Open /opt/apigee/customer/application/component_name.properties in an editor, where component_name can be one of the following:
    • apigee-cassandra (Cassandra)
    • apigee-openldap (OpenLDAP)
    • apigee-postgresql (PostgreSQL database)
    • apigee-qpidd (Qpidd)
    • apigee-sso (Edge SSO)
    • apigee-zookeeper (ZooKeeper)
    • edge-management-server (Management Server)
    • edge-management-ui (new Edge UI)
    • edge-message-processor (Message Processor)
    • edge-postgres-server (Postgres Server)
    • edge-qpid-server (Qpid Server)
    • edge-router (Edge Router)
    • edge-ui (Classic UI)

    If the file does not exist, create it.

  2. Set the following property in the properties file to the desired log level. For example, to set it to DEBUG: 
    conf_system_log.level=DEBUG
  3. Save the file.
  4. Ensure the properties file is owned by the "apigee" user: 
    chown apigee:apigee /opt/apigee/customer/application/component_properties_file_name.properties
  5. Restart the component by using the following syntax: 
    /opt/apigee/apigee-service/bin/apigee-service component_name restart

For more information about the name and location of the component configuration files, see Location of properties files.