api

Documentation

Index

• Constants
• func AddServerlessParams(req *http.Request, maxBytes int) *http.Request
• func BuildSearchBlockRequest(req *http.Request, searchReq *tempopb.SearchBlockRequest) (*http.Request, error)
• func BuildSearchRequest(req *http.Request, searchReq *tempopb.SearchRequest) (*http.Request, error)
• func ExtractServerlessParams(req *http.Request) (int, error)
• func IsBackendSearch(r *http.Request) bool
• func IsSearchBlock(r *http.Request) bool
• func ParseSearchBlockRequest(r *http.Request) (*tempopb.SearchBlockRequest, error)
• func ParseSearchRequest(r *http.Request) (*tempopb.SearchRequest, error)
• func ParseTraceID(r *http.Request) ([]byte, error)
• func ValidateAndSanitizeRequest(r *http.Request) (string, string, string, int64, int64, error)

Constants

const (
	URLParamTraceID = "traceID"

	HeaderAccept         = "Accept"
	HeaderContentType    = "Content-Type"
	HeaderAcceptProtobuf = "application/protobuf"
	HeaderAcceptJSON     = "application/json"

	PathPrefixQuerier = "/querier"

	PathTraces          = "/api/traces/{traceID}"
	PathSearch          = "/api/search"
	PathSearchTags      = "/api/search/tags"
	PathSearchTagValues = "/api/search/tag/{tagName}/values"
	PathEcho            = "/api/echo"

	QueryModeKey       = "mode"
	QueryModeIngesters = "ingesters"
	QueryModeBlocks    = "blocks"
	QueryModeAll       = "all"
	BlockStartKey      = "blockStart"
	BlockEndKey        = "blockEnd"
)

Functions

func AddServerlessParams

func AddServerlessParams(req *http.Request, maxBytes int) *http.Request

AddServerlessParams takes an already existing http.Request and adds maxBytes

to it

func BuildSearchBlockRequest

func BuildSearchBlockRequest(req *http.Request, searchReq *tempopb.SearchBlockRequest) (*http.Request, error)

BuildSearchBlockRequest takes a tempopb.SearchBlockRequest and populates the passed http.Request with the appropriate params. If no http.Request is provided a new one is created.

func BuildSearchRequest

func BuildSearchRequest(req *http.Request, searchReq *tempopb.SearchRequest) (*http.Request, error)

BuildSearchRequest takes a tempopb.SearchRequest and populates the passed http.Request with the appropriate params. If no http.Request is provided a new one is created.

func ExtractServerlessParams

func ExtractServerlessParams(req *http.Request) (int, error)

ExtractServerlessParams extracts params for the serverless functions from

an http.Request

func IsBackendSearch

func IsBackendSearch(r *http.Request) bool

IsBackendSearch returns true if the request has a start, end and tags parameter and is the /api/search path

func IsSearchBlock

func IsSearchBlock(r *http.Request) bool

IsSearchBlock returns true if the request appears to be for backend blocks. It is not exhaustive and only looks for blockID

func ParseSearchBlockRequest

func ParseSearchBlockRequest(r *http.Request) (*tempopb.SearchBlockRequest, error)

ParseBlockSearchRequest parses all http parameters necessary to perform a block search.

func ParseSearchRequest

func ParseSearchRequest(r *http.Request) (*tempopb.SearchRequest, error)

ParseSearchRequest takes an http.Request and decodes query params to create a tempopb.SearchRequest

func ParseTraceID

func ParseTraceID(r *http.Request) ([]byte, error)

func ValidateAndSanitizeRequest

func ValidateAndSanitizeRequest(r *http.Request) (string, string, string, int64, int64, error)

ValidateAndSanitizeRequest validates params for trace by id api return values are (blockStart, blockEnd, queryMode, start, end, error)