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

diagnostics docs

Browse source
This commit is contained in:
Michael Baird 2017-10-18 09:22:55 -05:00
parent 722e73d305
commit 78b599f1f1
2 changed files with 34 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/administration.md
View file

@ -112,6 +112,27 @@ Note: This will only work when the replication factor is >= 2
- Restart the cluster
- Wait for the 1st sync (10 minutes) to validate Index connections
#### Diagnostics
Each Pilosa cluster is configured by default to share anonymous usage details with Pilosa Corp. These metrics allow us to understand how Pilosa is used by the community and improve the technology to suit your needs. Diagnostics are sent to Pilosa every hour. Each of the metrics are detailed below as well as opt-out instructions.
<strong id="version">Version:</strong> Version string of the build.
<strong id="host">Host:</strong> Host URI.
<strong id="cluster">Cluster:</strong> List of nodes in the Cluster.
<strong id="num_nodes">NumNodes:</strong> Number of nodes in the Cluster.
<strong id="num_cpu">NumCPU:</strong> Number of Cores per Node
<strong id="bsa_enabled">BSIEnabled:</strong> Bit Slice Index Frames in use.
<strong id="time_quantum_enabled">TimeQuantumEnabled:</strong> Time Quantum Frames in use.
<strong id="inverse_enabled">InverseEnabled:</strong> Inverse Frames in use.
<strong id="num_indexes">NumIndexes:</strong> Number of Indexes in the Cluster.
<strong id="num_frames">NumFrames:</strong> Number of Frames in the Cluster.
<strong id="num_slices">NumSlices:</strong> Number of Slices in the Cluster.
<strong id="num_views">NumViews:</strong> Number of Views in the Cluster.
<strong id="open_files">OpenFiles:</strong> Open file handle count.
<strong id="go_routines">GoRoutines:</strong> Go routine count.
You can opt-out of the Pilosa diagnostics reporting by setting the `diagnostics` configuration option under `metric` to `0m0s`.
#### Metrics
Pilosa can be configured to emit metrics pertaining to its internal processes in one of two formats: Expvar or StatsD. Metric recording is disabled by default.

13
docs/configuration.md
View file

@ -206,6 +206,19 @@ Any flag that has a value that is a comma separated list on the command line bec
poll-interval = "0m15s"
```
##### Metric Diagnostics Interval
* Description: Diagnostic reporting interval. To disable diagnostics set to zero.
* Flag: `metric.diagnostics=”60m0s”`
* Env: `PILOSA_METRIC_DIAGNOSTICS=60m0s`
* Config:
```toml
[metric]
diagnostics = "60m0s"
```
##### TLS Certificate
* Description: Path to the TLS certificate to use for serving HTTPS. Usually has one of`.crt` or `.pem` extensions.