From a5dd5caaf5827311bd2839278dfb39da295525aa Mon Sep 17 00:00:00 2001 From: Matt Sanders Date: Thu, 3 Jul 2014 15:45:08 -0700 Subject: [PATCH] Update README for revised instrument_action naming scheme --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 267752b..53e62bd 100644 --- a/README.md +++ b/README.md @@ -183,9 +183,16 @@ class CommentController < ApplicationController end ``` -Once you instrument an action, `librato-rails` will start reporting a set of metrics specific to that action including # of requests, total time used per request, and db and view time used per request. +Once you instrument an action, `librato-rails` will start reporting a set of metrics specific to that action including: -Action instrumentation metrics are named following the format `rails.action....*`. +* rails.action.request.total (# of requests) +* rails.action.request.slow (requests >= 200ms to produce) +* rails.action.request.exceptions +* rails.action.request.time (total time spent in action) +* rails.action.request.time.db (db interaction time) +* rails.action.request.time.view (view rendering time) + +Each instrumented action will appear as a source for the `rails.action.*` metrics, for example `mycontroller.action.html`. IMPORTANT NOTE: Metrics from `instrument_action` take into account all time spent in the ActionController stack for that action, including before/after filters and any global processing. They are _not_ equivalent to using a `Librato.timing` block inside the method body.