domain

Documentation

Index

• Constants
• Variables
• type Response
• type ResponseError

Constants

const HttpMetricPointName = "http"

Variables

var (
	HttpPathKey          = namespace.Namespace{Parent: &HttpRequestContextKey, Identifier: "path"}
	HttpFullPathKey      = namespace.Namespace{Parent: &HttpRequestContextKey, Identifier: "fullPath"}
	HttpMethodKey        = namespace.Namespace{Parent: &HttpRequestContextKey, Identifier: "method"}
	HttpCorrelationIdKey = namespace.Namespace{Parent: &HttpRequestContextKey, Identifier: "correlationId", IsMetricTag: true}
	HttpRequestIdKey     = namespace.Namespace{Parent: &HttpRequestContextKey, Identifier: "requestId", IsMetricTag: true}
)

var (
	LogHTTPScope = namespace.Namespace{Identifier: "http"}

	LogRouteScope    = namespace.Namespace{Parent: &LogHTTPScope, Identifier: "route"}
	LogResponseScope = namespace.Namespace{Parent: &LogHTTPScope, Identifier: "response"}
)

var (
	LogHttpMethodField       = namespace.Namespace{Parent: &LogRouteScope, Identifier: "method"}
	LogHttpPathField         = namespace.Namespace{Parent: &LogRouteScope, Identifier: "path"}
	LogHttpHandlerCountField = namespace.Namespace{Parent: &LogRouteScope, Identifier: "handler_count"}
	LogHttpHandlerNameField  = namespace.Namespace{Parent: &LogRouteScope, Identifier: "handler"}

	LogHttpResponseStatusCodeField = namespace.Namespace{Parent: &LogResponseScope, Identifier: "status"}
	LogHttpResponseTimeField       = namespace.Namespace{Parent: &LogResponseScope, Identifier: "ms"}
)

var HeaderXCorrelationId = "X-Correlation-ID"

var HeaderXRequestId = "X-Request-ID"

var HttpContextKey = namespace.Namespace{Identifier: "http"}

var HttpRequestContextKey = namespace.Namespace{Parent: &HttpContextKey, Identifier: "request"}

var HttpResponseContextKey = namespace.Namespace{Parent: &HttpContextKey, Identifier: "response"}

Types

type Response

type Response struct {
	StatusCode int `json:"status"`

	Body  interface{}    `json:"body,omitempty"`
	Error *ResponseError `json:"error,omitempty"`

	RequestId     string `json:"requestId,omitempty"`
	CorrelationId string `json:"correlationId,omitempty"`
}

type ResponseError

type ResponseError struct {
	Code    string `json:"code,omitempty"`
	Message string `json:"message"`

	HowToFix string `json:"howToFix,omitempty"`
}