treblle/treblle-spring

The official Treblle SDK for Java. Seamlessly integrate Treblle to manage communication with your dashboard, send errors, and secure sensitive data.

Treblle

Integrations   •   Website   •   Docs   •   Blog   •   Twitter   •   Discord

---

Treblle is a lightweight SDK that helps Engineering and Product teams build, ship & maintain REST based APIs faster.

Features

• API Monitoring & Observability
• Auto-generated API Docs
• API analytics
• Treblle API Score
• API Lifecycle Collaboration
• Native Treblle Apps

How Treblle Works

Once you’ve integrated a Treblle SDK in your codebase, this SDK will send requests and response data to your Treblle Dashboard.

In your Treblle Dashboard you get to see real-time requests to your API, auto-generated API docs, API analytics like how fast the response was for an endpoint, the load size of the response, etc.

Treblle also uses the requests sent to your Dashboard to calculate your API score which is a quality score that’s calculated based on the performance, quality, and security best practices for your API.

Visit https://docs.treblle.com for the complete documentation.

Security

Masking fields

Masking fields ensure certain sensitive data are removed before being sent to Treblle.

To make sure masking is done before any data leaves your server we built it into all our SDKs.

This means data masking is super fast and happens on a programming level before the API request is sent to Treblle. You can customize exactly which fields are masked when you’re integrating the SDK.

Visit the Masked fields section of the docs for the complete documentation.

Get Started

1. Sign in to Treblle.
2. Create a Treblle project.
3. Setup the SDK for your platform.

Install the SDK

Add the subsequent dependency to your pom.xml file while ensuring it aligns with your Spring Boot version:

For Spring Boot 2.4.X with Java 8 and higher:

<dependencies>
  <!-- Other dependencies -->
    <dependency>
        <groupId>com.treblle</groupId>
        <artifactId>treblle-spring-boot-starter</artifactId>
        <version>1.0.1</version>
    </dependency>
  <!-- Other dependencies -->
</dependencies>

For Spring Boot 3.X with Java 17 and higher:

<dependencies>
  <!-- Other dependencies -->
    <dependency>
        <groupId>com.treblle</groupId>
        <artifactId>treblle-spring-boot-starter</artifactId>
        <version>2.0.4</version>
    </dependency>
  <!-- Other dependencies -->
</dependencies>

Get your API key and Project ID from the Treblle dashboard. After you have those, simply initialize Treblle in your project like so:

Annotate the desired configuration with @EnableTreblle

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

Configure the following properties in your application.properties file:

treblle.endpoint=<OPTIONAL_ENDPOINT_URL> # Default is https://rocknrolla.treblle.com
treblle.apiKey=<API_KEY>
treblle.projectId=<PROJECT_ID>
treblle.filter-order=<ORDER_OF_TREBLLE_FILTER> # Default Ordered.LOWEST_PRECEDENCE - 10, similar to Springs HttpTraceFilter
treblle.debug=false # Default is false
treblle.masking-keywords=<ADDITIONAL_KEYWORDS_TO_MASK> # Additional masking keywords separated by comma, to mask whole objects use <keyword>.*

In case you are using the application.yml file:

treblle:
  endpoint: <OPTIONAL_ENDPOINT_URL> # Default is https://rocknrolla.treblle.com
  api-key: <API_KEY>
  project-id: <PROJECT_ID>
  filter-order: <ORDER_OF_TREBLLE_FILTER> # Default Ordered.LOWEST_PRECEDENCE - 10, similar to Springs HttpTraceFilter
  debug: false # Default is false
  masking-keywords: <ADDITIONAL_KEYWORDS_TO_MASK> # Additional masking keywords separated by comma, to mask whole objects use <keyword>.*

That's it. Your API requests and responses are now being sent to your Treblle project.

Need to disable Treblle processing based on certain request conditions? Just implement the following bean:

import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;

@Primary
@Component
public class MyTreblleConfiguration implements TreblleConfiguration {

  @Override
  public boolean shouldProcess(HttpServletRequest servletRequest) {
    // You custom logic in deciding if the request should be processed. Default implementation returns true.
    return true;
  }

}

See the docs for this SDK to learn more.

Available SDKs

Treblle provides open-source SDKs that let you seamlessly integrate Treblle with your REST-based APIs.

• treblle-laravel: SDK for Laravel
• treblle-php: SDK for PHP
• treblle-symfony: SDK for Symfony
• treblle-lumen: SDK for Lumen
• treblle-sails: SDK for Sails
• treblle-adonisjs: SDK for AdonisJS
• treblle-fastify: SDK for Fastify
• treblle-directus: SDK for Directus
• treblle-strapi: SDK for Strapi
• treblle-express: SDK for Express
• treblle-koa: SDK for Koa
• treblle-go: SDK for Go
• treblle-ruby: SDK for Ruby on Rails
• treblle-python: SDK for Python/Django

See the docs for more on SDKs and Integrations.

Other Packages

Besides the SDKs, we also provide helpers and configuration used for SDK development. If you're thinking about contributing to or creating a SDK, have a look at the resources below:

• treblle-utils: A set of helpers and utility functions useful for the JavaScript SDKs.
• php-utils: A set of helpers and utility functions useful for the PHP SDKs.

Community 💙

First and foremost: Star and watch this repository to stay up-to-date.

Also, follow our Blog, and on Twitter.

You can chat with the team and other members on Discord and follow our tutorials and other video material at YouTube.

How to contribute

Here are some ways of contributing to making Treblle better:

• Try out Treblle, and let us know ways to make Treblle better for you. Let us know here on Discord.
• Join our Discord and connect with other members to share and learn from.
• Send a pull request to any of our open source repositories on Github. Check the contribution guide on the repo you want to contribute to for more details about how to contribute. We're looking forward to your contribution!

Contributors

treblle-spring's Issues

Don’t block API response with network call

The current response filtering approach waits for Trebble to respond (or fail) before allowing Spring to respond to the client. A more robust approach would be to save the Trebble request to a local bounded buffer, and upload to Trebble from the buffer asynchronously. This will reduce the latency impact to clients.

Payload exception error on version 1.0.1

• Spring Boot version: 2.7.3
• Java Version: 17
• Enviroment: Heroku

Exception:

com.treblle.spring.TreblleFilter : An error occurred while sending data to Treblle. Jan 24 08:53:32 pitchyn-service app/web.1 java.lang.IllegalStateException: Duplicate key Vary (attempted merging values Origin and Origin) Jan 24 08:53:32 pitchyn-service app/web.1 at java.base/java.util.stream.Collectors.duplicateKeyException(Collectors.java:135)

A customer reported a bug which seems to happen only when they deploy to Heroku. Locally everything works fine. Based on the exception it might be something that is maybe duplicated in the payload?

Any ideas @IvoMajic