Documentation
¶
Overview ¶
The library for making Ayd plugin or client.
Example (AlertPlugin) ¶
args, err := ayd.ParseAlertPluginArgs()
if err != nil {
fmt.Fprintln(os.Stderr, err)
os.Exit(1)
}
logger := ayd.NewLogger(args.AlertURL).StartTimer()
// send alert to somewhere
logger.Healthy("alert sent")
Example (ApiClient) ¶
aydURL, _ := url.Parse("http://localhost:9000")
// fetch status from Ayd server
report, err := ayd.Fetch(aydURL)
if err != nil {
panic(err)
}
for target, status := range report.ProbeHistory {
// show target name
fmt.Printf("# %s\n", target)
// show status history
for _, x := range status.Records {
fmt.Println(x.Status)
}
}
Example (ProbePlugin) ¶
args, err := ayd.ParseProbePluginArgs()
if err != nil {
fmt.Fprintln(os.Stderr, err)
os.Exit(1)
}
logger := ayd.NewLogger(args.TargetURL).StartTimer()
// check your target here
ok := true
if ok {
logger.Healthy("target is healthy!")
} else {
logger.Failure("target is down")
}
Index ¶
- Variables
- func SortProbeHistories(hs []ProbeHistory)
- type AlertPluginArgs
- type Incident
- type Logger
- func (l Logger) Aborted(message string) error
- func (l Logger) Failure(message string) error
- func (l Logger) Healthy(message string) error
- func (l Logger) Print(r Record) error
- func (l Logger) StartTimer() Logger
- func (l Logger) StopTimer() Logger
- func (l Logger) Unknown(message string) error
- func (l Logger) WithTarget(target *url.URL) Logger
- func (l Logger) WithTime(startTime time.Time, latency time.Duration) Logger
- type ProbeHistory
- type ProbePluginArgs
- type Record
- type Report
- type Status
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var ( // ErrInvalidArgument is a error for if the argument was wrong. ErrInvalidArgumentValue = errors.New("invalid argument value") // ErrArgumentCount is a error for if the count of arguments was wrong. ErrArgumentCount = errors.New("unexpected count of arguments") // ErrCommunicate is a error for if connect or communicate with the Ayd server. ErrCommunicate = errors.New("server communication error") // ErrInvalidRecord is a error for if failed to parse log because it was invalid format. ErrInvalidRecord = errors.New("invalid record") // ErrIO is a error for if failed to wread/write log. ErrIO = errors.New("failed to read/write log") // ErrEmptyTarget is a error for if the target URL of Record was empty. ErrEmptyTarget = errors.New("invalid record: the target URL is required") )
The errors in Ayd library can check the error type via errors.Is function.
Functions ¶
func SortProbeHistories ¶ added in v0.10.0
func SortProbeHistories(hs []ProbeHistory)
SortProbeHistories sorts list of ProbeHistory by latest status and target URL.
This function will edit slice directly.
Types ¶
type AlertPluginArgs ¶
type AlertPluginArgs struct {
AlertURL *url.URL
CheckedAt time.Time
Status Status
TargetURL *url.URL
Message string
}
AlertPluginArgs is arguments for alert plugin
func ParseAlertPluginArgs ¶
func ParseAlertPluginArgs() (AlertPluginArgs, error)
ParseAlertPluginArgs is get arguments for alert plugin
This function is shorthand of `ayd.ParseAlertPluginArgs(os.Args)`.
func ParseAlertPluginArgsFrom ¶
func ParseAlertPluginArgsFrom(args []string) (AlertPluginArgs, error)
ParseAlertPluginArgsFrom is parse arguments for alert plugin
type Incident ¶
type Incident struct {
Target *url.URL
Status Status
Message string
// CausedAt is the first detected time the target is unhealthy status
CausedAt time.Time
// ResolvedAt is the earliest time that detected the target back to healthy status
ResolvedAt time.Time
}
Incident is a period of failure or unknown status that has the same status and message
func (Incident) MarshalJSON ¶ added in v0.10.0
MarshalJSON implements the json.Marshaler interface.
func (*Incident) UnmarshalJSON ¶ added in v0.10.0
UnmarshalJSON implements the json.Unmarshaler interface.
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
Logger is the logger for Ayd plugin
Example ¶
target, _ := url.Parse("foobar:your-plugin-url")
logger := ayd.NewLogger(target)
logger.Healthy("hello world")
Example (SetExtraValues) ¶
logger := ayd.NewLogger(nil)
// change target URL
target, _ := url.Parse("foobar:your-plugin-url")
logger = logger.WithTarget(target)
// set check time and latency of the target
startTime, _ := time.Parse(time.RFC3339, "2001-02-03T16:05:06+09:00")
latency := 123 * time.Millisecond
logger = logger.WithTime(startTime, latency)
// report target status with a message
logger.Healthy("target is healthy")
logger.Failure("target seems down")
logger.Unknown("failed to check, so target status is unknown")
logger.Aborted("the check was aborted by user or something")
Output: 2001-02-03T16:05:06+09:00 HEALTHY 123.000 foobar:your-plugin-url target is healthy 2001-02-03T16:05:06+09:00 FAILURE 123.000 foobar:your-plugin-url target seems down 2001-02-03T16:05:06+09:00 UNKNOWN 123.000 foobar:your-plugin-url failed to check, so target status is unknown 2001-02-03T16:05:06+09:00 ABORTED 123.000 foobar:your-plugin-url the check was aborted by user or something
func NewLogger ¶
NewLogger makes new Logger
This is the shorthand to `ayd.NewLoggerWithWriter(os.Stdout, target)`.
func NewLoggerWithWriter ¶
NewLoggerWithWriter makes new Logger with a io.Writer
func (Logger) Print ¶
Print prints a Record
Example ¶
logger := ayd.NewLogger(nil)
logger.Print(ayd.Record{
Target: &url.URL{Scheme: "foo", Host: "bar"},
Status: ayd.StatusHealthy,
CheckedAt: time.Date(2001, 2, 3, 16, 5, 6, 7, time.UTC),
Message: "hello world",
})
logger.Print(ayd.Record{
Target: &url.URL{Scheme: "foo", Host: "bar"},
CheckedAt: time.Date(2001, 2, 3, 16, 5, 7, 0, time.UTC),
Message: "without status",
})
err := logger.Print(ayd.Record{
CheckedAt: time.Date(2001, 2, 3, 16, 5, 8, 0, time.UTC),
Message: "without target",
})
fmt.Println("error:", err)
Output: 2001-02-03T16:05:06Z HEALTHY 0.000 foo://bar hello world 2001-02-03T16:05:07Z UNKNOWN 0.000 foo://bar without status error: invalid record: the target URL is required
func (Logger) StartTimer ¶
StartTimer makes new Logger that set start time as current time, and start timer for latency from now.
You can stop the timer with StopTimer method, or just call print method like Healthy or Failure.
Example ¶
target, _ := url.Parse("foobar:your-plugin-url")
logger := ayd.NewLogger(target)
l := logger.StartTimer()
// check your target status
l.Healthy("hello world")
func (Logger) StopTimer ¶
StopTimer stops latency timer that started by StartTimer method, and makes new Logger with measured latency.
Example ¶
target, _ := url.Parse("foobar:your-plugin-url")
logger := ayd.NewLogger(target)
l := logger.StartTimer()
// check your target status
l = l.StopTimer()
// do something, for example calculate result of the check
l.Healthy("hello world")
func (Logger) WithTarget ¶
WithTarget makes new Logger with new target URL
Example ¶
logger := ayd.NewLogger(nil)
target, _ := url.Parse("foobar:your-plugin-url")
logger.WithTarget(target).Healthy("hello world")
func (Logger) WithTime ¶
WithTime makes new Logger with start time and latency value
Example ¶
target, _ := url.Parse("foobar:your-plugin-url")
logger := ayd.NewLogger(target)
startTime, _ := time.Parse(time.RFC3339, "2001-02-03T16:05:06+09:00")
latency := 123 * time.Millisecond
logger.WithTime(startTime, latency).Healthy("hello world")
Output: 2001-02-03T16:05:06+09:00 HEALTHY 123.000 foobar:your-plugin-url hello world
type ProbeHistory ¶ added in v0.10.0
type ProbeHistory struct {
Target *url.URL
// Status is the latest status of the target
Status Status
// Status is the same as CheckedAt of the latest History record
Updated time.Time
Records []Record
}
ProbeHistory is the status history data of single target
func (ProbeHistory) MarshalJSON ¶ added in v0.10.0
func (ph ProbeHistory) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaler interface.
func (*ProbeHistory) UnmarshalJSON ¶ added in v0.10.0
func (ph *ProbeHistory) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaler interface.
type ProbePluginArgs ¶
ProbePluginArgs is arguments for probe plugin
func ParseProbePluginArgs ¶
func ParseProbePluginArgs() (ProbePluginArgs, error)
ParseProbePluginArgs is get arguments for probe plugin
This function is shorthand of `ayd.ParseProbePluginArgs(os.Args)`.
func ParseProbePluginArgsFrom ¶
func ParseProbePluginArgsFrom(args []string) (ProbePluginArgs, error)
ParseProbePluginArgsFrom is parse arguments for probe plugin
type Record ¶
type Record struct {
// CheckedAt is the time the check started
CheckedAt time.Time
Status Status
Latency time.Duration
Target *url.URL
// Message is the reason of the status, or extra informations of the check
Message string
}
Record is a record in Ayd log
func ParseRecord ¶
ParseRecord is parse string as a Record row in the log
func (Record) MarshalJSON ¶ added in v0.10.0
MarshalJSON implements the json.Marshaler interface.
func (Record) MarshalText ¶ added in v0.8.0
MarshalText is marshal to text
func (*Record) UnmarshalJSON ¶ added in v0.10.0
UnmarshalJSON implements the json.Unmarshaler interface.
func (*Record) UnmarshalText ¶ added in v0.8.0
UnmarshalText is unmarshal from text
type Report ¶ added in v0.10.0
type Report struct {
// ProbeHistory is the map of ProbeHistory.
// The key is target URL string, and the value is struct ProbeHistory.
ProbeHistory map[string]ProbeHistory
// CurrentIncidents is the list of Incident that current causing.
CurrentIncidents []Incident
// IncidentHistory is the list of Incident that already resolved.
//
// If you want get current causing incidents, please use CurrentIncidents.
IncidentHistory []Incident
// ReportedAt is the time the report created in server.
ReportedAt time.Time
}
Report is a report from Ayd server.
func (Report) MarshalJSON ¶ added in v0.10.0
MarshalJSON implements the json.Marshaler interface.
func (Report) TargetURLs ¶ added in v0.10.0
TargetURLs returns target URLs that to status checking
func (*Report) UnmarshalJSON ¶ added in v0.10.0
UnmarshalJSON implements the json.Unmarshaler interface.
type Status ¶
type Status int8
Status is the status of target service
const ( // StatusUnknown means UNKNOWN current status because failed to check the target status. // System administrator have to fix Ayd settings, or do something to target system when this status. StatusUnknown Status = iota // StatusHealthy means success to status check and the target is HEALTHY. StatusHealthy // StatusFailure means the target is in FAILURE, but status check is success. // System administrator have to do something action to target system when this status. StatusFailure // StatusAborted means the status check ABORTED because stop by system administrator or other system program like systemd. // System administrator doesn't have to do something on this status. StatusAborted )
func ParseStatus ¶
ParseStatus is parse status string
If passed unsupported status, it will returns StatusUnknown
func (Status) MarshalText ¶
MarshalText is marshal Status as text
func (*Status) UnmarshalText ¶
UnmarshalText is unmarshal text as status
This function always returns nil. This parses as StatusUnknown instead of returns error if unsupported status passed.
Source Files