Diagnostics
- class couchbase.diagnostics.ClusterState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
The state of the SDK’s connections, summed over the endpoints of a diagnostics report.
Onlinewhen every endpoint is connected,Offlinewhen none is, andDegradedotherwise.- Degraded = 'degraded'
- Offline = 'offline'
- Online = 'online'
- class couchbase.diagnostics.EndpointDiagnosticsReport(record: _EndpointDiagnosticsRecord)
One endpoint of a
DiagnosticsResult.- property last_activity: timedelta | None
The time since the endpoint last sent or received anything, if known.
Deprecated since version 4.0.0: Use
last_activity_usinstead.
- property last_activity_us: timedelta | None
The time since the endpoint last sent or received anything, if known.
- property service_type: ServiceType
The service the endpoint belongs to.
- property state: EndpointState
The state of the endpoint’s connection.
- property type: ServiceType
The service the endpoint belongs to.
Deprecated since version 4.0.0: Use
service_typeinstead.
- class couchbase.diagnostics.EndpointPingReport(record: _EndpointPingRecord)
One endpoint of a
PingResult.- property service_type: ServiceType
The service the endpoint belongs to.
- class couchbase.diagnostics.EndpointState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
The state of one endpoint’s connection, in a diagnostics report.
- Connected = 'connected'
- Connecting = 'connecting'
- Disconnected = 'disconnected'
- Disconnecting = 'disconnecting'
- class couchbase.diagnostics.PingState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
The outcome of pinging one endpoint.
- ERROR = 'error'
- OK = 'ok'
- TIMEOUT = 'timeout'
- class couchbase.diagnostics.ServiceType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
A Couchbase Server service, as an endpoint in a diagnostics or ping report names it.
- Analytics = 'analytics'
- Eventing = 'eventing'
- KeyValue = 'key_value'
- Management = 'management'
- Query = 'query'
- Search = 'search'
- View = 'view'