{"id":14973029,"url":"https://github.com/treblle/treblle-spring","last_synced_at":"2025-07-08T04:11:38.772Z","repository":{"id":57729145,"uuid":"408377763","full_name":"Treblle/treblle-spring","owner":"Treblle","description":"The official Treblle SDK for Java. Seamlessly integrate Treblle to manage communication with your dashboard, send errors, and secure sensitive data.","archived":false,"fork":false,"pushed_at":"2025-03-29T19:24:30.000Z","size":139,"stargazers_count":13,"open_issues_count":2,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-08T02:51:16.368Z","etag":null,"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"],"latest_commit_sha":null,"homepage":"https://www.treblle.com/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Treblle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-20T09:11:29.000Z","updated_at":"2025-03-15T15:58:16.000Z","dependencies_parsed_at":"2024-04-07T13:41:03.039Z","dependency_job_id":"8f162399-6d5a-44c7-ab4f-36b66a1a6b84","html_url":"https://github.com/Treblle/treblle-spring","commit_stats":{"total_commits":28,"total_committers":5,"mean_commits":5.6,"dds":0.4285714285714286,"last_synced_commit":"dc0f814112891ba3d32602264adf52068a26eacb"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/Treblle/treblle-spring","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Treblle%2Ftreblle-spring","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Treblle%2Ftreblle-spring/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Treblle%2Ftreblle-spring/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Treblle%2Ftreblle-spring/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Treblle","download_url":"https://codeload.github.com/Treblle/treblle-spring/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Treblle%2Ftreblle-spring/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260126444,"owners_count":22962649,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["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"],"created_at":"2024-09-24T13:47:58.825Z","updated_at":"2025-06-16T08:32:45.348Z","avatar_url":"https://github.com/Treblle.png","language":"Java","readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/user-attachments/assets/e9845001-32c7-4fbf-b044-0f509fd15ce1\"/\u003e\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\n\n# Treblle\n\n\u003ca href=\"https://docs.treblle.com/en/integrations\" target=\"_blank\"\u003eIntegrations\u003c/a\u003e\n\u003cspan\u003e\u0026nbsp;\u0026nbsp;•\u0026nbsp;\u0026nbsp;\u003c/span\u003e\n\u003ca href=\"http://treblle.com/\" target=\"_blank\"\u003eWebsite\u003c/a\u003e\n\u003cspan\u003e\u0026nbsp;\u0026nbsp;•\u0026nbsp;\u0026nbsp;\u003c/span\u003e\n\u003ca href=\"https://docs.treblle.com\" target=\"_blank\"\u003eDocs\u003c/a\u003e\n\u003cspan\u003e\u0026nbsp;\u0026nbsp;•\u0026nbsp;\u0026nbsp;\u003c/span\u003e\n\u003ca href=\"https://blog.treblle.com\" target=\"_blank\"\u003eBlog\u003c/a\u003e\n\u003cspan\u003e\u0026nbsp;\u0026nbsp;•\u0026nbsp;\u0026nbsp;\u003c/span\u003e\n\u003ca href=\"https://twitter.com/treblleapi\" target=\"_blank\"\u003eTwitter\u003c/a\u003e\n\u003cspan\u003e\u0026nbsp;\u0026nbsp;•\u0026nbsp;\u0026nbsp;\u003c/span\u003e\n\u003ca href=\"https://treblle.com/chat\" target=\"_blank\"\u003eDiscord\u003c/a\u003e\n\u003cbr /\u003e\n\n  \u003chr /\u003e\n\u003c/div\u003e\n\nAPI Intelligence Platform. 🚀\n\nTreblle is a lightweight SDK that helps Engineering and Product teams build, ship \u0026 maintain REST-based APIs faster.\n\n## Features\n\n\u003cdiv align=\"center\"\u003e\n  \u003cbr /\u003e\n  \u003cimg src=\"https://github.com/user-attachments/assets/58be66d4-c101-4ec1-b6c3-fd33477ddddb\"/\u003e\n  \u003cbr /\u003e\n  \u003cbr /\u003e\n\u003c/div\u003e\n\n- [API Monitoring \u0026 Observability](https://www.treblle.com/features/api-monitoring-observability)\n- [Auto-generated API Docs](https://www.treblle.com/features/auto-generated-api-docs)\n- [API analytics](https://www.treblle.com/features/api-analytics)\n- [Treblle API Score](https://www.treblle.com/features/api-quality-score)\n- [API Lifecycle Collaboration](https://www.treblle.com/features/api-lifecycle)\n- [Native Treblle Apps](https://www.treblle.com/features/native-apps)\n\n\n## How Treblle Works\nOnce you’ve integrated a Treblle SDK in your codebase, this SDK will send requests and response data to your Treblle Dashboard.\n\nIn 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.\n\nTreblle 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.\n\n\u003e Visit [https://docs.treblle.com](http://docs.treblle.com) for the complete documentation.\n\n## Security\n\n### Masking fields\nMasking fields ensure certain sensitive data are removed before being sent to Treblle.\n\nTo 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).\n\nThis 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.\n\n\u003e Visit the [Masked fields](https://docs.treblle.com/en/security/masked-fields) section of the [docs](https://docs.sailscasts.com) for the complete documentation.\n\n\n## Get Started\n\n1. Sign in to [Treblle](https://platform.treblle.com).\n2. [Create a Treblle project](https://docs.treblle.com/en/dashboard/projects#creating-a-project).\n3. [Setup the SDK](#install-the-SDK) for your platform.\n\n### Install the SDK\n\nAdd the subsequent dependency to your `pom.xml` file while ensuring it aligns with your Spring Boot version:\n\nFor Spring Boot `2.4.X` with `Java 8` and higher:\n\n```xml\n\u003cdependencies\u003e\n  \u003c!-- Other dependencies --\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003ecom.treblle\u003c/groupId\u003e\n        \u003cartifactId\u003etreblle-spring-boot-starter\u003c/artifactId\u003e\n        \u003cversion\u003e1.0.1\u003c/version\u003e\n    \u003c/dependency\u003e\n  \u003c!-- Other dependencies --\u003e\n\u003c/dependencies\u003e\n```\n\nFor Spring Boot `3.X` with `Java 17` and higher:\n```xml\n\u003cdependencies\u003e\n  \u003c!-- Other dependencies --\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003ecom.treblle\u003c/groupId\u003e\n        \u003cartifactId\u003etreblle-spring-boot-starter\u003c/artifactId\u003e\n        \u003cversion\u003e2.0.4\u003c/version\u003e\n    \u003c/dependency\u003e\n  \u003c!-- Other dependencies --\u003e\n\u003c/dependencies\u003e\n```\n\nGet 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:\n\nAnnotate the desired configuration with `@EnableTreblle`\n\n```java\n@EnableTreblle\n@SpringBootApplication\npublic class MyApplication {\n  \n    public static void main(String[] args) {\n        SpringApplication.run(MyApplication.class, args);\n    }\n    \n}\n```\n\nConfigure the following properties in your `application.properties` file:\n\n```properties\ntreblle.endpoint=\u003cOPTIONAL_ENDPOINT_URL\u003e # Default is https://rocknrolla.treblle.com\ntreblle.apiKey=\u003cAPI_KEY\u003e\ntreblle.projectId=\u003cPROJECT_ID\u003e\ntreblle.filter-order=\u003cORDER_OF_TREBLLE_FILTER\u003e # Default Ordered.LOWEST_PRECEDENCE - 10, similar to Springs HttpTraceFilter\ntreblle.debug=false # Default is false\ntreblle.masking-keywords=\u003cADDITIONAL_KEYWORDS_TO_MASK\u003e # Additional masking keywords separated by comma, to mask whole objects use \u003ckeyword\u003e.*\n```\n\nIn case you are using the `application.yml` file:\n\n```yaml\ntreblle:\n  endpoint: \u003cOPTIONAL_ENDPOINT_URL\u003e # Default is https://rocknrolla.treblle.com\n  api-key: \u003cAPI_KEY\u003e\n  project-id: \u003cPROJECT_ID\u003e\n  filter-order: \u003cORDER_OF_TREBLLE_FILTER\u003e # Default Ordered.LOWEST_PRECEDENCE - 10, similar to Springs HttpTraceFilter\n  debug: false # Default is false\n  masking-keywords: \u003cADDITIONAL_KEYWORDS_TO_MASK\u003e # Additional masking keywords separated by comma, to mask whole objects use \u003ckeyword\u003e.*\n```\n\nThat's it. Your API requests and responses are now being sent to your Treblle project.\n\n#### Need to disable Treblle processing based on certain request conditions? Just implement the following bean:\n\n```java\nimport org.springframework.context.annotation.Primary;\nimport org.springframework.stereotype.Component;\n\n@Primary\n@Component\npublic class MyTreblleConfiguration implements TreblleConfiguration {\n\n  @Override\n  public boolean shouldProcess(HttpServletRequest servletRequest) {\n    // You custom logic in deciding if the request should be processed. Default implementation returns true.\n    return true;\n  }\n\n}\n```\n\n\u003e See the [docs]() for this SDK to learn more.\n\n## Available SDKs\n\nTreblle provides [open-source SDKs](https://docs.treblle.com/en/integrations) that let you seamlessly integrate Treblle with your REST-based APIs.\n\n- [`treblle-laravel`](https://github.com/Treblle/treblle-laravel): SDK for Laravel\n- [`treblle-php`](https://github.com/Treblle/treblle-php): SDK for PHP\n- [`treblle-symfony`](https://github.com/Treblle/treblle-symfony): SDK for Symfony\n- [`treblle-lumen`](https://github.com/Treblle/treblle-lumen): SDK for Lumen\n- [`treblle-sails`](https://github.com/Treblle/treblle-sails): SDK for Sails\n- [`treblle-adonisjs`](https://github.com/Treblle/treblle-adonisjs): SDK for AdonisJS\n- [`treblle-fastify`](https://github.com/Treblle/treblle-fastify): SDK for Fastify\n- [`treblle-directus`](https://github.com/Treblle/treblle-directus): SDK for Directus\n- [`treblle-strapi`](https://github.com/Treblle/treblle-strapi): SDK for Strapi\n- [`treblle-express`](https://github.com/Treblle/treblle-express): SDK for Express\n- [`treblle-koa`](https://github.com/Treblle/treblle-koa): SDK for Koa\n- [`treblle-go`](https://github.com/Treblle/treblle-go): SDK for Go\n- [`treblle-ruby`](https://github.com/Treblle/treblle-ruby): SDK for Ruby on Rails\n- [`treblle-python`](https://github.com/Treblle/treblle-python): SDK for Python/Django\n\n\u003e See the [docs](https://docs.treblle.com/en/integrations) for more on SDKs and Integrations.\n\n## Other Packages\n\nBesides the SDKs, we also provide helpers and configuration used for SDK\ndevelopment. If you're thinking about contributing to or creating a SDK, have a look at the resources\nbelow:\n\n- [`treblle-utils`](https://github.com/Treblle/treblle-utils):  A set of helpers and\n  utility functions useful for the JavaScript SDKs.\n- [`php-utils`](https://github.com/Treblle/php-utils):   A set of helpers and\n  utility functions useful for the PHP SDKs.\n\n## Community 💙\n\nFirst and foremost: **Star and watch this repository** to stay up-to-date.\n\nAlso, follow our [Blog](https://blog.treblle.com), and on [Twitter](https://twitter.com/treblleapi).\n\nYou 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).\n\n[![Treblle Discord](https://img.shields.io/badge/Treblle%20Discord-Join%20our%20Discord-F3F5FC?labelColor=7289DA\u0026style=for-the-badge\u0026logo=discord\u0026logoColor=F3F5FC\u0026link=https://treblle.com/chat)](https://treblle.com/chat)\n\n[![Treblle YouTube](https://img.shields.io/badge/Treblle%20YouTube-Subscribe%20on%20YouTube-F3F5FC?labelColor=c4302b\u0026style=for-the-badge\u0026logo=YouTube\u0026logoColor=F3F5FC\u0026link=https://youtube.com/@treblle)](https://youtube.com/@treblle)\n\n[![Treblle on Twitter](https://img.shields.io/badge/Treblle%20on%20Twitter-Follow%20Us-F3F5FC?labelColor=1DA1F2\u0026style=for-the-badge\u0026logo=Twitter\u0026logoColor=F3F5FC\u0026link=https://twitter.com/treblleapi)](https://twitter.com/treblleapi)\n\n### How to contribute\n\nHere are some ways of contributing to making Treblle better:\n\n- **[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).\n- Join our [Discord](https://treblle.com/chat) and connect with other members to share and learn from.\n- 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!\n\n### Contributors\n\u003c!-- Replace link with the link of the SDK contributors--\u003e\n\u003ca href=\"https://github.com/Treblle/treblle-spring/graphs/contributors\"\u003e\n  \u003cp align=\"center\"\u003e\n    \u003cimg  src=\"https://contrib.rocks/image?repo=Treblle/treblle-spring\" alt=\"A table of avatars from the project's contributors\" /\u003e\n  \u003c/p\u003e\n\u003c/a\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftreblle%2Ftreblle-spring","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftreblle%2Ftreblle-spring","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftreblle%2Ftreblle-spring/lists"}