Skip to main content

Check and analyze a couchbase cluster in terms of cluster health,bucket,and replication

Project description

Couchbase Complete Snapshot

InsideCouchbase is a Python library that allows you to analyze and monitor the health of a Couchbase cluster. With InsideCouchbase, you can perform health checks on your Couchbase cluster, check for missing or corrupted data, analyze bucket usage, and monitor cluster settings.

Features

InsideCouchbase provides the following features:

  • Analyze bucket usage: You can analyze the usage of a bucket to see how much data it contains, how many items it has, and how much memory it is using.

  • Check cluster health: You can perform a health check on your Couchbase cluster to see if it is functioning properly.

  • Check replication status: You can check the replication status of a bucket to see if it is properly replicating data to other nodes.

  • Monitor cluster settings: You can monitor the settings of your Couchbase cluster to ensure that they are properly configured.

Getting Started

  1. Install the module
pip3 install insidecouchbase
  1. Create a simple python script/module to utilize library.
import couchbase

couchbaseInstance=couchbase.couchbaseNode('127.0.0.1','Administrator','test123')

Example results

+----+------------------+--------------------------------------------------+----------+--------------------------------------------------------------------------------------+
|    | code             | definition                                       | result   | Recommendation                                                                       |
|----+------------------+--------------------------------------------------+----------+--------------------------------------------------------------------------------------|
|  0 | configuration-01 | Data Memory Quota Configuration                  | ✔        | Data memory quota can not be greater than %70 of OS memory                           |
|  1 | configuration-02 | SWAP Configuration                               | ✘        | SWAP can not be used in production couchbase environments                            |
|  2 | configuration-03 | All Nodes are Using Same Couchbase Version       | ✘        | Different versions of couchbase can not be used inside the same cluster.             |
|  3 | configuration-04 | Cluster is Working Wtih MDS Model                | ✘        | 1 Couchbase node has to be use 1 service only.                                       |
|  4 | configuration-05 | Autofailover Enabled                             | ✘        | Autofailover needs to be enabled to achive better HA                                 |
|  5 | health-01        | All Nodes Up and Running                         | ✔        | All nodes have to be up and joined cluster.                                          |
|  6 | bucket-01        | All Buckets Have Resident Ratio Greater Than %50 | ✔        | Bucket resident ratio needs to be greater than %50                                   |
|  7 | bucket-02        | All Buckets Have At Least 1 Replica              | ✘        | All buckets must have at least one replica to prevent data loss in case of emergency |
|  8 | bucket-03        | All Buckets Have 1024 Primary Vbucket            | ✔        | All buckets must carry 1024 primary vbucket.                                         |
+----+------------------+--------------------------------------------------+----------+--------------------------------------------------------------------------------------+

Supported Couchbase Version

  • Couchbase 7.0.X
  • Couchbase 7.1.X

Contributing

If you would like to contribute to InsideCouchbase, please submit a pull request with your changes. Before submitting a pull request, please make sure that your changes are properly tested and documented.

License

InsideCouchbase is licensed under the MIT license. See the LICENSE file for more information.

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-2.1.0.tar.gz (19.7 kB view details)

Uploaded Source

Built Distribution

insidecouchbase-2.1.0-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for insidecouchbase-2.1.0.tar.gz
Algorithm Hash digest
SHA256 e5e408763d42a89b14452c54902d42dbaa3a06663a5fa9f02e7bd5f6758e2dcf
MD5 419c540d0be8e92be1d0cc84b38144fd
BLAKE2b-256 a80ce3892203e7f37efaa7d3868b53e6fce161e15936bd14b34f2cfab476c0fd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for insidecouchbase-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f8157f4057ffc0bfdf7d98f687e1e05dd497507339b47bbaa017efccbdcfc001
MD5 185184e5a9211e640cccac255c41e93e
BLAKE2b-256 ef4591680ee9060b9c7e01c2e44fedbffd8c0505a080e44ded9aa04771b13720

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