softbaked/graphite-statsd repository overview

⁠Docker Image for Graphite & Statsd

⁠Get Graphite & Statsd running instantly

Graphite & Statsd can be complex to setup. This image will have you running & collecting stats in just a few minutes.

⁠Quick Start

sudo docker run -d \
  --name graphite \
  --restart=always \
  -p 80:80 \
  -p 2003:2003 \
  -p 8125:8125/udp \
  softbaked/graphite-statsd

This starts a Docker container named: graphite

That's it, you're done ... almost.

⁠Includes the following components

• Nginx⁠ - reverse proxies the graphite dashboard
• Graphite⁠ - front-end dashboard
• Carbon⁠ - back-end
• Statsd⁠ - UDP based back-end proxy

⁠Mapped Ports

⁠Mounted Volumes

⁠Base Image

Built using Phusion's base image⁠.

• All Graphite related processes are run as daemons & monitored with runit⁠.
• Includes additional services such as logrotate.

⁠Start Using Graphite & Statsd

⁠Send Some Stats

Let's fake some stats with a random counter to prove things are working.

while true
do
  echo -n "example.statsd.counter.changed:$(((RANDOM % 10) + 1))|c" | nc -w 1 -u localhost 8125
done
<CTL-C>

⁠Visualize the Data

Open Graphite in a browser at http://localhost/dashboard⁠.

⁠Secure the Django Admin

Update the default Django admin user account. The default is insecure.

• username: root
• password: root
• email: [email protected]⁠

First login at: http://localhost/account/login⁠ Then update the root user's profile at: http://localhost/admin/auth/user/1/⁠

⁠Change the Configuration

Read up on Graphite's post-install tasks⁠. Focus on the storage-schemas.conf⁠

1. Stop the container docker stop graphite.
2. Find the configuration files on the host by inspecting the container docker inspect graphite.
3. Update the desired config files.
4. Restart the container docker start graphite.

Note: If you change settings in /opt/graphite/conf/storage-schemas.conf be sure to delete the old whisper files under /opt/graphite/storage/whisper/.

Important: Ensure your Statsd flush interval is at least as long as the highest-resolution retention. For example, if /opt/statsd/config.js looks like this.

flushInterval: 10000

Ensure that storage-schemas.conf retentions are no finer grained than 10 seconds.

[all]
pattern = .*
retentions = 5s:12h # WRONG
retentions = 10s:12h # OK
retentions = 60s:12h # OK

⁠Statsd Admin Management Interface

A management interface (default on port 8126) allows you to manage statsd and retrieve stats

# show all current counters
echo counters | nc localhost 8126

more info and additional commands: admin_interface⁠

⁠A Note on Disk Space

If running this image on cloud infrastructure such as AWS, you should consider mounting /opt/graphite/storage on a larger volume.

1. Configure the host to mount a large EBS volume.

2. Specify the volume mounts when starting the container.

   sudo docker run -d \
     --name graphite \
     --restart=always \
     -v /path/to/ebs/graphite:/opt/graphite/storage \
     -p 80:80 \
     -p 2003:2003 \
     -p 8125:8125/udp \
     softbaked/graphite-statsd
   

   Copy

⁠Additional Reading

• Introduction to Docker⁠
• Official Statsd Documentation⁠
• Practical Guide to StatsD/Graphite Monitoring⁠
• Configuring Graphite for StatsD⁠

⁠Contributors

Build the image yourself.

⁠OSX

1. git clone https://github.com/softbaked/docker-graphite-statsd.git
2. cd docker-graphite-statsd
3. vagrant up
4. vagrant ssh
5. sudo docker build -t softbaked/graphite-statsd /vagrant

Note: Pay attention to the forwarded ports in the Vagrantfile⁠.

⁠Linux

1. git clone https://github.com/softbaked/docker-graphite-statsd.git
2. sudo docker build -t softbaked/graphite-statsd ./docker-graphite-statsd