Google Git
Sign in
apache / cassandra-sidecar / 02cc6548f291528e9749a51d103463f9552f4b4e
commit02cc6548f291528e9749a51d103463f9552f4b4e[log] [tgz]
authorFrancisco Guerrero <francisco.guerrero@apple.com>Wed Nov 02 12:54:54 2022 -0700
committerYifan Cai <yifan_cai@apple.com>Fri Nov 18 10:16:17 2022 -0800
treedc8bdd297e479b5f51c2ba4487327a0030600e55
parent30c04eb38a796183643bdcbaff8f425d90ebf671 [diff]
CASSANDRASC-47: Introduce JMX foundation in Sidecar

In this commit, we introduce the JMX foundation in Sidecar to enable the ability to communicate
with the Cassandra process. This commit adds new configuration parameters to configure the
a `org.apache.cassandra.sidecar.common.JmxClient`. This client is available as part of the Cassandra
delegate.

A new interface is introduced and exposed through the `org.apache.cassandra.sidecar.common.ICassandraAdapter`.
The new interface `StorageOperations` is intended to interface with the Cassandra StorageService.
This commit provides an example implementation of the `takeSnapshot` method, which is also found
in the Cassandra code base. This should allow us to interact with the Cassandra process to create
snapshots.

A fix is required in the `CassandraSidecarDaemon` class, where the `healthCheck` runs the first time
only after the configured health check frequency (millis) has passed. This causes issues in the unit
tests as well as the actual execution of the service, as the `adapter` will be `null` until the first
health check is performed. To fix this issue, we perform a health check right after the server
successfully starts up.

Additional integration tests are added for testing the JMX integration with Cassandra. In the test,
we spin up a new Cassandra container using `testcontainers` and we perform validation against the
StorageService in Cassandra.

Co-authored-by: Doug Rohrer <drohrer@apple.com>

patch by Francisco Guerrero, Doug Rohrer; reviewed by Yifan Cai, Dinesh Joshi for CASSANDRASC-47
43 files changed
tree: dc8bdd297e479b5f51c2ba4487327a0030600e55
  1. .circleci/
  2. cassandra-integration-tests/
  3. cassandra40/
  4. common/
  5. docs/
  6. gradle/
  7. ide/
  8. src/
  9. .gitignore
  10. build.gradle
  11. CHANGES.txt
  12. checkstyle.xml
  13. CONTRIBUTING.md
  14. gradle.properties
  15. gradlew
  16. gradlew.bat
  17. LICENSE.txt
  18. README.md
  19. settings.gradle
  20. spotbugs-exclude.xml
README.md

Apache Cassandra Sidecar [WIP]

This is a Sidecar for the highly scalable Apache Cassandra database. For more information, see the Apache Cassandra web site and CIP-1.

This is project is still WIP.

Requirements

  1. Java >= 1.8 (OpenJDK or Oracle), or Java 11
  2. Apache Cassandra 4.0. We depend on virtual tables which is a 4.0 only feature.
  3. Docker for running integration tests.

Getting started: Running The Sidecar

After you clone the git repo, you can use the gradle wrapper to build and run the project. Make sure you have Apache Cassandra running on the host & port specified in conf/sidecar.yaml.

$ ./gradlew run

Configuring Cassandra Instance

While setting up cassandra instance, make sure the data directories of cassandra are in the path stored in sidecar.yaml file, else modify data directories path to point to the correct directories for stream APIs to work.

Testing

We rely on docker containers for integration tests.

The only requirement is to install and run Docker on your test machine.

CircleCI Testing

You will need to use the “Add Projects” function of CircleCI to set up CircleCI on your fork. When promoted to create a branch, do not replace the CircleCI config, choose the option to do it manually. CircleCI will pick up the in project configuration.

Contributing

We warmly welcome and appreciate contributions from the community. Please see CONTRIBUTING.md if you wish to submit pull requests.

Wondering where to go from here?