Merge pull request #20 from Treblle/feat/exclude-routes

Introduce excludedRoutes feature

Author: cindreta

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 treblle
+Copyright (c) 2021 Treblle
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,66 +1,47 @@
-# Treblle
+# Treblle - API Intelligence Platform
 
-![Treblle Logo](https://github.com/user-attachments/assets/54f0c084-65bb-4431-b80d-cceab6c63dc3 "Treblle Logo")
+[![Treblle API Intelligence](https://github.com/user-attachments/assets/b268ae9e-7c8a-4ade-95da-b4ac6fce6eea)](https://treblle.com)
 
-[Integrations](https://docs.treblle.com/en/integrations) •
-[Website](http://treblle.com/) •
-[Docs](https://docs.treblle.com) •
-[Blog](https://blog.treblle.com) •
-[Twitter](https://twitter.com/treblleapi) •
-[Discord](https://treblle.com/chat)
+[Website](http://treblle.com/) • [Documentation](https://docs.treblle.com/) • [Pricing](https://treblle.com/pricing)
 
----
-
-API Intelligence Platform.
-
-Treblle is a lightweight SDK that helps Engineering and Product teams build, ship & maintain REST-based APIs faster.
-
-## Features
-
-![Treblle Features](https://github.com/user-attachments/assets/9b5f40ba-bec9-414b-af88-f1c1cc80781b "Treblle 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.
+Treblle is an API intelligence platfom that helps developers, teams and organizations understand their APIs from a single integration point.
 
-## 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).
+## Treblle Go Lang SDK
 
-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.
+### Requirements
 
-> Visit the [Masked fields](https://docs.treblle.com/en/security/masked-fields) section of the [docs](https://docs.sailscasts.com) for the complete documentation.
+| Go Version | Support Status |
+|------------|----------------|
+| 1.23+      | Fully Supported |
+| 1.21 - 1.22 | Should work, not officially tested |
+| < 1.21     | Not Supported |
 
-## Get Started
+### Router & Framework Support
 
-1. Sign in to [Treblle](https://platform.treblle.com).
-2. [Create a Treblle project](https://docs.treblle.com/en/dashboard/projects#creating-a-project).
-3. [Setup the SDK](#installation) for your platform.
+| Router/Framework | Support Level | Native Integration |
+|------------------|---------------|-------------------|
+| **Standard Library** (`net/http`) | Fully Supported | Yes |
+| **Gin** | Fully Supported | Yes |
+| **Gorilla Mux** | ✅ Fully Supported | Yes |
+| **Chi** | Fully Supported | Yes |
+| **Echo** | Compatible | No |
+| **Fiber** | Compatible | No |
+| **Other Routers** | Compatible | No |
 
 ## Installation
 
+### 1. Install the Package
+
 ```bash
 go get github.com/Treblle/treblle-go/v2
 ```
 
-## Configuration
+### 2. Get Your Credentials
+Get your SDK Token and API Key from the [Treblle Dashboard](https://platform.treblle.com).
+
+### 3. Configure Treblle
 
 ```go
 import (
@@ -72,14 +53,12 @@ func main() {
         SDK_TOKEN: "your-treblle-sdk-token",
         API_KEY:   "your-treblle-api-key",
     })
-    
+
     // Your API server setup
     // ...
 }
 ```
 
-## Usage with Different Routers
-
 ### With Gin
 
 The SDK provides native support for the Gin framework with automatic route pattern extraction:
@@ -181,77 +160,87 @@ router.GET("/users/:id", wrapHandler(treblle.WithRoutePath("/users/:id",
     treblle.Middleware(http.HandlerFunc(getUserHandler)))))
 ```
 
-## Manual Route Path Setting
+## Excluding Routes
 
-You can also set route paths programmatically in your handlers:
+You can configure Treblle to exclude specific routes from being tracked. This is useful for health checks, metrics endpoints, internal APIs, or any routes you don't want to monitor.
+
+### Basic Usage
 
 ```go
-func myHandler(w http.ResponseWriter, r *http.Request) {
-    // Set the route path for this specific request
-    r = treblle.SetRoutePath(r, "/api/custom/:param")
-    
-    // Your handler logic
-    // ...
-}
+treblle.Configure(treblle.Configuration{
+    SDK_TOKEN: "your-treblle-sdk-token",
+    API_KEY:   "your-treblle-api-key",
+    ExcludedRoutes: []string{
+        "/health",           // Exact match
+        "/metrics",          // Exact match
+        "/admin/*",          // Wildcard: matches all admin routes
+        "/api/*/internal/*", // Multiple wildcards
+    },
+})
 ```
 
-## Examples
-
-Check the `examples` directory for complete example applications:
+### Pattern Types
 
-- `gorilla_example`: Shows integration with Gorilla Mux
-- `standard_example`: Shows integration with the standard HTTP package
+**Exact Match:**
+```go
+ExcludedRoutes: []string{"/health", "/status", "/readiness"}
+```
+- Matches exactly `/health`, `/status`, and `/readiness`
+- Case-insensitive matching
+- Trailing slashes are normalized (`/health/` matches `/health`)
 
-## Available SDKs
+**Simple Wildcard:**
+```go
+ExcludedRoutes: []string{"/admin/*"}
+```
+- Matches `/admin/dashboard`, `/admin/users`, `/admin/users/123`, etc.
+- The `*` matches any segment and **all nested paths**
+- Perfect for excluding entire sections of your API
 
-Treblle provides [open-source SDKs](https://docs.treblle.com/en/integrations) that let you seamlessly integrate Treblle with your REST-based APIs.
+**Multiple Wildcards:**
+```go
+ExcludedRoutes: []string{
+    "/api/*/internal/*",
+    "/v*/debug/*",
+}
+```
+- Each `*` matches exactly one path segment
+- `/api/*/internal/*` matches `/api/v1/internal/debug`, `/api/v2/internal/metrics/detailed`, etc.
+- Provides fine-grained control over exclusions
 
-- [`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
+### Environment Variable
 
-> See the [docs](https://docs.treblle.com/en/integrations) for more on SDKs and Integrations.
+You can also set excluded routes via environment variable:
+```bash
+export TREBLLE_EXCLUDED_ROUTES="/health,/metrics,/admin/*"
+```
 
-## Other Packages
+The environment variable uses comma-separated values and is loaded automatically if `ExcludedRoutes` is not set in the configuration.
 
-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.
+## Examples
 
-## Community
+Check the `examples` directory for complete example applications:
 
-First and foremost: **Star and watch this repository** to stay up-to-date.
+- `gorilla_example`: Shows integration with Gorilla Mux
+- `standard_example`: Shows integration with the standard HTTP package
 
-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).
+## Getting Help
 
-[![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)
+If you continue to experience issues:
 
-[![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)
+1. Enable `debug: true` and check console output
+2. Verify your SDK token and API key are correct in Treblle dashboard
+3. Test with a simple endpoint first
+4. Check [Treblle documentation](https://docs.treblle.com) for the latest updates
+5. Contact support at <https://treblle.com> or email support@treblle.com
 
-[![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)
+## Support
 
-### How to contribute
+If you have problems of any kind feel free to reach out via <https://treblle.com> or email support@treblle.com and we'll do our best to help you out.
 
-Here are some ways of contributing to making Treblle better:
+## License
 
-- **[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!
+Copyright 2025, Treblle Inc. Licensed under the MIT license:
+http://www.opensource.org/licenses/mit-license.php

configuration.go

@@ -1,6 +1,7 @@
 package treblle
 
 import (
+	"fmt"
 	"os"
 	"strconv"
 	"strings"
@@ -26,6 +27,7 @@ type Configuration struct {
 	MaxConcurrentProcessing int           // Maximum number of concurrent async operations (default: 10)
 	AsyncShutdownTimeout    time.Duration // Timeout for async shutdown (default: 5s)
 	IgnoredEnvironments     []string      // Environments where Treblle does not track requests
+	ExcludedRoutes          []string      // Routes that Treblle should not track
 	Debug                   bool          // Enable debug mode to see what's being sent to Treblle
 }
 
@@ -48,6 +50,8 @@ type internalConfiguration struct {
 	MaxConcurrentProcessing int
 	AsyncShutdownTimeout    time.Duration
 	IgnoredEnvironments     []string
+	ExcludedRoutes          []string
+	compiledExclusions      *compiledRoutePatterns // Pre-compiled patterns for performance
 }
 
 func Configure(config Configuration) {
@@ -133,6 +137,25 @@ func Configure(config Configuration) {
 		Config.IgnoredEnvironments = getEnvAsSlice("TREBLLE_IGNORED_ENV", defaultIgnoredEnvs)
 	}
 
+	// Load excluded routes from config or environment variable
+	if len(config.ExcludedRoutes) > 0 {
+		Config.ExcludedRoutes = config.ExcludedRoutes
+	} else {
+		Config.ExcludedRoutes = getEnvAsSlice("TREBLLE_EXCLUDED_ROUTES", []string{})
+	}
+
+	// Pre-compile route exclusion patterns for efficient matching
+	Config.compiledExclusions = compileRoutePatterns(Config.ExcludedRoutes)
+
+	// Debug: Log excluded routes if debug mode is enabled
+	if Config.Debug && len(Config.ExcludedRoutes) > 0 {
+		fmt.Printf("==== TREBLLE: EXCLUDED ROUTES ====\n")
+		for _, route := range Config.ExcludedRoutes {
+			fmt.Printf("  - %s\n", route)
+		}
+		fmt.Printf("==================================\n")
+	}
+
 	Config.FieldsMap = generateFieldsToMask(Config.DefaultFieldsToMask, Config.AdditionalFieldsToMask)
 }
 

gin_middleware.go

@@ -37,6 +37,22 @@ func GinMiddleware() gin.HandlerFunc {
 			return
 		}
 
+		// Check if route is excluded
+		routePath := c.FullPath()
+		if routePath == "" {
+			routePath = c.Request.URL.Path
+		}
+		normalizedRoute := normalizeRoutePath(routePath)
+
+		if Config.compiledExclusions != nil && isRouteExcluded(normalizedRoute, Config.compiledExclusions) {
+			if Config.Debug {
+				fmt.Printf("==== TREBLLE GIN: ROUTE EXCLUDED ====\nRoute: %s\n=====================================\n", normalizedRoute)
+			}
+			// Skip Treblle logging for excluded routes
+			c.Next()
+			return
+		}
+
 		// Create error provider for this request
 		errorProvider := NewErrorProvider()
 		defer errorProvider.Clear()
@@ -60,7 +76,7 @@ func GinMiddleware() gin.HandlerFunc {
 		c.Request = tracker.StoreStartTime(c.Request)
 
 		// Extract route pattern from Gin (e.g., "/users/:id")
-		routePath := c.FullPath()
+		routePath = c.FullPath()
 		if routePath != "" {
 			c.Request = SetRoutePath(c.Request, routePath)
 		}

middleware.go

@@ -17,6 +17,22 @@ func Middleware(next http.Handler) http.Handler {
 			return
 		}
 
+		// Check if route is excluded
+		routePath := GetRoutePath(r)
+		if routePath == "" {
+			routePath = r.URL.Path
+		}
+		normalizedRoute := normalizeRoutePath(routePath)
+
+		if Config.compiledExclusions != nil && isRouteExcluded(normalizedRoute, Config.compiledExclusions) {
+			if Config.Debug {
+				fmt.Printf("==== TREBLLE: ROUTE EXCLUDED ====\nRoute: %s\n=================================\n", normalizedRoute)
+			}
+			// Skip Treblle logging for excluded routes
+			next.ServeHTTP(w, r)
+			return
+		}
+
 		// Create error provider for this request
 		errorProvider := NewErrorProvider()
 		defer errorProvider.Clear()