Skip to content

Commit e9a0634

Browse files
author
Roberto Sora
committed
Refactor the telemetry module
1 parent 8b5fc5d commit e9a0634

File tree

5 files changed

+84
-27
lines changed

5 files changed

+84
-27
lines changed

‎cli/daemon/daemon.go‎

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ import (
2929
srv_commands "github.com/arduino/arduino-cli/rpc/commands"
3030
srv_monitor "github.com/arduino/arduino-cli/rpc/monitor"
3131
srv_settings "github.com/arduino/arduino-cli/rpc/settings"
32-
stats "github.com/segmentio/stats/v4"
33-
"github.com/segmentio/stats/v4/prometheus"
32+
"github.com/arduino/arduino-cli/telemetry"
3433
"github.com/sirupsen/logrus"
3534
"github.com/spf13/cobra"
3635
"github.com/spf13/viper"
@@ -57,22 +56,8 @@ var daemonize bool
5756

5857
func runDaemonCommand(cmd *cobra.Command, args []string) {
5958

60-
// Configure telemetry engine
61-
// Create a Prometheus default handler
62-
ph := prometheus.DefaultHandler
63-
// Replace the default stats engine with an engine that prepends the "daemon" prefix to all metrics
64-
stats.DefaultEngine = stats.WithPrefix("daemon")
65-
// Register the handler so it receives metrics from the default engine.
66-
stats.Register(ph)
67-
// Flush the default stats engine on return to ensure all buffered
68-
// metrics are sent to the server.
69-
defer stats.Flush()
70-
// move everything inside commands and search for setting up a common prefix for all metrics sent!
71-
logrus.Infof("Setting up Prometheus telemetry on /metrics, TCP port 2112")
72-
go func() {
73-
http.Handle("/metrics", ph)
74-
logrus.Error(http.ListenAndServe(":2112", nil))
75-
}()
59+
telemetry.Activate("daemon")
60+
defer telemetry.Engine.Flush()
7661

7762
port := viper.GetString("daemon.port")
7863
s := grpc.NewServer()
@@ -106,6 +91,7 @@ func runDaemonCommand(cmd *cobra.Command, args []string) {
10691
go func() {
10792
// stdin is closed when the controlling parent process ends
10893
_, _ = io.Copy(ioutil.Discard, os.Stdin)
94+
telemetry.Engine.Flush()
10995
os.Exit(0)
11096
}()
11197
}
@@ -118,5 +104,4 @@ func runDaemonCommand(cmd *cobra.Command, args []string) {
118104
if err := s.Serve(lis); err != nil {
119105
logrus.Fatalf("failed to serve: %v", err)
120106
}
121-
122107
}

‎commands/board/attach.go‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,12 @@ import (
2828
"github.com/arduino/arduino-cli/arduino/sketches"
2929
"github.com/arduino/arduino-cli/commands"
3030
rpc "github.com/arduino/arduino-cli/rpc/commands"
31-
discovery "github.com/arduino/board-discovery"
32-
paths "github.com/arduino/go-paths-helper"
31+
"github.com/arduino/board-discovery"
32+
"github.com/arduino/go-paths-helper"
3333
)
3434

3535
// Attach FIXMEDOC
3636
func Attach(ctx context.Context, req *rpc.BoardAttachReq, taskCB commands.TaskProgressCB) (*rpc.BoardAttachResp, error) {
37-
3837
pm := commands.GetPackageManager(req.GetInstance().GetId())
3938
if pm == nil {
4039
return nil, errors.New("invalid instance")

‎commands/board/list.go‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ package board
1818
import (
1919
"encoding/json"
2020
"fmt"
21+
"github.com/arduino/arduino-cli/telemetry"
2122
"github.com/segmentio/stats/v4"
2223
"io/ioutil"
2324
"net/http"
@@ -107,13 +108,13 @@ func List(instanceID int32) ([]*rpc.DetectedPort, error) {
107108

108109
pm := commands.GetPackageManager(instanceID)
109110
if pm == nil {
110-
stats.Incr("board.list", stats.Tag{"success", "false"})
111+
telemetry.Engine.Incr("board.list", stats.T("success", "false"))
111112
return nil, errors.New("invalid instance")
112113
}
113114

114115
ports, err := commands.ListBoards(pm)
115116
if err != nil {
116-
stats.Incr("board.list", stats.Tag{"success", "false"})
117+
telemetry.Engine.Incr("board.list", stats.T("success", "false"))
117118
return nil, errors.Wrap(err, "error getting port list from serial-discovery")
118119
}
119120

@@ -139,7 +140,7 @@ func List(instanceID int32) ([]*rpc.DetectedPort, error) {
139140
logrus.Debug("Board not recognized")
140141
} else if err != nil {
141142
// this is bad, bail out
142-
stats.Incr("board.list", stats.Tag{"success", "false"})
143+
telemetry.Engine.Incr("board.list", stats.T("success", "false"))
143144
return nil, errors.Wrap(err, "error getting board info from Arduino Cloud")
144145
}
145146

@@ -160,6 +161,6 @@ func List(instanceID int32) ([]*rpc.DetectedPort, error) {
160161
retVal = append(retVal, p)
161162
}
162163

163-
stats.Incr("board.list", stats.Tag{"success", "true"})
164+
telemetry.Engine.Incr("board.list", stats.T("success", "true"))
164165
return retVal, nil
165166
}

‎commands/compile/compile.go‎

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import (
2222
"io"
2323
"path/filepath"
2424
"sort"
25+
"strconv"
2526
"strings"
2627

2728
"github.com/arduino/arduino-cli/arduino/cores"
@@ -33,26 +34,48 @@ import (
3334
"github.com/arduino/arduino-cli/legacy/builder/i18n"
3435
"github.com/arduino/arduino-cli/legacy/builder/types"
3536
rpc "github.com/arduino/arduino-cli/rpc/commands"
37+
"github.com/arduino/arduino-cli/telemetry"
3638
paths "github.com/arduino/go-paths-helper"
3739
properties "github.com/arduino/go-properties-orderedmap"
40+
"github.com/segmentio/stats/v4"
3841
"github.com/sirupsen/logrus"
3942
"github.com/spf13/viper"
4043
)
4144

4245
// Compile FIXMEDOC
4346
func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.Writer, debug bool) (*rpc.CompileResp, error) {
47+
48+
tags := map[string]string{
49+
"fqbn": req.Fqbn,
50+
"sketchPath": req.SketchPath,
51+
"showProperties": strconv.FormatBool(req.ShowProperties),
52+
"preprocess": strconv.FormatBool(req.Preprocess),
53+
"buildProperties": strings.Join(req.BuildProperties, ","),
54+
"warnings": req.Warnings,
55+
"verbose": strconv.FormatBool(req.Verbose),
56+
"quiet": strconv.FormatBool(req.Quiet),
57+
"vidPid": req.VidPid,
58+
"exportFile": req.ExportFile,
59+
"jobs": strconv.FormatInt(int64(req.Jobs), 10),
60+
"libraries": strings.Join(req.Libraries, ","),
61+
"success": "false",
62+
}
63+
4464
pm := commands.GetPackageManager(req.GetInstance().GetId())
4565
if pm == nil {
66+
telemetry.Engine.Incr("compile", stats.M(tags)...)
4667
return nil, errors.New("invalid instance")
4768
}
4869

4970
logrus.Tracef("Compile %s for %s started", req.GetSketchPath(), req.GetFqbn())
5071
if req.GetSketchPath() == "" {
72+
telemetry.Engine.Incr("compile", stats.M(tags)...)
5173
return nil, fmt.Errorf("missing sketchPath")
5274
}
5375
sketchPath := paths.New(req.GetSketchPath())
5476
sketch, err := sketches.NewSketchFromPath(sketchPath)
5577
if err != nil {
78+
telemetry.Engine.Incr("compile", stats.M(tags)...)
5679
return nil, fmt.Errorf("opening sketch: %s", err)
5780
}
5881

@@ -61,10 +84,12 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
6184
fqbnIn = sketch.Metadata.CPU.Fqbn
6285
}
6386
if fqbnIn == "" {
87+
telemetry.Engine.Incr("compile", stats.M(tags)...)
6488
return nil, fmt.Errorf("no FQBN provided")
6589
}
6690
fqbn, err := cores.ParseFQBN(fqbnIn)
6791
if err != nil {
92+
telemetry.Engine.Incr("compile", stats.M(tags)...)
6893
return nil, fmt.Errorf("incorrect FQBN: %s", err)
6994
}
7095

@@ -78,6 +103,7 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
78103
// "\"%[1]s:%[2]s\" platform is not installed, please install it by running \""+
79104
// version.GetAppName()+" core install %[1]s:%[2]s\".", fqbn.Package, fqbn.PlatformArch)
80105
// feedback.Error(errorMessage)
106+
telemetry.Engine.Incr("compile", stats.M(tags)...)
81107
return nil, fmt.Errorf("platform not installed")
82108
}
83109

@@ -97,6 +123,7 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
97123
builderCtx.BuildPath = paths.New(req.GetBuildPath())
98124
err = builderCtx.BuildPath.MkdirAll()
99125
if err != nil {
126+
telemetry.Engine.Incr("compile", stats.M(tags)...)
100127
return nil, fmt.Errorf("cannot create build directory: %s", err)
101128
}
102129
}
@@ -122,6 +149,7 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
122149
builderCtx.BuildCachePath = paths.New(req.GetBuildCachePath())
123150
err = builderCtx.BuildCachePath.MkdirAll()
124151
if err != nil {
152+
telemetry.Engine.Incr("compile", stats.M(tags)...)
125153
return nil, fmt.Errorf("cannot create build cache directory: %s", err)
126154
}
127155
}
@@ -154,13 +182,18 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
154182

155183
// if --preprocess or --show-properties were passed, we can stop here
156184
if req.GetShowProperties() {
185+
tags["success"] = "true"
186+
telemetry.Engine.Incr("compile", stats.M(tags)...)
157187
return &rpc.CompileResp{}, builder.RunParseHardwareAndDumpBuildProperties(builderCtx)
158188
} else if req.GetPreprocess() {
189+
tags["success"] = "true"
190+
telemetry.Engine.Incr("compile", stats.M(tags)...)
159191
return &rpc.CompileResp{}, builder.RunPreprocess(builderCtx)
160192
}
161193

162194
// if it's a regular build, go on...
163195
if err := builder.RunBuilder(builderCtx); err != nil {
196+
telemetry.Engine.Incr("compile", stats.M(tags)...)
164197
return nil, err
165198
}
166199

@@ -196,6 +229,7 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
196229
// Copy "sketch.ino.*.hex" / "sketch.ino.*.bin" artifacts to sketch directory
197230
srcDir, err := outputPath.Parent().ReadDir() // read "/build/path/*"
198231
if err != nil {
232+
telemetry.Engine.Incr("compile", stats.M(tags)...)
199233
return nil, fmt.Errorf("reading build directory: %s", err)
200234
}
201235
srcDir.FilterPrefix(base + ".")
@@ -206,6 +240,7 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
206240
dstOutput := exportPath.Join(exportFile + srcFilename)
207241
logrus.WithField("from", srcOutput).WithField("to", dstOutput).Debug("copying sketch build output")
208242
if err = srcOutput.CopyTo(dstOutput); err != nil {
243+
telemetry.Engine.Incr("compile", stats.M(tags)...)
209244
return nil, fmt.Errorf("copying output file: %s", err)
210245
}
211246
}
@@ -216,11 +251,13 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
216251
dstElf := exportPath.Join(exportFile + ".elf")
217252
logrus.WithField("from", srcElf).WithField("to", dstElf).Debug("copying sketch build output")
218253
if err = srcElf.CopyTo(dstElf); err != nil {
254+
telemetry.Engine.Incr("compile", stats.M(tags)...)
219255
return nil, fmt.Errorf("copying elf file: %s", err)
220256
}
221257
}
222258

223259
logrus.Tracef("Compile %s for %s successful", sketch.Name, fqbnIn)
224-
260+
tags["success"] = "true"
261+
telemetry.Engine.Incr("compile", stats.M(tags)...)
225262
return &rpc.CompileResp{}, nil
226263
}

‎telemetry/telemetry.go‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,36 @@
11
package telemetry
2+
3+
import (
4+
"net/http"
5+
6+
"github.com/segmentio/stats/v4"
7+
"github.com/segmentio/stats/v4/prometheus"
8+
"github.com/sirupsen/logrus"
9+
)
10+
11+
// Engine is the engine used by global helper functions for this module.
12+
var Engine = stats.DefaultEngine
13+
14+
var serverAddr = ":2112"
15+
var serverPattern = "/metrics"
16+
17+
//Activate configure and starts the telemetry server exposing a Prometheus resource
18+
func Activate(metricPrefix string) {
19+
// Configure telemetry engine
20+
// Create a Prometheus default handler
21+
ph := prometheus.DefaultHandler
22+
// Replace the default stats engine with an engine that prepends the "daemon" prefix to all metrics
23+
Engine = stats.WithPrefix(metricPrefix)
24+
// Register the handler so it receives metrics from the default engine.
25+
Engine.Register(ph)
26+
// Flush the default stats engine on return to ensure all buffered
27+
// metrics are sent to the server.
28+
defer Engine.Flush()
29+
// move everything inside commands and search for setting up a common prefix for all metrics sent!
30+
logrus.Infof("Setting up Prometheus telemetry on %s%s", serverAddr, serverPattern)
31+
go func() {
32+
http.Handle(serverPattern, ph)
33+
logrus.Error(http.ListenAndServe(serverAddr, nil))
34+
}()
35+
36+
}

0 commit comments

Comments
 (0)