Documentation
¶
Index ¶
- Variables
- func FromProto(rg *RuleGroupDesc) rulefmt.RuleGroup
- type RuleDesc
- func (*RuleDesc) Descriptor() ([]byte, []int)
- func (this *RuleDesc) Equal(that interface{}) bool
- func (m *RuleDesc) GetAlert() string
- func (m *RuleDesc) GetExpr() string
- func (m *RuleDesc) GetFor() time.Duration
- func (m *RuleDesc) GetRecord() string
- func (this *RuleDesc) GoString() string
- func (m *RuleDesc) Marshal() (dAtA []byte, err error)
- func (m *RuleDesc) MarshalTo(dAtA []byte) (int, error)
- func (m *RuleDesc) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*RuleDesc) ProtoMessage()
- func (m *RuleDesc) Reset()
- func (m *RuleDesc) Size() (n int)
- func (this *RuleDesc) String() string
- func (m *RuleDesc) Unmarshal(dAtA []byte) error
- func (m *RuleDesc) XXX_DiscardUnknown()
- func (m *RuleDesc) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RuleDesc) XXX_Merge(src proto.Message)
- func (m *RuleDesc) XXX_Size() int
- func (m *RuleDesc) XXX_Unmarshal(b []byte) error
- type RuleGroupDesc
- func (*RuleGroupDesc) Descriptor() ([]byte, []int)
- func (this *RuleGroupDesc) Equal(that interface{}) bool
- func (m *RuleGroupDesc) GetInterval() time.Duration
- func (m *RuleGroupDesc) GetName() string
- func (m *RuleGroupDesc) GetNamespace() string
- func (m *RuleGroupDesc) GetOptions() []*types.Any
- func (m *RuleGroupDesc) GetRules() []*RuleDesc
- func (m *RuleGroupDesc) GetUser() string
- func (this *RuleGroupDesc) GoString() string
- func (m *RuleGroupDesc) Marshal() (dAtA []byte, err error)
- func (m *RuleGroupDesc) MarshalTo(dAtA []byte) (int, error)
- func (m *RuleGroupDesc) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*RuleGroupDesc) ProtoMessage()
- func (m *RuleGroupDesc) Reset()
- func (m *RuleGroupDesc) Size() (n int)
- func (this *RuleGroupDesc) String() string
- func (m *RuleGroupDesc) Unmarshal(dAtA []byte) error
- func (m *RuleGroupDesc) XXX_DiscardUnknown()
- func (m *RuleGroupDesc) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RuleGroupDesc) XXX_Merge(src proto.Message)
- func (m *RuleGroupDesc) XXX_Size() int
- func (m *RuleGroupDesc) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
View Source
var (
ErrInvalidLengthRules = fmt.Errorf("proto: negative length found during unmarshaling")
ErrIntOverflowRules = fmt.Errorf("proto: integer overflow")
)
Functions ¶
Types ¶
type RuleDesc ¶
type RuleDesc struct {
Expr string `protobuf:"bytes,1,opt,name=expr,proto3" json:"expr,omitempty"`
Record string `protobuf:"bytes,2,opt,name=record,proto3" json:"record,omitempty"`
Alert string `protobuf:"bytes,3,opt,name=alert,proto3" json:"alert,omitempty"`
For time.Duration `protobuf:"bytes,4,opt,name=for,proto3,stdduration" json:"for"`
Labels []github_com_cortexproject_cortex_pkg_cortexpb.LabelAdapter `protobuf:"bytes,5,rep,name=labels,proto3,customtype=github.com/cortexproject/cortex/pkg/cortexpb.LabelAdapter" json:"labels"`
Annotations []github_com_cortexproject_cortex_pkg_cortexpb.LabelAdapter `` /* 134-byte string literal not displayed */
}
RuleDesc is a proto representation of a Prometheus Rule
func (*RuleDesc) Descriptor ¶
func (*RuleDesc) Descriptor() ([]byte, []int)
func (*RuleDesc) MarshalToSizedBuffer ¶
func (m *RuleDesc) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*RuleDesc) ProtoMessage ¶
func (*RuleDesc) ProtoMessage()
func (*RuleDesc) XXX_DiscardUnknown ¶
func (m *RuleDesc) XXX_DiscardUnknown()
func (*RuleDesc) XXX_Marshal ¶
func (m *RuleDesc) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*RuleDesc) XXX_Unmarshal ¶
func (m *RuleDesc) XXX_Unmarshal(b []byte) error
type RuleGroupDesc ¶
type RuleGroupDesc struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
Interval time.Duration `protobuf:"bytes,3,opt,name=interval,proto3,stdduration" json:"interval"`
Rules []*RuleDesc `protobuf:"bytes,4,rep,name=rules,proto3" json:"rules,omitempty"`
User string `protobuf:"bytes,6,opt,name=user,proto3" json:"user,omitempty"`
// The options field can be used to extend Cortex Ruler functionality without
// having to repeatedly redefine the proto description. It can also be leveraged
// to create custom `ManagerOpts` based on rule configs which can then be passed
// to the Prometheus Manager.
Options []*types.Any `protobuf:"bytes,9,rep,name=options,proto3" json:"options,omitempty"`
}
RuleGroupDesc is a proto representation of a cortex rule group.
func ToProto ¶
func ToProto(user string, namespace string, rl rulefmt.RuleGroup) *RuleGroupDesc
ToProto transforms a formatted prometheus rulegroup to a rule group protobuf
func (*RuleGroupDesc) Descriptor ¶
func (*RuleGroupDesc) Descriptor() ([]byte, []int)
func (*RuleGroupDesc) GetInterval ¶
func (m *RuleGroupDesc) GetInterval() time.Duration
func (*RuleGroupDesc) GetNamespace ¶
func (m *RuleGroupDesc) GetNamespace() string
func (*RuleGroupDesc) GetOptions ¶
func (m *RuleGroupDesc) GetOptions() []*types.Any
func (*RuleGroupDesc) MarshalToSizedBuffer ¶
func (m *RuleGroupDesc) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*RuleGroupDesc) ProtoMessage ¶
func (*RuleGroupDesc) ProtoMessage()
func (*RuleGroupDesc) XXX_DiscardUnknown ¶
func (m *RuleGroupDesc) XXX_DiscardUnknown()
func (*RuleGroupDesc) XXX_Marshal ¶
func (m *RuleGroupDesc) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*RuleGroupDesc) XXX_Unmarshal ¶
func (m *RuleGroupDesc) XXX_Unmarshal(b []byte) error
Click to show internal directories.
Click to hide internal directories.