From e106568ddaa0059d69180cb7858b05c6f3b7caa8 Mon Sep 17 00:00:00 2001 From: Brice Fernandes Date: Thu, 15 Feb 2018 10:36:49 +0000 Subject: [PATCH] Create README.md --- probe/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 probe/README.md diff --git a/probe/README.md b/probe/README.md new file mode 100644 index 000000000..2e26cb568 --- /dev/null +++ b/probe/README.md @@ -0,0 +1,18 @@ +# Quick overview + +## Information gatherers +These implement the `Reporter` interface + +- `awsecs` Deals with talking to AWS ECS to get stats and info +- `docker` Inspects the docker status +- `endpoint` Gathers connection data +- `host` Gets data from the host os, including things like CPU and mem stats +- `kubernetes` Gathers data from k8s +- `overlay` Talks to Weave Net for network stats from the overlay network +- `process` Is code that looks up running process and stats form the os + +## Utility and control +- `appclient` Deals with generating and sending reports +- `controls` Utility code for control messages and the like +- `plugins` allows plugins to be added to the probe. +