https://github.com/apitoolkit/apitoolkit-laravel
APItoolkit's Laravel (PHP) client SDK.
https://github.com/apitoolkit/apitoolkit-laravel
apitoolkit apitoolkit-sdk laravel php
Last synced: 3 months ago
JSON representation
APItoolkit's Laravel (PHP) client SDK.
- Host: GitHub
- URL: https://github.com/apitoolkit/apitoolkit-laravel
- Owner: apitoolkit
- Created: 2022-04-05T04:25:08.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-06T18:03:30.000Z (6 months ago)
- Last Synced: 2025-03-22T01:07:17.924Z (4 months ago)
- Topics: apitoolkit, apitoolkit-sdk, laravel, php
- Language: PHP
- Homepage: https://apitoolkit.io/docs/sdks/php/laravel/
- Size: 2.43 MB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Laravel SDK
[](https://github.com/topics/apitoolkit-sdk) [](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [](https://apitoolkit.io/docs/sdks/php/laravel?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme)
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](#installation)
- [Open Telemetry Configuration](#setup-opentelemetry)
- [APItoolkit Middleware Setup](#setup-apitoolkit-middleware)
- [Contributing and Help](#contributing-and-help)
- [License](#license)
---
## Installation
Kindly run the command below to install the apitoolkit-laravel sdk and required otel packages:
```sh
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
```sh
pecl install opentelemetry
```
Then add it to your `php.ini` file like so.
```ini
[opentelemetry]
extension=opentelemetry.so
```
export the following opentelemetry variables
```sh
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
[
// 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
\APIToolkit\Http\Middleware\APIToolkit::class,
];
}
```
Then you can use the `apitoolkit` middleware in your routes like so:
```php
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](https://apitoolkit.io/docs/dashboard/settings-pages/api-keys?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) generated from the APItoolkit dashboard.
> [!IMPORTANT]
>
> To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read this [SDK documentation](https://apitoolkit.io/docs/sdks/php/laravel?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).
## 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](https://github.com/apitoolkit/.github/blob/main/CONTRIBUTING.md).
- Join our community [Discord Server](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).
- Create a [new issue](https://github.com/apitoolkit/apitoolkit-laravel/issues/new/choose) in this repository.
## License
This repository is published under the [MIT](LICENSE) license.
---
