使用 plot 绘制图表

作为一个程序员，很多时候虽然我喜欢盯着 console 输出的一堆数字看一些系统变化指标，但俗话说，一图胜千言，如果能自动的将很多数据生成图表展示，会更加清晰明了，而且能直接从变化的曲线上面得知更多的信息。这也就是我特别喜欢 Prometheus + Grafana 的原因。

但很多项目，尤其是临时的一些测试项目，我不可能为了看一个数据图表就搭建一套 Prometheus + Grafana 系统，那样效率太低，更多时候，我还是希望能有一个更简单的工具将一些数据展示出来。

幸运的是，我们可以通过 plot 非常方便的做到。plot 是一个用 Go 语言实现的绘图库，我们可以通过它绘制非常丰富的图表，并且可以输出成多种格式。另外，plot 还提供了非常方便的 interface，我们可以通过它来定制自己的图表。

简单示例

我们可以通过 plot 自己提供的 plotutil 工具绘制简单的图形。

Line and Points

因为最近刚在看可汗学院的微观经济学，所以就以 price 和 quantity demand 来作为第一个例子，价格和需求数量通常是成反比的关系，绘制的图形应该是一条下降的曲线。为了简化代码行数，这里特意去掉了错误处理。

import (
    "github.com/gonum/plot"
    "github.com/gonum/plot/plotter"
    "github.com/gonum/plot/plotutil"
    "github.com/gonum/plot/vg"
)

func main() {
    p, _ := plot.New()

    p.Title.Text = "Hello Price"
    p.X.Label.Text = "Quantity Demand"
    p.Y.Label.Text = "Price"

    points := plotter.XYs{
        {2.0, 60000.0},
        {4.0, 40000.0},
        {6.0, 30000.0},
        {8.0, 25000.0},
        {10.0, 23000.0},
    }

    plotutil.AddLinePoints(p, points)

    p.Save(4*vg.Inch, 4*vg.Inch, "price.png")
}

执行之后，我们就能可以得到一个命名为 price 的 png 文件，看起来就是这样的：

Histograms

在用 Prometheus 和 Grafana 的时候，我其实对一些 histogram 的 metric 的展示不怎么满意，因为 Grafana 的 X 轴是时间相关的，所以并不能展示柱状图，只能使用 histogram_quantile 或者其他函数得到相关的变化曲线，用 plot 则可以非常方便的将 Prometheus 的数据拿出来画图。

一个简单的例子:

import (
    "github.com/gonum/plot"
    "github.com/gonum/plot/plotter"
    "github.com/gonum/plot/vg"
)

func main() {
    p, _ := plot.New()
    p.Title.Text = "Histogram"

    bins := plotter.XYs{
        {10, 10},
        {20, 20},
        {30, 50},
        {40, 20},
        {50, 10},
    }

    h, _ := plotter.NewHistogram(bins, 5)
    p.Add(h)

    p.Save(4*vg.Inch, 4*vg.Inch, "histogram.png")
}

柱状图如下：

自定制 Plotter

Plotter

除了使用 plot 提供的图表之外，我们还可以非常方便定制自己的图表。这里我们简单的画一个边长为 20 的正方形。首先定义 Sqaures:

type Squares struct {
    plotter.XYs
}

Squares 里面就只有一批 points，用来表示各个正方形的中心 point。然后我们实现 Plotter 的 Plot 函数，如下：

func (s *Squares) Plot(c draw.Canvas, plt *plot.Plot) {
    trX, trY := plt.Transforms(&c)

    c.SetColor(color.RGBA{R: 196, B: 128, A: 255})

    r := vg.Length(10.0)
    for _, p := range s.XYs {
        p1 := vg.Point{trX(p.X) - r, trY(p.Y) - r}
        p2 := vg.Point{trX(p.X) - r, trY(p.Y) + r}
        p3 := vg.Point{trX(p.X) + r, trY(p.Y) + r}
        p4 := vg.Point{trX(p.X) + r, trY(p.Y) - r}

        var p vg.Path
        p.Move(p1)
        p.Line(p2)
        p.Line(p3)
        p.Line(p4)
        p.Line(p1)
        p.Close()
        c.Fill(p)
    }
}

上面的 Plot 函数里面，我们使用 plt.Transforms(&c) ，得到两个转换函数，能够将后面正方形的 point 转换到实际的 canvas 的 point 上面。

func main() {
    points := plotter.XYs{
        {2, 2},
        {4, 4},
        {6, 6},
        {8, 8},
        {10, 10},
    }

    s := Squares{points}

    p, _ := plot.New()
    p.Title.Text = "Squares"
    p.X.Label.Text = "X"
    p.Y.Label.Text = "Y"

    p.X.Min = 0
    p.X.Max = 20
    p.Y.Min = 0
    p.Y.Max = 20

    p.Add(&s)
    p.Save(4*vg.Inch, 4*vg.Inch, "squares.png")
}

创建一个 Sqaures，然后执行，得到图表：

DataRanger

在上面的例子中，我们使用了类似 p.X.Min = 0, p.X.Max = 20 的方式来设置整个图表的范围，但实际我们更希望能动态的调整，因为我们不可能预估到实际的范围到底有多大，这里可以使用 DataRange 来实现：

func (s *Squares) DataRange() (float64, float64, float64, float64) {
    return plotter.XYRange(s.XYs)
}

得到图表如下：

GlyphBoxer

虽然通过 DataRange 能解决范围的问题，但我们又发现，一些正方形在边界上面被切掉了，这主要是因为我们是以正方形的中心绘制的，一个解决方法就是 DataRange 返回更大的区间，能够覆盖掉整个正方向。但另一个更好的办法就是使用 GlyphBoxes，用来显示的告诉要绘制的图表的位置和大小。

func (s *Squares) GlyphBoxes(plt *plot.Plot) []plot.GlyphBox {
    boxes := make([]plot.GlyphBox, len(s.XYs))

    r := vg.Length(10.0)
    for i, p := range s.XYs {
        boxes[i].X = plt.X.Norm(p.X)
        boxes[i].Y = plt.Y.Norm(p.Y)
        boxes[i].Rectangle = vg.Rectangle{
            Min: vg.Point{X: -r, Y: -r},
            Max: vg.Point{X: +r, Y: +r},
        }
    }
    return boxes
}

现在看起来就是这样了：

后记

可以看到，使用 plot，我们可以非常方便的绘制图表。当然，plot 的功能远远不止上面说的那么简单，譬如我们可以直接获取 Prometheus 的数据然后绘图，在发送给 Slack，或者画一个 PieChart。

后面，我们也会考虑在一些内部的系统上面使用 plot，譬如性能测试框架，每次提交之后，跑很多性能测试，收集到每次的性能测试结果，使用 plot 绘图展示等等。