Documentation
¶
Index ¶
- Variables
- func BuildCustomMetricName(configType, metric string) string
- func NewLogsProcessor(_ context.Context, set processor.CreateSettings, _ component.Config, ...) (processor.Logs, error)
- func NewMetricsProcessor(_ context.Context, set processor.CreateSettings, _ component.Config, ...) (processor.Metrics, error)
- func NewTracesProcessor(_ context.Context, set processor.CreateSettings, _ component.Config, ...) (processor.Traces, error)
- type ObsReport
- func (or *ObsReport) LogsAccepted(ctx context.Context, numRecords int)
- func (or *ObsReport) LogsDropped(ctx context.Context, numRecords int)
- func (or *ObsReport) LogsRefused(ctx context.Context, numRecords int)
- func (or *ObsReport) MetricsAccepted(ctx context.Context, numPoints int)
- func (or *ObsReport) MetricsDropped(ctx context.Context, numPoints int)
- func (or *ObsReport) MetricsRefused(ctx context.Context, numPoints int)
- func (or *ObsReport) TracesAccepted(ctx context.Context, numSpans int)
- func (or *ObsReport) TracesDropped(ctx context.Context, numSpans int)
- func (or *ObsReport) TracesRefused(ctx context.Context, numSpans int)
- type ObsReportSettings
- type Option
- type ProcessLogsFunc
- type ProcessMetricsFunc
- type ProcessTracesFunc
Constants ¶
This section is empty.
Variables ¶
var ErrSkipProcessingData = errors.New("sentinel error to skip processing data from the remainder of the pipeline")
ErrSkipProcessingData is a sentinel value to indicate when traces or metrics should intentionally be dropped from further processing in the pipeline because the data is determined to be irrelevant. A processor can return this error to stop further processing without propagating an error back up the pipeline to logs.
Functions ¶
func BuildCustomMetricName ¶ added in v0.86.0
BuildCustomMetricName is used to be build a metric name following the standards used in the Collector. The configType should be the same value used to identify the type on the config.
func NewLogsProcessor ¶
func NewLogsProcessor( _ context.Context, set processor.CreateSettings, _ component.Config, nextConsumer consumer.Logs, logsFunc ProcessLogsFunc, options ...Option, ) (processor.Logs, error)
NewLogsProcessor creates a processor.Logs that ensure context propagation and the right tags are set.
func NewMetricsProcessor ¶
func NewMetricsProcessor( _ context.Context, set processor.CreateSettings, _ component.Config, nextConsumer consumer.Metrics, metricsFunc ProcessMetricsFunc, options ...Option, ) (processor.Metrics, error)
NewMetricsProcessor creates a processor.Metrics that ensure context propagation and the right tags are set.
func NewTracesProcessor ¶
func NewTracesProcessor( _ context.Context, set processor.CreateSettings, _ component.Config, nextConsumer consumer.Traces, tracesFunc ProcessTracesFunc, options ...Option, ) (processor.Traces, error)
NewTracesProcessor creates a processor.Traces that ensure context propagation and the right tags are set.
Types ¶
type ObsReport ¶ added in v0.86.0
type ObsReport struct {
// contains filtered or unexported fields
}
ObsReport is a helper to add observability to a processor.
func NewObsReport ¶ added in v0.86.0
func NewObsReport(cfg ObsReportSettings) (*ObsReport, error)
NewObsReport creates a new Processor.
func (*ObsReport) LogsAccepted ¶ added in v0.86.0
LogsAccepted reports that the logs were accepted.
func (*ObsReport) LogsDropped ¶ added in v0.86.0
LogsDropped reports that the logs were dropped.
func (*ObsReport) LogsRefused ¶ added in v0.86.0
LogsRefused reports that the logs were refused.
func (*ObsReport) MetricsAccepted ¶ added in v0.86.0
MetricsAccepted reports that the metrics were accepted.
func (*ObsReport) MetricsDropped ¶ added in v0.86.0
MetricsDropped reports that the metrics were dropped.
func (*ObsReport) MetricsRefused ¶ added in v0.86.0
MetricsRefused reports that the metrics were refused.
func (*ObsReport) TracesAccepted ¶ added in v0.86.0
TracesAccepted reports that the trace data was accepted.
func (*ObsReport) TracesDropped ¶ added in v0.86.0
TracesDropped reports that the trace data was dropped.
type ObsReportSettings ¶ added in v0.86.0
type ObsReportSettings struct {
ProcessorID component.ID
ProcessorCreateSettings processor.CreateSettings
}
ObsReportSettings are settings for creating an ObsReport.
type Option ¶
type Option func(*baseSettings)
Option apply changes to internalOptions.
func WithCapabilities ¶
func WithCapabilities(capabilities consumer.Capabilities) Option
WithCapabilities overrides the default GetCapabilities function for an processor. The default GetCapabilities function returns mutable capabilities.
func WithShutdown ¶
func WithShutdown(shutdown component.ShutdownFunc) Option
WithShutdown overrides the default Shutdown function for an processor. The default shutdown function does nothing and always returns nil.
type ProcessLogsFunc ¶
ProcessLogsFunc is a helper function that processes the incoming data and returns the data to be sent to the next component. If error is returned then returned data are ignored. It MUST not call the next component.
type ProcessMetricsFunc ¶
ProcessMetricsFunc is a helper function that processes the incoming data and returns the data to be sent to the next component. If error is returned then returned data are ignored. It MUST not call the next component.
type ProcessTracesFunc ¶
ProcessTracesFunc is a helper function that processes the incoming data and returns the data to be sent to the next component. If error is returned then returned data are ignored. It MUST not call the next component.
Source Files