Simple, privacy-focused API monitoring & analytics

Apitally helps you understand how your APIs are being used and alerts you when things go wrong.
Just add two lines of code to your project to get started.

---

Apitally client library for Java

This client library for Apitally currently supports the following Java web frameworks:

• Spring Boot (≥ 3.0, Java 17+)

Learn more about Apitally on our 🌎 website or check out the 📚 documentation.

Key features

API analytics

Track traffic, error and performance metrics for your API, each endpoint and individual API consumers, allowing you to make informed, data-driven engineering and product decisions.

Error tracking

Understand which validation rules in your endpoints cause client errors. Capture error details and stack traces for 500 error responses, and have them linked to Sentry issues automatically.

Request logging

Drill down from insights to individual requests or use powerful filtering to understand how consumers have interacted with your API. Configure exactly what is included in the logs to meet your requirements.

API monitoring & alerting

Get notified immediately if something isn't right using custom alerts, synthetic uptime checks and heartbeat monitoring. Notifications can be delivered via email, Slack or Microsoft Teams.

Install

Add the following dependency to your pom.xml file:

<dependency>
  <groupId>io.apitally</groupId>
  <artifactId>apitally-java</artifactId>
  <version>[0.1.0,)</version>
</dependency>

Usage

Add Apitally to your Spring Boot application using the @UseApitally annotation.

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

import io.apitally.spring.UseApitally;

@UseApitally
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

Then add the following properties to your application.yml file:

apitally:
  client-id: "your-client-id"
  env: "dev" # or "prod" etc.

For further instructions, see our setup guide for Spring Boot.

Getting help

If you need help please create a new discussion on GitHub or join our Slack workspace.

License

This library is licensed under the terms of the MIT license.