logging

type BatchLoggerOptions struct {
	MaxBatchSize  int            // The maximum size of a batch in bytes
	MaxLogAge     time.Duration  // The maximum age of a log item in a batch - once an item is older than this, the batch is passed to the callback
	LogApiKey     string         // The API key used by the default BatchCallback used to send logs to the Firetail logging API
	LogApiUrl     string         // The URL of the Firetail logging API endpoint to send log entries to
	BatchCallback func([][]byte) // An optional callback to which batches will be passed; the default callback sends logs to the Firetail logging API
}

type HTTPProtocol string

type HeaderMask int

type LogEntry struct {
	DateCreated   int64    `json:"dateCreated"`   // The time the request was logged in UNIX milliseconds
	ExecutionTime float64  `json:"executionTime"` // The time elapsed during the execution required to respond to the request, in milliseconds
	Request       Request  `json:"request"`
	Response      Response `json:"response"`
	Version       Version  `json:"version"` // The version of the firetail logging schema used
}

type Method string

type Request struct {
	Body         string              `json:"body"`         // The request body, stringified
	Headers      map[string][]string `json:"headers"`      // The request headers
	HTTPProtocol HTTPProtocol        `json:"httpProtocol"` // The HTTP protocol used in the request
	IP           string              `json:"ip"`           // The source IP of the request
	Method       Method              `json:"method"`       // The request method. Src for allowed values can be found here: <a; href='https://www.iana.org/assignments/http-methods/http-methods.xhtml#methods'>https://www.iana.org/assignments/http-methods/http-methods.xhtml#methods</a>.
	URI          string              `json:"uri"`          // The URI the request was made to
	Resource     string              `json:"resource"`     // The resource path that the request matched up to in the OpenAPI spec
}

type Response struct {
	Body       string              `json:"body"`    // The response body, stringified
	Headers    map[string][]string `json:"headers"` // The response headers
	StatusCode int64               `json:"statusCode"`
}

type SanitiserOptions struct {
	// RequestHeadersMask is a map of header names (lower cased) to HeaderMask values, which can be used to control the request headers reported to Firetail
	RequestHeadersMask map[string]HeaderMask

	// RequestHeadersMaskStrict is an optional flag which, if set to true, will configure the Firetail middleware to only report request headers explicitly described in the RequestHeadersMask
	RequestHeadersMaskStrict bool

	// ResponseHeadersMask is a map of header names (lower cased) to HeaderMask values, which can be used to control the response headers reported to Firetail
	ResponseHeadersMask map[string]HeaderMask

	// ResponseHeadersMaskStrict is an optional flag which, if set to true, will configure the Firetail middleware to only report response headers explicitly described in the ResponseHeadersMask
	ResponseHeadersMaskStrict bool

	// RequestSanitisationCallback is an optional callback which is given the request body as bytes & returns a stringified request body which
	// is then logged to Firetail. This is useful for writing custom logic to redact any sensitive data from your request bodies before it is logged
	// in Firetail.
	RequestSanitisationCallback func(string) string

	// ResponseSanitisationCallback is an optional callback which is given the response body as bytes & returns a stringified response body which
	// is then logged to Firetail. This is useful for writing custom logic to redact any sensitive data from your response bodies before it is logged
	// in Firetail.
	ResponseSanitisationCallback func(string) string
}

type Version string