chrusty / ctop Goto Github PK

CTOP ("top" for Cassandra) - See what's going on in real-time

License: MIT License

Go 100.00%

ctop's Introduction

CTOP ("Top for Cassandra")

CTOP is a tool which allows you to quickly find out what's happening on a machine running Cassandra. It is particularly useful on a cluster with multiple-tenants, multiple-applications, and large numbers of tables. If you suspect that the performance is not good, then you can use this to figure out which table is giving you trouble.

Screenshots:

Installation (deb):

Download a DEB file from the releases section
Install mx4j "apt-get install libmx4j-java"
Install CTOP "dpkg -i ctop_1.3_amd64.deb"
Find out what's killing your Cassandra cluster

Installation (binary):

Download a binary (or compile one yourself)
Install mx4j jars in the java/cassandra classpath (download from here)
Re-start cassandra
Run CTOP

How to use it:

Run the binary
Allow CTOP some time to collect metrics, then press SPACE to refresh the display. You will see your tables listed by Reads/s (in descending order).
You can press SPACE at any time to refresh the display
The numbers 1 through 5 change the sorting order: 1: Order by Reads/s 2: Order by Writes/s 3: Order by the amount of disk-space used (in Bytes) 4: Order by read-latency (in miliseconds) 5: Order by write-latency (in miliseconds)
Pressing "Q" will quit
Metrics are for one node only (not cluster-wide)

Notes

CTOP should run on anything. Originally was developed on Ubuntu, and it's reported to run on CentOS and MacOS X.

Pre-requisites:

CTOP uses "libmx4j-java" (an HTTP -> JMX) to retrieve JMX metrics from Cassandra (there was no easy way to query JMX directly), so this needs to be in the class-path where Cassandra can find it upon startup (with Ubuntu it is enough to do "apt-get install libmx4j-java", then to re-start Cassandra).
Cassandra needs to be told how to run MX4J (the default is to listen to the interface that Cassandra listens on):

  MX4J_ADDRESS="-Dmx4jaddress=127.0.0.1"  
  MX4J_PORT="-Dmx4jport=8081"  
  JVM_OPTS="$JVM_OPTS $MX4J_ADDRESS"  
  JVM_OPTS="$JVM_OPTS $MX4J_PORT"

ctop's People

Contributors

Stargazers

Watchers

Forkers

imaxxs ulfbert-inc mgrennan leleueri bigdoggbaby75 infraio nilkonto gophersgang r4d1um phanirajl utf7

ctop's Issues

error in ctop "could not unmarshal the response! EOF"

Hello Team,

i have installed CTOP on ubuntu 14.04, from the released debian package ctop_1.3_amd64.deb.
In the logs i can see below error for all the metrics
Info: Getting metrics:LiveDiskSpaceUsed
debug: Got http resonse code (200)
Error: could not unmarshal the response! EOF

Seems there is code issue, Can you please resolve this.

This should probably have been written in Java

To query JMX directly (without having to use the HTTP bridge)

Cluster-wide statistics

Having written a similar tool (only focussed on the entire cluster), I have to ask if you're intending to expand the scope to look at more than just one system?

which cassandra version does ctop support

After I build ctop, and run it, I couldn't get the column family metrics.
Then, I review the source code, I found the mx4j http request is like below:
http://host:8081/getattribute?objectname=org.apache.cassandra.db:type=ColumnFamilies,keyspace=keyspac e1,columnfamily=standard1&attribute=ReadCount&format=long&template=identity

I copy the http url in browser, only
<?xml version="1.0" encoding="UTF-8"?>
retured.

I use cassandra 2.2.7, does it my cassandra version is too old?
Is the mx4j interface is changed?

I would very much appreciate any help or guidance you are able to give me.
thanks~

no data found

run ctop ok, but no data found

Changing ctop

Hi All,

I am trying to execute ctop and receive the following error:
Can't connect to stats-provider! (127.0.0.1)

I am running Ubuntu 13 and Cassandra version 1.2.19 and my Cassandra server is not listening on 127.0.0.1.
I have performed the steps as mentioned in the "Pre-requisites:" and "Installation (deb):"

-- Added the following to cassandra-env.sh
MX4J_ADDRESS="-Dmx4jaddress=127.0.0.1"  
MX4J_PORT="-Dmx4jport=8081"  
JVM_OPTS="$JVM_OPTS $MX4J_ADDRESS"  
JVM_OPTS="$JVM_OPTS $MX4J_PORT"

-- Executed the following  
apt-get install libmx4j-java
dpkg -i ctop_1.3_amd64.deb (after downloading ctop_1.3_amd64.deb from the provided link)
restarted cassandra

but it doesn't work and outputs the following: Can't connect to stats-provider! (127.0.0.1)

Any ideas how to get ctop working on my env?

Thanks,

Eyal.

Getting LOGS but NO Metrics

hi,

I have followed the document and the config seems to be correct.
I am able to get the logs for each read write and other stuff , but i am not able to get the metrics for any.

Thanks in advance.
Rohit

Any plans for releasing it with Jolokia support?

Hi,

I've noticed you have a branch for Jolokia support.

How is the status of this?

thanks!