treblle/treblle-php

The official Treblle SDK for PHP. 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

 composer require treblle/treblle-php

After retrieving your API key and Project ID from the Treblle dashboard, simply initialize Treblle in your API code like so:

<?php

declare(strict_types=1);

use GuzzleHttp\Client;
use Treblle\Factory\TreblleFactory;

require_once __DIR__.'/../vendor/autoload.php';

error_reporting(E_ALL);
ob_start();

$treblle = TreblleFactory::create('_YOUR_API_KEY_', '_YOUR_PROJECT_ID_');

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

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-php's Issues

Filter urls

Hello
my backend is using multiple url workspaces
api/v1/*
api/v2/*
system/*
...etc

i need to apply trebble to only some of them. It's possible to provide a wildcard mask to filter processed endpoints?

Consider exposing more from builder

Trebble factory exposes a single method: create() which is great when using SAPIs that support shutdown functions :) but causes a memory leak when the SAPI doesn't support shutdown functions. For example, FrankenPHP (disclosure: I'm a contributor on the project), doesn't support shutdown functions.

It would be great if the factory also exposed a a method that did the same thing as create() just without registering side-effects, so it could be used as such:

function handle_request(\Closure $afterRequest) {
  $treblle = TreblleFactory::onlyCreate($apiKey, $projectId);
  set_error_handler($treblle->onError(...));
  set_exception_handler($treblle->onException(...));
  $afterRequest($treblle->onShutdown(...));

  // do request
}

$running = true;
while($running) {
  $later = [];
  $afterRequest = static function ($callback) use (&$later) {
    $later[] = $callback;
  };
  
  $running = frankenphp_handle_request(fn() => handle_request($afterRequest));
  foreach($later as $cb) $cb();
}

Treblle/Treblle-php

Trouble installing Trebble

Was trying to integrate Treblle via PHP, on your github I can see that the minimum PHP version required is 7.4. However, when I run it with my code, I am getting the following error :

 AH01071: Got error 'PHP message: PHP Fatal error:  Composer detected issues in your platform: Your Composer dependencies require a PHP version ">= 8.1.0". You are running 8.0.20. in .../vendor/composer/platform_check.php on line 24'

Here is my composer.json

{
    "require": {
        "treblle/treblle-php": "^2.0"
    }
}

Not sure where I am going wrong. Please help me out