isabella232 / dropwizard-web-logger

WebLoggerBundle is a Dropwizard bundle used to help log web activity to log files on a server’s backend

Dropwizard Web Logger

WebLoggerBundle is a Dropwizard bundle used to help log web activity to log files on a server's backend.

###Example 1: Log Event

####Make Call Send a POST request to:

http://localhost:8000/<web-app-name>/api/web-logger/events/<eventName>

Example

http://localhost:8000/<web-app-name>/api/web-logger/events/jump

with the body content:

{"height":"42feet","name":"douglas"}

and the following configuration:

webLoggerEnabled: true

####A Line is Logged Logger will log the following line to a file on a specific backend

{"name":"douglas","eventName":"jump","height":"42feet","timestamp":"2016-03-07 10:41:38 UTC"}

###Example 2: Log Batch of Events

Send a POST request to:

http://localhost:8000/<web-app-name>/api/web-logger/events/batch

Example

http://localhost:8000/<web-app-name>/api/web-logger/events/batch

with the body content:

{"jump": {"height":"42feet","name":"douglas"}, "crawl": {"height":"45feet","name":"robert"}}

and the following configuration:

webLoggerEnabled: true

####The Lines are Logged Logger will log the following lines to a file on a specific backend

{"name":"douglas","eventName":"jump","height":"42feet","timestamp":"2016-03-07 10:41:38 UTC"}
{"name":"robert","eventName":"crawl","height":"45feet","timestamp":"2016-03-07 10:41:40 UTC"}

###Fixed Fields Fixed fields will be added to all logged lines.

Type	Description
Timestamp	The timestamp of the log will be logged as yyyy-MM-dd HH:mm:ss z in UTC

Usage

1. Add the com.palantir.weblogger:dropwizard-web-logger:<VERSION> dependency to your project's build.gradle file. The most recent version number can be found by looking at the Releases Page. The dependencies section should look something like this:

   dependencies {
   	// ... unrelated dependencies omitted ...
   	compile "com.palantir.weblogger:dropwizard-web-logger:<VERSION>"
   }
   

2. Modify your server's configuration file

   a. Add webLoggerEnabled to your yml file and enable it. server.yml

       webLoggerEnabled: true
   

   b. Add an appender of type web-logger to your Dropwizard configuration YAML in the logging section: server.yml

         - type: web-logger
           currentLogFilename: ./var/log/<APPNAME>-usage.json.log
           archivedLogFilenamePattern: ./var/log/<APPNAME>-usage-%d.json.log
           archivedFileCount: <NUMBER_OF_LOGFILES_TO_ARCHIVE>
   

   Example

       logging:
         appenders:
           - type: file
             currentLogFilename: var/log/server.log
             archivedLogFilenamePattern: var/log/server-%d.log
             archivedFileCount: 5
             timeZone: UTC
             threshold: INFO
           - type: console
             threshold: INFO
           - type: web-logger
             currentLogFilename: ./var/log/fe-logger-usage.json.log
             archivedLogFilenamePattern: ./var/log/fe-logger-usage-%d.json.log
             archivedFileCount: 5
   

3. Have your configuration implement WebLoggerConfigurable:

   public final class ExampleApplicationConfiguration extends Configuration
           implements WebLoggerConfigurable {
   
       private final boolean webLoggerEnabled;
   
       @JsonCreator
       public ExampleApplicationConfiguration(
           @JsonProperty("webLoggerEnabled") boolean webLoggerEnabled) {
   
           this.webLoggerEnabled = webLoggerEnabled;
       }
   
       @Override
       public boolean isWebLoggerEnabled() {
           return this.webLoggerEnabled;
       }
   }

4. Add the bundle to your Dropwizard application.

       @Override
       public void initialize(Bootstrap<ExampleApplicationConfiguration> bootstrap) {
           bootstrap.addBundle(new WebLoggerBundle());
       }

Setting up the project with an IDE

with Eclipse, import the project and run:

    ./gradlew eclipse

with IntelliJ, import the project and run:

    ./gradlew idea

Authentication and Security

While it is possible to use this bundle without requiring user authentication or handling possible XSRF (cross-site request forgery) issues, the data collected by the event logger would likely not be useful.

It is strongly recommended that this bundle be used together with authentication and XSRF prevention.

Contributing

Before working on the code, if you plan to contribute changes, please read the CONTRIBUTING document.

License

This project is made available under the Apache 2.0 License.