Class: Appwrite::Health

Inherits:
Service show all
Defined in:
lib/appwrite/services/health.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Health

Returns a new instance of Health.



6
7
8
 
# File 'lib/appwrite/services/health.rb', line 6

def initialize(client)
    @client = client
end

Instance Method Details

#get ⇒ HealthStatus

Check the Appwrite HTTP server is up and responsive.

Returns:

  • (HealthStatus) 


14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/appwrite/services/health.rb', line 14

def get()
    api_path = '/health'

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

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::HealthStatus
    )
end

#get_antivirus ⇒ HealthAntivirus

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

Returns:

  • (HealthAntivirus) 


38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/appwrite/services/health.rb', line 38

def get_antivirus()
    api_path = '/health/anti-virus'

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

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::HealthAntivirus
    )
end

#get_cache ⇒ HealthStatus

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

Returns:

  • (HealthStatus) 


63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/appwrite/services/health.rb', line 63

def get_cache()
    api_path = '/health/cache'

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

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::HealthStatus
    )
end

#get_db ⇒ HealthStatus

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

Returns:

  • (HealthStatus) 


87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/appwrite/services/health.rb', line 87

def get_db()
    api_path = '/health/db'

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

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::HealthStatus
    )
end

#get_pub_sub ⇒ HealthStatus

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

Returns:

  • (HealthStatus) 


111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/appwrite/services/health.rb', line 111

def get_pub_sub()
    api_path = '/health/pubsub'

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

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::HealthStatus
    )
end

#get_queue ⇒ HealthStatus

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

Returns:

  • (HealthStatus) 


136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/appwrite/services/health.rb', line 136

def get_queue()
    api_path = '/health/queue'

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

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::HealthStatus
    )
end

#get_queue_certificates ⇒ HealthQueue

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

Returns:

  • (HealthQueue) 


162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/appwrite/services/health.rb', line 162

def get_queue_certificates()
    api_path = '/health/queue/certificates'

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

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::HealthQueue
    )
end

#get_queue_functions ⇒ HealthQueue

Returns:

  • (HealthQueue) 


186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/appwrite/services/health.rb', line 186

def get_queue_functions()
    api_path = '/health/queue/functions'

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

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::HealthQueue
    )
end

#get_queue_logs ⇒ HealthQueue

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

Returns:

  • (HealthQueue) 


211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/appwrite/services/health.rb', line 211

def get_queue_logs()
    api_path = '/health/queue/logs'

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

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::HealthQueue
    )
end

#get_queue_webhooks ⇒ HealthQueue

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

Returns:

  • (HealthQueue) 


236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/appwrite/services/health.rb', line 236

def get_queue_webhooks()
    api_path = '/health/queue/webhooks'

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

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::HealthQueue
    )
end

#get_storage_local ⇒ HealthStatus

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

Returns:

  • (HealthStatus) 


260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/appwrite/services/health.rb', line 260

def get_storage_local()
    api_path = '/health/storage/local'

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

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::HealthStatus
    )
end

#get_time ⇒ 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.

Returns:

  • (HealthTime) 


290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/appwrite/services/health.rb', line 290

def get_time()
    api_path = '/health/time'

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

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