v1

package
v0.0.0-...-80f207f Latest Latest
Warning

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

 Go to latest Published: Oct 25, 2023 License: MIT Imports: 17 Imported by: 0

README

Monitor

A monitor is a set of checks that you can run against your data. A monitor watches your data over time and alerts you when certain conditions are met. For example, you can create a monitor that watches the average response time of your website and alerts you when the response time is greater than 1 second.

Monitors are made up of one or more checks. A check is a single test that you can run against your data. For example, you can create a check that watches the average response time of your website. You can also create a check that watches the percentage of 5xx errors in your logs.

Guance Cloud supports defining monitors, users can customize the configuration of detection rules and trigger conditions, and open the monitors to receive related alarm events triggered by the detection rules.

Relationships:

graph LR

A[Monitor] --> B[Alert Policy] --> C[Notification]

Documentation

Overview

Package v1

Monitor

A monitor is a set of checks that you can run against your data. A monitor watches your data over time and alerts you when certain conditions are met. For example, you can create a monitor that watches the average response time of your website and alerts you when the response time is greater than 1 second.

Monitors are made up of one or more checks. A check is a single test that you can run against your data. For example, you can create a check that watches the average response time of your website. You can also create a check that watches the percentage of 5xx errors in your logs.

Guance Cloud supports defining monitors, users can customize the configuration of detection rules and trigger conditions, and open the monitors to receive related alarm events triggered by the detection rules.

Relationships:

```mermaid graph LR

A[Monitor] --> B[Alert Policy] --> C[Notification] ```

Code generated by Iacker. DO NOT EDIT IT.

Index

Constants

View Source 
const ResourceType = "Monitor"

ResourceType is the unique type name of Monitor

Variables

View Source 
var File_pkg_resources_monitor_v1_monitor_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AlertPolicy 

type AlertPolicy struct {

	// Alert Policy ID
	Id *string `protobuf:"bytes,1,opt,name=id,proto3,oneof" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*AlertPolicy) Descriptor deprecated 

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

Deprecated: Use AlertPolicy.ProtoReflect.Descriptor instead.

func (*AlertPolicy) GetId 

func (x *AlertPolicy) GetId() string

func (*AlertPolicy) ProtoMessage 

func (*AlertPolicy) ProtoMessage()

func (*AlertPolicy) ProtoReflect 

func (x *AlertPolicy) ProtoReflect() protoreflect.Message

func (*AlertPolicy) Reset 

func (x *AlertPolicy) Reset()

func (*AlertPolicy) String 

func (x *AlertPolicy) String() string

func (*AlertPolicy) Validate 

func (m *AlertPolicy) Validate() error

Validate checks the field values on AlertPolicy with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*AlertPolicy) ValidateAll 

func (m *AlertPolicy) ValidateAll() error

ValidateAll checks the field values on AlertPolicy with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in AlertPolicyMultiError, or nil if none found.

type AlertPolicyMultiError 

type AlertPolicyMultiError []error

AlertPolicyMultiError is an error wrapping multiple validation errors returned by AlertPolicy.ValidateAll() if the designated constraints aren't met.

func (AlertPolicyMultiError) AllErrors 

func (m AlertPolicyMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (AlertPolicyMultiError) Error 

func (m AlertPolicyMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type AlertPolicyValidationError 

type AlertPolicyValidationError struct {
	// contains filtered or unexported fields
}

AlertPolicyValidationError is the validation error returned by AlertPolicy.Validate if the designated constraints aren't met.

func (AlertPolicyValidationError) Cause 

func (e AlertPolicyValidationError) Cause() error

Cause function returns cause value.

func (AlertPolicyValidationError) Error 

func (e AlertPolicyValidationError) Error() string

Error satisfies the builtin error interface

func (AlertPolicyValidationError) ErrorName 

func (e AlertPolicyValidationError) ErrorName() string

ErrorName returns error name.

func (AlertPolicyValidationError) Field 

func (e AlertPolicyValidationError) Field() string

Field function returns field value.

func (AlertPolicyValidationError) Key 

func (e AlertPolicyValidationError) Key() bool

Key function returns key value.

func (AlertPolicyValidationError) Reason 

func (e AlertPolicyValidationError) Reason() string

Reason function returns reason value.

type Dashboard 

type Dashboard struct {

	// Dashboard ID
	Id *string `protobuf:"bytes,1,opt,name=id,proto3,oneof" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*Dashboard) Descriptor deprecated 

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

Deprecated: Use Dashboard.ProtoReflect.Descriptor instead.

func (*Dashboard) GetId 

func (x *Dashboard) GetId() string

func (*Dashboard) ProtoMessage 

func (*Dashboard) ProtoMessage()

func (*Dashboard) ProtoReflect 

func (x *Dashboard) ProtoReflect() protoreflect.Message

func (*Dashboard) Reset 

func (x *Dashboard) Reset()

func (*Dashboard) String 

func (x *Dashboard) String() string

func (*Dashboard) Validate 

func (m *Dashboard) Validate() error

Validate checks the field values on Dashboard with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Dashboard) ValidateAll 

func (m *Dashboard) ValidateAll() error

ValidateAll checks the field values on Dashboard with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in DashboardMultiError, or nil if none found.

type DashboardMultiError 

type DashboardMultiError []error

DashboardMultiError is an error wrapping multiple validation errors returned by Dashboard.ValidateAll() if the designated constraints aren't met.

func (DashboardMultiError) AllErrors 

func (m DashboardMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (DashboardMultiError) Error 

func (m DashboardMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type DashboardValidationError 

type DashboardValidationError struct {
	// contains filtered or unexported fields
}

DashboardValidationError is the validation error returned by Dashboard.Validate if the designated constraints aren't met.

func (DashboardValidationError) Cause 

func (e DashboardValidationError) Cause() error

Cause function returns cause value.

func (DashboardValidationError) Error 

func (e DashboardValidationError) Error() string

Error satisfies the builtin error interface

func (DashboardValidationError) ErrorName 

func (e DashboardValidationError) ErrorName() string

ErrorName returns error name.

func (DashboardValidationError) Field 

func (e DashboardValidationError) Field() string

Field function returns field value.

func (DashboardValidationError) Key 

func (e DashboardValidationError) Key() bool

Key function returns key value.

func (DashboardValidationError) Reason 

func (e DashboardValidationError) Reason() string

Reason function returns reason value.

type Monitor 

type Monitor struct {

	// Monitor Configuration
	Manifest string `protobuf:"bytes,1,opt,name=manifest,proto3" json:"manifest,omitempty"`
	// Alert Policy Configuration
	AlertPolicy *AlertPolicy `protobuf:"bytes,2,opt,name=alert_policy,json=alertPolicy,proto3" json:"alert_policy,omitempty"`
	// Dashboard Configuration
	Dashboard *Dashboard `protobuf:"bytes,3,opt,name=dashboard,proto3" json:"dashboard,omitempty"`
	// contains filtered or unexported fields
}

func (*Monitor) Descriptor deprecated 

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

Deprecated: Use Monitor.ProtoReflect.Descriptor instead.

func (*Monitor) GetAlertPolicy 

func (x *Monitor) GetAlertPolicy() *AlertPolicy

func (*Monitor) GetDashboard 

func (x *Monitor) GetDashboard() *Dashboard

func (*Monitor) GetManifest 

func (x *Monitor) GetManifest() string

func (*Monitor) ProtoMessage 

func (*Monitor) ProtoMessage()

func (*Monitor) ProtoReflect 

func (x *Monitor) ProtoReflect() protoreflect.Message

func (*Monitor) Reset 

func (x *Monitor) Reset()

func (*Monitor) String 

func (x *Monitor) String() string

func (*Monitor) Validate 

func (m *Monitor) Validate() error

Validate checks the field values on Monitor with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Monitor) ValidateAll 

func (m *Monitor) ValidateAll() error

ValidateAll checks the field values on Monitor with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in MonitorMultiError, or nil if none found.

type MonitorMultiError 

type MonitorMultiError []error

MonitorMultiError is an error wrapping multiple validation errors returned by Monitor.ValidateAll() if the designated constraints aren't met.

func (MonitorMultiError) AllErrors 

func (m MonitorMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (MonitorMultiError) Error 

func (m MonitorMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type MonitorValidationError 

type MonitorValidationError struct {
	// contains filtered or unexported fields
}

MonitorValidationError is the validation error returned by Monitor.Validate if the designated constraints aren't met.

func (MonitorValidationError) Cause 

func (e MonitorValidationError) Cause() error

Cause function returns cause value.

func (MonitorValidationError) Error 

func (e MonitorValidationError) Error() string

Error satisfies the builtin error interface

func (MonitorValidationError) ErrorName 

func (e MonitorValidationError) ErrorName() string

ErrorName returns error name.

func (MonitorValidationError) Field 

func (e MonitorValidationError) Field() string

Field function returns field value.

func (MonitorValidationError) Key 

func (e MonitorValidationError) Key() bool

Key function returns key value.

func (MonitorValidationError) Reason 

func (e MonitorValidationError) Reason() string

Reason function returns reason value.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.