Skip to content
This repository has been archived by the owner on Jan 1, 2019. It is now read-only.

Latest commit

 

History

History
146 lines (88 loc) · 4.34 KB

README.rst

File metadata and controls

146 lines (88 loc) · 4.34 KB
Raw

Welcome to GottWall's documentation!

GottWall is a scalable realtime metrics collecting and aggregation platform and service. This package, at its core, is just a simple aggregation server and beautiful customizable web dashboard for visualizing metrics with charts.

It will handle authenticating clients (such as stati) and all of the logic behind storage and aggregation.

image

Features

  • Beautiful customizable dashboard for visualizing metrics with charts.
  • Data aggregation
  • Data collection
  • Embedded charts (HTML, iframe, javascript, JSON)

Screenshots

Dashboard

image

image

Custom graph type and title

image

image

Simple chart charing

image

image

Installation

To use gottwall use pip or `easy_install`:

pip install gottwall

or :

easy_install gottwall

or you can use official gottwall chef cookbook for automatic setup on system.

Configuration

See gottwall/examples/config.py

Usage

GottWall have 2 independent parts. Web interface application and aggregator application (application that process data).

Starting web dashboard

To run web application execute command:

gottwall --config="examples/config.py" server start

Starting aggregator

To run aggregator application execute command:

gottwall --config="examples/config.py" aggregator start

Available storages

Storages that store metrics:

  • Memory storage (not optimal for hightload projects)
  • Redis storage (fast for counters increment, but time complexity O(N) for data range select)
  • TODO: mongodb
  • TODO: SQL

Available transport backends

The following transport available:

  • Redis transport backend
  • TCP/IP transport backend
  • TODO: UDP transport backend
  • HTTP transport backend

Available clients

The following clients are officially recognized as production-ready, and support the current GottWall protocol:

CONTRIBUTE

We need you help.

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. There is a Contributor Friendly tag for issues that should be ideal for people who are not very familiar with the codebase yet.
  2. Fork the repository on Github to start making your changes to the develop branch (or branch off of it).
  3. Write a test which shows that the bug was fixed or that the feature works as expected.
  4. Send a pull request and bug the maintainer until it gets merged and published.

ETC

  • Graphs widgets rendered with rickshaw (HTML5 + SVG and d3.js) library.