prompb

package
v0.0.0-...-2e5e298 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 22, 2024 License: BSD-3-Clause, Apache-2.0 Imports: 17 Imported by: 0

Documentation

Overview

Package prompb is a generated protocol buffer package.

It is generated from these files:
	remote.proto
	rpc.proto
	types.proto

It has these top-level messages:
	WriteRequest
	ReadRequest
	ReadResponse
	Query
	QueryResult
	TSDBSnapshotRequest
	TSDBSnapshotResponse
	TSDBCleanTombstonesRequest
	TSDBCleanTombstonesResponse
	SeriesDeleteRequest
	SeriesDeleteResponse
	Sample
	TimeSeries
	Label
	Labels
	LabelMatcher
	ReadHints

Package prompb is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrInvalidLengthRemote = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowRemote   = fmt.Errorf("proto: integer overflow")
)
View Source
var (
	ErrInvalidLengthRpc = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowRpc   = fmt.Errorf("proto: integer overflow")
)
View Source
var (
	ErrInvalidLengthTypes = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTypes   = fmt.Errorf("proto: integer overflow")
)
View Source
var LabelMatcher_Type_name = map[int32]string{
	0: "EQ",
	1: "NEQ",
	2: "RE",
	3: "NRE",
}
View Source
var LabelMatcher_Type_value = map[string]int32{
	"EQ":  0,
	"NEQ": 1,
	"RE":  2,
	"NRE": 3,
}

Functions

func RegisterAdminHandler

func RegisterAdminHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterAdminHandler registers the http handlers for service Admin to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterAdminHandlerClient

func RegisterAdminHandlerClient(ctx context.Context, mux *runtime.ServeMux, client AdminClient) error

RegisterAdminHandler registers the http handlers for service Admin to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "AdminClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "AdminClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "AdminClient" to call the correct interceptors.

func RegisterAdminHandlerFromEndpoint

func RegisterAdminHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterAdminHandlerFromEndpoint is same as RegisterAdminHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterAdminServer

func RegisterAdminServer(s *grpc.Server, srv AdminServer)

Types

type AdminClient

type AdminClient interface {
	// Snapshot creates a snapshot of all current data into 'snapshots/<datetime>-<rand>' under the TSDB's data directory.
	TSDBSnapshot(ctx context.Context, in *TSDBSnapshotRequest, opts ...grpc.CallOption) (*TSDBSnapshotResponse, error)
	// CleanTombstones removes the deleted data from disk and cleans up the existing tombstones.
	TSDBCleanTombstones(ctx context.Context, in *TSDBCleanTombstonesRequest, opts ...grpc.CallOption) (*TSDBCleanTombstonesResponse, error)
	// DeleteSeries deletes data for a selection of series in a time range.
	DeleteSeries(ctx context.Context, in *SeriesDeleteRequest, opts ...grpc.CallOption) (*SeriesDeleteResponse, error)
}

func NewAdminClient

func NewAdminClient(cc *grpc.ClientConn) AdminClient

type AdminServer

type AdminServer interface {
	// Snapshot creates a snapshot of all current data into 'snapshots/<datetime>-<rand>' under the TSDB's data directory.
	TSDBSnapshot(context.Context, *TSDBSnapshotRequest) (*TSDBSnapshotResponse, error)
	// CleanTombstones removes the deleted data from disk and cleans up the existing tombstones.
	TSDBCleanTombstones(context.Context, *TSDBCleanTombstonesRequest) (*TSDBCleanTombstonesResponse, error)
	// DeleteSeries deletes data for a selection of series in a time range.
	DeleteSeries(context.Context, *SeriesDeleteRequest) (*SeriesDeleteResponse, error)
}

type Label

type Label struct {
	Name  string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
}

func (*Label) Descriptor

func (*Label) Descriptor() ([]byte, []int)

func (*Label) GetName

func (m *Label) GetName() string

func (*Label) GetValue

func (m *Label) GetValue() string

func (*Label) Marshal

func (m *Label) Marshal() (dAtA []byte, err error)

func (*Label) MarshalTo

func (m *Label) MarshalTo(dAtA []byte) (int, error)

func (*Label) ProtoMessage

func (*Label) ProtoMessage()

func (*Label) Reset

func (m *Label) Reset()

func (*Label) Size

func (m *Label) Size() (n int)

func (*Label) String

func (m *Label) String() string

func (*Label) Unmarshal

func (m *Label) Unmarshal(dAtA []byte) error

type LabelMatcher

type LabelMatcher struct {
	Type  LabelMatcher_Type `protobuf:"varint,1,opt,name=type,proto3,enum=prometheus.LabelMatcher_Type" json:"type,omitempty"`
	Name  string            `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Value string            `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
}

Matcher specifies a rule, which can match or set of labels or not.

func (*LabelMatcher) Descriptor

func (*LabelMatcher) Descriptor() ([]byte, []int)

func (*LabelMatcher) GetName

func (m *LabelMatcher) GetName() string

func (*LabelMatcher) GetType

func (m *LabelMatcher) GetType() LabelMatcher_Type

func (*LabelMatcher) GetValue

func (m *LabelMatcher) GetValue() string

func (*LabelMatcher) Marshal

func (m *LabelMatcher) Marshal() (dAtA []byte, err error)

func (*LabelMatcher) MarshalTo

func (m *LabelMatcher) MarshalTo(dAtA []byte) (int, error)

func (*LabelMatcher) ProtoMessage

func (*LabelMatcher) ProtoMessage()

func (*LabelMatcher) Reset

func (m *LabelMatcher) Reset()

func (*LabelMatcher) Size

func (m *LabelMatcher) Size() (n int)

func (*LabelMatcher) String

func (m *LabelMatcher) String() string

func (*LabelMatcher) Unmarshal

func (m *LabelMatcher) Unmarshal(dAtA []byte) error

type LabelMatcher_Type

type LabelMatcher_Type int32
const (
	LabelMatcher_EQ  LabelMatcher_Type = 0
	LabelMatcher_NEQ LabelMatcher_Type = 1
	LabelMatcher_RE  LabelMatcher_Type = 2
	LabelMatcher_NRE LabelMatcher_Type = 3
)

func (LabelMatcher_Type) EnumDescriptor

func (LabelMatcher_Type) EnumDescriptor() ([]byte, []int)

func (LabelMatcher_Type) String

func (x LabelMatcher_Type) String() string

type Labels

type Labels struct {
	Labels []Label `protobuf:"bytes,1,rep,name=labels" json:"labels"`
}

func (*Labels) Descriptor

func (*Labels) Descriptor() ([]byte, []int)

func (*Labels) GetLabels

func (m *Labels) GetLabels() []Label

func (*Labels) Marshal

func (m *Labels) Marshal() (dAtA []byte, err error)

func (*Labels) MarshalTo

func (m *Labels) MarshalTo(dAtA []byte) (int, error)

func (*Labels) ProtoMessage

func (*Labels) ProtoMessage()

func (*Labels) Reset

func (m *Labels) Reset()

func (*Labels) Size

func (m *Labels) Size() (n int)

func (*Labels) String

func (m *Labels) String() string

func (*Labels) Unmarshal

func (m *Labels) Unmarshal(dAtA []byte) error

type Query

type Query struct {
	StartTimestampMs int64           `protobuf:"varint,1,opt,name=start_timestamp_ms,json=startTimestampMs,proto3" json:"start_timestamp_ms,omitempty"`
	EndTimestampMs   int64           `protobuf:"varint,2,opt,name=end_timestamp_ms,json=endTimestampMs,proto3" json:"end_timestamp_ms,omitempty"`
	Matchers         []*LabelMatcher `protobuf:"bytes,3,rep,name=matchers" json:"matchers,omitempty"`
	Hints            *ReadHints      `protobuf:"bytes,4,opt,name=hints" json:"hints,omitempty"`
}

func (*Query) Descriptor

func (*Query) Descriptor() ([]byte, []int)

func (*Query) GetEndTimestampMs

func (m *Query) GetEndTimestampMs() int64

func (*Query) GetHints

func (m *Query) GetHints() *ReadHints

func (*Query) GetMatchers

func (m *Query) GetMatchers() []*LabelMatcher

func (*Query) GetStartTimestampMs

func (m *Query) GetStartTimestampMs() int64

func (*Query) Marshal

func (m *Query) Marshal() (dAtA []byte, err error)

func (*Query) MarshalTo

func (m *Query) MarshalTo(dAtA []byte) (int, error)

func (*Query) ProtoMessage

func (*Query) ProtoMessage()

func (*Query) Reset

func (m *Query) Reset()

func (*Query) Size

func (m *Query) Size() (n int)

func (*Query) String

func (m *Query) String() string

func (*Query) Unmarshal

func (m *Query) Unmarshal(dAtA []byte) error

type QueryResult

type QueryResult struct {
	// Samples within a time series must be ordered by time.
	Timeseries []*TimeSeries `protobuf:"bytes,1,rep,name=timeseries" json:"timeseries,omitempty"`
}

func (*QueryResult) Descriptor

func (*QueryResult) Descriptor() ([]byte, []int)

func (*QueryResult) GetTimeseries

func (m *QueryResult) GetTimeseries() []*TimeSeries

func (*QueryResult) Marshal

func (m *QueryResult) Marshal() (dAtA []byte, err error)

func (*QueryResult) MarshalTo

func (m *QueryResult) MarshalTo(dAtA []byte) (int, error)

func (*QueryResult) ProtoMessage

func (*QueryResult) ProtoMessage()

func (*QueryResult) Reset

func (m *QueryResult) Reset()

func (*QueryResult) Size

func (m *QueryResult) Size() (n int)

func (*QueryResult) String

func (m *QueryResult) String() string

func (*QueryResult) Unmarshal

func (m *QueryResult) Unmarshal(dAtA []byte) error

type ReadHints

type ReadHints struct {
	StepMs int64  `protobuf:"varint,1,opt,name=step_ms,json=stepMs,proto3" json:"step_ms,omitempty"`
	Func   string `protobuf:"bytes,2,opt,name=func,proto3" json:"func,omitempty"`
}

func (*ReadHints) Descriptor

func (*ReadHints) Descriptor() ([]byte, []int)

func (*ReadHints) GetFunc

func (m *ReadHints) GetFunc() string

func (*ReadHints) GetStepMs

func (m *ReadHints) GetStepMs() int64

func (*ReadHints) Marshal

func (m *ReadHints) Marshal() (dAtA []byte, err error)

func (*ReadHints) MarshalTo

func (m *ReadHints) MarshalTo(dAtA []byte) (int, error)

func (*ReadHints) ProtoMessage

func (*ReadHints) ProtoMessage()

func (*ReadHints) Reset

func (m *ReadHints) Reset()

func (*ReadHints) Size

func (m *ReadHints) Size() (n int)

func (*ReadHints) String

func (m *ReadHints) String() string

func (*ReadHints) Unmarshal

func (m *ReadHints) Unmarshal(dAtA []byte) error

type ReadRequest

type ReadRequest struct {
	Queries []*Query `protobuf:"bytes,1,rep,name=queries" json:"queries,omitempty"`
}

func (*ReadRequest) Descriptor

func (*ReadRequest) Descriptor() ([]byte, []int)

func (*ReadRequest) GetQueries

func (m *ReadRequest) GetQueries() []*Query

func (*ReadRequest) Marshal

func (m *ReadRequest) Marshal() (dAtA []byte, err error)

func (*ReadRequest) MarshalTo

func (m *ReadRequest) MarshalTo(dAtA []byte) (int, error)

func (*ReadRequest) ProtoMessage

func (*ReadRequest) ProtoMessage()

func (*ReadRequest) Reset

func (m *ReadRequest) Reset()

func (*ReadRequest) Size

func (m *ReadRequest) Size() (n int)

func (*ReadRequest) String

func (m *ReadRequest) String() string

func (*ReadRequest) Unmarshal

func (m *ReadRequest) Unmarshal(dAtA []byte) error

type ReadResponse

type ReadResponse struct {
	// In same order as the request's queries.
	Results []*QueryResult `protobuf:"bytes,1,rep,name=results" json:"results,omitempty"`
}

func (*ReadResponse) Descriptor

func (*ReadResponse) Descriptor() ([]byte, []int)

func (*ReadResponse) GetResults

func (m *ReadResponse) GetResults() []*QueryResult

func (*ReadResponse) Marshal

func (m *ReadResponse) Marshal() (dAtA []byte, err error)

func (*ReadResponse) MarshalTo

func (m *ReadResponse) MarshalTo(dAtA []byte) (int, error)

func (*ReadResponse) ProtoMessage

func (*ReadResponse) ProtoMessage()

func (*ReadResponse) Reset

func (m *ReadResponse) Reset()

func (*ReadResponse) Size

func (m *ReadResponse) Size() (n int)

func (*ReadResponse) String

func (m *ReadResponse) String() string

func (*ReadResponse) Unmarshal

func (m *ReadResponse) Unmarshal(dAtA []byte) error

type Sample

type Sample struct {
	Value     float64 `protobuf:"fixed64,1,opt,name=value,proto3" json:"value,omitempty"`
	Timestamp int64   `protobuf:"varint,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
}

func (*Sample) Descriptor

func (*Sample) Descriptor() ([]byte, []int)

func (*Sample) GetTimestamp

func (m *Sample) GetTimestamp() int64

func (*Sample) GetValue

func (m *Sample) GetValue() float64

func (*Sample) Marshal

func (m *Sample) Marshal() (dAtA []byte, err error)

func (*Sample) MarshalTo

func (m *Sample) MarshalTo(dAtA []byte) (int, error)

func (*Sample) ProtoMessage

func (*Sample) ProtoMessage()

func (*Sample) Reset

func (m *Sample) Reset()

func (*Sample) Size

func (m *Sample) Size() (n int)

func (*Sample) String

func (m *Sample) String() string

func (*Sample) Unmarshal

func (m *Sample) Unmarshal(dAtA []byte) error

type SeriesDeleteRequest

type SeriesDeleteRequest struct {
	MinTime  *time.Time     `protobuf:"bytes,1,opt,name=min_time,json=minTime,stdtime" json:"min_time,omitempty"`
	MaxTime  *time.Time     `protobuf:"bytes,2,opt,name=max_time,json=maxTime,stdtime" json:"max_time,omitempty"`
	Matchers []LabelMatcher `protobuf:"bytes,3,rep,name=matchers" json:"matchers"`
}

func (*SeriesDeleteRequest) Descriptor

func (*SeriesDeleteRequest) Descriptor() ([]byte, []int)

func (*SeriesDeleteRequest) Marshal

func (m *SeriesDeleteRequest) Marshal() (dAtA []byte, err error)

func (*SeriesDeleteRequest) MarshalTo

func (m *SeriesDeleteRequest) MarshalTo(dAtA []byte) (int, error)

func (*SeriesDeleteRequest) ProtoMessage

func (*SeriesDeleteRequest) ProtoMessage()

func (*SeriesDeleteRequest) Reset

func (m *SeriesDeleteRequest) Reset()

func (*SeriesDeleteRequest) Size

func (m *SeriesDeleteRequest) Size() (n int)

func (*SeriesDeleteRequest) String

func (m *SeriesDeleteRequest) String() string

func (*SeriesDeleteRequest) Unmarshal

func (m *SeriesDeleteRequest) Unmarshal(dAtA []byte) error

type SeriesDeleteResponse

type SeriesDeleteResponse struct {
}

func (*SeriesDeleteResponse) Descriptor

func (*SeriesDeleteResponse) Descriptor() ([]byte, []int)

func (*SeriesDeleteResponse) Marshal

func (m *SeriesDeleteResponse) Marshal() (dAtA []byte, err error)

func (*SeriesDeleteResponse) MarshalTo

func (m *SeriesDeleteResponse) MarshalTo(dAtA []byte) (int, error)

func (*SeriesDeleteResponse) ProtoMessage

func (*SeriesDeleteResponse) ProtoMessage()

func (*SeriesDeleteResponse) Reset

func (m *SeriesDeleteResponse) Reset()

func (*SeriesDeleteResponse) Size

func (m *SeriesDeleteResponse) Size() (n int)

func (*SeriesDeleteResponse) String

func (m *SeriesDeleteResponse) String() string

func (*SeriesDeleteResponse) Unmarshal

func (m *SeriesDeleteResponse) Unmarshal(dAtA []byte) error

type TSDBCleanTombstonesRequest

type TSDBCleanTombstonesRequest struct {
}

func (*TSDBCleanTombstonesRequest) Descriptor

func (*TSDBCleanTombstonesRequest) Descriptor() ([]byte, []int)

func (*TSDBCleanTombstonesRequest) Marshal

func (m *TSDBCleanTombstonesRequest) Marshal() (dAtA []byte, err error)

func (*TSDBCleanTombstonesRequest) MarshalTo

func (m *TSDBCleanTombstonesRequest) MarshalTo(dAtA []byte) (int, error)

func (*TSDBCleanTombstonesRequest) ProtoMessage

func (*TSDBCleanTombstonesRequest) ProtoMessage()

func (*TSDBCleanTombstonesRequest) Reset

func (m *TSDBCleanTombstonesRequest) Reset()

func (*TSDBCleanTombstonesRequest) Size

func (m *TSDBCleanTombstonesRequest) Size() (n int)

func (*TSDBCleanTombstonesRequest) String

func (m *TSDBCleanTombstonesRequest) String() string

func (*TSDBCleanTombstonesRequest) Unmarshal

func (m *TSDBCleanTombstonesRequest) Unmarshal(dAtA []byte) error

type TSDBCleanTombstonesResponse

type TSDBCleanTombstonesResponse struct {
}

func (*TSDBCleanTombstonesResponse) Descriptor

func (*TSDBCleanTombstonesResponse) Descriptor() ([]byte, []int)

func (*TSDBCleanTombstonesResponse) Marshal

func (m *TSDBCleanTombstonesResponse) Marshal() (dAtA []byte, err error)

func (*TSDBCleanTombstonesResponse) MarshalTo

func (m *TSDBCleanTombstonesResponse) MarshalTo(dAtA []byte) (int, error)

func (*TSDBCleanTombstonesResponse) ProtoMessage

func (*TSDBCleanTombstonesResponse) ProtoMessage()

func (*TSDBCleanTombstonesResponse) Reset

func (m *TSDBCleanTombstonesResponse) Reset()

func (*TSDBCleanTombstonesResponse) Size

func (m *TSDBCleanTombstonesResponse) Size() (n int)

func (*TSDBCleanTombstonesResponse) String

func (m *TSDBCleanTombstonesResponse) String() string

func (*TSDBCleanTombstonesResponse) Unmarshal

func (m *TSDBCleanTombstonesResponse) Unmarshal(dAtA []byte) error

type TSDBSnapshotRequest

type TSDBSnapshotRequest struct {
	SkipHead bool `protobuf:"varint,1,opt,name=skip_head,json=skipHead,proto3" json:"skip_head,omitempty"`
}

func (*TSDBSnapshotRequest) Descriptor

func (*TSDBSnapshotRequest) Descriptor() ([]byte, []int)

func (*TSDBSnapshotRequest) Marshal

func (m *TSDBSnapshotRequest) Marshal() (dAtA []byte, err error)

func (*TSDBSnapshotRequest) MarshalTo

func (m *TSDBSnapshotRequest) MarshalTo(dAtA []byte) (int, error)

func (*TSDBSnapshotRequest) ProtoMessage

func (*TSDBSnapshotRequest) ProtoMessage()

func (*TSDBSnapshotRequest) Reset

func (m *TSDBSnapshotRequest) Reset()

func (*TSDBSnapshotRequest) Size

func (m *TSDBSnapshotRequest) Size() (n int)

func (*TSDBSnapshotRequest) String

func (m *TSDBSnapshotRequest) String() string

func (*TSDBSnapshotRequest) Unmarshal

func (m *TSDBSnapshotRequest) Unmarshal(dAtA []byte) error

type TSDBSnapshotResponse

type TSDBSnapshotResponse struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
}

func (*TSDBSnapshotResponse) Descriptor

func (*TSDBSnapshotResponse) Descriptor() ([]byte, []int)

func (*TSDBSnapshotResponse) Marshal

func (m *TSDBSnapshotResponse) Marshal() (dAtA []byte, err error)

func (*TSDBSnapshotResponse) MarshalTo

func (m *TSDBSnapshotResponse) MarshalTo(dAtA []byte) (int, error)

func (*TSDBSnapshotResponse) ProtoMessage

func (*TSDBSnapshotResponse) ProtoMessage()

func (*TSDBSnapshotResponse) Reset

func (m *TSDBSnapshotResponse) Reset()

func (*TSDBSnapshotResponse) Size

func (m *TSDBSnapshotResponse) Size() (n int)

func (*TSDBSnapshotResponse) String

func (m *TSDBSnapshotResponse) String() string

func (*TSDBSnapshotResponse) Unmarshal

func (m *TSDBSnapshotResponse) Unmarshal(dAtA []byte) error

type TimeSeries

type TimeSeries struct {
	Labels  []*Label  `protobuf:"bytes,1,rep,name=labels" json:"labels,omitempty"`
	Samples []*Sample `protobuf:"bytes,2,rep,name=samples" json:"samples,omitempty"`
}

func (*TimeSeries) Descriptor

func (*TimeSeries) Descriptor() ([]byte, []int)

func (*TimeSeries) GetLabels

func (m *TimeSeries) GetLabels() []*Label

func (*TimeSeries) GetSamples

func (m *TimeSeries) GetSamples() []*Sample

func (*TimeSeries) Marshal

func (m *TimeSeries) Marshal() (dAtA []byte, err error)

func (*TimeSeries) MarshalTo

func (m *TimeSeries) MarshalTo(dAtA []byte) (int, error)

func (*TimeSeries) ProtoMessage

func (*TimeSeries) ProtoMessage()

func (*TimeSeries) Reset

func (m *TimeSeries) Reset()

func (*TimeSeries) Size

func (m *TimeSeries) Size() (n int)

func (*TimeSeries) String

func (m *TimeSeries) String() string

func (*TimeSeries) Unmarshal

func (m *TimeSeries) Unmarshal(dAtA []byte) error

type WriteRequest

type WriteRequest struct {
	Timeseries []*TimeSeries `protobuf:"bytes,1,rep,name=timeseries" json:"timeseries,omitempty"`
}

func (*WriteRequest) Descriptor

func (*WriteRequest) Descriptor() ([]byte, []int)

func (*WriteRequest) GetTimeseries

func (m *WriteRequest) GetTimeseries() []*TimeSeries

func (*WriteRequest) Marshal

func (m *WriteRequest) Marshal() (dAtA []byte, err error)

func (*WriteRequest) MarshalTo

func (m *WriteRequest) MarshalTo(dAtA []byte) (int, error)

func (*WriteRequest) ProtoMessage

func (*WriteRequest) ProtoMessage()

func (*WriteRequest) Reset

func (m *WriteRequest) Reset()

func (*WriteRequest) Size

func (m *WriteRequest) Size() (n int)

func (*WriteRequest) String

func (m *WriteRequest) String() string

func (*WriteRequest) Unmarshal

func (m *WriteRequest) Unmarshal(dAtA []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL