app

Documentation

Overview

Package app implements OTEL, prometheus, graceful shutdown and other common application features for pfm projects.

Index

• func NewSpanNameFormatter(h Router) func(operation string, r *http.Request) string
• func Resource(ctx context.Context) (*resource.Resource, error)
• func Run(f func(ctx context.Context, lg *zap.Logger, m *Metrics) error)
• type Metrics
  • func (m *Metrics) LogMiddleware() middleware.Middleware
  • func (m *Metrics) MeterProvider() metric.MeterProvider
  • func (m *Metrics) String() string
  • func (m *Metrics) TextMapPropagator() propagation.TextMapPropagator
  • func (m *Metrics) TracerProvider() trace.TracerProvider
• type Router

Functions

func NewSpanNameFormatter

func NewSpanNameFormatter(h Router) func(operation string, r *http.Request) string

func Resource

func Resource(ctx context.Context) (*resource.Resource, error)

Resource returns new resource for application.

func Run

func Run(f func(ctx context.Context, lg *zap.Logger, m *Metrics) error)

Run f until interrupt.

If errors.Is(err, ctx.Err()) is valid for returned error, shutdown is considered graceful. Context is canceled on SIGINT. After watchdogTimeout application is forcefully terminated with exitCodeWatchdog.

Types

type Metrics

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

Metrics implement common basic metrics and infrastructure to it.

func (*Metrics) LogMiddleware

func (m *Metrics) LogMiddleware() middleware.Middleware

LogMiddleware adds logger via zctx.With to request context.

func (*Metrics) MeterProvider

func (m *Metrics) MeterProvider() metric.MeterProvider

func (*Metrics) String

func (m *Metrics) String() string

func (*Metrics) TextMapPropagator

func (m *Metrics) TextMapPropagator() propagation.TextMapPropagator

func (*Metrics) TracerProvider

func (m *Metrics) TracerProvider() trace.TracerProvider

type Router

type Router interface {
	FindRoute(method, path string) (oas.Route, bool)
}