Edit this page on GitHub

metrictools v0.8.0

metrictools is a collection of lightweight tools that allow you to record measurements and build beautiful real-time dashboards within minutes. If you're new to metrictools it's highly recommended that you start with the Getting Started page..

Here's a quick rundown of the key features for people who don't like reading documentation.:

  • Add your own custom metrics and labels
  • Insert data, run queries and create charts using a standalone command line interface
  • Pull ("scrape") measurements via HTTP, shell scripts or SNMP or push via HTTP or UDP/statsd
  • Include charts and tables in any HTML page using the HTTP API
  • All metrics are explicitly configured and have a number of rich settings (like units of measurement)
  • Data is stored in a pluggable storage backend (SQLite, MySQL, Postgres, EventQL)
  • Optional background daemon that runs data collection and exposes a HTTP API
  • Plugins can contain metric configuration, exporters and dashboards (check out the linux plugin)
  • Implemented as a collection of lightweight composable commands in spirit of the original daemontools project
  • Written in self-contained modern C++; quick to set up and does not require a lot of resources
  • The metrictools project was started over 7 years ago and is still actively maintained
View on GitHub
Join metrictools development now on GitHub. We're always appreciating new pull requests, bugs and feature requests!

Commands

This is a list of the metrictl commands and a quick description for each of them. For more detailed information you're kindly referred to the following pages.

Command Description
metrictl list List all metrics and their instances and latest values.
metrictl log Rretrieve a logfile of collected measurements for a specific metric.
metrictl plot Draw a chart from one or more metrics.
metrictl collect Collect data (i.e. run the collect_* blocks) from the command line.
metrictl insert Add a measurement to a metric.

Datastores

The currently supported data stores are SQLite, MySQL, Postgres and EventQL. If you'd like to add a new storage backend, please have a look at src/metrictools/storage and create a pull request on GitHub.

Support

To get started with metrictools, have a look at the Getting Started, Data Model, Metric Types and Federation pages. If you have any questions please don't hesitate to reach out via Github Issues or The metrictools Google Group.