Documentation
¶
Index ¶
- Constants
- func Match(xs []string) ([][]*labels.Matcher, error)
- func ParseLabelQuery(r *http.Request) (*logproto.LabelRequest, error)
- func ParseSeriesQuery(r *http.Request) (*logproto.SeriesRequest, error)
- func ParseTailQuery(r *http.Request) (*logproto.TailRequest, error)
- type DroppedStream
- type Entry
- type InstantQuery
- type LabelResponse
- type LabelSet
- type Matrix
- type PushRequest
- type QueryResponse
- type QueryResponseData
- type QueryStatus
- type RangeQuery
- type ResultType
- type ResultValue
- type SeriesResponse
- type Stream
- type Streams
- type TailResponse
- type Vector
- type Version
Constants ¶
const (
ResultTypeStream = "streams"
ResultTypeVector = "vector"
ResultTypeMatrix = "matrix"
)
ResultType values
const (
VersionLegacy = Version(iota)
VersionV1
)
Valid Version values
const (
QueryStatusSuccess = "success"
)
QueryStatus values
Variables ¶
This section is empty.
Functions ¶
func Match ¶ added in v1.3.0
func Match(xs []string) ([][]*labels.Matcher, error)
Match extracts and parses multiple matcher groups from a slice of strings
func ParseLabelQuery ¶
func ParseLabelQuery(r *http.Request) (*logproto.LabelRequest, error)
ParseLabelQuery parses a LabelRequest request from an http request.
func ParseSeriesQuery ¶ added in v1.3.0
func ParseSeriesQuery(r *http.Request) (*logproto.SeriesRequest, error)
func ParseTailQuery ¶
func ParseTailQuery(r *http.Request) (*logproto.TailRequest, error)
ParseTailQuery parses a TailRequest request from an http request.
Types ¶
type DroppedStream ¶
type DroppedStream struct {
Timestamp time.Time
Labels LabelSet
}
DroppedStream represents a dropped stream in tail call
func (*DroppedStream) MarshalJSON ¶
func (s *DroppedStream) MarshalJSON() ([]byte, error)
MarshalJSON implements json.Marshaller
func (*DroppedStream) UnmarshalJSON ¶
func (s *DroppedStream) UnmarshalJSON(data []byte) error
UnmarshalJSON implements json.UnMarshaller
type Entry ¶
type Entry struct {
Timestamp time.Time
Line string
}
Entry represents a log entry. It includes a log message and the time it occurred at.
func (*Entry) MarshalJSON ¶
func (e *Entry) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaler interface.
func (*Entry) UnmarshalJSON ¶
func (e *Entry) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaler interface.
type InstantQuery ¶
type InstantQuery struct {
Query string
Ts time.Time
Limit uint32
Direction logproto.Direction
}
InstantQuery defines a log instant query.
func ParseInstantQuery ¶
func ParseInstantQuery(r *http.Request) (*InstantQuery, error)
ParseInstantQuery parses an InstantQuery request from an http request.
type LabelResponse ¶
type LabelResponse struct {
Status string `json:"status"`
Data []string `json:"data,omitempty"`
}
LabelResponse represents the http json response to a label query
type LabelSet ¶
type LabelSet map[string]string
LabelSet is a key/value pair mapping of labels
type PushRequest ¶
type PushRequest struct {
Streams []*Stream `json:"streams"`
}
PushRequest models a log stream push
type QueryResponse ¶
type QueryResponse struct {
Status string `json:"status"`
Data QueryResponseData `json:"data"`
}
QueryResponse represents the http json response to a label query
type QueryResponseData ¶
type QueryResponseData struct {
ResultType ResultType `json:"resultType"`
Result ResultValue `json:"result"`
}
QueryResponseData represents the http json response to a label query
func (*QueryResponseData) UnmarshalJSON ¶
func (q *QueryResponseData) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaler interface.
type RangeQuery ¶
type RangeQuery struct {
Start time.Time
End time.Time
Step time.Duration
Query string
Direction logproto.Direction
Limit uint32
}
RangeQuery defines a log range query.
func ParseRangeQuery ¶
func ParseRangeQuery(r *http.Request) (*RangeQuery, error)
ParseRangeQuery parses a RangeQuery request from an http request.
type ResultValue ¶
type ResultValue interface {
Type() ResultType
}
ResultValue interface mimics the promql.Value interface
type SeriesResponse ¶ added in v1.3.0
type SeriesResponse struct {
Status string `json:"status"`
Data []LabelSet `json:"data"`
}
type Stream ¶
type Stream struct {
Labels LabelSet `json:"stream"`
Entries []Entry `json:"values"`
}
Stream represents a log stream. It includes a set of log entries and their labels.
type TailResponse ¶
type TailResponse struct {
Streams []Stream `json:"streams,omitempty"`
DroppedStreams []DroppedStream `json:"dropped_entries,omitempty"`
}
TailResponse represents the http json response to a tail query
type Version ¶
type Version int
Version holds a loghttp version
func GetVersion ¶
func GetVersion(uri string) Version
GetVersion returns the loghttp version for a given path.