slog-handler-guide: guide to writing a slog Handler

Add a document for helping writers of slog handlers.

Change-Id: I079b738d1109a5e1d555c5dfb81eabf1d187f907
Reviewed-on: https://go-review.googlesource.com/c/example/+/494576
TryBot-Result: Gopher Robot <gobot@golang.org>
Run-TryBot: Jonathan Amsterdam <jba@google.com>
Reviewed-by: Ian Cottrell <iancottrell@google.com>
4 files changed
tree: 12b8ac24f739ea786f2814bcdc45a4e07e2e9a21
  1. appengine-hello/
  2. gotypes/
  3. hello/
  4. internal/
  5. outyet/
  6. slog-handler-guide/
  7. stringutil/
  8. template/
  9. go.mod
  10. go.sum
  11. LICENSE
  12. README.md
README.md

Go example projects

Go Reference

This repository contains a collection of Go programs and libraries that demonstrate the language, standard libraries, and tools.

Clone the project

$ git clone https://go.googlesource.com/example
$ cd example

https://go.googlesource.com/example is the canonical Git repository. It is mirrored at https://github.com/golang/example.

hello and stringutil

$ cd hello
$ go build

A trivial “Hello, world” program that uses a stringutil package.

Command hello covers:

  • The basic form of an executable command
  • Importing packages (from the standard library and the local repository)
  • Printing strings (fmt)

Library stringutil covers:

  • The basic form of a library
  • Conversion between string and []rune
  • Table-driven unit tests (testing)

outyet

$ cd outyet
$ go build

A web server that answers the question: “Is Go 1.x out yet?”

Topics covered:

  • Command-line flags (flag)
  • Web servers (net/http)
  • HTML Templates (html/template)
  • Logging (log)
  • Long-running background processes
  • Synchronizing data access between goroutines (sync)
  • Exporting server state for monitoring (expvar)
  • Unit and integration tests (testing)
  • Dependency injection
  • Time (time)

appengine-hello

A trivial “Hello, world” App Engine application intended to be used as the starting point for your own code. Please see Google App Engine SDK for Go and Quickstart for Go in the App Engine Standard Environment.

gotypes

The go/types package is a type-checker for Go programs. It is one of the most complex packages in Go's standard library, so we have provided this tutorial to help you find your bearings. It comes with several example programs that you can obtain using go get and play with as you learn to build tools that analyze or manipulate Go programs.

template

A trivial web server that demonstrates the use of the template package's block feature.

slog-handler-guide

The log/slog package supports structured logging. It features a flexible backend in the form of a Handler interface. This guide can help you write your own handler.