https://github.com/apitally/apitally-java
Simple, privacy-focused API monitoring & analytics for Java web apps
https://github.com/apitally/apitally-java
api api-analytics api-logging api-monitoring api-observability monitoring rest-api spring-boot
Last synced: 2 months ago
JSON representation
Simple, privacy-focused API monitoring & analytics for Java web apps
- Host: GitHub
- URL: https://github.com/apitally/apitally-java
- Owner: apitally
- License: mit
- Created: 2025-02-16T03:55:46.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-04-04T22:33:34.000Z (3 months ago)
- Last Synced: 2025-04-11T22:17:45.751Z (3 months ago)
- Topics: api, api-analytics, api-logging, api-monitoring, api-observability, monitoring, rest-api, spring-boot
- Language: Java
- Homepage: https://apitally.io
- Size: 45.9 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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 SDK for Java
[](https://github.com/apitally/apitally-java/actions)
[](https://codecov.io/gh/apitally/apitally-java)
This SDK for Apitally currently supports the following Java web frameworks:
- [Spring Boot](https://docs.apitally.io/frameworks/spring-boot) (≥ 3.0, Java
17+)
Learn more about Apitally on our 🌎 [website](https://apitally.io) or check out
the 📚 [documentation](https://docs.apitally.io).
## 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:
```xml
io.apitally
apitally
[0.1.0,)
```
## Usage
Add Apitally to your Spring Boot application using the `@UseApitally`
annotation.
```java
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:
```yaml
apitally:
client-id: "your-client-id"
env: "dev" # or "prod" etc.
```
For further instructions, see our
[setup guide for Spring Boot](https://docs.apitally.io/frameworks/spring-boot).
## Getting help
If you need help please
[create a new discussion](https://github.com/orgs/apitally/discussions/categories/q-a)
on GitHub or
[join our Slack workspace](https://join.slack.com/t/apitally-community/shared_invite/zt-2b3xxqhdu-9RMq2HyZbR79wtzNLoGHrg).
## License
This library is licensed under the terms of the MIT license.