You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Returns OK status if API is available.
33
+
responses:
34
+
'200':
35
+
description: Returned status
36
+
content:
37
+
text/plain:
38
+
schema:
39
+
type: string
40
+
example: OK
41
+
tags:
42
+
- Server
43
+
operationId: get__ping
44
+
head:
45
+
responses:
46
+
'200':
47
+
description: Server is available
48
+
tags:
49
+
- Server
50
+
summary: Check if API is available
51
+
description: Returns OK status if API is available.
52
+
operationId: head__ping
53
+
/_metrics:
54
+
get: &ref_0
25
55
summary: Debugging/monitoring runtime stats in Prometheus Exposition format
26
56
description: |-
27
57
Returns Sync Gateway statistics and other runtime variables in Prometheus Exposition format.
@@ -40,7 +70,9 @@ paths:
40
70
type: string
41
71
tags:
42
72
- Prometheus
43
-
operationId: get__metrics
73
+
operationId: get_metrics
74
+
/metrics:
75
+
get: *ref_0
44
76
/_expvar:
45
77
get:
46
78
summary: Get all Sync Gateway statistics
@@ -61,7 +93,7 @@ paths:
61
93
application/javascript:
62
94
schema:
63
95
type: object
64
-
properties: &ref_0
96
+
properties: &ref_1
65
97
cmdline:
66
98
description: Built-in variables from the Go runtime, lists the command-line arguments
67
99
type: object
@@ -151,42 +183,72 @@ paths:
151
183
properties:
152
184
admin_net_bytes_recv:
153
185
type: integer
186
+
description: The total number of bytes received (since node start-up) on the network interface to which the Sync Gateway api.admin_interface is bound.
154
187
admin_net_bytes_sent:
155
188
type: integer
189
+
description: The total number of bytes sent (since node start-up) on the network interface to which the Sync Gateway api.admin_interface is bound.
156
190
error_count:
157
191
type: integer
192
+
description: The total number of errors logged.
158
193
go_memstats_heapalloc:
159
194
type: integer
195
+
description: HeapAlloc is bytes of allocated heap objects. Allocated heap objects include all reachable objects, as well as unreachable objects that the garbage collector has not yet freed. Specifically, HeapAlloc increases as heap objects are allocated and decreases as the heap is swept and unreachable objects are freed. Sweeping occurs incrementally between GC cycles, so these two processes occur simultaneously, and as a result HeapAlloc tends to change smoothly (in contrast with the sawtooth that is typical of stop-the-world garbage collectors).
160
196
go_memstats_heapidle:
161
197
type: integer
198
+
description: HeapIdle is bytes in idle (unused) spans. Idle spans have no objects in them. These spans could be (and may already have been) returned to the OS, or they can be reused for heap allocations, or they can be reused as stack memory. HeapIdle minus HeapReleased estimates the amount of memory that could be returned to the OS, but is being retained by the runtime so it can grow the heap without requesting more memory from the OS. If this difference is significantly larger than the heap size, it indicates there was a recent transient spike in live heap size.
162
199
go_memstats_heapinuse:
163
200
type: integer
201
+
description: HeapInuse is bytes in in-use spans. In-use spans have at least one object in them. These spans an only be used for other objects of roughly the same size. HeapInuse minus HeapAlloc estimates the amount of memory that has been dedicated to particular size classes, but is not currently being used. This is an upper bound on fragmentation, but in general this memory can be reused efficiently.
164
202
go_memstats_heapreleased:
165
203
type: integer
204
+
description: HeapReleased is bytes of physical memory returned to the OS. This counts heap memory from idle spans that was returned to the OS and has not yet been reacquired for the heap.
166
205
go_memstats_pausetotalns:
167
206
type: integer
207
+
description: PauseTotalNs is the cumulative nanoseconds in GC stop-the-world pauses since the program started. During a stop-the-world pause, all goroutines are paused and only the garbage collector can run.
168
208
go_memstats_stackinuse:
169
209
type: integer
210
+
description: StackInuse is bytes in stack spans. In-use stack spans have at least one stack in them. These spans can only be used for other stacks of the same size. There is no StackIdle because unused stack spans are returned to the heap (and hence counted toward HeapIdle).
170
211
go_memstats_stacksys:
171
212
type: integer
213
+
description: StackSys is bytes of stack memory obtained from the OS. StackSys is StackInuse, plus any memory obtained directly from the OS for OS thread stacks (which should be minimal).
172
214
go_memstats_sys:
173
215
type: integer
216
+
description: Sys is the total bytes of memory obtained from the OS. Sys is the sum of the XSys fields below. Sys measures the virtual address space reserved by the Go runtime for the heap, stacks, and other internal data structures. It's likely that not all of the virtual address space is backed by physical memory at any given moment, though in general it all was at some point.
174
217
goroutines_high_watermark:
175
218
type: integer
219
+
description: Peak number of go routines since process start.
176
220
num_goroutines:
177
221
type: integer
178
-
process_cpu_percent_utilization:
222
+
description: The total number of goroutines.
223
+
num_idle_kv_ops:
179
224
type: integer
225
+
description: The total number of idle kv operations.
226
+
process_cpu_percent_utilization:
227
+
type: number
228
+
format: float
229
+
description: The CPU utilization as percentage value * 10. The extra 10 multiplier is a mistake left for backwards compatibility. Please consider using node_cpu_percent_utilization as of version 3.2. The CPU usage calculation is performed based on user and system CPU time, but it does not include components such as iowait. The derivation means that the values of process_cpu_percent_utilization and %Cpu, returned when running the top command, will differ.
230
+
node_cpu_percent_utilization:
231
+
type: number
232
+
format: float
233
+
description: The node CPU utilization as percentage value, since the last time this stat was called. The CPU usage calculation is performed based on user and system CPU time, but it does not include components such as iowait.
180
234
process_memory_resident:
181
235
type: integer
236
+
description: The memory utilization (Resident Set Size) for the process, in bytes.
182
237
pub_net_bytes_recv:
183
238
type: integer
239
+
description: The total number of bytes received (since node start-up) on the network interface to which the Sync Gateway api.public_interface is bound. By default, that is the number of bytes received on 127.0.0.1:4984 since node start-up
184
240
pub_net_bytes_sent:
185
241
type: integer
242
+
description: The total number of bytes sent (since node start-up) on the network interface to which Sync Gateway api.public_interface is bound. By default, that is the number of bytes sent on 127.0.0.1:4984 since node start-up.
186
243
system_memory_total:
187
244
type: integer
245
+
description: The total memory available on the system in bytes.
188
246
warn_count:
189
247
type: integer
248
+
description: The total number of warnings logged.
249
+
uptime:
250
+
type: integer
251
+
description: The total uptime.
190
252
per_db:
191
253
description: |-
192
254
This array contains stats for all databases declared in the config file -- see the [Sync Gateway Statistics Schema](./../stats-monitoring.html) for more details on the metrics collected and reported by Sync Gateway.
description: Check if the server is online by checking the status code of response.
364
384
operationId: head_-
385
+
/_ping:
386
+
get:
387
+
summary: Check if API is available
388
+
description: Returns OK status if API is available.
389
+
responses:
390
+
'200':
391
+
description: Returned status
392
+
content:
393
+
text/plain:
394
+
schema:
395
+
type: string
396
+
example: OK
397
+
tags:
398
+
- Server
399
+
operationId: get__ping
400
+
head:
401
+
responses:
402
+
'200':
403
+
description: Server is available
404
+
tags:
405
+
- Server
406
+
summary: Check if API is available
407
+
description: Returns OK status if API is available.
408
+
operationId: head__ping
365
409
/{keyspace}/:
366
410
parameters:
367
411
- name: keyspace
@@ -414,7 +458,7 @@ paths:
414
458
type: string
415
459
_exp:
416
460
description: |-
417
-
Expiry time after which the document will be purged. The expiration time is set and managed on the Couchbase Server document. The value can be specified in two ways; in ISO-8601 format, for example the 6th of July 2022 at 17:00 in the BST timezone would be `2016-07-06T17:00:00+01:00`; it can also be specified as a numeric Couchbase Server expiry value. Couchbase Server expiries are specified as Unix time, and if the desired TTL is below 30 days then it can also represent an interval in seconds from the current time (for example, a value of 5 will remove the document 5 seconds after it is written to Couchbase Server). The document expiration time is returned in the response of `GET /{db}/{doc} ` when `show_exp=true` is included in the query.
461
+
Expiry time after which the document will be purged. The expiration time is set and managed on the Couchbase Server document. The value can be specified in two ways; in ISO-8601 format, for example the 6th of July 2022 at 17:00 in the BST timezone would be `2016-07-06T17:00:00+01:00`; it can also be specified as a numeric Couchbase Server expiry value. Couchbase Server expiry values are specified as Unix time, and if the desired TTL is below 30 days then it can also represent an interval in seconds from the current time (for example, a value of 5 will remove the document 5 seconds after it is written to Couchbase Server). The document expiration time is returned in the response of `GET /{db}/{doc} ` when `show_exp=true` is included in the query.
418
462
419
463
As with the existing explicit purge mechanism, this applies only to the local database; it has nothing to do with replication. This expiration time is not propagated when the document is replicated. The purge of the document does not cause it to be deleted on any other database.
420
464
type: string
@@ -2881,26 +2925,6 @@ paths:
2881
2925
tags:
2882
2926
- Replication
2883
2927
operationId: get_db-_blipsync
2884
-
tags:
2885
-
- name: Server
2886
-
description: Manage server activities
2887
-
- name: Database Management
2888
-
description: Create and manage Sync Gateway databases
2889
-
- name: Session
2890
-
description: Manage user sessions
2891
-
- name: Authentication
2892
-
description: Manage OpenID Connect Authentication
2893
-
- name: Document
2894
-
description: Create and manage documents
2895
-
- name: Document Attachment
2896
-
description: Create and manage document attachments
2897
-
- name: Replication
2898
-
description: Create and manage inter-Sync Gateway replications
2899
-
- name: Unsupported
2900
-
description: Endpoints that are not supported by Sync Gateway
0 commit comments