vvraskin commented on a change in pull request #3884: Document metrics generated within OpenWhisk URL: https://github.com/apache/incubator-openwhisk/pull/3884#discussion_r203759126
########## File path: docs/metrics.md ########## @@ -75,6 +75,183 @@ The docker image exposes StatsD via the (standard) port 8125 and a Grafana dashb The address of your docker host has to be configured in the `metrics_kamon_statsd_host` configuration property. +### Metric Names + +All metric names have to prefixed by a prefix that you specify and are subject to modification by graphite, datadog, or statsd. For example if prefix used is `openwhisk` then metric names would be like `openwhisk.counter.controller_activation_start`. This document assumes that metric name prefix is `openwhisk` + +Currently OpenWhisk emits following types of metrics + +#### Counter + +Counter [record the count](http://kamon.io/documentation/0.6.x/kamon-core/metrics/instruments/#counters) of metric and there names are prefixed with `openwhisk.counter`. For example `openwhisk.counter.controller_activation_start`. Counters just counts and resets to zero upon each flush. + +#### Histograms + +Histogram record the [distribution](http://kamon.io/documentation/0.6.x/kamon-core/metrics/instruments/#histograms) of given metric and there names are prefixed with `openwhisk.histogram`. For example `openwhisk.histogram.controller_activation_finish`. A histogram metrics may result in multiple values at the metric aggregator level. For example in [Datadog](https://docs.datadoghq.com/developers/metrics/histograms/) for each histogram metric following values are record + +* `my_metric.avg` - Average of aggregated values during the flush interval. +* `my_metric.count` - Count of aggregated values during the flush interval. +* `my_metric.median` - Median of aggregated values during the flush interval. +* `my_metric.95percentile` - 95th percentile value of aggregated values during the flush interval. +* `my_metric.max` - Max of aggregated values during the flush interval. +* `my_metric.min` - Min of aggregated values during the flush interval. + +### Metric Details + +Below are some of the important metrics emitted by OpenWhisk setup + +#### Controller metrics + +Metrics below are emitted from with a Controller instance. + +##### Controller Startup + +* `openwhisk.counter.controller_startup<controller_id>_count` (counter) Review comment: I think its `openwhisk.counter.controller<controller_id>_startup_count` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
