Documentation
¶
Overview ¶
Package remote implements bindings for Prometheus Remote APIs.
Index ¶
- func NewHandler(store writeStorage, acceptedMessageTypes MessageTypes, opts ...HandlerOption) http.Handler
- func SnappyDecompressorMiddleware(logger *slog.Logger) func(http.Handler) http.Handler
- type API
- type APIOption
- type Compression
- type HandlerOption
- type MessageTypes
- type WriteMessageType
- type WriteResponse
- func (w *WriteResponse) ExtraHeaders() http.Header
- func (w *WriteResponse) SetExtraHeader(key, value string)
- func (r *WriteResponse) SetHeaders(w http.ResponseWriter)
- func (w *WriteResponse) SetStatusCode(code int)
- func (w *WriteResponse) Stats() WriteResponseStats
- func (w *WriteResponse) StatusCode() int
- type WriteResponseStats
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewHandler ¶
func NewHandler(store writeStorage, acceptedMessageTypes MessageTypes, opts ...HandlerOption) http.Handler
NewHandler returns HTTP handler that receives Remote Write 2.0 protocol https://prometheus.io/docs/specs/remote_write_spec_2_0/.
func SnappyDecompressorMiddleware ¶
SnappyDecompressorMiddleware returns a middleware that checks if the request body is snappy-encoded and decompresses it. If the request body is not snappy-encoded, it returns an error. Used by default in NewRemoteWriteHandler.
Types ¶
type API ¶
type API struct {
// contains filtered or unexported fields
}
API is a client for Prometheus Remote Protocols. NOTE(bwplotka): Only https://prometheus.io/docs/specs/remote_write_spec_2_0/ is currently implemented, read protocols to be implemented if there will be a demand.
func (*API) Write ¶
func (r *API) Write(ctx context.Context, msgType WriteMessageType, msg any) (_ WriteResponseStats, err error)
Write writes given, non-empty, protobuf message to a remote storage.
Depending on serialization methods,
- https://github.com/planetscale/vtprotobuf methods will be used if your msg supports those (e.g. SizeVT() and MarshalToSizedBufferVT(...)), for efficiency
- Otherwise https://github.com/gogo/protobuf methods (e.g. Size() and MarshalToSizedBuffer(...)) will be used
- If neither is supported, it will marshaled using generic google.golang.org/protobuf methods and error out on unknown scheme.
type APIOption ¶
type APIOption func(o *apiOpts) error
APIOption represents a remote API option.
func WithAPIBackoff ¶
WithAPIBackoff returns APIOption that allows overriding backoff configuration.
func WithAPIHTTPClient ¶
WithAPIHTTPClient returns APIOption that allows providing http client.
func WithAPILogger ¶
WithAPILogger returns APIOption that allows providing slog logger. By default, nothing is logged.
func WithAPINoRetryOnRateLimit ¶
func WithAPINoRetryOnRateLimit() APIOption
WithAPIRetryOnRateLimit returns APIOption that disables retrying on rate limit status code.
func WithAPIPath ¶
WithAPIPath returns APIOption that allows providing path to send remote write requests to.
type Compression ¶
type Compression string
Compression represents the encoding. Currently remote storage supports only one, but we experiment with more, thus leaving the compression scaffolding for now.
const ( // SnappyBlockCompression represents https://github.com/google/snappy/blob/2c94e11145f0b7b184b831577c93e5a41c4c0346/format_description.txt SnappyBlockCompression Compression = "snappy" )
type HandlerOption ¶
type HandlerOption func(o *handlerOpts)
HandlerOption represents an option for the handler.
func WithHandlerLogger ¶
func WithHandlerLogger(logger *slog.Logger) HandlerOption
WithHandlerLogger returns HandlerOption that allows providing slog logger. By default, nothing is logged.
func WithHandlerMiddlewares ¶
func WithHandlerMiddlewares(middlewares ...func(http.Handler) http.Handler) HandlerOption
WithHandlerMiddleware returns HandlerOption that allows providing middlewares. Multiple middlewares can be provided and will be applied in the order they are passed. When using this option, SnappyDecompressorMiddleware is not applied by default so it (or any other decompression middleware) needs to be added explicitly.
type MessageTypes ¶
type MessageTypes []WriteMessageType
func (MessageTypes) Contains ¶
func (m MessageTypes) Contains(mType WriteMessageType) bool
func (MessageTypes) String ¶
func (m MessageTypes) String() string
func (MessageTypes) Strings ¶
func (m MessageTypes) Strings() []string
type WriteMessageType ¶
type WriteMessageType string
WriteMessageType represents the fully qualified name of the protobuf message to use in Remote write 1.0 and 2.0 protocols. See https://prometheus.io/docs/specs/remote_write_spec_2_0/#protocol.
const ( // WriteV1MessageType represents the `prometheus.WriteRequest` protobuf // message introduced in the https://prometheus.io/docs/specs/remote_write_spec/. // DEPRECATED: Use WriteV2MessageType instead. WriteV1MessageType WriteMessageType = "prometheus.WriteRequest" // WriteV2MessageType represents the `io.prometheus.write.v2.Request` protobuf // message introduced in https://prometheus.io/docs/specs/remote_write_spec_2_0/ WriteV2MessageType WriteMessageType = "io.prometheus.write.v2.Request" )
func ParseProtoMsg ¶
func ParseProtoMsg(contentType string) (WriteMessageType, error)
ParseProtoMsg parses the content-type header and returns the proto message type.
The expected content-type will be of the form,
- `application/x-protobuf;proto=io.prometheus.write.v2.Request` which will be treated as RW2.0 request,
- `application/x-protobuf;proto=prometheus.WriteRequest` which will be treated as RW1.0 request,
- `application/x-protobuf` which will be treated as RW1.0 request.
If the content-type is not of the above forms, it will return an error.
func (WriteMessageType) Validate ¶
func (n WriteMessageType) Validate() error
Validate returns error if the given reference for the protobuf message is not supported.
type WriteResponse ¶
type WriteResponse struct {
WriteResponseStats
// contains filtered or unexported fields
}
WriteResponse represents the response from the remote storage upon receiving a remote write request.
func NewWriteResponse ¶
func NewWriteResponse() *WriteResponse
NewWriteResponse creates a new WriteResponse with empty stats and status code http.StatusNoContent.
func (*WriteResponse) ExtraHeaders ¶
func (w *WriteResponse) ExtraHeaders() http.Header
ExtraHeaders returns all additional headers to be set in the response (apart from stats headers).
func (*WriteResponse) SetExtraHeader ¶
func (w *WriteResponse) SetExtraHeader(key, value string)
SetExtraHeader adds additional headers to be set in the response (apart from stats headers)
func (*WriteResponse) SetHeaders ¶
func (r *WriteResponse) SetHeaders(w http.ResponseWriter)
SetHeaders sets response headers in a given response writer. Make sure to use it before http.ResponseWriter.WriteHeader and .Write.
func (*WriteResponse) SetStatusCode ¶
func (w *WriteResponse) SetStatusCode(code int)
SetStatusCode sets the HTTP status code for the response. http.StatusNoContent is the default unless 5xx is set.
func (*WriteResponse) Stats ¶
func (w *WriteResponse) Stats() WriteResponseStats
Stats returns the current statistics.
func (*WriteResponse) StatusCode ¶
func (w *WriteResponse) StatusCode() int
StatusCode returns the current HTTP status code.
type WriteResponseStats ¶
type WriteResponseStats struct {
// Samples represents X-Prometheus-Remote-Write-Written-Samples
Samples int
// Histograms represents X-Prometheus-Remote-Write-Written-Histograms
Histograms int
// Exemplars represents X-Prometheus-Remote-Write-Written-Exemplars
Exemplars int
// contains filtered or unexported fields
}
WriteResponseStats represents the response, remote write statistics.
func (*WriteResponseStats) Add ¶
func (s *WriteResponseStats) Add(rs WriteResponseStats)
Add adds the given WriteResponseStats to this WriteResponseStats. If this WriteResponseStats is empty, it will be replaced by the given WriteResponseStats.
func (WriteResponseStats) AllSamples ¶
func (s WriteResponseStats) AllSamples() int
AllSamples returns both float and histogram sample numbers.
func (WriteResponseStats) NoDataWritten ¶
func (s WriteResponseStats) NoDataWritten() bool
NoDataWritten returns true if statistics indicate no data was written.
Source Files
Directories