Health class
The Health service allows you to both validate and monitor your Appwrite server's health.
Constructors
- Health.new(Client client)
Properties
Methods
-
get(
) → Future< HealthStatus> - Check the Appwrite HTTP server is up and responsive.
-
getAntivirus(
) → Future< HealthAntivirus> - Check the Appwrite Antivirus server is up and connection is successful.
-
getCache(
) → Future< HealthStatus> - Check the Appwrite in-memory cache servers are up and connection is successful.
-
getCertificate(
{String? domain}) → Future< HealthCertificate> - Get the SSL certificate for a domain
-
getDB(
) → Future< HealthStatus> - Check the Appwrite database servers are up and connection is successful.
-
getFailedJobs(
{required Name name, int? threshold}) → Future< HealthQueue> - Returns the amount of failed jobs in a given queue.
-
getPubSub(
) → Future< HealthStatus> - Check the Appwrite pub-sub servers are up and connection is successful.
-
getQueueBuilds(
{int? threshold}) → Future< HealthQueue> - Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
-
getQueueCertificates(
{int? threshold}) → Future< HealthQueue> - Get the number of certificates that are waiting to be issued against Letsencrypt in the Appwrite internal queue server.
-
getQueueDatabases(
{String? name, int? threshold}) → Future< HealthQueue> - Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.
-
getQueueDeletes(
{int? threshold}) → Future< HealthQueue> - Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.
-
getQueueFunctions(
{int? threshold}) → Future< HealthQueue> - Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.
-
getQueueLogs(
{int? threshold}) → Future< HealthQueue> - Get the number of logs that are waiting to be processed in the Appwrite internal queue server.
-
getQueueMails(
{int? threshold}) → Future< HealthQueue> - Get the number of mails that are waiting to be processed in the Appwrite internal queue server.
-
getQueueMessaging(
{int? threshold}) → Future< HealthQueue> - Get the number of messages that are waiting to be processed in the Appwrite internal queue server.
-
getQueueMigrations(
{int? threshold}) → Future< HealthQueue> - Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.
-
getQueueStatsResources(
{int? threshold}) → Future< HealthQueue> - Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
-
getQueueUsage(
{int? threshold}) → Future< HealthQueue> - Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
-
getQueueWebhooks(
{int? threshold}) → Future< HealthQueue> - Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
-
getStorage(
) → Future< HealthStatus> - Check the Appwrite storage device is up and connection is successful.
-
getStorageLocal(
) → Future< HealthStatus> - Check the Appwrite local storage device is up and connection is successful.
-
getTime(
) → Future< HealthTime> - 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.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited