{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Please note that the feature describe here is only available in Platform 2.4.4+, 2.5.1+ and, once it's released 2.6.0+","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"OpenMRS uses the ","type":"text"},{"text":"Apache Log4J2","type":"text","marks":[{"type":"link","attrs":{"href":"https://logging.apache.org/log4j/2.x/"}}]},{"text":" project to support logging, which comes with a very rich set of ","type":"text"},{"text":"configuration","type":"text","marks":[{"type":"link","attrs":{"href":"https://logging.apache.org/log4j/2.x/manual/configuration.html"}}]},{"text":" options for determining how messages are logged, determining which messages go where, etc. Previously, however, this configuration has been somewhat hidden or inaccessible to administrators. With the release of the above mentioned version, the Log4J2 settings can now be fully controlled via a log4j2.xml file placed either in the ","type":"text"},{"text":"OpenMRS Application Data Directory","type":"text","marks":[{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/display/docs/Application+Data+Directory"}}]},{"text":" or in the configuration sub-directory of the OpenMRS Application Data Directory.","type":"text"}]},{"type":"paragraph","content":[{"text":"The default OpenMRS logging configuration can be found ","type":"text"},{"text":"on GitHub","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-core/blob/master/webapp/src/main/resources/log4j2.xml"}}]},{"text":" as part of the ","type":"text"},{"text":"openmrs-core","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/openmrs/openmrs-core"}}]},{"text":" project. And looks something like this (as of ","type":"text"},{"type":"date","attrs":{"timestamp":"1641945600000"}},{"text":" ):","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":5},"content":[{"text":"log4j2.xml","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"\n\n\n\n\t\n\t\t\n\t\t%p - %C{1}.%M(%L) |%d{ISO8601}| %m%n\n\t\n\t\n\t\t\n\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t \n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\n","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Extensive details on how to configure Log4J2 ","type":"text"},{"text":"can be found in the Log4J2 manual","type":"text","marks":[{"type":"link","attrs":{"href":"https://logging.apache.org/log4j/2.x/manual/configuration.html"}}]},{"text":". However, there are some OpenMRS-specific points that are worth considering:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you have an appender that writes to a file it should have the name ","type":"text"},{"text":"OPENMRS FILE APPENDER","type":"text","marks":[{"type":"code"}]},{"text":" as shown above. This will enable OpenMRS to tell you where your log file actually is.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"MEMORY_APPENDER","type":"text","marks":[{"type":"code"}]},{"text":" is used to hold logging messages in memory for display, e.g. in the View System Logs link. You are not required to have this in your configuration, but if you do not, a memory appender with the default settings (100 entries using the pattern ","type":"text"},{"text":"%p - %C{1}.%M(%L) |%d{ISO8601}| %m%n","type":"text","marks":[{"type":"code"}]},{"text":") will be automatically created and attached to the root logger for you.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"In addition, as can be seen in the above file, OpenMRS exposes some OpenMRS-specific logging configuration settings, specifically:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"openmrs:logLayout","type":"text","marks":[{"type":"code"}]},{"text":": this will be the value of the ","type":"text"},{"text":"log.layout","type":"text","marks":[{"type":"code"}]},{"text":" setting. If you want that setting to be able to control the log layout, you should use it in your appenders as shown above.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"openmrs:logLocation","type":"text","marks":[{"type":"code"}]},{"text":": this will be the value of the ","type":"text"},{"text":"log.location","type":"text","marks":[{"type":"code"}]},{"text":" setting. If you want that setting to be able to control where the log file is output, you should use it as shown above.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"openmrs:applicationDirectory","type":"text","marks":[{"type":"code"}]},{"text":": this will be the location of the OpenMRS Application Data Directory. It is useful for ensuring your logs are written there, if that is the desired behaviour.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"NB ","type":"text","marks":[{"type":"strong"}]},{"text":"If you do not use ","type":"text"},{"text":"openmrs:logLayout","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"openmrs:logLocation","type":"text","marks":[{"type":"code"}]},{"text":" in your log4j2 configuration file, then the ","type":"text"},{"text":"log.layout","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"log.location","type":"text","marks":[{"type":"code"}]},{"text":" settings will have no effect.","type":"text"}]}],"version":1}

Browser not supported