Tail a JVM gc.log and emit stats over dogstatsd
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
garbagedog
grafana-examples
tests
.gitignore
.travis.yml
LICENSE
README.md
build.sh
dev_requirements.txt
requirements.txt
setup.py
test.sh

README.md

garbagedog 🗑🐶

Tail a JVM gc.log and emit stats over the dogstatsd protocol.

garbagedog monitors JVM gc logs and emits stats via dogstatsd. Normally, these will be recieved by a local agent such as telegraf or datadog-agent.

You can use these stats to monitor continuously monitor your GC performance (though active tuning is probably better left to more comprehensive tools).

Does not support the G1 garbage collector.

The log parsing logic based on https://github.com/Netflix-Skunkworks/gcviz

Build Status Total Alerts

Installation

pip3 install git+ssh://git@github.com/eero-inc/garbagedog.git#egg=garbagedog (requires python 3.4)

or

wget https://github.com/eero-inc/garbagedog/releases/download/0.0.12/garbagedog-linux-gnu-0.0.12.pex

JVM Setup

Run your JVM app with the following flags:

-Xloggc:/var/log/eero/gc.log
-XX:+UseGCLogFileRotation
-XX:GCLogFileSize=64M
-XX:NumberOfGCLogFiles=2
-XX:+PrintGCDetails
-XX:+PrintGCDateStamps
-XX:+PrintGCApplicationConcurrentTime
-XX:+PrintGCApplicationStoppedTime
-XX:+PrintTenuringDistribution
-XX:+PrintPromotionFailure
-XX:+PrintHeapAtGC
-XX:+PrintGCCause

Usage

usage: garbagedog --log-dir /var/log/eero/

Parse JVM gc.logs and emit stats over dogstatsd

optional arguments:
  -h, --help            show this help message and exit
  --tags TAGS           Extra datadog tags, comma separated; ie
                        "application:actorcluster, version:2017.07.27"
  --dogstatsd-host DOGSTATSD_HOST
                        dogstatsd host (default: localhost)
  --dogstatsd-port DOGSTATSD_PORT
                        dogstatsd port (default: 8125)
  --verbose             Emit noisy messages on stdout
  --log-dir LOG_DIR     Read from this log dir instead of stdin
  --glob-pattern GLOB_PATTERN
                        Glob pattern to select gc.log files (default: gc.log*)
  --refresh-logfiles-seconds REFRESH_LOGFILES_SECONDS
                        How often to recheck --log-dir if there are no
                        logfiles found or no new loglines have been written
                        (default: 60)
  --sleep-seconds SLEEP_SECONDS
                        How long to sleep between checking the logfile for new
                        lines (default: 1)
  --version, -v         Print version information

Stats

Timing by event type: garbagedog_gc_event_duration

Allocation rate: garbagedog_allocation_rate_histogram

Promotion rate: garbagedog_promotion_rate_histogram

Old gen GC frequency: garbagedog_time_between_old_gc

Young gen GC frequency: garbagedog_time_between_young_gc

Grafana Examples

Example Graphs Grafana Graph Example

See grafana json

Development

Running

git clone git@github.com:eero-inc/garbagedog.git
cd garbagedog
virtualenv --python=python3 ENV
source ENV/bin/activate
pip install -e .

Testing

git clone git@github.com:eero-inc/garbagedog.git
cd garbagedog
virtualenv --python=python3 ENV
source ENV/bin/activate
pip install -r dev_requirements.txt

./test.sh

Building a standalone executable pex

On your targeted environment check out the source and build

git clone git@github.com:eero-inc/garbagedog.git
cd garbagedog
virtualenv --python=python3 ENV
source ENV/bin/activate
pip install pex
./build.sh

About

Made for eero Hack Week 2017 - ps we're hiring! https://eero.com/jobs Not related to the retired RedHat project also called garbagedog