Health Class Reference

Monitors the status of Appwrite's internal services. More...

#include <Health.hpp>

Collaboration diagram for Health:

Public Member Functions
std::string	getAntivirus ()
	Check Antivirus service status.
std::string	getCache ()
	Check cache service status.
std::string	getCertificate (const std::string &domain="")
	Get SSL certificate status for a domain.
std::string	getDB ()
	Check database service status.
std::string	getHealthStatus ()
	Check overall Appwrite health.
std::string	getPubSub ()
	Check pub/sub service status.
std::string	getQueue ()
	Check job queue service status.
std::string	getQueueBuilds (const std::string &threshold="")
	Get queued build jobs.
std::string	getQueueCertificates (const std::string &threshold="")
	Get queued certificate jobs.
std::string	getQueueFunctions (const std::string &threshold="")
	Get queued function executions.
std::string	getQueueMails (const std::string &domain="")
	Get queued emails.
std::string	getQueueMessaging (const std::string &threshold="")
	Get queued messaging jobs.
std::string	getQueueMigrations (const std::string &threshold="")
	Get queued database migrations.
std::string	getQueueUsageDump (const std::string &threshold="")
	Get queued usage dump jobs.
std::string	getQueueUsageWebhooks (const std::string &threshold="")
	Get queued usage webhook events.
std::string	getStorage ()
	Check storage service status.
std::string	getStorageLocal ()
	Check local storage service status.
std::string	getTime ()
	Get current server time.
	Health (const std::string &projectId, const std::string &apiKey)
	Constructor for Health class.

Detailed Description

Monitors the status of Appwrite's internal services.

Definition at line 16 of file Health.hpp.

Constructor & Destructor Documentation

Health()

Health::Health	(	const std::string &	projectId,
		const std::string &	apiKey
	)

Constructor for Health class.

Parameters

projectId	Appwrite project ID.
apiKey	Appwrite API key.

Member Function Documentation

getAntivirus()

std::string Health::getAntivirus

(

)

Check Antivirus service status.

Returns

JSON string with antivirus health.

getCache()

std::string Health::getCache

(

)

Check cache service status.

Returns

JSON string with cache health.

getCertificate()

std::string Health::getCertificate

(

const std::string &

domain = ""

)

Get SSL certificate status for a domain.

Parameters

domain

Domain name to check.

Returns

JSON string with certificate status.

getDB()

std::string Health::getDB

(

)

Check database service status.

Returns

JSON string with database health.

getHealthStatus()

std::string Health::getHealthStatus

(

)

Check overall Appwrite health.

Returns

JSON string with health status.

getPubSub()

std::string Health::getPubSub

(

)

Check pub/sub service status.

Returns

JSON string with pub/sub health.

getQueue()

std::string Health::getQueue

(

)

Check job queue service status.

Returns

JSON string with queue health.

getQueueBuilds()

std::string Health::getQueueBuilds

(

const std::string &

threshold = ""

)

Get queued build jobs.

Parameters

threshold

Optional threshold filter.

Returns

JSON string with build queue.

getQueueCertificates()

std::string Health::getQueueCertificates

(

const std::string &

threshold = ""

)

Get queued certificate jobs.

Parameters

threshold

Optional threshold filter.

Returns

JSON string with certificate queue.

getQueueFunctions()

std::string Health::getQueueFunctions

(

const std::string &

threshold = ""

)

Get queued function executions.

Parameters

threshold

Optional threshold filter.

Returns

JSON string with function queue.

getQueueMails()

std::string Health::getQueueMails

(

const std::string &

domain = ""

)

Get queued emails.

Parameters

domain

Optional domain to filter.

Returns

JSON string with email queue.

getQueueMessaging()

std::string Health::getQueueMessaging

(

const std::string &

threshold = ""

)

Get queued messaging jobs.

Parameters

threshold

Optional threshold filter.

Returns

JSON string with messaging queue.

getQueueMigrations()

std::string Health::getQueueMigrations

(

const std::string &

threshold = ""

)

Get queued database migrations.

Parameters

threshold

Optional threshold filter.

Returns

JSON string with migration queue.

getQueueUsageDump()

std::string Health::getQueueUsageDump

(

const std::string &

threshold = ""

)

Get queued usage dump jobs.

Parameters

threshold

Optional threshold filter.

Returns

JSON string with usage dump queue.

getQueueUsageWebhooks()

std::string Health::getQueueUsageWebhooks

(

const std::string &

threshold = ""

)

Get queued usage webhook events.

Parameters

threshold

Optional threshold filter.

Returns

JSON string with usage webhook queue.

getStorage()

std::string Health::getStorage

(

)

Check storage service status.

Returns

JSON string with storage health.

getStorageLocal()

std::string Health::getStorageLocal

(

)

Check local storage service status.

Returns

JSON string with local storage health.

getTime()

std::string Health::getTime

(

)

Get current server time.

Returns

JSON string with server time.

---

The documentation for this class was generated from the following file:

• Health.hpp