github/flagger
1
0
Fork 0
mirror of https://github.com/fluxcd/flagger.git synced 2026-04-15 06:57:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add monitoring section to readme

Browse Source
This commit is contained in:
Stefan Prodan
2018-10-02 20:33:48 +03:00
parent e092e516a0
commit 10dad2e866
1 changed files with 28 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+28 -1
View File
@@ -1,9 +1,9 @@
# steerer
[![build](https://travis-ci.org/stefanprodan/steerer.svg?branch=master)](https://travis-ci.org/stefanprodan/steerer)
[![release](https://img.shields.io/github/release/stefanprodan/steerer/all.svg)](https://github.com/stefanprodan/steerer/releases)
[![report](https://goreportcard.com/badge/github.com/stefanprodan/steerer)](https://goreportcard.com/report/github.com/stefanprodan/steerer)
[![license](https://img.shields.io/github/license/stefanprodan/steerer.svg)](https://github.com/stefanprodan/steerer/blob/master/LICENSE)
[![release](https://img.shields.io/github/release/stefanprodan/steerer/all.svg)](https://github.com/stefanprodan/steerer/releases)
Steerer is a Kubernetes operator that automates the promotion of canary deployments
using Istio routing for traffic shifting and Prometheus metrics for canary analysis.
@@ -353,6 +353,8 @@ Events:
Normal Synced 5s steerer Promotion completed! Scaling down podinfo-canary.test
```
### Monitoring
Steerer comes with a Grafana dashboard made for canary analysis.
Install Grafana with Helm:
@@ -363,8 +365,33 @@ helm upgrade -i steerer-grafana steerer/grafana \
--set url=http://prometheus.istio-system:9090
```
The dashboard shows the RED and USE metrics for the primary and canary workloads:
![steerer-grafana](https://github.com/stefanprodan/steerer/blob/master/docs/screens/grafana-canary-analysis.png)
The canary errors and latency spikes have been recorded as Kubernetes events and logged by Steerer in json format:
```
kubectl -n istio-system logs deployment/steerer -f
Starting rollout for podinfo.test
Advance rollout podinfo.test weight 5
Advance rollout podinfo.test weight 10
Advance rollout podinfo.test weight 15
Advance rollout podinfo.test weight 20
Advance rollout podinfo.test weight 25
Advance rollout podinfo.test weight 30
Advance rollout podinfo.test weight 35
Halt rollout podinfo.test success rate 98.69% < 99%
Advance rollout podinfo.test weight 40
Halt rollout podinfo.test request duration 1.515s > 500ms
Advance rollout podinfo.test weight 45
Advance rollout podinfo.test weight 50
Copying podinfo-canary.test template spec to podinfo-primary.test
Scaling down podinfo-canary.test
romotion completed! podinfo-canary.test revision 81289
```
### Contributing
Steerer is Apache 2.0 licensed and accepts contributions via GitHub pull requests.