Skip to main content agent

Project description

# vizbee agent


## Installation

python -m pip install vizbee

optionally the target(s) data source an be passed as argument to install
required dependencies:

python -m pip install vizbee[<source>]

where `<source>` is one of:

* postgresql
* oracle
* mysql
* redshift
* sqlserver
* sybase

## Usage

Usage: vizbee [OPTIONS] COMMAND [ARGS]...

-c, --config TEXT The YAML configuration file path.
--client-id TEXT The application id.
--client-secret TEXT The application secret.
--api-url TEXT The api url.
--help Show this message and exit.

dashboard Manage dashboards.
dataset Manage datasets.
start Start scheduler.
sync Push all datasets and dashboards.

## Connections

This section defines the connections to the data stores
(the ``default`` field sets the default one).

default: {DATABASE_URL}

Currently supported database are:

* PostgreSQL: `postgresql://<user>:<password>@<host>/<db>`
* MySQL: `mysql://<user>:<password>@<host>/<db>`
* Oracle: `oracle://<user>:<password>@<host>/<db>`
* Redshift: `redshift://<user>:<password>@<host>/<db>`
* SQLServer: `mssql://<user>:<password>@<host>/<db>`

## Datasets

A `Dataset` represents a single set of data:

name: <The dataset name>

connection: <The connection to use>

query: <The query used to fetched data>

graph: <The graph options>

schedule: <The scheduling rule>

See [dataset schema]( for more details.

## Dashboards

A `Dashboard` represents a `Dataset` collection:

name: <The dashboard name>

- <The datasets to include>

See [dashboard schema]( for more details.

## Scheduling

The agent can be started as a daemon to schedule datasets update,
it require to define a scheduling rule such as:

schedule: 5 minutes

and the start the deamon:

vizbee start

For each `Dataset` the scheduling rule can be overriden by adding a
`schedule: <rule>` in its schema.

The scheduling rule format is: `<count> <seconds|minutes|hours|days>`

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for vizbee, version 0.1b1
Filename, size File type Python version Upload date Hashes
Filename, size vizbee-0.1b1.tar.gz (6.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page