diff --git a/README.md b/README.md index ead23ff..003461e 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,14 @@ -# stackify-api-java - [![Maven Central](https://img.shields.io/maven-central/v/com.stackify/stackify-api-java.svg)](http://mvnrepository.com/artifact/com.stackify/stackify-api-java) -[![Build Status](https://travis-ci.org/stackify/stackify-api-java.png)](https://travis-ci.org/stackify/stackify-api-java) [![Coverage Status](https://coveralls.io/repos/stackify/stackify-api-java/badge.png?branch=master)](https://coveralls.io/r/stackify/stackify-api-java?branch=master) -Stackify API for Java - -Errors and Logs Overview: - -http://support.stackify.com/errors-and-logs-overview/ - -Sign Up for a Trial: - -http://www.stackify.com/sign-up/ +## Stackify API for Java -Log4j 1.2 Appender: - -https://github.com/stackify/stackify-log-log4j12 - -Logback Appender: - -https://github.com/stackify/stackify-log-logback +* **Errors and Logs Overview:** http://support.stackify.com/errors-and-logs-overview/ +* **Sign Up for a Trial:** http://www.stackify.com/sign-up/ +* **Appenders** + * **Log4j 1.2:** https://github.com/stackify/stackify-log-log4j12 + * **Log4j 2.x:** https://github.com/stackify/stackify-log-log4j2 + * **Logback:** https://github.com/stackify/stackify-log-logback ## Installation @@ -29,7 +17,7 @@ Add it as a maven dependency: com.stackify stackify-api-java - INSERT_LATEST_MAVEN_CENTRAL_VERSION + 4.0.0 ``` @@ -88,38 +76,20 @@ Be sure to shutdown the Direct Logger to flush this appender of any messages and LogManager.shutdown(); ``` -### RUM Manual Instrumentation - -Real User Monitoring (RUM) manual instrumentation allows you to specify where the RUM JavaScript block is injected. - -It is recommended you provide a `stackify-api.properties` file in your application classpath with the following content: - -```` -stackify.application=My Application Name -stackify.environment=My Environment Name -```` - -Your application code will need to call out to the Stackify `com.stackify.apm.Stackify.getRUMJavaScriptBlock()` method in the `` section as detailed below: - -**JSP Example** - -```` - - - <%= com.stackify.apm.Stackify.getRUMJavaScriptBlock() %> -