logs

Documentation

Index

• func NewLogBatch() *logsBatch
• type LMLogIngest
  • func NewLMLogIngest(ctx context.Context, opts ...Option) (*LMLogIngest, error)
  • func (logIngest *LMLogIngest) SendLogs(ctx context.Context, body []model.LogInput, o ...SendLogsOptionalParameters) (*model.IngestResponse, error)
• type LMLogIngestRequest
• type LMLogIngestResponse
• 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
• type SendLogsOptionalParameters
  • func NewSendLogOptionalParameters() *SendLogsOptionalParameters

Functions

func NewLogBatch

func NewLogBatch() *logsBatch

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) SendLogs

func (logIngest *LMLogIngest) SendLogs(ctx context.Context, body []model.LogInput, o ...SendLogsOptionalParameters) (*model.IngestResponse, error)

SendLogs is the entry point for receiving log data

type LMLogIngestRequest

type LMLogIngestRequest struct {
	Payload []model.LogPayload
}

type LMLogIngestResponse

type LMLogIngestResponse struct {
	Success   bool                     `json:"success"`
	Message   string                   `json:"message"`
	Errors    []map[string]interface{} `json:"errors"`
	RequestID uuid.UUID                `json:"requestId"`
}

type Option

type Option func(*LMLogIngest) error

LMLogIngest configuration options

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 configuring batching time interval for logs.

func WithRateLimit

func WithRateLimit(requestCount int) Option

WithRateLimit is used to limit the log request count per minute

type SendLogsOptionalParameters

type SendLogsOptionalParameters struct {
}

func NewSendLogOptionalParameters

func NewSendLogOptionalParameters() *SendLogsOptionalParameters