mirror of
https://github.com/deployphp/deployer.git
synced 2025-02-24 01:02:24 +01:00
57 lines
1.2 KiB
Markdown
57 lines
1.2 KiB
Markdown
|
<!-- DO NOT EDIT THIS FILE! -->
|
|||
|
|
<!-- Instead edit contrib/grafana.php -->
|
|||
|
|
<!-- Then run bin/docgen -->
|
|||
|
|
|
|||
|
|
# grafana
|
|||
|
|
|
|||
|
|
[Source](/contrib/grafana.php)
|
|||
|
|
|
|||
|
|
|
|||
|
|
## Installing
|
|||
|
|
|
|||
|
|
Add to your _deploy.php_
|
|||
|
|
|
|||
|
|
```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")
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
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.
|
|||
|
|
|
|||
|
|
```php
|
|||
|
|
after('success', 'grafana:annotation');
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
* Tasks
|
|||
|
|
* [`grafana:annotation`](#grafanaannotation) — Create Grafana annotation of deployment
|
|||
|
|
|
|||
|
|
|
|||
|
|
## Tasks
|
|||
|
|
### grafana:annotation
|
|||
|
|
[Source](/contrib/grafana.php#L45)
|
|||
|
|
|
|||
|
|
|
|||
|
|
|