scriptoriumadmin/featurebase
1
0
Fork 0
mirror of https://github.com/featurebasedb/featurebase.git synced 2026-09-07 00:55:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

StatsD documentation

Browse source
This commit is contained in:
Michael Baird 2017-05-22 11:31:28 -05:00
parent 7693fc4211
commit 08a150f1eb
2 changed files with 88 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
docs/administration.md
View file

@ -97,3 +97,58 @@ Note: This will only work when the replication factor is >= 2
- Modify the cluster config file to replace the previous node address with the new node address.
- Restart the cluster
- Wait for the 1st sync (10 minutes) to validate Index connections
#### Metrics
Pilosa can be configured to emit metrics on its internal processes in 2 formats, Expvar or StatsD. Metric recording is disabled by default and enabled through the configuration file.
Through the configuration file choose the metric type, host to receive events, and polling interval for runtime metrics.
##### Tags
StatsD Tags are in DataDog format (key:value), and we tag the following:
- NodeID
- Index
- Frame
- View
- Slice
##### Events
We currently track the following events
<strong id="index">Index:</strong> The creation of a new Index.
<strong id="frame">Frame:</strong> The creation of a new Frame.
<strong id="maxSlice">MaxSlice:</strong> The Creation of a new Slice.
<strong id="setbit">SetBit:</strong> Count of set bits on a row and column.
<strong id="clearbit">ClearBit:</strong> Count of cleared bits a previously set bit on a row and column.
<strong id="importbit">ImportBit:</strong> During a bulk data import this records the count of bits created.
<strong id="setrowattrs">SetRowAttrs:</strong> Count of Attributes set per row
<strong id="setcollumnattrs">SetColumnAttrs:</strong> Count of Attributes set per collumn.
<strong id="bitmap">Bitmap:</strong> Count of Bitmap queries run.
<strong id="topn">TopN:</strong> Count of TopN queries run.
<strong id="union">Union:</strong> Count of Union queries.
<strong id="intersection">Intersection:</strong> Count of Intersection queries.
<strong id="difference">Difference:</strong> Count of Difference queries.
<strong id="count">Count:</strong> Count of Count queries.
<strong id="range">Range:</strong> Count of Range queries.
<strong id="snapshot">Snapshot:</strong> Event count when the snapshot process is triggered.
<strong id="blockrepair">BlockRepair:</strong> Count of data blocks that were out of sync and repaired.
<strong id="garbage_collection">Garbage Collection:</strong> Event count when Garbage Collection occurs,
<strong id="goroutines">Goroutines:</strong> Number of running Goroutines.

33
docs/configuration.md
View file

@ -167,3 +167,36 @@ Any flag that has a value that is a comma separated list on the command line bec
[profile]
cpu-time = "30s"
```
##### Metric Service
* Description: which stats service to use (StatsD or ExpVar)
* Flag: `--metric.service=statsd`
* Env: `PILOSA_METRIC.SERVICE=statsd'
* Config:
```toml
[metric]
service = “statsd”
```
##### Metric Host
* Description: where is the StatsD service hosted
* Flag: `--metric.host=localhost:8125`
* Env: `PILOSA_METRIC.HOST=localhost:8125'
* Config:
```toml
[metric]
host = "localhost:8125"
```
##### Metric Poll Interval
* Description: Polling interval for runtime metrics.
* Flag: `metric.poll-interval=”0m15s”`
* Env: `PILOSA_METRIC.POLL_INTERVAL=0m15s`
* Config:
```toml
[metric]
poll-interval = "0m15s"
```