middleware

Documentation

Overview

Package middleware provides the ability for injecting Vela resources into the middleware chain for the API.

Usage:

import "github.com/go-vela/worker/router/middleware"

Index

• func Executors(e map[int]executor.Engine) gin.HandlerFunc
• func Logger(logger *logrus.Logger, timeFormat string, utc bool) gin.HandlerFunc
• func NoCache(c *gin.Context)
• func Options(c *gin.Context)
• func Payload() gin.HandlerFunc
• func RequestVersion(c *gin.Context)
• func ResponseVersion(c *gin.Context)
• func Secret(secret string) gin.HandlerFunc
• func Secure(c *gin.Context)

Functions

func Executors

func Executors(e map[int]executor.Engine) gin.HandlerFunc

Executors is a middleware function that attaches the executors to the context of every http.Request.

func Logger

func Logger(logger *logrus.Logger, timeFormat string, utc bool) gin.HandlerFunc

Logger returns a gin.HandlerFunc (middleware) that logs requests using logrus.

Requests with errors are logged using logrus.Error(). Requests without errors are logged using logrus.Info().

It receives:

1. A time package format string (e.g. time.RFC3339).
2. A boolean stating whether to use UTC time zone or local.

func NoCache

func NoCache(c *gin.Context)

NoCache is a middleware function that appends headers to prevent the client from caching the HTTP response.

func Options

func Options(c *gin.Context)

Options is a middleware function that appends headers for options requests and aborts then exits the middleware chain and ends the request.

func Payload

func Payload() gin.HandlerFunc

Payload is a middleware function that captures the user provided json body and attaches it to the context of every http.Request to be logged

func RequestVersion

func RequestVersion(c *gin.Context)

RequestVersion is a middleware function that injects the Vela API version information into the request so it will be logged. This is intended for debugging and troubleshooting.

func ResponseVersion

func ResponseVersion(c *gin.Context)

ResponseVersion is a middleware function that injects the Vela API version information into the response so it will be logged. This is intended for debugging and troubleshooting.

func Secret

func Secret(secret string) gin.HandlerFunc

Secret is a middleware function that attaches the secret used for server <-> agent communication to the context of every http.Request.

func Secure

func Secure(c *gin.Context)

Secure is a middleware function that appends security and resource access headers.