Documentation
¶
Index ¶
- Variables
- type Comment
- func (*Comment) Descriptor() ([]byte, []int)deprecated
- func (x *Comment) GetAuthor() string
- func (x *Comment) GetComment() string
- func (x *Comment) GetTimestamp() *timestamppb.Timestamp
- func (*Comment) ProtoMessage()
- func (x *Comment) ProtoReflect() protoreflect.Message
- func (x *Comment) Reset()
- func (x *Comment) String() string
- type Matcher
- func (*Matcher) Descriptor() ([]byte, []int)deprecated
- func (x *Matcher) GetName() string
- func (x *Matcher) GetPattern() string
- func (x *Matcher) GetType() Matcher_Type
- func (*Matcher) ProtoMessage()
- func (x *Matcher) ProtoReflect() protoreflect.Message
- func (x *Matcher) Reset()
- func (x *Matcher) String() string
- type MatcherSet
- type Matcher_Type
- func (Matcher_Type) Descriptor() protoreflect.EnumDescriptor
- func (x Matcher_Type) Enum() *Matcher_Type
- func (Matcher_Type) EnumDescriptor() ([]byte, []int)deprecated
- func (x Matcher_Type) Number() protoreflect.EnumNumber
- func (x Matcher_Type) String() string
- func (Matcher_Type) Type() protoreflect.EnumType
- type MeshSilence
- func (*MeshSilence) Descriptor() ([]byte, []int)deprecated
- func (x *MeshSilence) GetExpiresAt() *timestamppb.Timestamp
- func (x *MeshSilence) GetSilence() *Silence
- func (*MeshSilence) ProtoMessage()
- func (x *MeshSilence) ProtoReflect() protoreflect.Message
- func (x *MeshSilence) Reset()
- func (x *MeshSilence) String() string
- type Silence
- func (*Silence) Descriptor() ([]byte, []int)deprecated
- func (x *Silence) GetAnnotations() map[string]string
- func (x *Silence) GetComment() string
- func (x *Silence) GetComments() []*Comment
- func (x *Silence) GetCreatedBy() string
- func (x *Silence) GetEndsAt() *timestamppb.Timestamp
- func (x *Silence) GetId() string
- func (x *Silence) GetMatcherSets() []*MatcherSet
- func (x *Silence) GetMatchers() []*Matcher
- func (x *Silence) GetStartsAt() *timestamppb.Timestamp
- func (x *Silence) GetUpdatedAt() *timestamppb.Timestamp
- func (*Silence) ProtoMessage()
- func (x *Silence) ProtoReflect() protoreflect.Message
- func (x *Silence) Reset()
- func (x *Silence) String() string
Constants ¶
This section is empty.
Variables ¶
var ( Matcher_Type_name = map[int32]string{ 0: "EQUAL", 1: "REGEXP", 2: "NOT_EQUAL", 3: "NOT_REGEXP", } Matcher_Type_value = map[string]int32{ "EQUAL": 0, "REGEXP": 1, "NOT_EQUAL": 2, "NOT_REGEXP": 3, } )
Enum value maps for Matcher_Type.
var File_silence_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Comment ¶
type Comment struct {
Author string `protobuf:"bytes,1,opt,name=author,proto3" json:"author,omitempty"`
Comment string `protobuf:"bytes,2,opt,name=comment,proto3" json:"comment,omitempty"`
Timestamp *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
// contains filtered or unexported fields
}
DEPRECATED: A comment can be attached to a silence.
func (*Comment) Descriptor
deprecated
func (*Comment) GetComment ¶ added in v0.32.0
func (*Comment) GetTimestamp ¶
func (x *Comment) GetTimestamp() *timestamppb.Timestamp
func (*Comment) ProtoMessage ¶
func (*Comment) ProtoMessage()
func (*Comment) ProtoReflect ¶ added in v0.32.0
func (x *Comment) ProtoReflect() protoreflect.Message
type Matcher ¶
type Matcher struct {
Type Matcher_Type `protobuf:"varint,1,opt,name=type,proto3,enum=silencepb.Matcher_Type" json:"type,omitempty"`
// The label name in a label set to against which the matcher
// checks the pattern.
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// The pattern being checked according to the matcher's type.
Pattern string `protobuf:"bytes,3,opt,name=pattern,proto3" json:"pattern,omitempty"`
// contains filtered or unexported fields
}
Matcher specifies a rule, which can match or set of labels or not.
func (*Matcher) Descriptor
deprecated
func (*Matcher) GetPattern ¶ added in v0.32.0
func (*Matcher) GetType ¶ added in v0.32.0
func (x *Matcher) GetType() Matcher_Type
func (*Matcher) ProtoMessage ¶
func (*Matcher) ProtoMessage()
func (*Matcher) ProtoReflect ¶ added in v0.32.0
func (x *Matcher) ProtoReflect() protoreflect.Message
type MatcherSet ¶ added in v0.32.0
type MatcherSet struct {
Matchers []*Matcher `protobuf:"bytes,1,rep,name=matchers,proto3" json:"matchers,omitempty"`
// contains filtered or unexported fields
}
MatcherSet is a set of matchers all of which have to be true for a silence to affect a given label set.
func (*MatcherSet) Descriptor
deprecated
added in
v0.32.0
func (*MatcherSet) Descriptor() ([]byte, []int)
Deprecated: Use MatcherSet.ProtoReflect.Descriptor instead.
func (*MatcherSet) GetMatchers ¶ added in v0.32.0
func (x *MatcherSet) GetMatchers() []*Matcher
func (*MatcherSet) ProtoMessage ¶ added in v0.32.0
func (*MatcherSet) ProtoMessage()
func (*MatcherSet) ProtoReflect ¶ added in v0.32.0
func (x *MatcherSet) ProtoReflect() protoreflect.Message
func (*MatcherSet) Reset ¶ added in v0.32.0
func (x *MatcherSet) Reset()
func (*MatcherSet) String ¶ added in v0.32.0
func (x *MatcherSet) String() string
type Matcher_Type ¶
type Matcher_Type int32
Type specifies how the given name and pattern are matched against a label set.
const ( Matcher_EQUAL Matcher_Type = 0 Matcher_REGEXP Matcher_Type = 1 Matcher_NOT_EQUAL Matcher_Type = 2 Matcher_NOT_REGEXP Matcher_Type = 3 )
func (Matcher_Type) Descriptor ¶ added in v0.32.0
func (Matcher_Type) Descriptor() protoreflect.EnumDescriptor
func (Matcher_Type) Enum ¶ added in v0.32.0
func (x Matcher_Type) Enum() *Matcher_Type
func (Matcher_Type) EnumDescriptor
deprecated
func (Matcher_Type) EnumDescriptor() ([]byte, []int)
Deprecated: Use Matcher_Type.Descriptor instead.
func (Matcher_Type) Number ¶ added in v0.32.0
func (x Matcher_Type) Number() protoreflect.EnumNumber
func (Matcher_Type) String ¶
func (x Matcher_Type) String() string
func (Matcher_Type) Type ¶ added in v0.32.0
func (Matcher_Type) Type() protoreflect.EnumType
type MeshSilence ¶
type MeshSilence struct {
Silence *Silence `protobuf:"bytes,1,opt,name=silence,proto3" json:"silence,omitempty"`
ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
// contains filtered or unexported fields
}
MeshSilence wraps a regular silence with an expiration timestamp after which the silence may be garbage collected.
func (*MeshSilence) Descriptor
deprecated
func (*MeshSilence) Descriptor() ([]byte, []int)
Deprecated: Use MeshSilence.ProtoReflect.Descriptor instead.
func (*MeshSilence) GetExpiresAt ¶
func (x *MeshSilence) GetExpiresAt() *timestamppb.Timestamp
func (*MeshSilence) GetSilence ¶
func (x *MeshSilence) GetSilence() *Silence
func (*MeshSilence) ProtoMessage ¶
func (*MeshSilence) ProtoMessage()
func (*MeshSilence) ProtoReflect ¶ added in v0.32.0
func (x *MeshSilence) ProtoReflect() protoreflect.Message
func (*MeshSilence) Reset ¶
func (x *MeshSilence) Reset()
func (*MeshSilence) String ¶
func (x *MeshSilence) String() string
type Silence ¶
type Silence struct {
// A globally unique identifier.
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// A set of matchers all of which have to be true for a silence
// to affect a given label set. For silences with matcher_sets,
// this is expected to be equal to the first entry in matcher_sets
Matchers []*Matcher `protobuf:"bytes,2,rep,name=matchers,proto3" json:"matchers,omitempty"`
// The time range during which the silence is active.
StartsAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=starts_at,json=startsAt,proto3" json:"starts_at,omitempty"`
EndsAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=ends_at,json=endsAt,proto3" json:"ends_at,omitempty"`
// The last notification made to the silence.
UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
// DEPRECATED: A set of comments made on the silence.
Comments []*Comment `protobuf:"bytes,7,rep,name=comments,proto3" json:"comments,omitempty"`
// Comment for the silence.
CreatedBy string `protobuf:"bytes,8,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"`
Comment string `protobuf:"bytes,9,opt,name=comment,proto3" json:"comment,omitempty"`
// Additional structured information about the silence
Annotations map[string]string `` /* 150-byte string literal not displayed */
// Multiple matcher sets with OR logic between them.
// At least one matcher set must match for the silence to apply.
MatcherSets []*MatcherSet `protobuf:"bytes,11,rep,name=matcher_sets,json=matcherSets,proto3" json:"matcher_sets,omitempty"`
// contains filtered or unexported fields
}
Silence specifies an object that ignores alerts based on a set of matchers during a given time frame.
func (*Silence) Descriptor
deprecated
func (*Silence) GetAnnotations ¶ added in v0.32.0
func (*Silence) GetComment ¶ added in v0.32.0
func (*Silence) GetComments ¶
func (*Silence) GetCreatedBy ¶ added in v0.32.0
func (*Silence) GetEndsAt ¶
func (x *Silence) GetEndsAt() *timestamppb.Timestamp
func (*Silence) GetMatcherSets ¶ added in v0.32.0
func (x *Silence) GetMatcherSets() []*MatcherSet
func (*Silence) GetMatchers ¶
func (*Silence) GetStartsAt ¶
func (x *Silence) GetStartsAt() *timestamppb.Timestamp
func (*Silence) GetUpdatedAt ¶
func (x *Silence) GetUpdatedAt() *timestamppb.Timestamp
func (*Silence) ProtoMessage ¶
func (*Silence) ProtoMessage()
func (*Silence) ProtoReflect ¶ added in v0.32.0
func (x *Silence) ProtoReflect() protoreflect.Message