Environment configuration¶

We recomended to install GottWall to separated environment.

The first thing you’ll need is the Python virtualenv package. You probably already have this, but if not, you can install it with:

easy_install -U virtualenv

Once that’s done, choose a location for the environment, and create it with the virtualenv command. For our guide, we’re going to choose /www/gottwall/:

virtualenv /www/gottwall

Finally, activate your virtualenv:

source /www/gottwall/bin/activate

Installation¶

After environment activation install GottWall package to your env via easy_install:

easy_install -U gottwall

or pip:

pip install gottwall

After installation you can execute command in console gottwall -h, it’s show gottwall manager documentation.

easy_install -U gottwall-storage-redis

pip install gottwall-storage-redis

Configuration¶

Now you’ll need to create the default configuration.

Execute gottwall init config.py ~/.gottwall/gottwall.conf.py or examples/config.py to your location (as example ~/.gottwall/gottwall.conf.py.)

STORAGE = 'gw_storage_redis.storage.RedisStorage'

BACKENDS = {
 }

TEMPLATE_DEBUG = True

STORAGE_SETTINGS = dict(
   HOST = 'localhost',
   PORT = 6379,
   PASSWORD = None,
   DB = 2
)

REDIS = {"CHANNEL": "gottwall"}


USERS = ["you@email.com"]

SECRET_KEY = "very secret key"



PROJECTS = {"test_project": "my_public_key",
            "another_project": "public_key2"}

cookie_secret="fkerwerwerwerw"

TEMPLATE_DEBUG = True

PREFIX = ""

Startings services¶

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

To run web application execute command: gottwall --config="examples/config.py" server start

To run aggregator application execute command: gottwall --config="examples/config.py" aggregator start

Storage development¶

Also you can develop custom storage for your own server. You need make package that included backend class inherited from gottwall.storages.base.BaseBackend.

Custom storage must override methods:

class CustomStorage(gottwall.storages.base.BaseBackend)¶

incr(project, name, timestamp, value=1, filters={}, **kwargs):

Add count for metric name and filters

decr()¶

Sub value from metric name in project

slise_data()¶

Get data by range and filters

metrics()¶

Get metrics list

Third party storages¶

Client Criteria¶

If you’re developing a client for your platform, there’s several things we highly encourage:

• It should fully implement the current version of the GottWall protocol.
• It should conform to the standard DSN configuration method.
• It should contain an acceptable level of documentation and tests.
• The client should be properly packaged, and named stati-<lang>-<transport-name>.

Environment¶

We created environment vagrant kit for contributors.

It’s named gottwall vagrant dev kit. You need to clone this repository to local system, initialize submodules and execute vagrant up in repository directory. This cookbooks configure virtual box node, installed needed services: postgresql, redis, rabbitmq.

Profiling¶

Stability and performance is a main priotitets. We working on its every day.

We use next utils to profile aplication:

Client Usage (End-user)¶

Generally, a client consists of three steps to the end user, which should look almost identical no matter the language:

1. Creation of the client (sometimes this is hidden to the user)

var my_client = new RedisClient('http://public_key:secret_key@example.com/default');

or

::

var my_client = new RedisClient(private_key=”private_key”,

public_key=”public_key”, project=”project_name”, host=”host”)

2. Send data

my_client.incr(name="metric_name", value=2, timestamp=ts, filters={"status": "New", "user":"registered"})