-
-
Notifications
You must be signed in to change notification settings - Fork 414
Export Prometheus telemetry in daemon mode #573
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
39 commits
Select commit
Hold shift + click to select a range
ba172c3
Apply cosmetics
2c6634d
Implement ugly telemetry POC
11d1bdb
Added prefix and moved Insrumentation inside the command package
bb6a490
Refactor the telemetry module
18cdce8
Implement configuration via Viper
1262ba6
Add stats flush in case of a not daemonized cli daemon proces
a9d1b31
Add repertory to store installation id and secret
74fe852
Repertory force write
ab0a98c
Cosmetics
315cf00
Use viper config for repertory dir
b961a48
Add test for repertory file creation
e1ea063
Add testing for telemetry deaemon and repertory
30e7a2b
Wait for repertory and kill daemon
eb33588
Updated pyinvoke to use async feature to test the daemon
8974523
Updated daemon test timeout
e98c271
Cosmetics
ead55a3
Set getDefaultArduinoDataDir as unexported
216303f
Cosmetics
18481c0
Cosmetics
c448704
Cosmetics
0aea65c
Lint on repertory module
855b377
Set SIGTERM as kill signal in case of win platform to overcome pyinvo…
b203b7e
Import platform as a module
d0f448c
Reverse platform if for signal value
dc61b78
Extract pid value
040dc85
Remove print leftover
2d0808a
Add better error handling in repertory creation
b3bbdc6
Update docs with old README extract
90477d5
Remove telemetry.pattern setting from docs
4d5af7a
Remove serverPattern config option for telemetry
0fdc125
Upgrade viper to 1.6.2
965a70f
Defer stats Increment in compile command and explicit set for success…
e1582e7
Fix board list help message
ce6f4fa
Implement stats flush anyway to leverage module no-op in case of no h…
4e7b4cf
Rename "repertory" module in "inventory" and refactor Sanitize function
aaed29d
Sanitize ExportFile in command/compile
8b425a7
Refactor daemon start fixture to include daemon process cleanup
0625b39
Use defer function to push success tag correctly updated
3300d4d
Use named return parameters to handle success tagging for a command stat
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Implement configuration via Viper
- Loading branch information
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,52 @@ | ||
| package telemetry | ||
|
|
||
| import ( | ||
| "crypto/hmac" | ||
| "crypto/sha256" | ||
| "encoding/hex" | ||
| "net/http" | ||
| "path/filepath" | ||
|
|
||
| "github.com/segmentio/stats/v4" | ||
| "github.com/segmentio/stats/v4/prometheus" | ||
| "github.com/sirupsen/logrus" | ||
| "github.com/spf13/viper" | ||
| ) | ||
|
|
||
| // Engine is the engine used by global helper functions for this module. | ||
| var Engine = stats.DefaultEngine | ||
|
|
||
| var serverAddr = ":2112" | ||
| var serverPattern = "/metrics" | ||
|
|
||
| //Activate configure and starts the telemetry server exposing a Prometheus resource | ||
| func Activate(metricPrefix string) { | ||
| // Activate configure and starts the telemetry server exposing a Prometheus resource | ||
| func Activate(metricPrefix, installationID string) { | ||
| // Configure telemetry engine | ||
| // Create a Prometheus default handler | ||
| ph := prometheus.DefaultHandler | ||
| // Replace the default stats engine with an engine that prepends the "daemon" prefix to all metrics | ||
| Engine = stats.WithPrefix(metricPrefix) | ||
| // Create a new stats engine with an engine that prepends the "daemon" prefix to all metrics | ||
| // and includes the installationID as a tag | ||
| Engine = stats.WithPrefix(metricPrefix, stats.T("installationID", installationID)) | ||
| // Register the handler so it receives metrics from the default engine. | ||
| Engine.Register(ph) | ||
| // Flush the default stats engine on return to ensure all buffered | ||
| // metrics are sent to the server. | ||
| defer Engine.Flush() | ||
| // move everything inside commands and search for setting up a common prefix for all metrics sent! | ||
|
|
||
| // Configure using viper settings | ||
| serverAddr := viper.GetString("telemetry.addr") | ||
| serverPattern := viper.GetString("telemetry.pattern") | ||
| logrus.Infof("Setting up Prometheus telemetry on %s%s", serverAddr, serverPattern) | ||
| go func() { | ||
| http.Handle(serverPattern, ph) | ||
| logrus.Error(http.ListenAndServe(serverAddr, nil)) | ||
| }() | ||
|
|
||
| } | ||
|
|
||
| // SanitizeSketchPath uses config generated UUID (installation.secret) as an HMAC secret to sanitize and anonymize the sketch | ||
| // name maintaining it distinguishable from a different sketch from the same Installation | ||
| func SanitizeSketchPath(sketchPath string) string { | ||
rsora marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| installationSecret := viper.GetString("installation.secret") | ||
| sketchName := filepath.Base(sketchPath) | ||
| // Create a new HMAC by defining the hash type and the key (as byte array) | ||
| h := hmac.New(sha256.New, []byte(installationSecret)) | ||
| // Write Data to it | ||
| h.Write([]byte(sketchName)) | ||
| // Get result and encode as hexadecimal string | ||
| return hex.EncodeToString(h.Sum(nil)) | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.