https://github.com/brightfish-be/blue-canary-php-client

Guzzle-based PHP client for Blue Canary
https://github.com/brightfish-be/blue-canary-php-client

Last synced: about 13 hours ago
JSON representation

Guzzle-based PHP client for Blue Canary

• Host: GitHub
• URL: https://github.com/brightfish-be/blue-canary-php-client
• Owner: brightfish-be
• License: gpl-3.0
• Created: 2019-12-26T13:40:35.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2020-06-28T09:04:56.000Z (over 4 years ago)
• Last Synced: 2023-08-21T08:25:35.195Z (about 1 year ago)
• Language: PHP
• Size: 44.9 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Blue Canary PHP Client

[![Tests](https://github.com/brightfish-be/blue-canary-php-client/workflows/Tests/badge.svg?event=push&style=flat-square)](https://github.com/brightfish-be/blue-canary-php-client/actions)

**[WORK IN PROGRESS...]**

Guzzle-based PHP client for [Blue Canary](https://github.com/brightfish-be/blue-canary-dashboard), 

monitoring and metrics collection server.

## Usage examples

```

use Brightfish\BlueCanary\Client;

$client = new \GuzzleHttp\Client();

$logger = new Client($client, [

    'base_uri' => 'https://canary.stage',

    'api_version' => 'v1',

    'uuid' => '5b8c58e9-b2ac-4ae4-9381-dcd4524dd7e7',

    'counter' => 'default.counter.1',

    'client_id' => 'some-id',

    'client_name' => 'Some name',

]);

// Send message and status code without metrics.

$logger->emergency('Whoops, my app is out!');

// Send message and status code without metrics, overriding the global parameters.

$logger->emergency('Whoops, my app is out again!', [

    'counter' => 'default.counter.2',

    'client_id' => 'some-id-2',

    'client_name' => 'Some Name 2',

]);

// Send one metric with message and status code, using the global parameters.

$logger->metric('throughput', 30.3567, 'fps')->warning('Whoops, my app may have troubles!');

// Send two metrics with casting, without message and default OK status code

$logger->metric('duration', 3465.3567, 'sec', 'int')

    ->metric(new Metric('throughput', 30.3567, 'fps', 'int'))

    ->info();

// Send INFO async 

$promise = $logger->infoAsync();

```

## Laravel usage

1. Edit your `.env` file:

```

BLUE_CANARY_CLIENT_ID=my-client-machine-id

BLUE_CANARY_CLIENT_NAME="My client machine"

```

2. Reference a custom log driver in `config/logging.php` under `channels`:

```

'canary' => [

    'driver' => 'custom',

    'via' => Brightfish\BlueCanary\Laravel\LogDriver::class,

    'client_id' => env('BLUE_CANARY_CLIENT_ID'),

    'client_name' => env('BLUE_CANARY_CLIENT_NAME'),

],

```

3. Usage:

```

// With facade

Log::emergency('Hello world!', $parameters);

// From container

app('log')->alert('Hello world!', $parameters);

// With instance

/** @var Brightfish\BlueCanary\Client $client */

$client = app('log')->driver('canary')->getLogger();

$logger->metric(...)->metric(...)->warning();

```

## License

GNU General Public License (GPL). Please see the license file for more information.