API docs by Redocly

App Services Metrics API (4.0)

Download OpenAPI specification:

License: Business Source License 1.1 (BSL)
⬆️ Manage App Services with the App Services API

Introduction

App Services manages access and synchronization between Couchbase Lite and Couchbase Capella. The App Services Metrics REST API returns App Services metrics, in Prometheus-compatible format, for performance monitoring and diagnostic purposes.

Prometheus

Endpoints for use with Prometheus

Get debugging and monitoring runtime stats in Prometheus Exposition format

Returns App Services statistics and other runtime variables in Prometheus Exposition format.

For detailed metrics descriptions, see Prometheus Metrics.

Responses

Response samples

Content type
# HELP go_gc_duration_seconds A summary of the wall-time pause (stop-the-world) duration in garbage collection cycles.
# TYPE go_gc_duration_seconds summary
go_gc_duration_seconds{quantile="0"} 3.2374e-05
go_gc_duration_seconds{quantile="0.25"} 3.6417e-05
go_gc_duration_seconds{quantile="0.5"} 7.9875e-05
go_gc_duration_seconds{quantile="0.75"} 0.000152499
go_gc_duration_seconds{quantile="1"} 0.001503708
go_gc_duration_seconds_sum 0.002018457
go_gc_duration_seconds_count 7
# HELP go_gc_gogc_percent Heap size target percentage configured by the user, otherwise 100. This value is set by the GOGC environment variable, and the runtime/debug.SetGCPercent function. Sourced from /gc/gogc:percent
# TYPE go_gc_gogc_percent gauge
go_gc_gogc_percent 100
...