# healthchecker

**Repository Path**: mirrors_couchbase/healthchecker

## Basic Information

- **Project Name**: healthchecker
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-05-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

HealthChecker
=============

We use this tool to collect cluster wide couchbase stats and generate health analysis report.

Build
-------

After you clone the project from `git://github.com/couchbase/healthchecker.git`, run the following command:

    config/autorun.sh

To build the package, run

    make bdist

Build on windows
-------

Make sure you install python and py2exe on your build machine

To build the pacakge, run

    make -f Makefile.mingw

Run command
------------

    cbhealthchecker CLUSTER USERNAME PASSWORD OPTIONS

CLUSTER:

  --cluster=HOST[:PORT] or -c HOST[:PORT] Default port is 8091

USERNAME:

  `-u USERNAME`, --user=USERNAME       admin username of the cluster

PASSWORD:

  `-p PASSWORD`, --password=PASSWORD   admin password of the cluster

OPTIONS:

  `-b BUCKETNAME`, --bucket=BUCKETNAME Specific bucket name. Default is all buckets

  `-i FILENAME`, --input=FILENAME      Construct report out of input JSON file

  `-o FILENAME`, --output=FILENAME     Default output filename is 'health_report.html

  `-d` --debug                         Show diagnosis information

  `-h` --help                          Show this help message and exit

  `-v` --verbose                       Display detailed node level information

  `-s SCALE`, --scale=SCALE            Specify stats scale, i.e. minute, hour, day, week, month and year
                                       Default scale is 'day'

  `-j` --jsononly                      Colllect data only but no analysis report generated