51 lines
1.7 KiB
Go
51 lines
1.7 KiB
Go
package protocol
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/getsentry/sentry-go/internal/ratelimit"
|
|
)
|
|
|
|
// EnvelopeItemConvertible represents any type that can be converted to a Sentry envelope item.
|
|
// This interface allows the telemetry buffers to work with items that can be batched together.
|
|
type EnvelopeItemConvertible interface {
|
|
// ToEnvelopeItem converts the item to a Sentry envelope item.
|
|
ToEnvelopeItem() (*EnvelopeItem, error)
|
|
|
|
// GetCategory returns the rate limit category for this item.
|
|
GetCategory() ratelimit.Category
|
|
|
|
// GetEventID returns the event ID for this item.
|
|
GetEventID() string
|
|
|
|
// GetSdkInfo returns SDK information for the envelope header.
|
|
GetSdkInfo() *SdkInfo
|
|
|
|
// GetDynamicSamplingContext returns trace context for the envelope header.
|
|
GetDynamicSamplingContext() map[string]string
|
|
}
|
|
|
|
// TelemetryTransport represents the envelope-first transport interface.
|
|
// This interface is designed for the telemetry buffer system and provides
|
|
// non-blocking sends with backpressure signals.
|
|
type TelemetryTransport interface {
|
|
// SendEnvelope sends an envelope to Sentry. Returns immediately with
|
|
// backpressure error if the queue is full.
|
|
SendEnvelope(envelope *Envelope) error
|
|
|
|
// HasCapacity reports whether the transport has capacity to accept at least one more envelope.
|
|
HasCapacity() bool
|
|
|
|
// IsRateLimited checks if a specific category is currently rate limited
|
|
IsRateLimited(category ratelimit.Category) bool
|
|
|
|
// Flush waits for all pending envelopes to be sent, with timeout
|
|
Flush(timeout time.Duration) bool
|
|
|
|
// FlushWithContext waits for all pending envelopes to be sent
|
|
FlushWithContext(ctx context.Context) bool
|
|
|
|
// Close shuts down the transport gracefully
|
|
Close()
|
|
}
|