metadata

Documentation

Index

• Constants
• Variables
• type LogBuilderOption
• type LogsBuilder
  • func NewLogsBuilder(settings receiver.Settings) *LogsBuilder
  • func (lb *LogsBuilder) AppendLogRecord(lr plog.LogRecord)
  • func (lb *LogsBuilder) Emit(options ...ResourceLogsOption) plog.Logs
  • func (lb *LogsBuilder) EmitForResource(options ...ResourceLogsOption)
• type ResourceLogsOption
  • func WithLogsResource(res pcommon.Resource) ResourceLogsOption

Constants

const (
	TracesStability  = component.StabilityLevelBeta
	MetricsStability = component.StabilityLevelBeta
	LogsStability    = component.StabilityLevelBeta
)

Variables

var (
	Type      = component.MustNewType("nop")
	ScopeName = "go.opentelemetry.io/collector/receiver/nopreceiver"
)

Types

type LogBuilderOption

type LogBuilderOption interface {
	// contains filtered or unexported methods
}

LogBuilderOption applies changes to default logs builder.

type LogsBuilder

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

LogsBuilder provides an interface for scrapers to report logs while taking care of all the transformations required to produce log representation defined in metadata and user config.

func NewLogsBuilder

func NewLogsBuilder(settings receiver.Settings) *LogsBuilder

func (*LogsBuilder) AppendLogRecord

func (lb *LogsBuilder) AppendLogRecord(lr plog.LogRecord)

AppendLogRecord adds a log record to the logs builder.

func (*LogsBuilder) Emit

func (lb *LogsBuilder) Emit(options ...ResourceLogsOption) plog.Logs

Emit returns all the logs accumulated by the logs builder and updates the internal state to be ready for recording another set of logs. This function will be responsible for applying all the transformations required to produce logs representation defined in metadata and user config.

func (*LogsBuilder) EmitForResource

func (lb *LogsBuilder) EmitForResource(options ...ResourceLogsOption)

EmitForResource saves all the generated logs under a new resource and updates the internal state to be ready for recording another set of log records as part of another resource. This function can be helpful when one scraper needs to emit logs from several resources. Otherwise calling this function is not required, just `Emit` function can be called instead. Resource attributes should be provided as ResourceLogsOption arguments.

type ResourceLogsOption

type ResourceLogsOption interface {
	// contains filtered or unexported methods
}

ResourceLogsOption applies changes to provided resource logs.

func WithLogsResource

func WithLogsResource(res pcommon.Resource) ResourceLogsOption

WithLogsResource sets the provided resource on the emitted ResourceLogs. It's recommended to use ResourceBuilder to create the resource.