Instrumental is a application monitoring platform built for developers who want a better understanding of their production software. Powerful tools, like the Instrumental Query Language, combined with an exploration-focused interface allow you to get real answers to complex questions, in real-time.
This is a pluggable StatsD backend for sending metrics to Instrumental.
$ cd /path/to/statsd $ npm install statsd-instrumental-backend
See our example config file for a complete StatsD configuration.
Otherwise, add the following basic configuration information to your StatsD config file.
instrumental:key: "[project token]" // REQUIREDsecure: true // OPTIONAL (boolean), whether or not to use secure protocol to connect to Instrumental, default trueverifyCert: true // OPTIONAL (boolean), should we attempt to verify the server certificate before allowing communication, default truetimeout: 10000 // OPTIONAL (integer), number of milliseconds to wait for establishing a connection to Instrumental before giving up, default 10srecordCounterRates: true // OPTIONAL (boolean) whether or not to send ".rate" metrics with counters, default truemetricPrefix: "" // OPTIONAL (string) this will be prepended (with a dot) to ALL of your metricsmetricFiltersExclude: // OPTIONAL (array of regexes) any metrics matching these filters will be dropped. e.g, [/\.rate$/, /\.[^\.]*_99$/] would filter out counter rates and extra metrics for stats like upper_99, mean_99, etc.metricFiltersInclude: // OPTIONAL (array of regexes) any metrics _NOT_ matching at least one of these filters will be dropped
Metrics can be filtered with either the
metricFiltersInclude options. Note that for a metric to be sent, it must match at least one include and no excludes. An empty or missing metricFiltersInclude option will allow all metrics (assuming the exclusion filter does not exclude any).
This is already done if you are using our example configuration.
statsd-instrumental-backend backend to the list of StatsD
backends in the StatsD configuration file:
Start/restart the statsd daemon and your StatsD metrics should now be pushed to your Instrumental account.