logs

Documentation

Index

• type LMLogIngest
  • func NewLMLogIngest(ctx context.Context, opts ...Option) (*LMLogIngest, error)
  • func (lli *LMLogIngest) BatchInterval() time.Duration
  • func (lli *LMLogIngest) CreateRequestBody() model.DataPayload
  • func (lli *LMLogIngest) ExportData(payloadList model.DataPayload, uri, method string) error
  • func (lli *LMLogIngest) SendLogs(ctx context.Context, logPayload model.LogInput) error
  • func (lli *LMLogIngest) URI() string
• type Option
  • func WithAuthentication(authParams utils.AuthParams) Option
  • func WithEndpoint(endpoint string) Option
  • func WithGzipCompression(gzip bool) Option
  • func WithHTTPClient(client *http.Client) Option
  • func WithLogBatchingDisabled() Option
  • func WithLogBatchingInterval(batchingInterval time.Duration) Option
  • func WithRateLimit(requestCount int) 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() model.DataPayload

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

func (*LMLogIngest) ExportData

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

ExportData exports logs to the LM platform

func (*LMLogIngest) SendLogs

func (lli *LMLogIngest) SendLogs(ctx context.Context, logPayload model.LogInput) 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(authParams utils.AuthParams) Option

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

func WithEndpoint

func WithEndpoint(endpoint string) Option

WithEndpoint is used to set Endpoint URL to export logs

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 WithHTTPClient

func WithHTTPClient(client *http.Client) Option

WithHTTPClient is used to set HTTP client

func WithLogBatchingDisabled

func WithLogBatchingDisabled() Option

WithLogBatchingDisabled is used for disabling log batching.

func WithLogBatchingInterval

func WithLogBatchingInterval(batchingInterval time.Duration) Option

WithLogBatchingInterval is used for passing batching time interval for logs.

func WithRateLimit

func WithRateLimit(requestCount int) Option

WithRateLimit is used to limit the log request count per minute