apexlogs

Documentation

Overview

Package apexlogs implements a handler for Apex Logs https://apex.sh/logs/.

Index

• type Handler
  • func New(url, projectID, authToken string, options ...Option) *Handler
  • func (h *Handler) Close()
  • func (h *Handler) Flush()
  • func (h *Handler) FlushSync()
  • func (h *Handler) HandleLog(e *log.Entry) error
• type Option
  • func WithBufferOptions(options ...buffer.Option) Option
  • func WithHTTPClient(client *http.Client) Option

Types

type Handler

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

Handler implementation.

func New

func New(url, projectID, authToken string, options ...Option) *Handler

New Apex Logs handler with the url, projectID, authToken and options.

func (*Handler) Close

func (h *Handler) Close()

Close flushes any pending logs, and waits for flushing to complete. This method should be called before exiting your program to ensure entries have flushed properly.

func (*Handler) Flush

func (h *Handler) Flush()

Flush any pending logs. This method is non-blocking.

func (*Handler) FlushSync

func (h *Handler) FlushSync()

FlushSync any pending logs. This method is blocking.

func (*Handler) HandleLog

func (h *Handler) HandleLog(e *log.Entry) error

HandleLog implements log.Handler.

type Option

type Option func(*Handler)

Option function.

func WithBufferOptions

func WithBufferOptions(options ...buffer.Option) Option

WithBufferOptions sets options for the underlying buffer used to batch logs.

func WithHTTPClient

func WithHTTPClient(client *http.Client) Option

WithHTTPClient sets the HTTP client used for requests.