synthetics

Documentation

Index

• Variables
• type ErrorDetail
• type ErrorResponse
  • func (e *ErrorResponse) Error() string
• type Monitor
• type MonitorLabel
• type MonitorOptions
• type MonitorScript
• type MonitorScriptLocation
• type MonitorStatusType
• type MonitorType
• type SecureCredential
• type Synthetics
  • func New(config config.Config) Synthetics
  • func (s *Synthetics) AddMonitorLabel(monitorID, labelKey, labelValue string) error
  • func (s *Synthetics) AddSecureCredential(key, value, description string) (*SecureCredential, error)
  • func (s *Synthetics) CreateMonitor(monitor Monitor) (*Monitor, error)
  • func (s *Synthetics) DeleteMonitor(monitorID string) error
  • func (s *Synthetics) DeleteMonitorLabel(monitorID, labelKey, labelValue string) error
  • func (s *Synthetics) DeleteSecureCredential(key string) error
  • func (s *Synthetics) GetMonitor(monitorID string) (*Monitor, error)
  • func (s *Synthetics) GetMonitorLabels(monitorID string) ([]*MonitorLabel, error)
  • func (s *Synthetics) GetMonitorScript(monitorID string) (*MonitorScript, error)
  • func (s *Synthetics) GetSecureCredential(key string) (*SecureCredential, error)
  • func (s *Synthetics) GetSecureCredentials() ([]*SecureCredential, error)
  • func (s *Synthetics) ListMonitors() ([]*Monitor, error)
  • func (s *Synthetics) UpdateMonitor(monitor Monitor) (*Monitor, error)
  • func (s *Synthetics) UpdateMonitorScript(monitorID string, script MonitorScript) (*MonitorScript, error)
  • func (s *Synthetics) UpdateSecureCredential(key, value, description string) (*SecureCredential, error)
• type Time
  • func (t Time) Equal(u Time) bool
  • func (t Time) MarshalJSON() ([]byte, error)
  • func (t *Time) UnmarshalJSON(s []byte) (err error)

Variables

var (
	// MonitorTypes specifies the possible types for a Synthetics monitor.
	MonitorTypes = struct {
		Ping            MonitorType
		Browser         MonitorType
		ScriptedBrowser MonitorType
		APITest         MonitorType
	}{
		Ping:            "SIMPLE",
		Browser:         "BROWSER",
		ScriptedBrowser: "SCRIPT_BROWSER",
		APITest:         "SCRIPT_API",
	}

	// MonitorStatus specifies the possible Synthetics monitor status types.
	MonitorStatus = struct {
		Enabled  MonitorStatusType
		Muted    MonitorStatusType
		Disabled MonitorStatusType
	}{
		Enabled:  "ENABLED",
		Muted:    "MUTED",
		Disabled: "DISABLED",
	}
)

var BaseURLs = map[region.Region]string{
	region.US:      "https://synthetics.newrelic.com/synthetics/api",
	region.EU:      "https://synthetics.eu.newrelic.com/synthetics/api",
	region.Staging: "https://staging-synthetics.newrelic.com/synthetics/api",
}

BaseURLs represents the base API URLs for the different environments of the Synthetics API.

Types

type ErrorDetail

type ErrorDetail struct {
	Message string `json:"error,omitempty"`
}

ErrorDetail represents an single error from New Relic Synthetics.

type ErrorResponse

type ErrorResponse struct {
	Message            string        `json:"error,omitempty"`
	Messages           []ErrorDetail `json:"errors,omitempty"`
	ServerErrorMessage string        `json:"message,omitempty"`
}

ErrorResponse represents an error response from New Relic Synthetics.

func (*ErrorResponse) Error

func (e *ErrorResponse) Error() string

Error surfaces an error message from the New Relic Synthetics error response.

type Monitor

type Monitor struct {
	ID           string            `json:"id,omitempty"`
	Name         string            `json:"name"`
	Type         MonitorType       `json:"type"`
	Frequency    uint              `json:"frequency"`
	URI          string            `json:"uri"`
	Locations    []string          `json:"locations"`
	Status       MonitorStatusType `json:"status"`
	SLAThreshold float64           `json:"slaThreshold"`
	UserID       uint              `json:"userId,omitempty"`
	APIVersion   string            `json:"apiVersion,omitempty"`
	ModifiedAt   *Time             `json:"modifiedAt,omitempty"`
	CreatedAt    *Time             `json:"createdAt,omitempty"`
	Options      MonitorOptions    `json:"options,omitempty"`
}

Monitor represents a New Relic Synthetics monitor.

type MonitorLabel

type MonitorLabel struct {
	Type  string `json:"type"`
	Value string `json:"value"`
	Href  string `json:"href"`
}

MonitorLabel represents a single label for a New Relic Synthetics monitor.

type MonitorOptions

type MonitorOptions struct {
	ValidationString       string `json:"validationString,omitempty"`
	VerifySSL              bool   `json:"verifySSL,omitempty"`
	BypassHEADRequest      bool   `json:"bypassHEADRequest,omitempty"`
	TreatRedirectAsFailure bool   `json:"treatRedirectAsFailure,omitempty"`
}

MonitorOptions represents the options for a New Relic Synthetics monitor.

type MonitorScript

type MonitorScript struct {
	Text      string                  `json:"scriptText"`
	Locations []MonitorScriptLocation `json:"scriptLocations"`
}

MonitorScript represents a New Relic Synthetics monitor script.

type MonitorScriptLocation

type MonitorScriptLocation struct {
	Name string `json:"name"`
	HMAC string `json:"hmac"`
}

MonitorScriptLocation represents a New Relic Synthetics monitor script location.

type MonitorStatusType

type MonitorStatusType string

MonitorStatusType represents a Synthetics monitor status type.

type MonitorType

type MonitorType string

MonitorType represents a Synthetics monitor type.

type SecureCredential

type SecureCredential struct {
	Key         string `json:"key"`
	Description string `json:"description"`
	Value       string `json:"value"`
	CreatedAt   *Time  `json:"createdAt"`
	LastUpdated *Time  `json:"lastUpdated"`
}

SecureCredential represents a Synthetics secure credential.

type Synthetics

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

Synthetics is used to communicate with the New Relic Synthetics product.

func New

func New(config config.Config) Synthetics

New is used to create a new Synthetics client instance.

func (*Synthetics) AddMonitorLabel

func (s *Synthetics) AddMonitorLabel(monitorID, labelKey, labelValue string) error

AddMonitorLabel is used to add a label to a given monitor.

func (*Synthetics) AddSecureCredential

func (s *Synthetics) AddSecureCredential(key, value, description string) (*SecureCredential, error)

AddSecureCredential is used to add a secure credential to your New Relic account.

func (*Synthetics) CreateMonitor

func (s *Synthetics) CreateMonitor(monitor Monitor) (*Monitor, error)

CreateMonitor is used to create a New Relic Synthetics monitor.

func (*Synthetics) DeleteMonitor

func (s *Synthetics) DeleteMonitor(monitorID string) error

DeleteMonitor is used to delete a New Relic Synthetics monitor.

func (*Synthetics) DeleteMonitorLabel

func (s *Synthetics) DeleteMonitorLabel(monitorID, labelKey, labelValue string) error

DeleteMonitorLabel deletes a key:value label from the given Syntheics monitor.

func (*Synthetics) DeleteSecureCredential

func (s *Synthetics) DeleteSecureCredential(key string) error

DeleteSecureCredential deletes a secure credential from your New Relic account.

func (*Synthetics) GetMonitor

func (s *Synthetics) GetMonitor(monitorID string) (*Monitor, error)

GetMonitor is used to retrieve a specific New Relic Synthetics monitor.

func (*Synthetics) GetMonitorLabels

func (s *Synthetics) GetMonitorLabels(monitorID string) ([]*MonitorLabel, error)

GetMonitorLabels is used to retrieve all labels for a given Synthetics monitor.

func (*Synthetics) GetMonitorScript

func (s *Synthetics) GetMonitorScript(monitorID string) (*MonitorScript, error)

GetMonitorScript is used to retrieve the script that belongs to a New Relic Synthetics scripted monitor.

func (*Synthetics) GetSecureCredential

func (s *Synthetics) GetSecureCredential(key string) (*SecureCredential, error)

GetSecureCredential is used to retrieve a specific secure credential from your New Relic account.

func (*Synthetics) GetSecureCredentials

func (s *Synthetics) GetSecureCredentials() ([]*SecureCredential, error)

GetSecureCredentials is used to retrieve all secure credentials from your New Relic account.

func (*Synthetics) ListMonitors

func (s *Synthetics) ListMonitors() ([]*Monitor, error)

ListMonitors is used to retrieve New Relic Synthetics monitors.

func (*Synthetics) UpdateMonitor

func (s *Synthetics) UpdateMonitor(monitor Monitor) (*Monitor, error)

UpdateMonitor is used to update a New Relic Synthetics monitor.

func (*Synthetics) UpdateMonitorScript

func (s *Synthetics) UpdateMonitorScript(monitorID string, script MonitorScript) (*MonitorScript, error)

UpdateMonitorScript is used to add a script to an existing New Relic Synthetics monitor_script.

func (*Synthetics) UpdateSecureCredential

func (s *Synthetics) UpdateSecureCredential(key, value, description string) (*SecureCredential, error)

UpdateSecureCredential is used to update a secure credential in your New Relic account.

type Time

type Time time.Time

Time is a type used for unmarshaling timestamps generated by the Synthetics API. Its underlying type is time.Time.

func (Time) Equal

func (t Time) Equal(u Time) bool

Equal provides a comparator for the Time type.

func (Time) MarshalJSON

func (t Time) MarshalJSON() ([]byte, error)

MarshalJSON is responsible for marshaling the Time type.

func (*Time) UnmarshalJSON

func (t *Time) UnmarshalJSON(s []byte) (err error)

UnmarshalJSON is responsible for unmarshaling the Time type.