API monitoring & analytics made simple

Metrics, logs, and alerts for your APIs — with just a few lines of code.

Apitally is a simple API monitoring and analytics tool that makes it easy to understand how your APIs are used and helps you troubleshoot API issues faster. Setup is easy and takes less than 5 minutes.

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

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.

Drill down from insights to individual API requests or use powerful search and filters to find specific requests. View correlated application logs for a complete picture of each request, making troubleshooting faster and easier.

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.

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

This SDK supports Spring Boot (>=3.0) on Java 17 or higher.

Apitally also supports many other web frameworks in JavaScript, Python, Go, and .NET via our other SDKs.

If you don't have an Apitally account yet, first sign up here. Create an app in the Apitally dashboard and select Spring Boot as your framework. You'll see detailed setup instructions with code snippets you can copy and paste. These also include your client ID.

Add the following dependency to your pom.xml file:

<dependency>
  <groupId>io.apitally</groupId>
  <artifactId>apitally</artifactId>
  <version>[0.5.0,)</version>
</dependency>

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 configure Apitally in your application.yml file:

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

  # Optional: configure request logging
  request-logging:
    enabled: true
    request-headers-included: true
    request-body-included: true
    response-body-included: true
    log-capture-enabled: true

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

See the SDK reference for all available configuration options, including how to mask sensitive data, customize request logging, and more.

If you need help please create a new discussion on GitHub or email us at support@apitally.io. We'll get back to you as soon as possible.

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