forked from open-telemetry/opentelemetry-collector-contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[receiver/awss3receiver]: Add ingest progress notifications via OpAMP (…
- Loading branch information
1 parent
0261bad
commit 57c7367
Showing
12 changed files
with
645 additions
and
14 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # Use this changelog template to create an entry for release notes. | ||
|
|
||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: 'enhancement' | ||
|
|
||
| # The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) | ||
| component: awss3receiver | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: 'Add support for monitoring the progress of ingesting data from an S3 bucket via OpAMP custom messages.' | ||
|
|
||
| # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
| issues: [30750] | ||
|
|
||
| # (Optional) One or more lines of additional information to render under the primary note. | ||
| # These lines will be padded with 2 spaces and then inserted directly into the document. | ||
| # Use pipe (|) for multiline entries. | ||
| subtext: | ||
|
|
||
| # If your change doesn't affect end users or the exported elements of any package, | ||
| # you should instead start your pull request title with [chore] or use the "Skip Changelog" label. | ||
| # Optional: The change log or logs in which this entry should be included. | ||
| # e.g. '[user]' or '[user, api]' | ||
| # Include 'user' if the change is relevant to end users. | ||
| # Include 'api' if there is a change to a library API. | ||
| # Default: '[user]' | ||
| change_logs: [user] |
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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,121 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package awss3receiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/awss3receiver" | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "github.com/open-telemetry/opamp-go/client/types" | ||
| "go.opentelemetry.io/collector/component" | ||
| "go.opentelemetry.io/collector/pdata/pcommon" | ||
| "go.opentelemetry.io/collector/pdata/plog" | ||
| "go.uber.org/zap" | ||
|
|
||
| "github.com/open-telemetry/opentelemetry-collector-contrib/extension/opampcustommessages" | ||
| ) | ||
|
|
||
| const ( | ||
| IngestStatusCompleted = "completed" | ||
| IngestStatusFailed = "failed" | ||
| IngestStatusIngesting = "ingesting" | ||
| CustomCapability = "org.opentelemetry.collector.receiver.awss3" | ||
| maxNotificationAttempts = 3 | ||
| ) | ||
|
|
||
| type statusNotification struct { | ||
| TelemetryType string | ||
| IngestStatus string | ||
| StartTime time.Time | ||
| EndTime time.Time | ||
| IngestTime time.Time | ||
| FailureMessage string | ||
| } | ||
|
|
||
| type statusNotifier interface { | ||
| Start(ctx context.Context, host component.Host) error | ||
| Shutdown(ctx context.Context) error | ||
| SendStatus(ctx context.Context, message statusNotification) | ||
| } | ||
|
|
||
| type opampNotifier struct { | ||
| logger *zap.Logger | ||
| opampExtensionID component.ID | ||
| handler opampcustommessages.CustomCapabilityHandler | ||
| } | ||
|
|
||
| func newNotifier(config *Config, logger *zap.Logger) statusNotifier { | ||
| if config.Notifications.OpAMP != nil { | ||
| return &opampNotifier{opampExtensionID: *config.Notifications.OpAMP, logger: logger} | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (n *opampNotifier) Start(_ context.Context, host component.Host) error { | ||
| ext, ok := host.GetExtensions()[n.opampExtensionID] | ||
| if !ok { | ||
| return fmt.Errorf("extension %q does not exist", n.opampExtensionID) | ||
| } | ||
|
|
||
| registry, ok := ext.(opampcustommessages.CustomCapabilityRegistry) | ||
| if !ok { | ||
| return fmt.Errorf("extension %q is not a custom message registry", n.opampExtensionID) | ||
| } | ||
|
|
||
| handler, err := registry.Register(CustomCapability) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to register custom capability: %w", err) | ||
| } | ||
| if handler == nil { | ||
| return errors.New("custom capability handler is nil") | ||
| } | ||
| n.handler = handler | ||
| return nil | ||
| } | ||
|
|
||
| func (n *opampNotifier) Shutdown(_ context.Context) error { | ||
| if n.handler != nil { | ||
| n.handler.Unregister() | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (n *opampNotifier) SendStatus(_ context.Context, message statusNotification) { | ||
| logs := plog.NewLogs() | ||
| log := logs.ResourceLogs().AppendEmpty().ScopeLogs().AppendEmpty().LogRecords().AppendEmpty() | ||
| log.Body().SetStr("status") | ||
| attributes := log.Attributes() | ||
| attributes.PutStr("telemetry_type", message.TelemetryType) | ||
| attributes.PutStr("ingest_status", message.IngestStatus) | ||
| attributes.PutInt("start_time", int64(pcommon.NewTimestampFromTime(message.StartTime))) | ||
| attributes.PutInt("end_time", int64(pcommon.NewTimestampFromTime(message.EndTime))) | ||
| log.SetTimestamp(pcommon.NewTimestampFromTime(message.IngestTime)) | ||
|
|
||
| if message.FailureMessage != "" { | ||
| attributes.PutStr("failure_message", message.FailureMessage) | ||
| } | ||
|
|
||
| marshaler := plog.ProtoMarshaler{} | ||
| bytes, err := marshaler.MarshalLogs(logs) | ||
| if err != nil { | ||
| return | ||
| } | ||
| for attempt := 0; attempt < maxNotificationAttempts; attempt++ { | ||
| sendingChan, sendingErr := n.handler.SendMessage("TimeBasedIngestStatus", bytes) | ||
| switch { | ||
| case sendingErr == nil: | ||
| return | ||
| case errors.Is(sendingErr, types.ErrCustomMessagePending): | ||
| <-sendingChan | ||
| default: | ||
| // The only other errors returned by the OpAmp extension are unrecoverable, ie ErrCustomCapabilityNotSupported | ||
| // so just log an error and return. | ||
| n.logger.Error("Failed to send notification", zap.Error(sendingErr), zap.Int("attempt", attempt)) | ||
| return | ||
| } | ||
| } | ||
| n.logger.Error("Failed to send notification after multiple attempts", zap.Int("max_attempts", maxNotificationAttempts)) | ||
| } |
Oops, something went wrong.