keyhole

README

Keyhole - Survey Your Mongo Land

Keyhole is a performance analytics tool, written in GO (Golang), to collect stats from MongoDB instances and to analyze performance of a MongoDB cluster. Golang was chosen to eliminate the needs to install an interpreter or software modules.

Blogs

Peek at your MongoDB Clusters like a Pro with Keyhole

• Part 1
• Part 2
• Part 3

Use Cases

With Keyhole, experienced users should be able to spot performance issues and to determine whether upgrades are needed quickly from a few minutes of testing and analyzing the results. Keyhole supports TLS/SSL connections.

Several features are available, and they are

• Write Throughputs Test measures the MongoDB performance by writing documents at a high rate to a MongoDB cluster.
• Load test extends the Write throughputs test by issuing different ops against a MongoDB cluster. Stats analytic is also provided
  • Memory: resident, virtual, and page faults
  • Executor and ops
  • Latency: read, write, and command
  • Metrics: index keys examined, collection scan, in-memory sort, and ops
  • WiredTiger analytic
• Customized load test with a sample document. Uses can load test using their own document format (see LOADTEST.md for details).
• Cluster Info and Sanity Check to display information of a cluster including stats to help determine working set data size.
• Display all indexes and their usages
• Duplicate all indexes to another MongoDB cluster.
• Seed data for demo and educational purposes as a trainer.
• Display average ops time and query patterns by parsing logs.
• Display indexes scores of a query shape.
• Monitor WiredTiger Cache in near real time.
• View FTDC Data and scores with a friendly interface.
• MongoDB Atlas API integration.

Refer to wiki for user's guide.

Build

You need go installed.

mkdir -p $GOPATH/src/github.com/simagix
cd $GOPATH/src/github.com/simagix
git clone --depth 1 https://github.com/simagix/keyhole.git
cd keyhole
./build.sh

Usage

keyhole --help

Unit Tests

./test.sh load

License

Apache-2.0 License

Disclaimer

This software is not supported by MongoDB, Inc. under any of their commercial support subscriptions or otherwise. Any usage of keyhole is at your own risk. Bug reports, feature requests and questions can be posted in the Issues section on GitHub.

Documentation

Index

• func Run(fullVersion string)
• type Comparison
  • func NewComparison(keyholeVersion string) *Comparison
  • func (p *Comparison) OutputBSON() error
  • func (p *Comparison) Run() error
  • func (p *Comparison) SetNoColor(nocolor bool)
  • func (p *Comparison) SetTLSCAFile(tlsCAFile string)
  • func (p *Comparison) SetTLSCertificateKeyFile(tlsCertificateKeyFile string)
  • func (p *Comparison) SetVerbose(verbose bool)

Functions

func Run

func Run(fullVersion string)

Run executes main()

Types

type Comparison

type Comparison struct {
	Logger      *mdb.Logger       `bson:"keyhole"`
	SourceStats *mdb.ClusterStats `bson:"source"`
	TargetStats *mdb.ClusterStats `bson:"target"`
	// contains filtered or unexported fields
}

Comparison contains parameters of comparison parameters

func NewComparison

func NewComparison(keyholeVersion string) *Comparison

NewComparison returns *Comparison

func (*Comparison) OutputBSON

func (p *Comparison) OutputBSON() error

OutputBSON writes bson data to a file

func (*Comparison) Run

func (p *Comparison) Run() error

Run executes migration commands

func (*Comparison) SetNoColor

func (p *Comparison) SetNoColor(nocolor bool)

SetNoColor set nocolor flag

func (*Comparison) SetTLSCAFile

func (p *Comparison) SetTLSCAFile(tlsCAFile string)

SetTLSCAFile sets cloneDataOnly

func (*Comparison) SetTLSCertificateKeyFile

func (p *Comparison) SetTLSCertificateKeyFile(tlsCertificateKeyFile string)

SetTLSCertificateKeyFile sets cloneDataOnly

func (*Comparison) SetVerbose

func (p *Comparison) SetVerbose(verbose bool)

SetVerbose sets verbose