Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/appwrite/src/services/health.ts>Health

[READ-ONLY] Official Appwrite Deno SDK 🦕
appwrite/sdk-for-deno
Latest
class Health
extends Service
import { Health } from "https://deno.land/x/appwrite@12.1.0/src/services/health.ts";

Constructors

new
Health(client: Client)

Methods

get(): Promise<Models.HealthStatus>

Get HTTP

Check the Appwrite HTTP server is up and responsive.

getAntivirus(): Promise<Models.HealthAntivirus>

Get antivirus

Check the Appwrite Antivirus server is up and connection is successful.

getCache(): Promise<Models.HealthStatus>

Get cache

Check the Appwrite in-memory cache servers are up and connection is successful.

getCertificate(domain?: string): Promise<Models.HealthCertificate>

Get the SSL certificate for a domain

Get the SSL certificate for a domain

getDB(): Promise<Models.HealthStatus>

Get DB

Check the Appwrite database servers are up and connection is successful.

getFailedJobs(name: Name, threshold?: number): Promise<Models.HealthQueue>

Get number of failed queue jobs

Returns the amount of failed jobs in a given queue.

getPubSub(): Promise<Models.HealthStatus>

Get pubsub

Check the Appwrite pub-sub servers are up and connection is successful.

getQueue(): Promise<Models.HealthStatus>

Get queue

Check the Appwrite queue messaging servers are up and connection is successful.

getQueueBuilds(threshold?: number): Promise<Models.HealthQueue>

Get builds queue

Get the number of builds that are waiting to be processed in the Appwrite internal queue server.

getQueueCertificates(threshold?: number): Promise<Models.HealthQueue>

Get certificates queue

Get the number of certificates that are waiting to be issued against Letsencrypt in the Appwrite internal queue server.

getQueueDatabases(name?: string, threshold?: number): Promise<Models.HealthQueue>

Get databases queue

Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.

getQueueDeletes(threshold?: number): Promise<Models.HealthQueue>

Get deletes queue

Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.

getQueueFunctions(threshold?: number): Promise<Models.HealthQueue>

Get functions queue

Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.

getQueueLogs(threshold?: number): Promise<Models.HealthQueue>

Get logs queue

Get the number of logs that are waiting to be processed in the Appwrite internal queue server.

getQueueMails(threshold?: number): Promise<Models.HealthQueue>

Get mails queue

Get the number of mails that are waiting to be processed in the Appwrite internal queue server.

getQueueMessaging(threshold?: number): Promise<Models.HealthQueue>

Get messaging queue

Get the number of messages that are waiting to be processed in the Appwrite internal queue server.

getQueueMigrations(threshold?: number): Promise<Models.HealthQueue>

Get migrations queue

Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.

getQueueUsage(threshold?: number): Promise<Models.HealthQueue>

Get usage queue

Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.

getQueueUsageDump(threshold?: number): Promise<Models.HealthQueue>

Get usage dump queue

Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.

getQueueWebhooks(threshold?: number): Promise<Models.HealthQueue>

Get webhooks queue

Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.

getStorage(): Promise<Models.HealthStatus>

Get storage

Check the Appwrite storage device is up and connection is successful.

getStorageLocal(): Promise<Models.HealthStatus>

Get local storage

Check the Appwrite local storage device is up and connection is successful.

getTime(): Promise<Models.HealthTime>

Get time

Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The Network Time Protocol (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.