Documentation

Overview

    Package actuator provide the health check endpoint for web application

    Package controller provide the controller for health check

    Index

    Constants

    View Source
    const (
    	// Profile is the profile of actuator, it should be as same as the package name
    	Profile = "actuator"
    )

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    type Health

    type Health struct {
    	at.Schema `json:"-"`
    	Status    string `schema:"The status of health check" json:"status"`
    }

      Health is the health check struct

      type HealthService

      type HealthService interface {
      	Name() string
      	Status() bool
      }

        HealthService is the interface for health check