observability

README

Usage

In main():

ctx := context.Background()
app, shutdown := NewLogrusAndTraceAwareFiberApp(ctx, "mailgun-api")
[...]
SafeShutdown(app.Listen(":8080"), shutdown(ctx))

And then inside the request handlers:

logger := GetLogger(c)

Documentation

Index

• Variables
• func GetLogger(c *fiber.Ctx) *logrus.Entry
• func NewLogrusAndTraceAwareFiberApp(ctx context.Context, serviceName string) (*fiber.App, func(context.Context) error)
• func NewProblemDetail(c *fiber.Ctx, d ProblemDetail) error
• func SafeShutdown(errs ...error)
• type ProblemDetail

Variables

var GCPProjectID = getGcpProjectID()

This operation is expensive, so do it once on start up which will be fine for any GCP deployments.

Functions

func GetLogger

func GetLogger(c *fiber.Ctx) *logrus.Entry

func NewLogrusAndTraceAwareFiberApp

func NewLogrusAndTraceAwareFiberApp(ctx context.Context, serviceName string) (*fiber.App, func(context.Context) error)

func NewProblemDetail

func NewProblemDetail(c *fiber.Ctx, d ProblemDetail) error

func SafeShutdown

func SafeShutdown(errs ...error)

Types

type ProblemDetail

type ProblemDetail struct {
	Type   string `json:"type"`
	Title  string `json:"title"`
	Detail string `json:"detail"`
	Status int    `json:"status"`
}