Skip to content

Commit

Permalink
Fixes #33: Publish both a standard and uber jar
Browse files Browse the repository at this point in the history
  • Loading branch information
ajsquared committed Jan 24, 2016
1 parent 378ab7a commit 150abde
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,25 @@ You will need the statsd-jvm-profiler JAR on the machine where the JVM will be r

The JAR can be built with `mvn package`. You will need a relatively recent Maven (at least Maven 3).

statsd-jvm-profiler is available in Maven Central:
```xml
<dependency>
<groupId>com.etsy</groupId>
<artifactId>statsd-jvm-profiler</artifactId>
<version>1.0.0</version>
</dependency>
```

If you would like an uberjar containing all of the dependencies instead of the standard JAR, use the `jar-with-dependencies` classifier:
```xml
<dependency>
<groupId>com.etsy</groupId>
<artifactId>statsd-jvm-profiler</artifactId>
<version>1.0.0</version>
<classifier>jar-with-dependencies</classifier>
</dependency>
```

## Usage

The profiler is enabled using the JVM's `-javaagent` argument. You are required to specify at least the StatsD host and port number to use. You can also specify the prefix for metrics and a whitelist of packages to be included in the CPU profiling. Arguments can be specified like so:
Expand Down
6 changes: 5 additions & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<groupId>com.etsy</groupId>
<artifactId>statsd-jvm-profiler</artifactId>
<version>0.9.1-SNAPSHOT</version>
<version>1.0.1-SNAPSHOT</version>
<packaging>jar</packaging>

<name>statsd-jvm-profiler</name>
Expand Down Expand Up @@ -163,6 +163,10 @@
<goals>
<goal>shade</goal>
</goals>
<configuration>
<shadedArtifactAttached>true</shadedArtifactAttached>
<shadedClassifierName>jar-with-dependencies</shadedClassifierName>
</configuration>
</execution>
</executions>
<configuration>
Expand Down

0 comments on commit 150abde

Please sign in to comment.