api

package
v5.10.0 Latest Latest
Warning

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

Go to latest
Published: Apr 19, 2024 License: Apache-2.0 Imports: 41 Imported by: 0

Documentation

Index

Constants

View Source
const (
	HealthStatusUp      = "up"
	HealthStatusDown    = "down"
	HealthStatusUnknown = "?"
)
View Source
const (
	// DefaultPage is the default page to use if none is specified or an invalid value is provided
	DefaultPage = 1

	// DefaultPageSize is the default page siZE to use if none is specified or an invalid value is provided
	DefaultPageSize = 20

	// MaximumPageSize is the maximum page size allowed
	MaximumPageSize = common.MaximumNumberOfResults
)

Variables

This section is empty.

Functions

func CreateExternalEndpointResult added in v5.9.0

func CreateExternalEndpointResult(cfg *config.Config) fiber.Handler

func EndpointStatus

func EndpointStatus(c *fiber.Ctx) error

EndpointStatus retrieves a single core.EndpointStatus by group and endpoint name

func EndpointStatuses

func EndpointStatuses(cfg *config.Config) fiber.Handler

EndpointStatuses handles requests to retrieve all EndpointStatus Due to how intensive this operation can be on the storage, this function leverages a cache.

func HealthBadge

func HealthBadge(c *fiber.Ctx) error

HealthBadge handles the automatic generation of badge based on the group name and endpoint name passed.

func HealthBadgeShields added in v5.8.0

func HealthBadgeShields(c *fiber.Ctx) error

func ResponseTimeBadge

func ResponseTimeBadge(cfg *config.Config) fiber.Handler

ResponseTimeBadge handles the automatic generation of badge based on the group name and endpoint name passed.

Valid values for :duration -> 7d, 24h, 1h

func ResponseTimeChart

func ResponseTimeChart(c *fiber.Ctx) error

func SinglePageApplication

func SinglePageApplication(ui *ui.Config) fiber.Handler

func UptimeBadge

func UptimeBadge(c *fiber.Ctx) error

UptimeBadge handles the automatic generation of badge based on the group name and endpoint name passed.

Valid values for :duration -> 7d, 24h, 1h

Types

type API

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

func New

func New(cfg *config.Config) *API

func (*API) Router

func (a *API) Router() *fiber.App

type ConfigHandler

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

func (ConfigHandler) GetConfig

func (handler ConfigHandler) GetConfig(c *fiber.Ctx) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL