Add metadata forwarder #1485
+256
−11
There are no files selected for viewing
This file contains 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 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 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 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 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 | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,148 @@ | ||||||
| package metadata | ||||||
|
|
||||||
| import ( | ||||||
| "bytes" | ||||||
| "context" | ||||||
| "fmt" | ||||||
| "io" | ||||||
| "net/http" | ||||||
| "net/url" | ||||||
| "os" | ||||||
| "strconv" | ||||||
| "time" | ||||||
|
|
||||||
| "github.com/go-logr/logr" | ||||||
| ) | ||||||
|
|
||||||
| const ( | ||||||
| apiHTTPHeaderKey = "Dd-Api-Key" | ||||||
| useragentHTTPHeaderKey = "User-Agent" | ||||||
| contentTypeHeaderKey = "Content-Type" | ||||||
| acceptHeaderKey = "Accept" | ||||||
|
|
||||||
| defaultURLScheme = "https" | ||||||
| defaultURLHost = "app.datadog.com" | ||||||
| defaultURLHostPrefix = "app." | ||||||
| defaultURLPath = "api/v1/metadata" | ||||||
|
|
||||||
| defaultInterval = 1 * time.Minute | ||||||
| ) | ||||||
|
|
||||||
| type MetadataForwarder struct { | ||||||
| OperatorMetadata OperatorMetadata | ||||||
| logger logr.Logger | ||||||
| stopChan chan struct{} | ||||||
| } | ||||||
|
|
||||||
| // NewMetadataForwarder creates a new instance of the metadata forwarder | ||||||
| func NewMetadataForwarder(logger logr.Logger) *MetadataForwarder { | ||||||
| return &MetadataForwarder{ | ||||||
| OperatorMetadata: OperatorMetadata{}, | ||||||
| logger: logger, | ||||||
| stopChan: make(chan struct{}), | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| // Start starts the metadata forwarder | ||||||
| func (mdf *MetadataForwarder) Start() { | ||||||
| ticker := time.NewTicker(getTickerInterval(mdf.logger)) | ||||||
| go func() { | ||||||
| for { | ||||||
| select { | ||||||
| case <-mdf.stopChan: | ||||||
| ticker.Stop() | ||||||
| mdf.logger.Info("Stopping ticker for metadata forwarder case") | ||||||
| return | ||||||
| case <-ticker.C: | ||||||
| if err := mdf.sendMetadata(); err != nil { | ||||||
| mdf.logger.Error(err, "Error while sending metadata") | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| }() | ||||||
| } | ||||||
|
|
||||||
| // Stop stops the metadata forwarder | ||||||
| func (mdf *MetadataForwarder) Stop() { | ||||||
| close(mdf.stopChan) | ||||||
| mdf.logger.Info("Stopping metadata forwarder") | ||||||
| } | ||||||
|
|
||||||
| func (mdf *MetadataForwarder) sendMetadata() error { | ||||||
| url := createURL(mdf.logger) | ||||||
| mdf.logger.V(1).Info("Sending metadata to URL", "url", url) | ||||||
|
|
||||||
| reader := bytes.NewReader(mdf.createPayload()) | ||||||
| req, err := http.NewRequestWithContext(context.TODO(), "POST", url, reader) | ||||||
| if err != nil { | ||||||
| mdf.logger.Error(err, "Error creating request", "url", url, "reader", reader) | ||||||
| } | ||||||
| req.Header = getHeaders() | ||||||
|
|
||||||
| client := &http.Client{ | ||||||
| Timeout: 10 * time.Second, | ||||||
| } | ||||||
| resp, err := client.Do(req) | ||||||
| if err != nil { | ||||||
| return fmt.Errorf("Error sending request: %w", err) | ||||||
| } | ||||||
|
|
||||||
| defer resp.Body.Close() | ||||||
| body, err := io.ReadAll(resp.Body) | ||||||
| if err != nil { | ||||||
| return fmt.Errorf("Failed to read response body: %w", err) | ||||||
| } | ||||||
| mdf.logger.V(1).Info("Read response", "status code", resp.StatusCode, "body", string(body)) | ||||||
| return nil | ||||||
| } | ||||||
|
|
||||||
| func getHeaders() http.Header { | ||||||
| header := http.Header{} | ||||||
| header.Set(apiHTTPHeaderKey, os.Getenv("DD_API_KEY")) | ||||||
| header.Set(useragentHTTPHeaderKey, fmt.Sprintf("datadog-operator/%s", "test")) // TODO: use operator version | ||||||
|
There was a problem hiding this comment. 🟠 Code Quality Violation
Suggested change
No need to use fmt.Sprintf("%s", var) when var is a string. (...read more)In Go, it is recommended to avoid using
That said, In summary, when it comes to simple string printing without any formatting needs or complex variable substitutions, it is best to use the string directly instead of
|
||||||
| header.Set(contentTypeHeaderKey, "application/json") | ||||||
| header.Set(acceptHeaderKey, "application/json") | ||||||
| return header | ||||||
| } | ||||||
|
|
||||||
| func createURL(logger logr.Logger) string { | ||||||
| url := url.URL{ | ||||||
| Scheme: defaultURLScheme, | ||||||
| Host: defaultURLHost, | ||||||
| Path: defaultURLPath, | ||||||
| } | ||||||
| // prioritize URL set in env var | ||||||
| if mdURLFromEnvVar := os.Getenv("METADATA_URL"); mdURLFromEnvVar != "" { | ||||||
|
There was a problem hiding this comment. do we want this to be configurable? |
||||||
| parsedURL, err := url.Parse(mdURLFromEnvVar) | ||||||
| if err != nil { | ||||||
| logger.Error(err, "Error parsing METADATA_URL") | ||||||
| } | ||||||
| // TODO: check for correct URL format | ||||||
| return parsedURL.String() | ||||||
| } | ||||||
| // check site env var | ||||||
| // example: datadoghq.com | ||||||
| if siteFromEnvVar := os.Getenv("DD_SITE"); siteFromEnvVar != "" { | ||||||
| url.Host = defaultURLHostPrefix + siteFromEnvVar | ||||||
| } | ||||||
| // check url env var | ||||||
| // example: https://app.datadoghq.com | ||||||
| if urlFromEnvVar := os.Getenv("DD_URL"); urlFromEnvVar != "" { | ||||||
| url.Host = urlFromEnvVar | ||||||
| } | ||||||
|
|
||||||
| return url.String() | ||||||
| } | ||||||
|
|
||||||
| func getTickerInterval(logger logr.Logger) time.Duration { | ||||||
| interval := defaultInterval | ||||||
| if s := os.Getenv("METADATA_INTERVAL"); s != "" { | ||||||
|
There was a problem hiding this comment. i wonder if we need this to be configurable as well |
||||||
| i, err := strconv.Atoi(s) | ||||||
| if err != nil { | ||||||
| logger.Error(err, "Error coverting METADATA_INTERVAL") | ||||||
| } | ||||||
| interval = time.Duration(i) * time.Minute | ||||||
| } | ||||||
| logger.Info("Operator metadata will be sent periodically", "frequency (seconds)", interval) | ||||||
| return interval | ||||||
| } | ||||||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe we could define
discoveryClientone level up and pass it toSetupControllers, instead of passingmf? (sincemfisn't related to controller setup.) then we could declareversionInfoone level up too and pass it tosetupMetadataForwarder