Diagnostics

Ping 

Bucket 

class couchbase.bucket.Bucket

ping(*opts, **kwargs) → PingResult

Performs a ping operation against the bucket.

The ping operation pings the services which are specified (or all services if none are specified). Returns a report which describes the outcome of the ping operations which were performed.

Parameters:: opts (PingOptions) – Optional parameters for this operation.
Returns:: A report which describes the outcome of the ping operations which were performed.
Return type:: PingResult

Cluster 

class couchbase.cluster.Cluster

ping(*opts, **kwargs) → PingResult

Performs a ping operation against the cluster.

The ping operation pings the services which are specified (or all services if none are specified). Returns a report which describes the outcome of the ping operations which were performed.

Parameters:: opts (PingOptions) – Optional parameters for this operation.
Returns:: A report which describes the outcome of the ping operations which were performed.
Return type:: PingResult

Options 

class couchbase.options.PingOptions(timeout=None, report_id=None, service_types=None)

Available options to for a ping operation.

Warning

Importing options from couchbase.collection is deprecated. All options should be imported from couchbase.options.

Parameters:

timeout (timedelta, optional) – The timeout for this operation. Defaults to global key-value operation timeout.
report_id (str, optional) – A unique identifier for the report generated by this operation.
(Iterable[class (service_types) – ~couchbase.diagnostics.ServiceType]): The services which should be pinged.

Results 

class couchbase.result.PingResult

property id: str

The unique identifier for this report.

Type:: str

property endpoints: Dict[str, Any]

A map of service endpoints and their ping status.

Type:: Dict[str, Any]

property sdk: str

The name of the SDK which generated this report.

Type:: str

property version: int

The version number of this report.

Type:: int

as_json() → str

Returns a JSON formatted diagnostics report.

Returns:: JSON formatted diagnostics report.
Return type:: str

Diagnostics 

Cluster 

class couchbase.cluster.Cluster

diagnostics(*opts, **kwargs) → DiagnosticsResult

Performs a diagnostic operation against the cluster.

The diagnostic operations returns a report about the current active connections with the cluster. Includes information about remote and local addresses, last activity, and other diagnostics information.

Parameters:: opts (DiagnosticsOptions) – Optional parameters for this operation.
Returns:: A report which describes current active connections with the cluster.
Return type:: DiagnosticsResult

Options 

class couchbase.options.DiagnosticsOptions(report_id=None)

Available options to for a diagnostics operation.

Warning

Importing options from couchbase.collection is deprecated. All options should be imported from couchbase.options.

Parameters:: report_id (str, optional) – A unique identifier for the report generated by this operation.

Results 

class couchbase.result.DiagnosticsResult

property id: str

The unique identifier for this report.

Type:: str

property endpoints: Dict[str, Any]

A map of service endpoints and their diagnostic status.

Type:: Dict[str, Any]

property state: ClusterState

The cluster state.

Type:: ClusterState

property sdk: str

The name of the SDK which generated this report.

Type:: str

property version: int

The version number of this report.

Type:: int

as_json() → str

Returns a JSON formatted diagnostics report.

Returns:: JSON formatted diagnostics report.
Return type:: str