class Appwrite::Health

Public Instance Methods

get() click to toggle source

Check the Appwrite HTTP server is up and responsive.

@return [HealthStatus]

# File lib/appwrite/services/health.rb, line 10
def get()
    path = '/health'

    params = {
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::HealthStatus
    )
end
get_antivirus() click to toggle source

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

@return [HealthAntivirus]

# File lib/appwrite/services/health.rb, line 33
def get_antivirus()
    path = '/health/anti-virus'

    params = {
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::HealthAntivirus
    )
end
get_cache() click to toggle source

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

@return [HealthStatus]

# File lib/appwrite/services/health.rb, line 57
def get_cache()
    path = '/health/cache'

    params = {
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::HealthStatus
    )
end
get_db() click to toggle source

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

@return [HealthStatus]

# File lib/appwrite/services/health.rb, line 80
def get_db()
    path = '/health/db'

    params = {
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::HealthStatus
    )
end
get_queue_certificates() click to toggle source

Get the number of certificates that are waiting to be issued against [Letsencrypt](letsencrypt.org/) in the Appwrite internal queue server.

@return [HealthQueue]

# File lib/appwrite/services/health.rb, line 105
def get_queue_certificates()
    path = '/health/queue/certificates'

    params = {
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::HealthQueue
    )
end
get_queue_functions() click to toggle source

@return [HealthQueue]

# File lib/appwrite/services/health.rb, line 128
def get_queue_functions()
    path = '/health/queue/functions'

    params = {
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::HealthQueue
    )
end
get_queue_logs() click to toggle source

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

@return [HealthQueue]

# File lib/appwrite/services/health.rb, line 152
def get_queue_logs()
    path = '/health/queue/logs'

    params = {
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::HealthQueue
    )
end
get_queue_usage() click to toggle source

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

@return [HealthQueue]

# File lib/appwrite/services/health.rb, line 176
def get_queue_usage()
    path = '/health/queue/usage'

    params = {
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::HealthQueue
    )
end
get_queue_webhooks() click to toggle source

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

@return [HealthQueue]

# File lib/appwrite/services/health.rb, line 200
def get_queue_webhooks()
    path = '/health/queue/webhooks'

    params = {
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::HealthQueue
    )
end
get_storage_local() click to toggle source

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

@return [HealthStatus]

# File lib/appwrite/services/health.rb, line 223
def get_storage_local()
    path = '/health/storage/local'

    params = {
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::HealthStatus
    )
end
get_time() click to toggle source

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](en.wikipedia.org/wiki/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.

@return [HealthTime]

# File lib/appwrite/services/health.rb, line 252
def get_time()
    path = '/health/time'

    params = {
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::HealthTime
    )
end