slogcloudlogging

README

slog: Cloud Logging handler

A Google Cloud Logging Handler for slog Go library.

Install

go get github.com/PumpkinSeed/slog-cloudlogging

Usage

GoDoc: https://pkg.go.dev/github.com/PumpkinSeed/slog-cloudlogging

Example

package main

import (
	"errors"
	"log/slog"
	"time"

	slogcloudlogging "github.com/PumpkinSeed/slog-cloudlogging"
)

func main() {
	googleHandler := slogcloudlogging.NewHandler("test", "test-logs", nil)
	googleHandler.AutoFlush()
	slog.SetDefault(slog.New(googleHandler))

	slog.Error("test message", slog.Any("error", errors.New("this is an error")))
	time.Sleep(2 * time.Second) // Wait for the Flush
}

Documentation

Index

• Constants
• Variables
• type Google
  • func NewHandler(project string, logName string, opts *Opts) *Google
  • func (g *Google) AutoFlush() chan bool
  • func (g *Google) Enabled(ctx context.Context, level slog.Level) bool
  • func (g *Google) Flush() error
  • func (g *Google) Handle(ctx context.Context, record slog.Record) error
  • func (g *Google) Print(ctx context.Context, main Line)
  • func (g *Google) WithAttrs(attrs []slog.Attr) slog.Handler
  • func (g *Google) WithGroup(name string) slog.Handler
• type Line
• type Opts

Constants

const (
	DefaultGoogleAutoFlushInterval = 500
)

Variables

var (
	ErrUninitializedLogger = errors.New("uninitialized logger error")
)

Types

type Google

type Google struct {
	ProjectID         string
	LogName           string
	AutoFlushInterval int

	Handler                slog.Handler
	ForwardHandler         bool
	UseOpenTelemetryTracer bool
	TracePrefix            string
	// contains filtered or unexported fields
}

func NewHandler

func NewHandler(project string, logName string, opts *Opts) *Google

func (*Google) AutoFlush

func (g *Google) AutoFlush() chan bool

func (*Google) Enabled

func (g *Google) Enabled(ctx context.Context, level slog.Level) bool

func (*Google) Flush

func (g *Google) Flush() error

func (*Google) Handle

func (g *Google) Handle(ctx context.Context, record slog.Record) error

func (*Google) Print

func (g *Google) Print(ctx context.Context, main Line)

func (*Google) WithAttrs

func (g *Google) WithAttrs(attrs []slog.Attr) slog.Handler

func (*Google) WithGroup

func (g *Google) WithGroup(name string) slog.Handler

type Line

type Line struct {
	Level     slog.Level             `json:"level,omitempty"`
	Timestamp int64                  `json:"timestamp,omitempty"`
	Time      string                 `json:"time,omitempty"`
	Data      map[string]interface{} `json:"data,omitempty"`
}

type Opts

type Opts struct {
	Handler           slog.Handler
	ForwardHandler    bool
	AutoFlushInterval int
}