logs

Documentation

Index

• type LMLogIngest
  • func NewLMLogIngest(ctx context.Context, opts ...Option) (*LMLogIngest, error)
  • func (lli *LMLogIngest) BatchInterval() time.Duration
  • func (lli *LMLogIngest) CreateRequestBody() internal.DataPayload
  • func (lli *LMLogIngest) ExportData(payloadList internal.DataPayload, uri, method string) error
  • func (lli *LMLogIngest) SendLogs(ctx context.Context, logMessage string, ...) error
  • func (lli *LMLogIngest) URI() string
• type Option
  • func WithAuthentication(authProvider model.AuthProvider) Option
  • func WithGzipCompression(gzip bool) Option
  • func WithLogBatchingEnabled(batchingInterval time.Duration) Option

Types

type LMLogIngest

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

func NewLMLogIngest

func NewLMLogIngest(ctx context.Context, opts ...Option) (*LMLogIngest, error)

NewLMLogIngest initializes LMLogIngest

func (*LMLogIngest) BatchInterval

func (lli *LMLogIngest) BatchInterval() time.Duration

BatchInterval returns the time interval for batching

func (*LMLogIngest) CreateRequestBody

func (lli *LMLogIngest) CreateRequestBody() internal.DataPayload

CreateRequestBody prepares log payload from the requests present in cache after batch interval expires

func (*LMLogIngest) ExportData

func (lli *LMLogIngest) ExportData(payloadList internal.DataPayload, uri, method string) error

ExportData exports logs to the LM platform

func (*LMLogIngest) SendLogs

func (lli *LMLogIngest) SendLogs(ctx context.Context, logMessage string, resourceidMap, metadata map[string]string) error

SendLogs is the entry point for receiving log data

func (*LMLogIngest) URI

func (lli *LMLogIngest) URI() string

URI returns the endpoint/uri of log ingest API

type Option

type Option func(*LMLogIngest) error

func WithAuthentication

func WithAuthentication(authProvider model.AuthProvider) Option

WithAuthentication is used for passing authentication token if not set in environment variables.

func WithGzipCompression

func WithGzipCompression(gzip bool) Option

WithGzipCompression can be used to enable/disable gzip compression of log payload Note: By default, gzip compression is enabled.

func WithLogBatchingEnabled

func WithLogBatchingEnabled(batchingInterval time.Duration) Option

WithLogBatchingEnabled is used for enabling batching for logs. Pass time interval for batch as an input parameter.