utopia-php/telemetry

0.1.0 2024-11-13 10:29 UTC

Requires

• php: >=8.0
• ext-opentelemetry: *
• ext-protobuf: *
• nyholm/psr7: ^1.8
• open-telemetry/exporter-otlp: ^1.1
• open-telemetry/sdk: ^1.1
• symfony/http-client: ^7.1

Requires (Dev)

• laravel/pint: ^1.2
• phpbench/phpbench: ^1.2
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^9.5.25

MIT

• framework
• php
• upf

README

Utopia Telemetry is a powerful Telemtry library. This library is aiming to be as simple and easy to learn and use. This library is maintained by the Appwrite team.

Although this library is part of the Utopia System project it is dependency free and can be used as standalone with any other PHP project or framework.

Getting Started

Install using composer:

composer require utopia-php/telemetry

Init in your application:

<?php

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

// Create a Telemetry instance using OpenTelemetry adapter.
use Utopia\Telemetry\Adapter\OpenTelemetry;

$telemetry = new OpenTelemetry('http://localhost:4138', 'namespace', 'app', 'unique-instance-name');
$counter = $telemetry->createUpDownCounter('http.server.active_requests', '{request}');

$counter->add(1);
$counter->add(2);

// Periodically collect metrics and send them to the configured OpenTelemetry endpoint.
$telemetry->collect();

// Example using Swoole
\Swoole\Timer::tick(60_000, fn () => $telemetry->collect());

System Requirements

Utopia Framework requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.

Copyright and license

The MIT License (MIT) http://www.opensource.org/licenses/mit-license.php