1// Copyright 2018 The etcd Authors
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15// etcd-dump-metrics automates etcd Prometheus metrics documentation.
16package main
17
18import (
19	"flag"
20	"fmt"
21	"io/ioutil"
22	"net/url"
23	"os"
24	"os/exec"
25	"path/filepath"
26	"time"
27
28	"go.etcd.io/etcd/embed"
29
30	"go.uber.org/zap"
31)
32
33var lg *zap.Logger
34
35func init() {
36	var err error
37	lg, err = zap.NewProduction()
38	if err != nil {
39		panic(err)
40	}
41}
42
43func main() {
44	addr := flag.String("addr", "", "etcd metrics URL to fetch from (empty to use current git branch)")
45	downloadVer := flag.String("download-ver", "", "etcd binary version to download and fetch metrics from")
46	debug := flag.Bool("debug", false, "true to enable debug logging")
47	flag.Parse()
48
49	if *addr != "" && *downloadVer != "" {
50		panic("specify either 'addr' or 'download-ver'")
51	}
52	if *debug {
53		lg = zap.NewExample()
54	}
55
56	ep := *addr
57	if ep == "" {
58		if *downloadVer != "" {
59			ver := *downloadVer
60
61			// download release binary to temporary directory
62			d, err := ioutil.TempDir(os.TempDir(), ver)
63			if err != nil {
64				panic(err)
65			}
66			defer os.RemoveAll(d)
67
68			var bp string
69			bp, err = install(ver, d)
70			if err != nil {
71				panic(err)
72			}
73
74			// set up 2-node cluster locally
75			ep = "http://localhost:2379/metrics"
76			cluster := "s1=http://localhost:2380,s2=http://localhost:22380"
77
78			d1 := filepath.Join(d, "s1")
79			d2 := filepath.Join(d, "s2")
80			os.RemoveAll(d1)
81			os.RemoveAll(d2)
82
83			type run struct {
84				err error
85				cmd *exec.Cmd
86			}
87			rc := make(chan run)
88
89			cs1 := getCommand(bp, "s1", d1, "http://localhost:2379", "http://localhost:2380", cluster)
90			cmd1 := exec.Command(cs1[0], cs1[1:]...)
91			go func() {
92				if *debug {
93					cmd1.Stderr = os.Stderr
94				}
95				if cerr := cmd1.Start(); cerr != nil {
96					lg.Warn("failed to start first process", zap.Error(cerr))
97					rc <- run{err: cerr}
98					return
99				}
100				lg.Debug("started first process")
101				rc <- run{cmd: cmd1}
102			}()
103			cs2 := getCommand(bp, "s2", d2, "http://localhost:22379", "http://localhost:22380", cluster)
104			cmd2 := exec.Command(cs2[0], cs2[1:]...)
105			go func() {
106				if *debug {
107					cmd2.Stderr = os.Stderr
108				}
109				if cerr := cmd2.Start(); cerr != nil {
110					lg.Warn("failed to start second process", zap.Error(cerr))
111					rc <- run{err: cerr}
112					return
113				}
114				lg.Debug("started second process")
115				rc <- run{cmd: cmd2}
116			}()
117			rc1 := <-rc
118			if rc1.err != nil {
119				panic(rc1.err)
120			}
121			rc2 := <-rc
122			if rc2.err != nil {
123				panic(rc2.err)
124			}
125
126			defer func() {
127				lg.Debug("killing processes")
128				rc1.cmd.Process.Kill()
129				rc2.cmd.Process.Kill()
130				rc1.cmd.Wait()
131				rc2.cmd.Wait()
132				lg.Debug("killed processes")
133			}()
134
135			// give enough time for peer-to-peer metrics
136			lg.Debug("waiting")
137			time.Sleep(7 * time.Second)
138			lg.Debug("started 2-node etcd cluster")
139		} else {
140			// fetch metrics from embedded etcd
141			uss := newEmbedURLs(4)
142			ep = uss[0].String() + "/metrics"
143
144			cfgs := []*embed.Config{embed.NewConfig(), embed.NewConfig()}
145			cfgs[0].Name, cfgs[1].Name = "0", "1"
146			setupEmbedCfg(cfgs[0], []url.URL{uss[0]}, []url.URL{uss[1]}, []url.URL{uss[1], uss[3]})
147			setupEmbedCfg(cfgs[1], []url.URL{uss[2]}, []url.URL{uss[3]}, []url.URL{uss[1], uss[3]})
148			type embedAndError struct {
149				ec  *embed.Etcd
150				err error
151			}
152			ech := make(chan embedAndError)
153			for _, cfg := range cfgs {
154				go func(c *embed.Config) {
155					e, err := embed.StartEtcd(c)
156					if err != nil {
157						ech <- embedAndError{err: err}
158						return
159					}
160					<-e.Server.ReadyNotify()
161					ech <- embedAndError{ec: e}
162				}(cfg)
163			}
164			for range cfgs {
165				ev := <-ech
166				if ev.err != nil {
167					lg.Panic("failed to start embedded etcd", zap.Error(ev.err))
168				}
169				defer ev.ec.Close()
170			}
171
172			// give enough time for peer-to-peer metrics
173			lg.Debug("waiting")
174			time.Sleep(7 * time.Second)
175			lg.Debug("started 2-node embedded etcd cluster")
176		}
177	}
178
179	// send client requests to populate gRPC client-side metrics
180	// TODO: enable default metrics initialization in v3.1 and v3.2
181	write(ep)
182
183	lg.Debug("fetching metrics", zap.String("endpoint", ep))
184	fmt.Println(getMetrics(ep))
185}
186