ginhelper

Documentation

Overview

Package ginhelper provides some common functionality across gin servers.

Index

• Constants
• func New(logger *log.ZapEventLogger) *gin.Engine
• func NewWithExperimentalLogger(ctx context.Context, logger logger.ExperimentalLogger) *gin.Engine

Constants

const HealthCheck string = "/health-check"

HealthCheck is the health check endpoint.

const MetricsEndpoint string = "/metrics"

MetricsEndpoint is used for prometheus metrics. Deprecated: use METRICS_PATH instead.

const RequestIDHeader = "X-Request-ID"

RequestIDHeader is used for tracking request ids.

const RobotsTxt string = "/robots.txt"

RobotsTxt is used for apis to disallow crawls.

Functions

func New

func New(logger *log.ZapEventLogger) *gin.Engine

New creates a new gin server with some sensible defaults. these include: - helmet-default handlers - request-ids (used for stack tracing) - cors (used for requests from the frontend) - health-checks - restrictive robots.txt.

func NewWithExperimentalLogger

func NewWithExperimentalLogger(ctx context.Context, logger logger.ExperimentalLogger) *gin.Engine

NewWithExperimentalLogger creates a new gin server with some sensible defaults. See New for more information.