Skip to content

Installation

Garvit Joshi edited this page Apr 2, 2026 · 3 revisions

Installation

This guide covers how to add tremor-client-java to a JVM project.

Requirements

  • Java 8 or higher
  • Maven or Gradle
  • Access to a Tremor server

Maven Coordinates

The current source tree uses:

<dependency>
    <groupId>in.riido</groupId>
    <artifactId>tremor-client-java</artifactId>
    <version>0.1.0-SNAPSHOT</version>
</dependency>

If a released version is available, use that released version instead of the snapshot.

Build From Source

If the artifact is not yet published where you consume dependencies from, install it locally first:

git clone https://github.com/riido-git/tremor-client-java.git
cd tremor-client-java
mvn -q install

After that, Maven projects can use the dependency directly.

Maven

Add this to pom.xml:

<dependency>
    <groupId>in.riido</groupId>
    <artifactId>tremor-client-java</artifactId>
    <version>0.1.0-SNAPSHOT</version>
</dependency>

Gradle

For Gradle:

implementation 'in.riido:tremor-client-java:0.1.0-SNAPSHOT'

For Kotlin DSL:

implementation("in.riido:tremor-client-java:0.1.0-SNAPSHOT")

Runtime Dependencies

The client keeps runtime dependencies minimal:

  • com.squareup.okhttp3:okhttp-jvm:5.3.2
  • com.google.code.gson:gson:2.13.2

You do not need to add Spring, Retrofit, Jackson, Apache HttpClient, or SLF4J for the core client.

Verify Installation

Use the smallest possible send flow:

import in.riido.tremor.client.TremorClient;

String tremorKey = "...";

try (TremorClient client =
    TremorClient.builder(tremorKey).baseUrl("http://localhost:8080/tremor").build()) {
    client.send(new IllegalStateException("installation test"));
}

On success, Tremor returns a fingerprint string.

Compatibility

Item Version
Java baseline 8
HTTP client OkHttp 5.3.2
JSON library Gson 2.13.2
Test stack JUnit Jupiter 5.14.3 + MockWebServer 5.3.2

Next Steps

  1. Configure the client
  2. Capture exceptions directly
  3. Send explicit events

Clone this wiki locally