Skip to content

rapid7/r7insight_java

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

88 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logging To InsightOps from Java

InsightOps currently supports logging from Java using the following logging libraries:


Maximum Log Length

Currently logs which exceed 65536 characters in length, including any patterns and timestamps you may include, will be split and sent as multiple logs.


Configure Java Util Logging with multiple handlers

This library allows you to set up different loggers (java.util.logging.Logger) each of them with a different Logentries handler configuration (e.g. to support different tokens).

  1. Add to logging.properties the following props:

    • Log configuration class:
    config=com.rapid7.jul.MultipleLogentriesHandlerConfig
    
    • List all the handler names you need:
    logentries.handler.names=logger1,logger2
    
    • Configure each handler using the handler name specified before as prefix:
    logger1.com.rapid7.jul.LogentriesHandler.token=4ff1cb0a-beea-4616-b647-1c113de8e7bb
    logger1.com.rapid7.jul.LogentriesHandler.region=eu
    logger1.com.rapid7.jul.LogentriesHandler.formatter=java.util.logging.SimpleFormatter
    
    logger2.com.rapid7.jul.LogentriesHandler.token=a70d9089-576c-4668-9641-14995d493a62
    logger2.com.rapid7.jul.LogentriesHandler.region=eu
    logger2.com.rapid7.jul.LogentriesHandler.formatter=java.util.logging.SimpleFormatter
    
  2. Get the LogManager and configure it with the property file:

    LogManager logManager = LogManager.getLogManager();
    InputStream is = new FileInputStream("src/main/resources/logging.properties");
    logManager.readConfiguration(is); 
    
  3. Get the loggers:

    Logger logger1 = Logger.getLogger("logger1");
    Logger logger2 = Logger.getLogger("logger2");
    

Logback Access Events

This library allows you to setup logback access events, as part of the standard logback distribution, with Servlet containers such as Jetty or Tomcat to provide HTTP-access log functionality.

Instructions to setup logback access events can be found in the Official logback-access documentation

After downloading the latest r7insight_java distribution, depending on your servlet container, place the r7insight_java-VERSION.jar under either :

  • $TOMCAT_HOME/lib/ directory, where $TOMCAT_HOME is the folder where you have installed Tomcat.
  • $JETTY_HOME/lib directory, where $JETTY_HOME is the folder where you have installed Jetty.

Refer to the sample logback-access.xml template provided and place the file according to the instructions in the logback-access documentation.