-
Notifications
You must be signed in to change notification settings - Fork 683
/
protocol.go
100 lines (87 loc) · 3.03 KB
/
protocol.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
package metriton
import (
"bytes"
"context"
"encoding/json"
"io/ioutil"
"net/http"
)
// Report is a telemetry report to submit to Metriton.
//
// See: https://github.com/datawire/metriton/blob/master/metriton/scout/jsonschema.py
type Report struct {
Application string `json:"application"` // (required) The name of the application reporting the event
InstallID string `json:"install_id"` // (required) Application installation ID (usually a UUID, but technically an opaque string)
Version string `json:"version"` // (required) Application version number
Metadata map[string]interface{} `json:"metadata"` // (optional) Additional metadata about the application
}
// Send the report to the given Metriton endpoint using the given
// httpClient.
//
// The returned *Response may be nil even if there is no error, if
// Metriton has not yet been configured to know about the Report's
// `.Application`; i.e. a Response is only returned for known
// applications.
func (r Report) Send(ctx context.Context, httpClient *http.Client, endpoint string) (*Response, error) {
body, err := json.MarshalIndent(r, "", " ")
if err != nil {
return nil, err
}
req, err := http.NewRequestWithContext(ctx, "POST", endpoint, bytes.NewReader(body))
if err != nil {
return nil, err
}
req.Header.Set("Content-Type", "application/json")
resp, err := httpClient.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()
respBytes, err := ioutil.ReadAll(resp.Body)
if err != nil {
return nil, err
}
if len(respBytes) == 0 {
// not a recognized .Application
return nil, nil
}
var parsedResp Response
if err := json.Unmarshal(respBytes, &parsedResp); err != nil {
return nil, err
}
return &parsedResp, nil
}
// Response is a response from Metriton, after submitting a Report to
// it.
type Response struct {
AppInfo
// Only set for .Application=="aes"
HardLimit bool `json:"hard_limit"`
// Disable submitting any more telemetry for the remaining
// lifetime of this process.
//
// This way, if we ever make another release that turns out to
// effectively DDoS Metriton, we can adjust the Metriton
// server's `api.py:handle_report()` to be able to tell the
// offending processes to shut up.
DisableScout bool `json:"disable_scout"`
}
// AppInfo is the information that Metriton knows about an
// application.
//
// There isn't really an otherwise fixed schema for this; Metriton
// returns whatever it reads from
// f"s3://scout-datawire-io/{report.application}/app.json". However,
// looking at all of the existing app.json files, they all agree on
// the schema
type AppInfo struct {
Application string `json:"application"`
LatestVersion string `json:"latest_version"`
Notices []Notice `json:"notices"`
}
// Notice is a notice that should be displayed to the user.
//
// I have no idea what the schema for Notice is, there are none
// currently, and reverse-engineering it from what diagd.py consumes
// isn't worth the effort at this time.
type Notice interface{}