README

Laravel SDK

APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Laravel (PHP) application with APItoolkit, you need to use this SDK to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers.

Table of Contents

• Installation
• Open Telemetry Configuration
• APItoolkit Middleware Setup
• Contributing and Help
• License

Installation

Kindly run the command below to install the apitoolkit-laravel sdk and required otel packages:

composer require \
    open-telemetry/sdk \
    open-telemetry/exporter-otlp \
    apitoolkit/apitoolkit-laravel

Setup Opentelemetry

Installing opentelemetry extension

After installing the necessary packages, you'll need to install the opentelemetry extention and add it to your php.ini file

pecl install opentelemetry

Then add it to your php.ini file like so.

[opentelemetry]
extension=opentelemetry.so

export the following opentelemetry variables

export OTEL_PHP_AUTOLOAD_ENABLED=true
export OTEL_SERVICE_NAME=your-service-name
export OTEL_TRACES_EXPORTER=otlp
export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
export OTEL_EXPORTER_OTLP_ENDPOINT=http://otelcol.apitoolkit.io:4318
export OTEL_RESOURCE_ATTRIBUTES="at-project-key={ENTER_YOUR_API_KEY_HERE}"
export OTEL_PROPAGATORS=baggage,tracecontext

Setup APItoolkit Middleware

Next, register the middleware in the app/Http/Kernel.php file under the correct middleware group (e.g., api) or at the root, like so. This creates a customs spans which captures and sends http request info such as headers, requests and repsonse bodies, matched route etc. for each request

<?php

namespace App\Http;

use Illuminate\Foundation\Http\Kernel as HttpKernel;

class Kernel extends HttpKernel
{
    protected $middlewareGroups = [
        'api' => [
            // Other middleware here...
            \APIToolkit\Http\Middleware\APIToolkit::class, // Initialize the APItoolkit client
        ],
    ];
}

Alternatively, if you want to monitor specific routes, you can register the middleware, like so:

<?php

namespace App\Http;

use Illuminate\Foundation\Http\Kernel as HttpKernel;

class Kernel extends HttpKernel
{
    protected $routeMiddleware = [
        // Other middleware here...
        'apitoolkit' => \APIToolkit\Http\Middleware\APIToolkit::class,
    ];
}

Then you can use the apitoolkit middleware in your routes like so:

Route::get('/', function () {
    return response()->json([
        'message' => 'Welcome to your new application!'
    ]);
})->middleware('apitoolkit');

Note

The {ENTER_YOUR_API_KEY_HERE} demo string should be replaced with the API key generated from the APItoolkit dashboard.

Important

To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read this SDK documentation.

Contributing and Help

To contribute to the development of this SDK or request help from the community and our team, kindly do any of the following:

• Read our Contributors Guide.
• Join our community Discord Server.
• Create a new issue in this repository.

License

This repository is published under the MIT license.