Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 1.88 KB

README.md

File metadata and controls

46 lines (34 loc) · 1.88 KB

mtail - extract whitebox monitoring data from application logs for collection into a timeseries database

GoDoc Build Status Coverage Status

mtail is a tool for extracting metrics from application logs to be exported into a timeseries database or timeseries calculator for alerting and dashboarding.

It aims to fill a niche between applications that do not export their own internal state, and existing monitoring systems, without patching those applications or rewriting the same framework for custom extraction glue code.

The extraction is controlled by mtail programs which define patterns and actions:

# simple line counter
counter line_count
/$/ {
  line_count++
}

Metrics are exported for scraping by a collector as JSON or Prometheus format over HTTP, or can be periodically sent to a collectd, StatsD, or Graphite collector socket.

See the Wiki for more details. Start with the programming guide if you want to learn how to write mtail programs.

Mailing list: https://groups.google.com/forum/#!forum/mtail-users

Installation

mtail uses a Makefile. To build mtail, type make at the commandline. See the Build instructions for more details.

Deployment

mtail works best when paired with a timeseries-based calculator and alerting tool, like Prometheus.