treblle

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
• 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.

Installation

Trebble uses Go Modules to manage dependencies.

go get github.com/treblle/treblle-go

Basic configuration

Configure Treblle at the start of your main() function:

import "github.com/treblle/treblle-go"

func main() {
	treblle.Configure(treblle.Configuration{
		APIKey:     "YOUR API KEY HERE",
		ProjectID:  "YOUR PROJECT ID HERE",
    AdditionalFieldsToMask: []string{"password", "card_number"}, // optional, specify additional fields to mask
	}

    // rest of your program.
}

After that, just use the middleware with any of your handlers:

mux := http.NewServeMux()
mux.Handle("/", treblle.Middleware(http.HandlerFunc(yourHandler)))

gorilla/mux

To setup the treblle.Middleware in gorilla/mux, you can use it as a global middleware:

r := mux.NewRouter()
r.Use(treblle.Middleware)

per-route

You can also use treblle.Middleware as a per-route middleware just like you will use it with net/http:

r := mux.NewRouter()
r.Handle("/", treblle.Middleware(http.HandlerFunc(yourHandler)))

Subroutes

You can also use treblle.Middleware on gorilla/mux subroutes:

r := mux.NewRouter()

apiRouter := r.PathPrefix("/api").Subrouter()

apiRouter.Use(treblle.Middleware) // Set as a middleware for this subroute

apiRouter.HandleFunc("/users", yourHandler)

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

Documentation

Index

• Variables
• func Configure(config Configuration)
• func Middleware(next http.Handler) http.Handler
• type BaseUrlOptions
• type Configuration
• type DataInfo
• type ErrorInfo
• type LanguageInfo
• type MetaData
• type OsInfo
• type RequestInfo
• type ResponseInfo
• type ServerInfo

Variables

var Config internalConfiguration

var ErrNotJson = errors.New("request body is not JSON")

Functions

func Configure

func Configure(config Configuration)

func Middleware

func Middleware(next http.Handler) http.Handler

Types

type BaseUrlOptions

type BaseUrlOptions struct {
	Debug bool
}

type Configuration

type Configuration struct {
	APIKey                 string
	ProjectID              string
	AdditionalFieldsToMask []string
}

Configuration sets up and customizes communication with the Treblle API

type DataInfo

type DataInfo struct {
	Server   ServerInfo   `json:"server"`
	Language LanguageInfo `json:"language"`
	Request  RequestInfo  `json:"request"`
	Response ResponseInfo `json:"response"`
}

type ErrorInfo

type ErrorInfo struct {
	Source  string `json:"source"`
	Type    string `json:"type"`
	Message string `json:"message"`
	File    string `json:"file"`
	Line    int    `json:"line"`
}

type LanguageInfo

type LanguageInfo struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

type MetaData

type MetaData struct {
	ApiKey    string   `json:"api_key"`
	ProjectID string   `json:"project_id"`
	Version   string   `json:"version"`
	Sdk       string   `json:"sdk"`
	Data      DataInfo `json:"data"`
}

type OsInfo

type OsInfo struct {
	Name         string `json:"name"`
	Release      string `json:"release"`
	Architecture string `json:"architecture"`
}

type RequestInfo

type RequestInfo struct {
	Timestamp string          `json:"timestamp"`
	Ip        string          `json:"ip"`
	Url       string          `json:"url"`
	UserAgent string          `json:"user_agent"`
	Method    string          `json:"method"`
	Headers   json.RawMessage `json:"headers"`
	Body      json.RawMessage `json:"body"`
}

type ResponseInfo

type ResponseInfo struct {
	Headers  json.RawMessage `json:"headers"`
	Code     int             `json:"code"`
	Size     int             `json:"size"`
	LoadTime float64         `json:"load_time"`
	Body     json.RawMessage `json:"body"`
	Errors   []ErrorInfo     `json:"errors"`
}

type ServerInfo

type ServerInfo struct {
	Ip        string `json:"ip"`
	Timezone  string `json:"timezone"`
	Software  string `json:"software"`
	Signature string `json:"signature"`
	Protocol  string `json:"protocol"`
	Os        OsInfo `json:"os"`
}