Skip to content

Latest commit

 

History

History
80 lines (43 loc) · 3.38 KB

configure-the-access-logs-of-an-application-64c1153.md

File metadata and controls

80 lines (43 loc) · 3.38 KB
Raw

Configure the Access Logs of an Application

The SAP Java Buildpack uses the logback-access module to provide HTTP-access log functionality.

Prerequisites

Context

The access logs differ slightly from the other logs and traces. There are many standard tools available that read access logs from any server, display them, calculate statistics and so on. That's why the format of the access log produced by Tomcat and TomEE is not SAP-specific either. The default pattern defined in configuration file is "%date "%r" %s %b".

In order to find the access log files of your application, you have to connect via SSH to the Cloud Foundry container and go to the logs directory.

Procedure

  1. Modify the default configuration.

    SAP Java buildpack uses LogbackValve to configure access logs in Tomcat and TomEE. There are four environment variables (<ACCESS_LOG_FILE>, <ACCESS_LOG_FILE_COUNT>, <ACCESS_LOG_FILE_MAX_SIZE>, <logback.access.log.xs.pattern>) which are used in the configuration file and could be overwritten.

  2. (Optional) Change the name of the access log files.

    By default access logs are placed in the application container in the logs/access.log file. You can configure the directory which contains those file and the name of the files, with the environment variable <ACCESS_LOG_FILE>. In order to do it you have to define the full path to the desired directory and name of the file.

    env:
    ACCESS_LOG_FILE: "/home/vcap/logs/access-log/access.log"

  3. (Optional) Change the number of access log files.

    You can change the number of stored files with the environment variable ACCESS_LOG_FILE_COUNT. The default value is 3.

    env:
    ACCESS_LOG_FILE_COUNT: 5

  4. (Optional) Change the size of the access log files.

    You can modify the size of every access log file with the environment variable ACCESS_LOG_FILE_MAX_SIZE. The default value is 8 MB.

    env:
    ACCESS_LOG_FILE_MAX_SIZE: 10

  5. (Optional) Change the format of the HTTP access log

    You can change the default format and have your access logs written differently. The SAP Java buildpack uses the Resource configuration functionality to allow this. Currently the change of the pattern attribute in the configuration file of Tomcat and TomEE is supported. The application has to provide the new value via the JBP_CONFIG mechanism:

    • Changing the format of the access log for Tomcat:

      env:
JBP_CONFIG_RESOURCE_CONFIGURATION: "['tomcat/conf/logback-access-localhost.xml':{'logback.access.log.xs.pattern' : 'combined'}]"

    • Changing the format of the access log for TomEE:

      env:
JBP_CONFIG_RESOURCE_CONFIGURATION: "['tomee/conf/logback-access-localhost.xml':{'logback.access.log.xs.pattern' : 'combined'}]"