output

Documentation

Index

• Variables
• func InitObservableMetrics(callbacks ObservableCallbacks)
• func Int64ToUint64(nanos int64) uint64
• func TimeToUnixNanoUint64(t time.Time) uint64
• type BlitzOutputActiveWorkersGaugeType
  • func (m BlitzOutputActiveWorkersGaugeType) Record(ctx context.Context, value int64, outputType string, ...)
• type BlitzOutputEntriesReceivedCounterType
  • func (m BlitzOutputEntriesReceivedCounterType) Add(ctx context.Context, value int64, outputType string, opts ...metric.AddOption)
• type BlitzOutputEntryRateCounterType
  • func (m BlitzOutputEntryRateCounterType) Add(ctx context.Context, value float64, outputType string, ...)
• type BlitzOutputRequestLatencyHistogramType
  • func (m BlitzOutputRequestLatencyHistogramType) Record(ctx context.Context, value float64, outputType string, ...)
• type BlitzOutputRequestSizeHistogramType
  • func (m BlitzOutputRequestSizeHistogramType) Record(ctx context.Context, value int64, outputType string, ...)
• type BlitzOutputSendErrorsCounterType
  • func (m BlitzOutputSendErrorsCounterType) Add(ctx context.Context, value int64, outputType string, opts ...metric.AddOption)
• type LogRecord
• type LogRecordMetadata
• type ObservableCallbacks
• type Output
• type Writer

Variables

var (

	// BlitzOutputEntriesReceivedCounter tracks the total number of log entries received by the output
	BlitzOutputEntriesReceivedCounter BlitzOutputEntriesReceivedCounterType

	// BlitzOutputActiveWorkersGauge tracks the number of active output worker goroutines
	BlitzOutputActiveWorkersGauge BlitzOutputActiveWorkersGaugeType

	// BlitzOutputEntryRateCounter tracks the rate of log entries processed per second
	BlitzOutputEntryRateCounter BlitzOutputEntryRateCounterType

	// BlitzOutputRequestSizeHistogram tracks the size of output requests in bytes
	BlitzOutputRequestSizeHistogram BlitzOutputRequestSizeHistogramType

	// BlitzOutputRequestLatencyHistogram tracks the latency of output requests
	BlitzOutputRequestLatencyHistogram BlitzOutputRequestLatencyHistogramType

	// BlitzOutputSendErrorsCounter tracks the total number of send errors
	BlitzOutputSendErrorsCounter BlitzOutputSendErrorsCounterType
)

Functions

func InitObservableMetrics

func InitObservableMetrics(callbacks ObservableCallbacks)

InitObservableMetrics initializes observable metrics with the provided callbacks

func Int64ToUint64

func Int64ToUint64(nanos int64) uint64

Int64ToUint64 safely converts an int64 timestamp to uint64. UnixNano() returns int64 but OTLP protobuf requires uint64. Since timestamps are always non-negative (nanoseconds since Unix epoch), this conversion is safe. However, we validate to satisfy static analysis tools.

func TimeToUnixNanoUint64

func TimeToUnixNanoUint64(t time.Time) uint64

TimeToUnixNanoUint64 converts a time.Time to uint64 nanoseconds. This is a convenience wrapper around Int64ToUint64 for better readability.

Types

type BlitzOutputActiveWorkersGaugeType

type BlitzOutputActiveWorkersGaugeType struct {
	// contains filtered or unexported fields
}

BlitzOutputActiveWorkersGaugeType wraps the blitz.output.active_workers metric with type-safe required attributes

func (BlitzOutputActiveWorkersGaugeType) Record

func (m BlitzOutputActiveWorkersGaugeType) Record(ctx context.Context, value int64, outputType string, opts ...metric.RecordOption)

Record records a value for blitz.output.active_workers with required attributes

type BlitzOutputEntriesReceivedCounterType

type BlitzOutputEntriesReceivedCounterType struct {
	// contains filtered or unexported fields
}

BlitzOutputEntriesReceivedCounterType wraps the blitz.output.entries_received metric with type-safe required attributes

func (BlitzOutputEntriesReceivedCounterType) Add

func (m BlitzOutputEntriesReceivedCounterType) Add(ctx context.Context, value int64, outputType string, opts ...metric.AddOption)

Add records a value for blitz.output.entries_received with required attributes

type BlitzOutputEntryRateCounterType

type BlitzOutputEntryRateCounterType struct {
	// contains filtered or unexported fields
}

BlitzOutputEntryRateCounterType wraps the blitz.output.entry_rate metric with type-safe required attributes

func (BlitzOutputEntryRateCounterType) Add

func (m BlitzOutputEntryRateCounterType) Add(ctx context.Context, value float64, outputType string, opts ...metric.AddOption)

Add records a value for blitz.output.entry_rate with required attributes

type BlitzOutputRequestLatencyHistogramType

type BlitzOutputRequestLatencyHistogramType struct {
	// contains filtered or unexported fields
}

BlitzOutputRequestLatencyHistogramType wraps the blitz.output.request_latency metric with type-safe required attributes

func (BlitzOutputRequestLatencyHistogramType) Record

func (m BlitzOutputRequestLatencyHistogramType) Record(ctx context.Context, value float64, outputType string, opts ...metric.RecordOption)

Record records a value for blitz.output.request_latency with required attributes

type BlitzOutputRequestSizeHistogramType

type BlitzOutputRequestSizeHistogramType struct {
	// contains filtered or unexported fields
}

BlitzOutputRequestSizeHistogramType wraps the blitz.output.request_size metric with type-safe required attributes

func (BlitzOutputRequestSizeHistogramType) Record

func (m BlitzOutputRequestSizeHistogramType) Record(ctx context.Context, value int64, outputType string, opts ...metric.RecordOption)

Record records a value for blitz.output.request_size with required attributes

type BlitzOutputSendErrorsCounterType

type BlitzOutputSendErrorsCounterType struct {
	// contains filtered or unexported fields
}

BlitzOutputSendErrorsCounterType wraps the blitz.output.send_errors metric with type-safe required attributes

func (BlitzOutputSendErrorsCounterType) Add

func (m BlitzOutputSendErrorsCounterType) Add(ctx context.Context, value int64, outputType string, opts ...metric.AddOption)

Add records a value for blitz.output.send_errors with required attributes

type LogRecord

type LogRecord struct {
	// Message is the raw log message
	Message string

	// ParseFunc is an optional function that will be
	// used by some outputs to parse the message to a
	// map[string]any structure.
	ParseFunc func(message string) (map[string]any, error)

	// Metadata is the metadata for a log record.
	Metadata LogRecordMetadata
}

type LogRecordMetadata

type LogRecordMetadata struct {
	Timestamp time.Time
	Severity  string
}

LogRecordMetadata is the metadata for a log record.

type ObservableCallbacks

type ObservableCallbacks interface {
	ObserveBlitzOutputQueueSize(ctx context.Context, observer metric.Int64Observer) error
}

ObservableCallbacks defines the callback interface for observable metrics

type Output

type Output interface {
	Writer

	// Stop stops the output.
	Stop(ctx context.Context) error
}

Output is the interface for outputting data.

type Writer

type Writer interface {
	// Write writes the data to the output.
	Write(ctx context.Context, data LogRecord) error
}

Writer can consume log records.