Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tessera-metrics/tessera

A dashboard front-end for graphite.
https://github.com/tessera-metrics/tessera

dashboard graphite metrics monitoring

Last synced: about 16 hours ago
JSON representation

A dashboard front-end for graphite.

Awesome Lists containing this project

README

        

# Tessera

Tessera is a front-end interface for the [Graphite](http://graphite.readthedocs.org/en/latest/) metrics system, which provides a large selection of presentations, layout, and interactivity options for building dashboards.

The biggest key differences between Tessera and other frontends are the separation of queries from presentations, and the ability to apply arbitrary transformations to the presentations & queries, allowing for a large degree of interactivity. Tessera is initially focused on information presentation - it does not NOT address the areas of metric discovery or query composition (although it may in the future).

## Overview

Tessera consists of a small python webserver written with Flask with a SQL backing store. The server manages storing and searching for dashboards, managing tags for organization, serving the basic UI assets, and providing a ReST API for the front-end to use.

Dashboards are big lumps of JSON data describing the queries, presentations, and layout, wrapped in a small shell of SQL metadata. Most of the heavy lifting is done by the javascript front-end, which is responsible for all rendering, data fetching from graphite, and editing of dashboards.

## Quick Start

### From Docker

If you're familiar with [docker](http://www.docker.com) and already have a Graphite instance running, you can boot up an instance of tessera with the demo dashboards preloaded and easily point it at your existing Graphite installation using the [`aalpern/tessera-simple`](https://registry.hub.docker.com/u/aalpern/tessera-simple/) image. If you don't have a Graphite installation handy, a Docker image like [`nickstenning/graphite`](https://registry.hub.docker.com/u/nickstenning/graphite/) can get that up and running quickly.

```
docker run -P -e GRAPHITE_URL=http://graphite.host -it aalpern/tessera-simple
```

### From PyPi

Tessera can be installed easily from
[PyPi](https://pypi.python.org/pypi) with `pip` or
`easy_install`. This method of installation is only recommended for
casual use.

```
pip install tessera
```

After installation, create a `config.py` script for your local
settings.

Example `config.py`:

```
GRAPHITE_URL="http://graphite.example.com"
SECRET_KEY="adf71812-9d57-88d3-dfe8-1e9860d2b7ab"
```

Initialize the database:

```
TESSERA_CONFIG=/path/to/config.py tessera-init
```

Then launch the service:

```
TESSERA_CONFIG=/path/to/config.py tessera
```

The service will be available on
[localhost:5000](http://localhost:5000) by default, with the demo
dashoards loaded.

### From Source

The TL;DR version:

```
./script/setup
./script/server &
cd tessera-server
inv json.import '../demo/*'
```

## Documentation

Documentation is hosted on GitHub Pages at
[tessera-metrics.github.io/tessera/docs](http://tessera-metrics.github.io/tessera/docs/).

* [Getting Started](http://tessera-metrics.github.io/tessera/docs/) for getting started and running from source and importing the demo dashboards.
* [Tutorial](http://tessera-metrics.github.io/tessera/docs/guides/tutorial/) for creating the most basic possible
dashboard.
* API [endpoints](http://tessera-metrics.github.io/tessera/docs/api/endpoints/) and [data format](http://tessera-metrics.github.io/tessera/docs/api/data-format/) for accessing Tessera via the HTTP REST API
* [Extending Tessera](http://tessera-metrics.github.io/tessera/docs/development/extension/), for adding new dashboard
items, transformations, and actions.

Some additional writeup of why Tessera exists can found on the
introductory blog post that was originally posted on Urban Airship's
company blog -
[Introducing Tessera, a Graphite Frontend](http://monster.partyhat.co/article/introducing-tessera/).

![screenshot](docs/screenshots/color-themes-small.png)

## Copyright & License

Copyright © 2014, Urban Airship and Contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

* [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Third-party software libraries included with this project are
distributed under their respective licenses.