glatus - v1.0.0

glatus

Types

ConditionResult

</> 
pub type ConditionResult {
  ConditionResult(condition: String, success: Bool)
}

Constructors 

  • ConditionResult(condition: String, success: Bool)

Endpoint

</> 
pub type Endpoint {
  Endpoint(
    name: String,
    key: String,
    results: List(StatusResult),
    events: List(StatusEvent),
  )
}

Constructors 

  • Endpoint(
  name: String,
  key: String,
  results: List(StatusResult),
  events: List(StatusEvent),
)

    Arguments

    • events

      This field is not populated by the /api/v1/endpoints/statuses endpoint. It is populated by then /api/v1/endpoints/:key/statuses endpoint.

Error

</> 
pub type Error {
  UnexpectedResonse(status: Int, body: String)
  UnexpectedPayload(json.DecodeError)
}

Constructors 

  • UnexpectedResonse(status: Int, body: String)
  • UnexpectedPayload(json.DecodeError)

StatusEvent

</> 
pub type StatusEvent {
  StatusEvent(type_: StatusEventType, timestamp: String)
}

Constructors 

  • StatusEvent(type_: StatusEventType, timestamp: String)

StatusEventType

</> 
pub type StatusEventType {
  Start
  Healthly
  Unhealthly
}

Constructors 

  • Start
  • Healthly
  • Unhealthly

StatusResult

</>

This field is not populated by the /api/v1/endpoints/statuses endpoint. It is populated by then /api/v1/endpoints/:key/statuses endpoint.

pub type StatusResult {
  StatusResult(
    status: Int,
    hostname: String,
    duration: Int,
    condition_results: List(ConditionResult),
    success: Bool,
    timestamp: String,
  )
}

Constructors 

  • StatusResult(
  status: Int,
  hostname: String,
  duration: Int,
  condition_results: List(ConditionResult),
  success: Bool,
  timestamp: String,
)

Functions

decode_endpoint

</> 
pub fn decode_endpoint(
  data: Dynamic,
) -> Result(Endpoint, List(DecodeError))

decode_endpoints

</> 
pub fn decode_endpoints(
  data: Dynamic,
) -> Result(List(Endpoint), List(DecodeError))

Decode a list of Endpoints from Dynamic.

endpoint_request

</> 
pub fn endpoint_request(
  host host: String,
  endpoint_key key: String,
  page page: Int,
) -> Request(String)

Create a request to fetch the status information from a specific Endpoint.

Send this request with a HTTP client such as gleam_httpc or gleam_fetch and handle the result with the handle_endpoint_response function.

handle_endpoint_response

</> 
pub fn handle_endpoint_response(
  response: Response(String),
) -> Result(Endpoint, Error)

Check and decode a response from the /api/v1/endpoints/statuses endpoint.

handle_statuses_response

</> 
pub fn handle_statuses_response(
  response: Response(String),
) -> Result(List(Endpoint), Error)

Check and decode a response from the /api/v1/endpoints/statuses endpoint.

statuses_request

</> 
pub fn statuses_request(
  host host: String,
  page page: Int,
) -> Request(String)

Create a request to fetch a list of all Endpoints from a Gatus instance.

Send this request with a HTTP client such as gleam_httpc or gleam_fetch and handle the result with the handle_statuses_response function.

✨ Search Document