Skip to main content

Couchbase checker

Project description

Couchbase Complete Snapshot

Couchbase complete snapshot is responsible for collecting metrics from a single cluster and evaluating the results according to the production best practices

Production Check List

Cluster Health Check List

Architecture

  • MDS model should be applied for better scaling and stability.
  • Couchbase version should be the same among the nodes in the cluster.

Buckets

  • Couchbase bucket should have at least 1 replica.
  • Couchbase bucket should have 1024 primary vbuckets.
  • A couchbase bucket's resident ratio needs to be high(It depends according to your bucket size, memory size etc..)

Settings

  • Auto failover configuration needs to be enabled.
  • Email alerts needs to be enabled.

XDCR Health Check List

  • XDCR cluster versions should be the with the production cluster.

Installation and Running

  1. Clone the repository
https://github.com/adiosamig/couchbase-complete-snapshot.git
  1. Run the following command in repo's directory.
python3 couchbase-snapshot.py 127.0.0.1 user_name password

Example results

----- Cluster Nodes -----
+----+-----------------+-----------------+---------------+-----------------+-----------------------+
|    | nodeIP          | clusterMember   | healtStatus   | services        | couchbaseVersion      |
|----+-----------------+-----------------+---------------+-----------------+-----------------------|
|  0 | 172.17.0.2:8091 | active          | healthy       | ['kv']          | 7.1.3-3479-enterprise |
|  1 | 172.17.0.3:8091 | active          | healthy       | ['kv']          | 7.1.3-3479-enterprise |
|  2 | 172.17.0.4:8091 | active          | healthy       | ['kv']          | 7.1.3-3479-enterprise |
|  3 | 172.17.0.5:8091 | active          | healthy       | ['index', 'kv'] | 7.1.3-3479-enterprise |
+----+-----------------+-----------------+---------------+-----------------+-----------------------+
----- Cluster Buckets -----
+----+--------------+-----------------------+--------------+------------------+-------------------------+-------------------+-----------------------+---------------------+
|    | bucketName   |   primaryVbucketCount | bucketType   |   bucketReplicas |   bucketQuotaPercentage |   bucketItemCount |   bucketResidentRatio |   bucketDisUsedInMb |
|----+--------------+-----------------------+--------------+------------------+-------------------------+-------------------+-----------------------+---------------------|
|  0 | beer-sample  |                  1024 | membase      |                1 |                     7.8 |              7303 |                   100 |                48.2 |
+----+--------------+-----------------------+--------------+------------------+-------------------------+-------------------+-----------------------+---------------------+
----- Cluster XDCR -----
+----+------------+--------------------+--------------+
|    | xdcrName   | xdcrConnectivity   | targetNode   |
|----+------------+--------------------+--------------|
|  0 | demo       | RC_OK              | 172.17.0.6   |
|  1 | demo_2     | RC_OK              | 172.17.0.7   |
+----+------------+--------------------+--------------+
----- Cluster Roles -----

----- Cluster Settings -----
+----+-----------------+----------+
|    | configName      |   status |
|----+-----------------+----------|
|  0 | autofailover    |     True |
|  1 | email-alerting  |    False |
|  2 | auto-compaction |       30 |
+----+-----------------+----------+
Good
----- Check Notes -----
+----+--------------------------------------------------------------------------------------------------------------------+-------------------+-------------------+
|    | problemStatement                                                                                                   | problemArea       | problemSeverity   |
|----+--------------------------------------------------------------------------------------------------------------------+-------------------+-------------------|
|  0 | XDCR and Production cluster versions are different                                                                 | 172.17.0.7 - XDCR | Critical          |
|  1 | The node has multiple couchbase services.For production MDS model should be followed.                              | 172.17.0.5:8091   | Medium            |
|  2 | Email alerts are disabled                                                                                          | Cluster           | Critical          |
|  3 | Default node exporter port can not be reached.If node exporter port is different from default ignore this problem. | Monitoring        | Medium            |
+----+--------------------------------------------------------------------------------------------------------------------+-------------------+-------------------+
----- Ping Test Results -----
+----+-----------------+-------------+---------------+
|    | nodeIp          | pingState   |   latency(us) |
|----+-----------------+-------------+---------------|
|  0 | 172.17.0.2:8091 | ok          |           615 |
|  1 | 172.17.0.3:8091 | ok          |           577 |
|  2 | 172.17.0.4:8091 | ok          |           550 |
|  3 | 172.17.0.5:8091 | ok          |           648 |
+----+-----------------+-------------+---------------+

Supported Couchbase Version

  • Couchbase 7.0.X
  • Couchbase 7.1.X

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

insidecouchbase-0.0.3.tar.gz (18.9 kB view details)

Uploaded Source

Built Distribution

insidecouchbase-0.0.3-py3-none-any.whl (17.7 kB view details)

Uploaded Python 3

File details

Details for the file insidecouchbase-0.0.3.tar.gz.

File metadata

  • Download URL: insidecouchbase-0.0.3.tar.gz
  • Upload date:
  • Size: 18.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for insidecouchbase-0.0.3.tar.gz
Algorithm Hash digest
SHA256 1816002d351666edd6ac7381b9023deecab7c0aff8aa8a28277ee613ebfd4d7f
MD5 a36e33dd2d0414cf8592c931e50521e3
BLAKE2b-256 7259cae481890e5c67504fe68ca7ea6071631b138d3cb747ac04dff13d27463e

See more details on using hashes here.

File details

Details for the file insidecouchbase-0.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for insidecouchbase-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ae439a446bbd7bbdcba59c058e296056801e652d270baf0e20e5308c54dcd291
MD5 ccd863778f021aebb41ad2f247bbf295
BLAKE2b-256 c3fd8551281a600875dfe947f34d0824158ca957f77b5f9cb5dfcb577bcf9ab0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page