extern/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2025-01-22 22:08:39 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix issue with canceled context before pushing metrics and decreasing pushing interval (#2235)

Browse Source 
Fix a bug where the post context was canceled before sending metrics to the server.

The interval time was decreased, and an optional environment variable NETBIRD_METRICS_INTERVAL_IN_SECONDS was added to control the interval time.

* update doc URL
This commit is contained in:
Maycon Santos 2024-07-04 19:15:59 +02:00 committed by GitHub
parent f9845e53a0
commit 85e991ff78
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 26 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
management/server/metrics/selfhosted.go
View File

@ -7,6 +7,7 @@ import (
"fmt" "fmt"
"io" "io"
"net/http" "net/http"
"os"
"sort" "sort"
"strings" "strings"
"time" "time"
@ -24,7 +25,7 @@ const (
// payloadEndpoint metrics defaultEndpoint to send anonymous data // payloadEndpoint metrics defaultEndpoint to send anonymous data
payloadEndpoint = "https://metrics.netbird.io" payloadEndpoint = "https://metrics.netbird.io"
// defaultPushInterval default interval to push metrics // defaultPushInterval default interval to push metrics
defaultPushInterval = 24 * time.Hour defaultPushInterval = 12 * time.Hour
// requestTimeout http request timeout // requestTimeout http request timeout
requestTimeout = 45 * time.Second requestTimeout = 45 * time.Second
) )
@ -82,7 +83,9 @@ func NewWorker(ctx context.Context, id string, dataSource DataSource, connManage
// Run runs the metrics worker // Run runs the metrics worker
func (w *Worker) Run(ctx context.Context) { func (w *Worker) Run(ctx context.Context) {
pushTicker := time.NewTicker(defaultPushInterval) interval := getMetricsInterval(ctx)
pushTicker := time.NewTicker(interval)
for { for {
select { select {
case <-w.ctx.Done(): case <-w.ctx.Done():
@ -97,6 +100,20 @@ func (w *Worker) Run(ctx context.Context) {
} }
} }
func getMetricsInterval(ctx context.Context) time.Duration {
interval := defaultPushInterval
if os.Getenv("NETBIRD_METRICS_INTERVAL_IN_SECONDS") != "" {
newInterval, err := time.ParseDuration(os.Getenv("NETBIRD_METRICS_INTERVAL_IN_SECONDS") + "s")
if err != nil {
log.WithContext(ctx).Errorf("unable to parse NETBIRD_METRICS_INTERVAL_IN_SECONDS, using default interval %v. Error: %v", defaultPushInterval, err)
} else {
log.WithContext(ctx).Infof("using NETBIRD_METRICS_INTERVAL_IN_SECONDS %s", newInterval)
interval = newInterval
}
}
return interval
}
func (w *Worker) sendMetrics(ctx context.Context) error { func (w *Worker) sendMetrics(ctx context.Context) error {
apiKey, err := getAPIKey(w.ctx) apiKey, err := getAPIKey(w.ctx)
if err != nil { if err != nil {
@ -112,10 +129,11 @@ func (w *Worker) sendMetrics(ctx context.Context) error {
httpClient := http.Client{} httpClient := http.Client{}
exportJobReq, err := createPostRequest(w.ctx, payloadEndpoint+"/capture/", payloadString) exportJobReq, cancelCTX, err := createPostRequest(w.ctx, payloadEndpoint+"/capture/", payloadString)
if err != nil { if err != nil {
return fmt.Errorf("unable to create metrics post request %v", err) return fmt.Errorf("unable to create metrics post request %v", err)
} }
defer cancelCTX()
jobResp, err := httpClient.Do(exportJobReq) jobResp, err := httpClient.Do(exportJobReq)
if err != nil { if err != nil {
@ -135,7 +153,7 @@ func (w *Worker) sendMetrics(ctx context.Context) error {
log.WithContext(ctx).Infof("sent anonymous metrics, next push will happen in %s. "+ log.WithContext(ctx).Infof("sent anonymous metrics, next push will happen in %s. "+
"You can disable these metrics by running with flag --disable-anonymous-metrics,"+ "You can disable these metrics by running with flag --disable-anonymous-metrics,"+
" see more information at https://netbird.io/docs/FAQ/metrics-collection", defaultPushInterval) " see more information at https://docs.netbird.io/about-netbird/faq#why-and-what-are-the-anonymous-usage-metrics", getMetricsInterval(ctx))
return nil return nil
} }
@ -373,20 +391,20 @@ func buildMetricsPayload(payload pushPayload) (string, error) {
return string(str), nil return string(str), nil
} }
func createPostRequest(ctx context.Context, endpoint string, payloadStr string) (*http.Request, error) { func createPostRequest(ctx context.Context, endpoint string, payloadStr string) (*http.Request, context.CancelFunc, error) {
ctx, cancel := context.WithTimeout(ctx, requestTimeout) ctx, cancel := context.WithTimeout(ctx, requestTimeout)
defer cancel()
reqURL := endpoint reqURL := endpoint
payload := strings.NewReader(payloadStr) payload := strings.NewReader(payloadStr)
req, err := http.NewRequestWithContext(ctx, "POST", reqURL, payload) req, err := http.NewRequestWithContext(ctx, "POST", reqURL, payload)
if err != nil { if err != nil {
return nil, err cancel()
return nil, nil, err
} }
req.Header.Add("content-type", "application/json") req.Header.Add("content-type", "application/json")
return req, nil return req, cancel, nil
} }
func getMinMaxVersion(inputList []string) (string, string) { func getMinMaxVersion(inputList []string) (string, string) {