yagd

KO | EN

gitlite — search

#javascript #hacktoberfest #llm #golang #go #docker #nodejs #java #windows #cli #kubernetes #security #pytorch #ios

(★ 8)

super simple dashboard framework in PHP

yagd Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# yagd

[![Build Status](https://travis-ci.org/mrtazz/yagd.svg?branch=master)](https://travis-ci.org/mrtazz/yagd)
[![Coverage Status](https://coveralls.io/repos/mrtazz/yagd/badge.svg?branch=master&service=github)](https://coveralls.io/github/mrtazz/yagd?branch=master)
[![Code Climate](https://codeclimate.com/github/mrtazz/yagd/badges/gpa.svg)](https://codeclimate.com/github/mrtazz/yagd)
[![Latest Stable Version](https://poser.pugx.org/mrtazz/yagd/v/stable)](https://packagist.org/packages/mrtazz/yagd)
[![Latest Unstable Version](https://poser.pugx.org/mrtazz/yagd/v/unstable)](https://packagist.org/packages/mrtazz/yagd) [![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)

## Overview
Yet Another Graphite Dashboard - because why not? It's heavily inspired by
[the Etsy dashboard framework](https://github.com/etsy/dashboard) but only
provides a very small subset of features. If you have a lot of hosts or need
advanced features I'd recommend checking that out.

## Look
![yagd look](http://s3itch.unwiredcouch.com/Dashboards-20151108-214111.jpg)

## Requirements
- PHP >= 5.5
- Graphite

## Installation
- in your dashboards repo, run: `composer require mrtazz/yagd`
- copy `config.example.php` to `config.php` and adapt it
- write php to create your dashboards

## Usage examples

### Generic dashboards
There is a generic `Page.php` class included which can just include all
Graphite graphs you have in an array called `$metrics` like this:

```
<?php

$metrics = array(
    'carbon.agents.foo_example_com-a.committedPoints',
    'carbon.agents.foo_example_com-a.cpuUsage',
    'carbon.agents.foo_example_com-a.avgUpdateTime',
    'carbon.agents.foo_example_com-a.creates',
    'carbon.agents.foo_example_com-a.errors',
    'carbon.agents.foo_example_com-a.metricsReceived',
    'carbon.agents.foo_example_com-a.pointsPerUpdate',
    'carbon.agents.foo_example_com-a.updateOperations',
);

$page = new Page($CONFIG);
$page->renderFullPageWithMetrics($metrics);
```

### Display CollectD host data
If you are using collectd to gather system level graphs you can draw basic
information onto a dashboard like this:

Configure hosts in your `config.php`

```
$CONFIG['hosts'] = [
        "foo.example.com" => [
            "cpus" => 2,
            "filesystems" => [ 'root', 'var', ]
            ],
            "additional_metrics" => [
                "disk temp" => [
                "disk temperature" => "collectd.foo_example_com.disktemp-ada*.current",
                ]
            ],
        ]
    ];
```

And then drop something like this into e.g. `htdocs/hosts.php`:

```
<?php

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

include_once("../config.php");

use Yagd\CollectdHost;
use Yagd\Page;

$page = new Page($CONFIG);
echo $page->getHeader($CONFIG["title"],
    $CONFIG["navitems"]);

foreach($CONFIG["hosts"] as $host => $data) {

$fss = empty($data["filesystems"]) ? [] : $data["filesystems"];

$server = new CollectdHost($host, $data["cpus"], $fss,
                               $data["interfaces"]);
    $server->setGraphiteConfiguration($CONFIG["graphite"]["host"]);
    echo "<h2> {$host} </h2>";
    $server->render();
}

echo $page->getFooter();

```

### Inject a select box into the navbar
For the host page for example you might wanna have an easy way to only show
one host. For that you can inject a select box into the header navbar like
this:

```
<?php

$selectbox = "";
$selectbox .= "<form method='get' action='hosts.php' style='margin-top: 15px'class='pull-right'>";
$selectbox .= "   <select name='hostname' onchange='this.form.submit()'>";
    foreach ($CONFIG["hosts"] as $host => $data) {
        $selected = ($_GET["hostname"] == $host) ? "selected" : "";
        $selectbox .= "<option value='{$host}' {$selected}>{$host}</option>";
}
$selectbox .= "</select>";
$selectbox .= "</form>";

$page = new Page($CONFIG);
echo $page->getHeader($CONFIG["title"],
    $CONFIG["navitems"],
    $selectbox);

if (empty($_GET["hostname"])) {
    $hosts = $CONFIG["hosts"];
} else {
    $hosts = [ $_GET["hostname"] => $CONFIG["hosts"][$_GET["hostname"]] ];
}
```

This will show the content of `$selectbox` in the header and only show the
actually selected host (if one was selected) on the page.

yagd

yagd Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

yagd

yagd Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README