Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lbovet committed Jan 26, 2016
1 parent de717e6 commit ba6117c
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,15 @@ Example:

```javascript
{
"interval": 500, // sampling period in ms (default: 1000)
"seconds" : true, // shows only number of seconds since start
"keep": true, // keeps showing the last value
"pattern": "([^-]*)-(.*)", // pattern to parse the metric name (see metric groups below)
"metrics": { // specific configuration for a given metric
"<metric-name>": { // the metric name (without group, see below)
"aggregator": "growth", // function aggregating values (see aggregators below)
"color": "yellow,bold" // [zibar configuration](https://www.npmjs.com/package/zibar#configuration)
"interval": 500, // sampling period in ms (default: 1000)
"seconds" : true, // shows only number of seconds since start
"keep": true, // keeps showing the last value
"pattern": "([^-]*)-(.*)", // pattern to parse the metric name (see metric groups below)
"metrics": { // specific configuration for a given metric
"<metric-name>": { // the metric name (without group, see below)
"aggregator": "growth", // function aggregating values (see aggregators below)
"color": "yellow,bold", // zibar configuration (see customizing below)
...
}
}
}
Expand All @@ -59,6 +60,10 @@ Metrics can be grouped. By default, the group name prefixes the metric name, sep

When using a metric source with a different format, you can specify in the `pattern` configuration value the regular expression that will be used to parse the metric group and name. It should provide one or two capture groups, for the group name and the metric name.

## Customizing

Graphs can be customized using [zibar configuration](https://www.npmjs.com/package/zibar#configuration).

## Aggregators

When multiples values are received during the sampling period, they are combined using an aggregator function.
Expand Down

0 comments on commit ba6117c

Please sign in to comment.