grafana_contact_points

README

Grafana Contact Point

To create a Grafana Contact Point:

    createGrafanaContactPoint := grafana_contact_points.GrafanaContactPoint{
                                    Name: "my-contact-point",
                                    Type: "email",
                                    Settings: map[string]interface{}{
                                            "addresses":   "example1@example.com;example2@example.com",
                                            "singleEmail": false,
                                        },
                                    DisableResolveMessage: false,
                                }	
    client, err := grafana_contact_points.New("some-token", "some-url")
    contactPoint, err := client.CreateGrafanaContactPoint(createGrafanaContactPoint)

function	func name
create contact point	func (c *GrafanaContactPointClient) CreateGrafanaContactPoint(payload GrafanaContactPoint) (GrafanaContactPoint, error)
delete contact point	func (c *GrafanaContactPointClient) DeleteGrafanaContactPoint(uid string) error
get all contact points	func (c *GrafanaContactPointClient) GetAllGrafanaContactPoints() ([]GrafanaContactPoint, error)
get contact point by uid	func (c *GrafanaContactPointClient) GetGrafanaContactPointByUid(uid string) (GrafanaContactPoint, error)
get contact points by name	func (c *GrafanaContactPointClient) GetGrafanaContactPointsByName(name string) ([]GrafanaContactPoint, error)
update contact point	func (c *GrafanaContactPointClient) UpdateContactPoint(contactPoint GrafanaContactPoint) error

Documentation

Index

• type ContactPointType
  • func GetSupportedContactPointTypes() []ContactPointType
  • func (cpt ContactPointType) String() string
• type GrafanaContactPoint
• type GrafanaContactPointClient
  • func New(apiToken string, baseUrl string) (*GrafanaContactPointClient, error)
  • func (c *GrafanaContactPointClient) CreateGrafanaContactPoint(payload GrafanaContactPoint) (GrafanaContactPoint, error)
  • func (c *GrafanaContactPointClient) DeleteGrafanaContactPoint(uid string) error
  • func (c *GrafanaContactPointClient) GetAllGrafanaContactPoints() ([]GrafanaContactPoint, error)
  • func (c *GrafanaContactPointClient) GetGrafanaContactPointByUid(uid string) (GrafanaContactPoint, error)
  • func (c *GrafanaContactPointClient) GetGrafanaContactPointsByName(name string) ([]GrafanaContactPoint, error)
  • func (c *GrafanaContactPointClient) UpdateContactPoint(contactPoint GrafanaContactPoint) error

Types

type ContactPointType

type ContactPointType string

const (
	GrafanaContactPointTypeEmail          ContactPointType = "email"
	GrafanaContactPointTypeGoogleChat     ContactPointType = "googlechat"
	GrafanaContactPointTypeOpsgenie       ContactPointType = "opsgenie"
	GrafanaContactPointTypePagerduty      ContactPointType = "pagerduty"
	GrafanaContactPointTypeSlack          ContactPointType = "slack"
	GrafanaContactPointTypeMicrosoftTeams ContactPointType = "teams"
	GrafanaContactPointTypeVictorps       ContactPointType = "victorops"
	GrafanaContactPointTypeWebhook        ContactPointType = "webhook"
)

func GetSupportedContactPointTypes

func GetSupportedContactPointTypes() []ContactPointType

func (ContactPointType) String

func (cpt ContactPointType) String() string

type GrafanaContactPoint

type GrafanaContactPoint struct {
	Uid                   string                 `json:"uid"`
	Name                  string                 `json:"name"`
	Type                  string                 `json:"type"`
	Settings              map[string]interface{} `json:"settings"`
	DisableResolveMessage bool                   `json:"disableResolveMessage"`
	Provenance            string                 `json:"provenance"`
}

type GrafanaContactPointClient

type GrafanaContactPointClient struct {
	*client.Client
}

func New

func New(apiToken string, baseUrl string) (*GrafanaContactPointClient, error)

func (*GrafanaContactPointClient) CreateGrafanaContactPoint

func (c *GrafanaContactPointClient) CreateGrafanaContactPoint(payload GrafanaContactPoint) (GrafanaContactPoint, error)

func (*GrafanaContactPointClient) DeleteGrafanaContactPoint

func (c *GrafanaContactPointClient) DeleteGrafanaContactPoint(uid string) error

func (*GrafanaContactPointClient) GetAllGrafanaContactPoints

func (c *GrafanaContactPointClient) GetAllGrafanaContactPoints() ([]GrafanaContactPoint, error)

func (*GrafanaContactPointClient) GetGrafanaContactPointByUid

func (c *GrafanaContactPointClient) GetGrafanaContactPointByUid(uid string) (GrafanaContactPoint, error)

GetGrafanaContactPointByUid - The actual API doesn't have functionality of getting specific Contact Point by uid. This function wraps the GetAllGrafanaContactPoints function, and looks for a match of a given uid

func (*GrafanaContactPointClient) GetGrafanaContactPointsByName

func (c *GrafanaContactPointClient) GetGrafanaContactPointsByName(name string) ([]GrafanaContactPoint, error)

func (*GrafanaContactPointClient) UpdateContactPoint

func (c *GrafanaContactPointClient) UpdateContactPoint(contactPoint GrafanaContactPoint) error