Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/treblle/treblle-spring

The official Treblle SDK for Java. Seamlessly integrate Treblle to manage communication with your dashboard, send errors, and secure sensitive data.
https://github.com/treblle/treblle-spring

api api-monitoring api-observability backend developer-tool java java-spring-sdk logging rest-api restful-api sdk sdk-java spring spring-backend treblle treblle-sdk

Last synced: about 18 hours ago
JSON representation

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

Host: GitHub
URL: https://github.com/treblle/treblle-spring
Owner: Treblle
License: mit
Created: 2021-09-20T09:11:29.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-04-07T12:52:11.000Z (6 months ago)
Last Synced: 2024-09-24T12:03:57.703Z (about 21 hours ago)
Topics: api, api-monitoring, api-observability, backend, developer-tool, java, java-spring-sdk, logging, rest-api, restful-api, sdk, sdk-java, spring, spring-backend, treblle, treblle-sdk
Language: Java
Homepage: https://www.treblle.com/
Size: 70.3 KB
Stars: 12
Watchers: 3
Forks: 2
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


  





# 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](https://www.treblle.com/features/api-monitoring-observability)

- [Auto-generated API Docs](https://www.treblle.com/features/auto-generated-api-docs)

- [API analytics](https://www.treblle.com/features/api-analytics)

- [Treblle API Score](https://www.treblle.com/features/api-quality-score)

- [API Lifecycle Collaboration](https://www.treblle.com/features/api-lifecycle)

- [Native Treblle Apps](https://www.treblle.com/features/native-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](http://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](https://docs.treblle.com/en/security/masked-fields#fields-masked-by-default).

This means data masking is super fast and happens on a programming level before the API request is sent to Treblle. You can [customize](https://docs.treblle.com/en/security/masked-fields#custom-masked-fields) exactly which fields are masked when you’re integrating the SDK.

> Visit the [Masked fields](https://docs.treblle.com/en/security/masked-fields) section of the [docs](https://docs.sailscasts.com) for the complete documentation.

## Get Started

1. Sign in to [Treblle](https://app.treblle.com).

2. [Create a Treblle project](https://docs.treblle.com/en/dashboard/projects#creating-a-project).

3. [Setup the SDK](#install-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:

```xml

  

    

        com.treblle

        treblle-spring-boot-starter

        1.0.1

    

  

```

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

```xml

  

    

        com.treblle

        treblle-spring-boot-starter

        2.0.4

    

  

```

Get your [API key](https://docs.treblle.com/en/dashboard#accessing-your-api-key) and [Project ID](https://docs.treblle.com/en/dashboard/projects#project-id) from the Treblle dashboard. After you have those, simply initialize Treblle in your project like so:

Annotate the desired configuration with `@EnableTreblle`

```java

@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:

```properties

treblle.endpoint= # Default is https://rocknrolla.treblle.com

treblle.apiKey=

treblle.projectId=

treblle.filter-order= # Default Ordered.LOWEST_PRECEDENCE - 10, similar to Springs HttpTraceFilter

treblle.debug=false # Default is false

treblle.masking-keywords= # Additional masking keywords separated by comma, to mask whole objects use .*

```

In case you are using the `application.yml` file:

```yaml

treblle:

  endpoint:  # Default is https://rocknrolla.treblle.com

  api-key: 

  project-id: 

  filter-order:  # Default Ordered.LOWEST_PRECEDENCE - 10, similar to Springs HttpTraceFilter

  debug: false # Default is false

  masking-keywords:  # Additional masking keywords separated by comma, to mask whole objects use .*

```

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:

```java

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](https://docs.treblle.com/en/integrations) that let you seamlessly integrate Treblle with your REST-based APIs.

- [`treblle-laravel`](https://github.com/Treblle/treblle-laravel): SDK for Laravel

- [`treblle-php`](https://github.com/Treblle/treblle-php): SDK for PHP

- [`treblle-symfony`](https://github.com/Treblle/treblle-symfony): SDK for Symfony

- [`treblle-lumen`](https://github.com/Treblle/treblle-lumen): SDK for Lumen

- [`treblle-sails`](https://github.com/Treblle/treblle-sails): SDK for Sails

- [`treblle-adonisjs`](https://github.com/Treblle/treblle-adonisjs): SDK for AdonisJS

- [`treblle-fastify`](https://github.com/Treblle/treblle-fastify): SDK for Fastify

- [`treblle-directus`](https://github.com/Treblle/treblle-directus): SDK for Directus

- [`treblle-strapi`](https://github.com/Treblle/treblle-strapi): SDK for Strapi

- [`treblle-express`](https://github.com/Treblle/treblle-express): SDK for Express

- [`treblle-koa`](https://github.com/Treblle/treblle-koa): SDK for Koa

- [`treblle-go`](https://github.com/Treblle/treblle-go): SDK for Go

- [`treblle-ruby`](https://github.com/Treblle/treblle-ruby): SDK for Ruby on Rails

- [`treblle-python`](https://github.com/Treblle/treblle-python): SDK for Python/Django

> See the [docs](https://docs.treblle.com/en/integrations) 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`](https://github.com/Treblle/treblle-utils):  A set of helpers and

  utility functions useful for the JavaScript SDKs.

- [`php-utils`](https://github.com/Treblle/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](https://blog.treblle.com), and on [Twitter](https://twitter.com/treblleapi).

You can chat with the team and other members on [Discord](https://treblle.com/chat) and follow our tutorials and other video material at [YouTube](https://youtube.com/@treblle).

[![Treblle Discord](https://img.shields.io/badge/Treblle%20Discord-Join%20our%20Discord-F3F5FC?labelColor=7289DA&style=for-the-badge&logo=discord&logoColor=F3F5FC&link=https://treblle.com/chat)](https://treblle.com/chat)

[![Treblle YouTube](https://img.shields.io/badge/Treblle%20YouTube-Subscribe%20on%20YouTube-F3F5FC?labelColor=c4302b&style=for-the-badge&logo=YouTube&logoColor=F3F5FC&link=https://youtube.com/@treblle)](https://youtube.com/@treblle)

[![Treblle on Twitter](https://img.shields.io/badge/Treblle%20on%20Twitter-Follow%20Us-F3F5FC?labelColor=1DA1F2&style=for-the-badge&logo=Twitter&logoColor=F3F5FC&link=https://twitter.com/treblleapi)](https://twitter.com/treblleapi)

### How to contribute

Here are some ways of contributing to making Treblle better:

- **[Try out Treblle](https://docs.treblle.com/en/introduction#getting-started)**, and let us know ways to make Treblle better for you. Let us know here on [Discord](https://treblle.com/chat).

- Join our [Discord](https://treblle.com/chat) and connect with other members to share and learn from.

- Send a pull request to any of our [open source repositories](https://github.com/Treblle) 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