 [](https://github.com/yaooqinn/kyuubi/pull/454)      [<img width="16" alt="Powered by Pull Request Badge" src="https://user-images.githubusercontent.com/1393946/111216524-d2bb8e00-85d4-11eb-821b-ed4c00989c02.png">](https://pullrequestbadge.com/?utm_medium=github&utm_source=yaooqinn&utm_campaign=badge_info)<!-- PR-BADGE: PLEASE DO NOT REMOVE THIS COMMENT --> Closes #454 from watermen/version. c141344 [watermen] Fix metrics Versions Authored-by: watermen <qiyadong2010@gmail.com> Signed-off-by: Kent Yao <yao@apache.org>
4.4 KiB
4.4 KiB
Kyuubi Server Metrics
Kyuubi has a configurable metrics system based on the Dropwizard Metrics Library.
This allows users to report Kyuubi metrics to a variety of kyuubi.metrics.reporters.
The metrics provide instrumentation for specific activities and Kyuubi server.
Configurations
The metrics system is configured via $KYUUBI_HOME/conf/kyuubi-defaults.conf.
| Key | Default | Meaning | Since |
|---|---|---|---|
| kyuubi.metrics .enabled |
true |
Set to true to enable kyuubi metrics system |
1.2.0 |
| kyuubi.metrics.json .report.location |
metrics |
Where the json metrics file located |
1.2.0 |
| kyuubi.metrics.report .interval |
PT5S |
How often should report metrics to json/console. no effect on JMX |
1.2.0 |
| kyuubi.metrics .reporters |
JSON |
A comma separated list for all metrics reporters
|
1.2.0 |
Metrics
These metrics include:
| Metrics Prefix | Metrics Suffix | Type | Since | Description |
|---|---|---|---|---|
| kyuubi .exec.pool .threads.alive |
gauge | 1.2.0 | threads keepAlive in the backend executive thread pool |
|
| kyuubi .exec.pool .threads.active |
gauge | 1.2.0 | threads active in the backend executive thread pool |
|
| kyuubi .connection.total |
counter | 1.2.0 | cumulative connection count |
|
| kyuubi .connection.opened |
gauge | 1.2.0 | current active connection count |
|
| kyuubi .connection.opened |
${user} |
counter | 1.2.0 | cumulative connections requested by a ${user} |
| kyuubi .connection.failed |
counter | 1.2.0 | cumulative failed connection count |
|
| kyuubi .connection.failed |
${user} |
counter | 1.2.0 | cumulative failed connections for a ${user} |
| kyuubi .statement.total |
counter | 1.2.0 | cumulative opened statement count |
|
| kyuubi .statement.opened |
counter | 1.2.0 | current opened statement count |
|
| kyuubi .statement.failed |
${errorType} |
counter | 1.2.0 | cumulative failed statement for a particular ${errorType}, e.g. AnalysisException |
| kyuubi .engine.total |
counter | 1.2.0 | cumulative created engines |
|
| kyuubi .engine.timeout |
counter | 1.2.0 | cumulative timeout engines |
|
| kyuubi .engine.failed |
${user} |
counter | 1.2.0 | cumulative explicitly failed engine count for a ${user} |
| kyuubi .engine.failed |
${errorType} |
counter | 1.2.0 | cumulative explicitly failed engine count for a particular ${errorType}, e.g. ClassNotFoundException |