Skip to content

Commit 01ac5dd

Browse files
author
Matthew Fisher
authored
Merge pull request #705 from bacongobbler/document-monitor
docs(components): document the monitoring stack
2 parents 5cef033 + c0410c6 commit 01ac5dd

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

src/understanding-workflow/components.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,25 @@ Application name. Logger does not persist logs to disk, instead maintaining an
131131
in-memory ring buffer. For more information on logger see the [project
132132
documentation][logger-documentation].
133133

134+
## Monitor
135+
136+
**Project Location:** [deis/monitor](https://github.com/deis/monitor)
137+
138+
The monitoring subsystem consists of three components: Telegraf, InfluxDB and Grafana.
139+
140+
Telegraf is the is the metrics collection agent that runs using the daemon set API. It runs on
141+
every worker node in the cluster, fetches information about the pods currently running and ships it
142+
to InfluxDB.
143+
144+
InfluxDB is a database that stores the metrics collected by Telegraf. Out of the box, it does not
145+
persist to disk, but you can set it up to back it with a persisitent volume or swap this out with
146+
a more robust InfluxDB setup in a production setting.
147+
148+
Grafana is a standalone graphing application. It natively supports InfluxDB as a datasource and
149+
provides a robust engine for creating dashboards on top of timeseries data. Workflow provides a few
150+
dashboards out of the box for monitoring Deis Workflow and Kubernetes. The dashboards can be used
151+
as a starting point for creating more custom dashboards to suit a user's needs.
152+
134153
## Workflow Manager
135154

136155
**Project Location:** [deis/workflow-manager](https://github.com/deis/workflow-manager)

0 commit comments

Comments
 (0)