mirror_php/deployer
1
0
Fork 0
mirror of https://github.com/deployphp/deployer.git synced 2025-02-23 16:54:08 +01:00
Code Issues Projects Releases Wiki Activity
deployer/docs/contrib/grafana.md
Anton Medvedev 47a193f9af
Add docgen
2020-10-02 01:11:13 +03:00

1.2 KiB
Raw Blame History

grafana

Source

Installing

Add to your deploy.php

require 'contrib/grafana.php';

Configuration options

  • url (required): the URL to the creates annotation api endpoint.
  • token (required): authentication token. Can be created at Grafana Console.
  • time (optional) – set deploy time of annotation. specify epoch milliseconds. (Defaults is set to the current time in epoch milliseconds.)
  • tags (optional) – set tag of annotation.
  • text (optional) – set text of annotation. (Defaults is set to "Deployed " + git log -n 1 --format="%h")
deploy.php

set('grafana', [
    'token' => 'eyJrIj...',
    'url' => 'http://grafana/api/annotations',
    'tags' => ['deploy', 'production'],
]);

Usage

If you want to create annotation about successful end of deployment.

after('success', 'grafana:annotation');

Tasks

grafana:annotation

Source