Type alias HealthCheck

HealthCheck: {
    created_at: Timestamp;
    id: Id<"health_check">;
    initial_delay: number;
    interval: number;
    max_retries: number;
    path: string;
    port: number;
    protocol: "http";
    timeout: number;
}

Type declaration

  • created_at: Timestamp

    When the health check was created

  • id: Id<"health_check">

    The ID of health check

  • initial_delay: number

    How long we should wait when the container starts before performing the first health check. This is useful for containers that take a while to start up, for example when running migrations. This value is in seconds

  • interval: number

    Interval for health check. This is how often the health check will be performed in seconds

  • max_retries: number

    Maximum number of consecutive failures before the container is considered unhealthy

  • path: string
  • port: number
  • protocol: "http"

    Protocol for health check

  • timeout: number

    How long to wait for a response before considering the health check failed in milliseconds

Generated using TypeDoc