Public Repository

Last pushed: 2 years ago
Short Description
Analyzes resource usage and performance characteristics of running containers
Full Description

GroundWork BoxSpy

BoxSpy is designed specifically to monitor Docker and other Linux container environments.

Benefits of monitoring Docker containers with BoxSpy:

  • Works ‘out-of-the-box’ with GroundWork, but also has a REST API that makes it compatible with other monitoring technologies
  • Lives in a container and is capable of monitoring other containers running on the same system
  • Designed for both DevOps and production environments
  • Adds full-featured enterprise monitoring to Docker environments with the ability to correlate Docker performance with the rest of the IT environment
  • Designed for dynamic environments — automatically monitors new Docker containers as you spin them up.

BoxSpy is based on Google’s cAdvisor container monitoring technology and improves it by:

  • Dramatically reducing the resource demand and performance impact
  • API clean-up and bug-fixing
  • Removing unnecessary overhead that isn’t needed when talking to an external monitoring system
  • Normalizing metrics to make them more human readable and standardized
  • Adding threshold setting
  • Adding process monitoring

Install instructions

There are two ways to get the GroundWork BoxSpy docker image into your environment

Build from Source

If you have setup the go language environment the image can be compiled from source as following:

Use pre-built docker image

  • A prebuilt container is also available in the docker index:
    sudo docker pull gwos/boxspy
    

Quick Start: Running BoxSpy in a Docker Container

To quickly tryout BoxSpy on your machine with Docker (version 1.3 or above), we have a Docker image that includes everything you need to get started. Simply run:

sudo docker run \
  --volume=/:/rootfs:ro \
  --volume=/var/run:/var/run:rw \
  --volume=/sys:/sys:ro \
  --volume=/var/lib/docker/:/var/lib/docker:ro \
  --publish=8081:8080 \
  --detach=true \
  --name=BoxSpy \
  gwos/boxspy:canary

Please note that the container will run on port 8081 and therefore the UI is available through: http://localhost:8081

Remote REST API

Current version is v1.2
Example to get all docker instances:
http://localhost:8081/api/v1.2/docker

Docker Pull Command
Owner
gwos