Logging

Log File Structure

The Request and Access log files each display specific type of activity and as such have a consistent and specific file structure for maximum readability

Service Log

The service log file console pattern uses colors to highlight the service type and message level. On Windows console colors should be disabled.

Timestamp (UTC) [Service Type] [Level] [Trace Id] [Class and Line Number] [Thread] - Message

2018-11-18T15:39:04.902Z [jfac ] [INFO ]  [4b1b8a0b04e31b80] [s.r.NodeRegistryServiceImpl:44] [http-exec-4         ] - request to "join" with serviceId jffe@000

Request Log

The request log file pattern contains a list of pipe ("|") separated values. The file pattern will contain the same number of columns, if a value is missing it will be empty.

Note: If not provided by the client, the 'Request Content-Length' value is initialised as "-1". 

Timestamp | Trace ID | Remote Address | Username | Request method | Request URL | Return Status | Request Content Length | Response Content Length | Request Duration | Request User Agent

2018-11-18T15:39:04.902Z|d5d75b3c41242768|127.0.0.1|anonymous|GET|api/v1/cert/root|200|0|6|0|JFrog Access Java Client/4.1.12

Outbound Request Log

The request-out log file pattern contains a list of pipe ("|") separated values. The file pattern will contain the same number of columns, if a value is missing it will be empty.

Note: If not provided by the client, the 'Request Content-Length' value is initialised as "-1". 

Timestamp | Trace ID | Remote Repository Name | Username | Request method | Request URL | Return Status | Request Content Length | Response Content Length | Request Duration

2021-05-12T13:58:46.686Z|40ea218a769325db|generic-remote|andreyt|HEAD|https://acme.jfrog.com/artifactory/generic-packages/jdbc-drivers/mssql-jdbc-7.4.1.jre11.jar|200|1219373|0|80

Router Request Log

The JFrog Router has a JSON based access log containing all the requests that went through the Router, including service service communication.

Below is an example of an entry in the Router request log (router-request.log)

{
  "BackendAddr": "http://localhost:8049",
  "ClientAddr": "127.0.0.1:61899",
  "DownstreamContentSize": 2,
  "DownstreamStatus": 200,
  "Duration": 8353000,
  "RequestMethod": "GET",
  "RequestPath": "/router/api/v1/system/ping",
  "StartUTC": "2020-11-12T11:53:03.605300906Z",
  "request_Uber-Trace-Id": "4ccb40200c199346:1a3f95ce1b27711d:71e15f8b6031c9e9:0",
  "request_User-Agent": "curl/7.54.0",  
  "time": "2019-08-05T14:42:09+03:00",
  "level": "info",
  "msg": ""
}

Console Log

The console log file appends the console outputs of all services into one common log file.

Log rotation is configured to occur every hour using a cron job for Docker Compose and native installations.

Viewing Log Files from the UI

You can view essential Platform log files from the UI.

To view system logs:

1. In the Administration module, go to Monitoring | System Logs.
2. Select the JFrog service you want to view logs for.
3. Select the node.
4. Select the file you want to view.
   The log tail view is automatically refreshed every few seconds, however can be paused and resumed if you wish to browse the log.

Sending Logs to Syslog

Some sites want to consolidate logs into the syslog facility. The following steps will enable you to send your Java microservices logs to syslog.

Configure the logback library

Edit the logback xml file in the $JFROG_HOME/<product>/var/etc/<microservice>/logback.xml file. For example, to configure Artifactory to use syslog, edit the $JFROG_HOME/artifactory/var/etc/artifactory/logback.xml file.

1. Add the following syslog appender to the logback xml (next to the other appenders)
   

   <appender name="SYSLOG" class= "ch.qos.logback.classic.net.SyslogAppender">
    <syslogHost>localhost</syslogHost>
    <facility>SYSLOG</facility>
    <suffixPattern>[%thread] %logger %msg</suffixPattern>
   </appender>

2. Add the following appender to the output:
   

   <root> 
    <level value="warn"/> 
    <appender-ref ref="CONSOLE"/> 
    <appender-ref ref="FILE"/>
    <appender-ref ref="SYSLOG"/>
   </root>

3. Save the file, and restart the service.

Configure syslog on your machine

Since logback is using internet sockets, you have to make sure your syslog facility accepts them. Modern Linux distributions are using the rsyslog daemon for syslogging. Ensure that the configuration for internet domain sockets is enabled, either by editing /etc/rsyslog.conf and uncommenting:

# Provides UDP syslog reception 
$ModLoad imudp
$UDPServerRun 514
# Provides TCP syslog reception 
$ModLoad imtcp
$InputTCPServerRun 514

or placing it in a file under /etc/rsyslog.d ending in .conf.

Restart rsyslog.

 service rsyslog restart

Configuring Log Verbosity

There are two ways to configure log verbosity, depending on if your JFrog microservice is logback based (Java microservices) or not.

Using logback (Java based microservices)

The verbosity of any Java based logger in your system can be configured by entering or modifying the level value in the corresponding entry in the Logback configuration file JFROG_HOME/<product>/var/etc/<microservice>/logback.xml. For example, to configure the Artifactory log verbosity, edit the $JFROG_HOME/artifactory/var/etc/artifactory/logback.xml file.

Changes made to the logging configuration are reloaded within several seconds without requiring a restart.

 <logger name="org.artifactory.http.out" level="debug"/>

Using system.yaml (non Java microservices)

The verbosity of any non Java based logger in your system can be configured by entering or modifying the level value in the corresponding entry in the system.yaml configuration file JFROG_HOME/<product>/var/etc/system.yaml.

Changes made to the logging configuration requires a restart.

frontend:
  logging:
    application:
      level: info