snorkel

README

snorkel

Scuba for the rest of us.

go get maragu.dev/snorkel

Made in 🇩🇰 by maragu, maker of online Go courses.

Features

• Simple logger with just a single method, Event, which logs named events with a given sample rate.
• Sane defaults log to STD_ERR and include event name, sample rate, time, and build info. More to come.
• No external dependencies.

Usage

package main

import (
	"maragu.dev/snorkel"
)

func main() {
	log := snorkel.New(snorkel.Options{})

	// Log an event with the name "Yo", sample rate 1, and env=sparkly
	log.Event("Yo", 1, "env", "sparkly")
}

Documentation

Overview

Package snorkel provides a Logger which logs wide events in JSON format.

Index

• type Logger
  • func New(opts Options) *Logger
  • func NewDiscard() *Logger
  • func (l *Logger) Event(name string, rate float32, args ...any)
• type Options

Examples

• Logger

Types

type Logger

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

Example

package main

import (
	"maragu.dev/snorkel"
)

func main() {
	log := snorkel.New(snorkel.Options{})
	log.Event("Yo", 1, "env", "sparkly")
}

func New

func New(opts Options) *Logger

New Logger with the given Options.

func NewDiscard

func NewDiscard() *Logger

func (*Logger) Event

func (l *Logger) Event(name string, rate float32, args ...any)

Event to log with the given name, sample rate, and arguments.

type Options

type Options struct {
	NoTime       bool
	RandomSource rand.Source
	W            io.Writer
}