This is an automated email from the ASF dual-hosted git repository. jasobrown pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/cassandra-sidecar.git
commit a15ed267d1977e38ba36d061139839fad7b865f2 Author: Dinesh Joshi <dinesh.jo...@apple.com> AuthorDate: Mon Feb 18 18:16:35 2019 -0800 C* Management process patch by Dinesh Joshi; reviewed by jasobrown and Chris Lohfink for CASSANDRA-14395 Co-authored-by: Vinay Chella <vinaykumar...@gmail.com> Co-authored-by: Joey Lynch <joe.e.ly...@gmail.com> --- .gitignore | 79 ++++++ CHANGES.txt | 3 + LICENSE.txt | 209 ++++++++++++++++ README.md | 29 +++ build.gradle | 117 +++++++++ conf/logback.xml | 76 ++++++ conf/sidecar.yaml | 13 + gradle/wrapper/gradle-wrapper.jar | Bin 0 -> 55190 bytes gradle/wrapper/gradle-wrapper.properties | 5 + gradlew | 172 +++++++++++++ gradlew.bat | 84 +++++++ ide/idea/codeStyleSettings.xml | 275 +++++++++++++++++++++ .../cassandra/sidecar/CassandraSidecarDaemon.java | 81 ++++++ .../apache/cassandra/sidecar/Configuration.java | 94 +++++++ .../org/apache/cassandra/sidecar/MainModule.java | 102 ++++++++ .../cassandra/sidecar/routes/HealthCheck.java | 122 +++++++++ .../cassandra/sidecar/routes/HealthService.java | 90 +++++++ .../cassandra/sidecar/HealthServiceTest.java | 105 ++++++++ .../org/apache/cassandra/sidecar/TestModule.java | 99 ++++++++ .../cassandra/sidecar/mocks/MockHealthCheck.java | 37 +++ 20 files changed, 1792 insertions(+) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d08471c --- /dev/null +++ b/.gitignore @@ -0,0 +1,79 @@ +.gitignore + +# C* +build/ +src/gen-java/ +src/resources/org/apache/cassandra/config/ +logs/ +data/ +conf/hotspot_compiler +doc/cql3/CQL.html + +# C* debs +build-stamp +build.properties +debian/cassandra*debhelper* +debian/cassandra*.substvars +debian/cassandra/ +debian/cassandra-tools/ +debian/files + +# gitignore doesn't help with modified files - you may wish to: +# git update-index --assume-unchanged test/data/serialization/2.0/db.RowMutation.bin +# to undo: +# git update-index --no-assume-unchanged test/data/serialization/2.0/db.RowMutation.bin + +# IntelliJ +.idea/ +*.eml +*.iml +*.ipr +*.iws + +# Eclipse +.classpath +.project +.metadata +.settings/ +local.properties + +# Cscope +cscope.* + +# NetBeans +nbbuild/ +nbdist/ +nbproject/ +nb-configuration.xml +nbactions.xml + +# Maven, etc. +out/ +target/ + +# General +*.pyc +*~ +*.bak +*.sw[o,p] +*.tmp +.DS_Store +Thumbs.db + +# JSR223 +lib/jsr223/clojure/*.jar +lib/jsr223/groovy/*.jar +lib/jsr223/jaskell/*.jar +lib/jsr223/jruby/*.jar +lib/jsr223/jruby/jni +lib/jsr223/jruby/ruby +lib/jsr223/jython/*.jar +lib/jsr223/jython/cachedir +lib/jsr223/scala/*.jar + +/.ant-targets-build.xml + +# Generated files from the documentation +doc/source/configuration/cassandra_config_file.rst +doc/source/tools/nodetool + diff --git a/CHANGES.txt b/CHANGES.txt new file mode 100644 index 0000000..0253303 --- /dev/null +++ b/CHANGES.txt @@ -0,0 +1,3 @@ +1.0.0 +----- + * C* Management process (CASSANDRA-14395) diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..d5c4984 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,209 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + +THIRD-PARTY DEPENDENCIES +======================== +Convenience copies of some third-party dependencies are distributed with +Apache Cassandra as Java jar files in lib/. Licensing information for +these files can be found in the lib/licenses directory. diff --git a/README.md b/README.md new file mode 100644 index 0000000..da3ce7c --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Apache Cassandra Sidecar [WIP] + +This is a Sidecar for the highly scalable Apache Cassandra database. +For more information, see [the Apache Cassandra web site](http://cassandra.apache.org/) and [CIP-1](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=95652224). + +**This is project is still WIP.** + +Requirements +------------ + 1. Java >= 1.8 (OpenJDK or Oracle) + 2. Apache Cassandra 4.0 + +Getting started +--------------- + +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 + +You can use `build`, `test` to build & test the project. + +Wondering where to go from here? +-------------------------------- + * Join us in #cassandra on irc.freenode.net and ask questions + * Subscribe to the Users mailing list by sending a mail to + user-subscr...@cassandra.apache.org + * Visit the [community section](http://cassandra.apache.org/community/) of the Cassandra website for more information on getting involved. + * Visit the [development section](http://cassandra.apache.org/doc/latest/development/index.html) of the Cassandra website for more information on how to contribute. \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..b7659a8 --- /dev/null +++ b/build.gradle @@ -0,0 +1,117 @@ +group 'org.apache.cassandra' +version '1.0-SNAPSHOT' + +apply plugin: 'java' +apply plugin: 'application' +apply plugin: 'idea' + +sourceCompatibility = 1.8 + +repositories { + mavenCentral() +} + +// Take the application out once we're running via Cassandra +mainClassName = "org.apache.cassandra.sidecar.CassandraSidecarDaemon" +applicationName = 'CassandraSidecarDaemon' + +// Config file location should be in file:/// format for local files, +// when we have the fix for adding /conf directory to classpaht, we can get away with below default JvmArg +def confFile = "file:" + File.separator + File.separator + "APP_HOME_TO_REPLACE/conf/sidecar.yaml" + +applicationDefaultJvmArgs = ["-Dsidecar.logdir=./logs", + "-Dsidecar.config=" + confFile, + "-Dvertx.logger-delegate-factory-class-name=io.vertx.core.logging.SLF4JLogDelegateFactory", + "-javaagent:APP_HOME_TO_REPLACE/agents/jolokia-jvm-1.6.0-agent.jar=port=7777,host=localhost"] +startScripts { + doLast { + unixScript.text = unixScript.text.replace("APP_HOME_TO_REPLACE", "\${APP_HOME}") + } +} + +run { + confFile = "file:" + File.separator + File.separator + "$projectDir/conf/sidecar.yaml" + jvmArgs = ["-Dsidecar.logdir=./logs", + "-Dsidecar.config=" + confFile, + "-Dvertx.logger-delegate-factory-class-name=io.vertx.core.logging.SLF4JLogDelegateFactory", + "-javaagent:$projectDir/src/dist/agents/jolokia-jvm-1.6.0-agent.jar=port=7777,host=localhost"] +} + +sourceSets { + // This is needed as gradle considers `src/main/resources` as the default resources folder + main { + resources { + srcDirs = ['conf', 'setup'] + } + } + test { + resources { + srcDirs = [main.resources] + } + } +} + +configurations { + jolokia +} + +dependencies { + compile 'io.vertx:vertx-web:3.6.3' + compile 'io.vertx:vertx-dropwizard-metrics:3.6.3' + compile 'io.vertx:vertx-web-client:3.6.3' + + // Trying to be exactly compatible with Cassandra's deps + compile 'org.slf4j:slf4j-api:1.7.25' + compile 'ch.qos.logback:logback-core:1.2.3' + compile 'ch.qos.logback:logback-classic:1.2.3' + compile 'com.datastax.cassandra:cassandra-driver-core:3.6+' + compile group: 'com.google.inject', name: 'guice', version: '4.2.2' + compile group: 'org.apache.commons', name: 'commons-configuration2', version: '2.4' + + runtime group: 'commons-beanutils', name: 'commons-beanutils', version: '1.9.3' + runtime group: 'org.yaml', name: 'snakeyaml', version: '1.23' + jolokia 'org.jolokia:jolokia-jvm:1.6.0:agent' + + testCompile group: 'org.cassandraunit', name: 'cassandra-unit-shaded', version: '3.3.0.2' + testCompile 'com.datastax.cassandra:cassandra-driver-core:3.6+:tests' + testCompile 'org.apache.commons:commons-exec:1.3+' + testCompile group: 'org.mockito', name: 'mockito-all', version: '1.10.19' + testCompile group: 'io.vertx', name: 'vertx-junit5', version: '3.6.3' +} + +task copyCodeStyle(type: Copy) { + from "ide/idea/codeStyleSettings.xml" + into ".idea" +} + +// Lets copy the distributions from build/install directory to /bin and /lib +// directories to be aligned with C* distribution format +task copyDist(type: Copy) { + from "$buildDir/install/$applicationName" + into "$projectDir" +} + +task copyJolokia(type: Copy) { + from configurations.jolokia + into "$projectDir/src/dist/agents" +} + +// Lets clean /bin and /lib directories along with default build directories. +clean { + println "Deleting directory $projectDir/bin" + delete "$projectDir/bin" + println "Deleting directory $projectDir/lib" + delete "$projectDir/lib" + println "Deleting agents $projectDir/src/dist/agents" + delete "$projectDir/src/dist/agents" + +} + +test { + useJUnitPlatform() +} + +// copyDist gets called on every build +copyDist.dependsOn installDist +build.dependsOn copyDist +build.dependsOn copyJolokia diff --git a/conf/logback.xml b/conf/logback.xml new file mode 100644 index 0000000..bd0e398 --- /dev/null +++ b/conf/logback.xml @@ -0,0 +1,76 @@ +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, software + ~ distributed under the License is distributed on an "AS IS" BASIS, + ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + ~ See the License for the specific language governing permissions and + ~ limitations under the License. + --> + +<configuration scan="true" scanPeriod="60 seconds"> + <jmxConfigurator /> + + <appender name="SIDECAR" class="ch.qos.logback.core.rolling.RollingFileAppender"> + <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> + <level>INFO</level> + </filter> + <file>${sidecar.logdir}/system.log</file> + <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> + <!-- rollover daily --> + <fileNamePattern>${sidecar.logdir}/system.log.%d{yyyy-MM-dd}.%i.zip</fileNamePattern> + <!-- each file should be at most 10MB, keep 3 days worth of history, but at most 5GB --> + <maxFileSize>10MB</maxFileSize> + <maxHistory>3</maxHistory> + <totalSizeCap>2GB</totalSizeCap> + </rollingPolicy> + <encoder> + <pattern>%-5level [%thread] %date{ISO8601} %F:%L - %msg%n</pattern> + </encoder> + </appender> + + <!-- DEBUGLOG rolling file appender to debug.log (all levels) --> + + <appender name="SIDECAR_DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender"> + <file>${sidecar.logdir}/debug.log</file> + <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> + <level>INFO</level> + </filter> + <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> + <!-- rollover daily --> + <fileNamePattern>${sidecar.logdir}/debug.log.%d{yyyy-MM-dd}.%i.zip</fileNamePattern> + <!-- each file should be at most 20MB, keep 3 days worth of history, but at most 5GB --> + <maxFileSize>20MB</maxFileSize> + <maxHistory>3</maxHistory> + <totalSizeCap>5GB</totalSizeCap> + </rollingPolicy> + <encoder> + <pattern>%-5level [%thread] %date{ISO8601} %F:%L - %msg%n</pattern> + </encoder> + </appender> + + <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> + <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> + <level>DEBUG</level> + </filter> + <encoder> + <pattern>%-5level [%thread] %date{ISO8601} %F:%L - %msg%n</pattern> + </encoder> + </appender> + + <root level="INFO"> + <appender-ref ref="SIDECAR" /> + <appender-ref ref="SIDECAR_DEBUG" /> + <appender-ref ref="STDOUT" /> + </root> + + <logger name="org.apache.cassandra" level="DEBUG"/> +</configuration> diff --git a/conf/sidecar.yaml b/conf/sidecar.yaml new file mode 100644 index 0000000..8ffbcc6 --- /dev/null +++ b/conf/sidecar.yaml @@ -0,0 +1,13 @@ +# +# Cassandra SideCar configuration file +# + +cassandra: + - host: localhost + - port: 9042 + +sidecar: + - port: 9043 + +healthcheck: + - poll_freq_millis: 30000 \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..87b738c Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..44e7c4d --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..af6708f --- /dev/null +++ b/gradlew @@ -0,0 +1,172 @@ +#!/usr/bin/env sh + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..0f8d593 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,84 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/ide/idea/codeStyleSettings.xml b/ide/idea/codeStyleSettings.xml new file mode 100644 index 0000000..d9190a7 --- /dev/null +++ b/ide/idea/codeStyleSettings.xml @@ -0,0 +1,275 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project version="4"> + <component name="ProjectCodeStyleSettingsManager"> + <option name="PER_PROJECT_SETTINGS"> + <value> + <option name="INSERT_OVERRIDE_ANNOTATION" value="false" /> + <option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="100" /> + <option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="100" /> + <option name="IMPORT_LAYOUT_TABLE"> + <value> + <package name="java" withSubpackages="true" static="false" /> + <package name="javax" withSubpackages="true" static="false" /> + <emptyLine /> + <package name="com.google.common" withSubpackages="true" static="false" /> + <package name="org.apache.log4j" withSubpackages="true" static="false" /> + <package name="org.apache.commons" withSubpackages="true" static="false" /> + <package name="org.cliffc.high_scale_lib" withSubpackages="true" static="false" /> + <package name="org.junit" withSubpackages="true" static="false" /> + <package name="org.slf4j" withSubpackages="true" static="false" /> + <emptyLine /> + <package name="" withSubpackages="true" static="false" /> + <emptyLine /> + <package name="" withSubpackages="true" static="true" /> + </value> + </option> + <option name="BRACE_STYLE" value="2" /> + <option name="CLASS_BRACE_STYLE" value="2" /> + <option name="METHOD_BRACE_STYLE" value="2" /> + <option name="ELSE_ON_NEW_LINE" value="true" /> + <option name="CATCH_ON_NEW_LINE" value="true" /> + <option name="FINALLY_ON_NEW_LINE" value="true" /> + <option name="ALIGN_MULTILINE_PARAMETERS_IN_CALLS" value="true" /> + <option name="ALIGN_MULTILINE_BINARY_OPERATION" value="true" /> + <option name="ALIGN_MULTILINE_ASSIGNMENT" value="true" /> + <option name="ALIGN_MULTILINE_TERNARY_OPERATION" value="true" /> + <option name="ALIGN_MULTILINE_THROWS_LIST" value="true" /> + <option name="ALIGN_MULTILINE_EXTENDS_LIST" value="true" /> + <option name="ALIGN_MULTILINE_PARENTHESIZED_EXPRESSION" value="true" /> + <option name="ALIGN_MULTILINE_ARRAY_INITIALIZER_EXPRESSION" value="true" /> + <option name="SPACE_WITHIN_ARRAY_INITIALIZER_BRACES" value="true" /> + <option name="DOWHILE_BRACE_FORCE" value="3" /> + <XML> + <option name="XML_LEGACY_SETTINGS_IMPORTED" value="true" /> + </XML> + <codeStyleSettings language="JAVA"> + <option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="0" /> + <option name="BRACE_STYLE" value="2" /> + <option name="CLASS_BRACE_STYLE" value="2" /> + <option name="METHOD_BRACE_STYLE" value="2" /> + <option name="ELSE_ON_NEW_LINE" value="true" /> + <option name="CATCH_ON_NEW_LINE" value="true" /> + <option name="FINALLY_ON_NEW_LINE" value="true" /> + <option name="ALIGN_MULTILINE_CHAINED_METHODS" value="true" /> + <option name="ALIGN_MULTILINE_PARAMETERS_IN_CALLS" value="true" /> + <option name="ALIGN_MULTILINE_BINARY_OPERATION" value="true" /> + <option name="ALIGN_MULTILINE_ASSIGNMENT" value="true" /> + <option name="ALIGN_MULTILINE_TERNARY_OPERATION" value="true" /> + <option name="ALIGN_MULTILINE_THROWS_LIST" value="true" /> + <option name="ALIGN_THROWS_KEYWORD" value="true" /> + <option name="ALIGN_MULTILINE_EXTENDS_LIST" value="true" /> + <option name="ALIGN_MULTILINE_PARENTHESIZED_EXPRESSION" value="true" /> + <option name="ALIGN_MULTILINE_ARRAY_INITIALIZER_EXPRESSION" value="true" /> + <option name="SPACE_WITHIN_ARRAY_INITIALIZER_BRACES" value="true" /> + <option name="DOWHILE_BRACE_FORCE" value="3" /> + <option name="PARENT_SETTINGS_INSTALLED" value="true" /> + <indentOptions> + <option name="CONTINUATION_INDENT_SIZE" value="0" /> + <option name="USE_RELATIVE_INDENTS" value="true" /> + </indentOptions> + <arrangement> + <groups> + <group> + <type>GETTERS_AND_SETTERS</type> + <order>KEEP</order> + </group> + </groups> + <rules> + <rule> + <match> + <AND> + <FIELD /> + <FINAL /> + <PUBLIC /> + <STATIC /> + </AND> + </match> + </rule> + <rule> + <match> + <AND> + <FIELD /> + <FINAL /> + <PROTECTED /> + <STATIC /> + </AND> + </match> + </rule> + <rule> + <match> + <AND> + <FIELD /> + <FINAL /> + <PACKAGE_PRIVATE /> + <STATIC /> + </AND> + </match> + </rule> + <rule> + <match> + <AND> + <FIELD /> + <FINAL /> + <PRIVATE /> + <STATIC /> + </AND> + </match> + </rule> + <rule> + <match> + <AND> + <FIELD /> + <PUBLIC /> + <STATIC /> + </AND> + </match> + </rule> + <rule> + <match> + <AND> + <FIELD /> + <PROTECTED /> + <STATIC /> + </AND> + </match> + </rule> + <rule> + <match> + <AND> + <FIELD /> + <PACKAGE_PRIVATE /> + <STATIC /> + </AND> + </match> + </rule> + <rule> + <match> + <AND> + <FIELD /> + <PRIVATE /> + <STATIC /> + </AND> + </match> + </rule> + <rule> + <match> + <AND> + <FIELD /> + <FINAL /> + <PUBLIC /> + </AND> + </match> + </rule> + <rule> + <match> + <AND> + <FIELD /> + <FINAL /> + <PROTECTED /> + </AND> + </match> + </rule> + <rule> + <match> + <AND> + <FIELD /> + <FINAL /> + <PACKAGE_PRIVATE /> + </AND> + </match> + </rule> + <rule> + <match> + <AND> + <FIELD /> + <FINAL /> + <PRIVATE /> + </AND> + </match> + </rule> + <rule> + <match> + <AND> + <FIELD /> + <PUBLIC /> + </AND> + </match> + </rule> + <rule> + <match> + <AND> + <FIELD /> + <PROTECTED /> + </AND> + </match> + </rule> + <rule> + <match> + <AND> + <FIELD /> + <PACKAGE_PRIVATE /> + </AND> + </match> + </rule> + <rule> + <match> + <AND> + <FIELD /> + <PRIVATE /> + </AND> + </match> + </rule> + <rule> + <match> + <FIELD /> + </match> + </rule> + <rule> + <match> + <CONSTRUCTOR /> + </match> + </rule> + <rule> + <match> + <AND> + <METHOD /> + <STATIC /> + </AND> + </match> + </rule> + <rule> + <match> + <METHOD /> + </match> + </rule> + <rule> + <match> + <ENUM /> + </match> + </rule> + <rule> + <match> + <INTERFACE /> + </match> + </rule> + <rule> + <match> + <AND> + <CLASS /> + <STATIC /> + </AND> + </match> + </rule> + <rule> + <match> + <CLASS /> + </match> + </rule> + </rules> + </arrangement> + </codeStyleSettings> + </value> + </option> + <option name="USE_PER_PROJECT_SETTINGS" value="true" /> + </component> +</project> \ No newline at end of file diff --git a/src/main/java/org/apache/cassandra/sidecar/CassandraSidecarDaemon.java b/src/main/java/org/apache/cassandra/sidecar/CassandraSidecarDaemon.java new file mode 100644 index 0000000..6ab682b --- /dev/null +++ b/src/main/java/org/apache/cassandra/sidecar/CassandraSidecarDaemon.java @@ -0,0 +1,81 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.cassandra.sidecar; + +import com.google.inject.Guice; +import com.google.inject.Inject; +import io.vertx.core.http.HttpServer; +import org.apache.cassandra.sidecar.routes.HealthService; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + + +public class CassandraSidecarDaemon +{ + private static final Logger logger = LoggerFactory.getLogger(CassandraSidecarDaemon.class); + private final HealthService healthService; + private final HttpServer server; + private final Configuration config; + + @Inject + public CassandraSidecarDaemon(HealthService healthService, HttpServer server, Configuration config) + { + this.healthService = healthService; + this.server = server; + this.config = config; + } + + public void start() + { + banner(); + logger.info("Starting Cassandra Sidecar on port {}", config.getPort()); + healthService.start(); + server.listen(); + } + + public void stop() + { + logger.info("Stopping Cassandra Sidecar"); + healthService.stop(); + server.close(); + } + + private void banner() + { + System.out.println(" _____ _ _____ _ _ \n" + + "/ __ \\ | | / ___(_) | | \n" + + "| / \\/ __ _ ___ ___ __ _ _ __ __| |_ __ __ _ \\ `--. _ __| | ___ ___ __ _ _ __ \n" + + "| | / _` / __/ __|/ _` | '_ \\ / _` | '__/ _` | `--. \\ |/ _` |/ _ \\/ __/ _` | '__|\n" + + "| \\__/\\ (_| \\__ \\__ \\ (_| | | | | (_| | | | (_| | /\\__/ / | (_| | __/ (_| (_| | | \n" + + " \\____/\\__,_|___/___/\\__,_|_| |_|\\__,_|_| \\__,_| \\____/|_|\\__,_|\\___|\\___\\__,_|_| \n" + + " \n" + + " "); + } + + public static void main(String[] args) + { + CassandraSidecarDaemon app = Guice.createInjector(new MainModule()) + .getInstance(CassandraSidecarDaemon.class); + + app.start(); + Runtime.getRuntime().addShutdownHook(new Thread(app::stop)); + } +} + diff --git a/src/main/java/org/apache/cassandra/sidecar/Configuration.java b/src/main/java/org/apache/cassandra/sidecar/Configuration.java new file mode 100644 index 0000000..8086164 --- /dev/null +++ b/src/main/java/org/apache/cassandra/sidecar/Configuration.java @@ -0,0 +1,94 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.cassandra.sidecar; + +/** + * Sidecar configuration + */ +public class Configuration +{ + /* Cassandra Host */ + private final String cassandraHost; + + /* Cassandra Port */ + private final Integer cassandraPort; + + /* Sidecar's HTTP REST API port */ + private final Integer port; + + /* Healthcheck frequency in miilis */ + private final Integer healthCheckFrequencyMillis; + + /** + * Constructor + * + * @param cassandraHost + * @param cassandraPort + * @param port + * @param healthCheckFrequencyMillis + */ + public Configuration(String cassandraHost, Integer cassandraPort, Integer port, + Integer healthCheckFrequencyMillis) + { + this.cassandraHost = cassandraHost; + this.cassandraPort = cassandraPort; + this.port = port; + this.healthCheckFrequencyMillis = healthCheckFrequencyMillis; + } + + /** + * Get the Cassandra host + * + * @return + */ + public String getCassandraHost() + { + return cassandraHost; + } + + /** + * Get the Cassandra port + * + * @return + */ + public Integer getCassandraPort() + { + return cassandraPort; + } + + /** + * Get the Sidecar's REST HTTP API port + * + * @return + */ + public Integer getPort() + { + return port; + } + + /** + * Get the health check frequency in millis + * + * @return + */ + public Integer getHealthCheckFrequencyMillis() + { + return healthCheckFrequencyMillis; + } +} diff --git a/src/main/java/org/apache/cassandra/sidecar/MainModule.java b/src/main/java/org/apache/cassandra/sidecar/MainModule.java new file mode 100644 index 0000000..a6950a7 --- /dev/null +++ b/src/main/java/org/apache/cassandra/sidecar/MainModule.java @@ -0,0 +1,102 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.cassandra.sidecar; + +import com.google.inject.AbstractModule; +import com.google.inject.Provides; +import com.google.inject.Singleton; +import io.vertx.core.Vertx; +import io.vertx.core.VertxOptions; +import io.vertx.core.http.HttpServer; +import io.vertx.core.http.HttpServerOptions; +import io.vertx.ext.dropwizard.DropwizardMetricsOptions; +import io.vertx.ext.web.Router; +import io.vertx.ext.web.handler.LoggerHandler; +import org.apache.cassandra.sidecar.routes.HealthCheck; +import org.apache.cassandra.sidecar.routes.HealthService; +import org.apache.commons.configuration2.YAMLConfiguration; +import org.apache.commons.configuration2.builder.fluent.Configurations; +import org.apache.commons.configuration2.ex.ConfigurationException; + +import java.io.File; + +public class MainModule extends AbstractModule +{ + @Override + protected void configure() + { + bind(CassandraSidecarDaemon.class).in(Singleton.class); + } + + @Provides + @Singleton + public Vertx getVertx() + { + return Vertx.vertx(new VertxOptions().setMetricsOptions( + new DropwizardMetricsOptions() + .setEnabled(true) + .setJmxEnabled(true) + .setJmxDomain("cassandra-sidecar-metrics") + )); + } + + @Provides + @Singleton + public HealthService healthService(Configuration config) + { + return new HealthService(config.getHealthCheckFrequencyMillis(), + new HealthCheck(config.getCassandraHost(), config.getCassandraPort())); + } + + @Provides + @Singleton + public HttpServer vertxServer(Vertx vertx, Configuration config, Router router) + { + HttpServer server = vertx.createHttpServer(new HttpServerOptions() + .setPort(config.getPort()) + .setLogActivity(true)); + server.requestHandler(router); + return server; + } + + @Provides + @Singleton + public Router vertxRouter(Vertx vertx, HealthService healthService) + { + Router router = Router.router(vertx); + router.route().handler(LoggerHandler.create()); + router.route().path("/api/v1/__health").handler(healthService::handleHealth); + return router; + } + + @Provides + @Singleton + public Configuration configuration() throws ConfigurationException + { + Configurations confs = new Configurations(); + File propFile = new File("sidecar.yaml"); + YAMLConfiguration yamlConf = confs.fileBased(YAMLConfiguration.class, propFile); + + return new Configuration( + yamlConf.get(String.class, "cassandra.host"), + yamlConf.get(Integer.class, "cassandra.port"), + yamlConf.get(Integer.class, "sidecar.port"), + yamlConf.get(Integer.class, "healthcheck.poll_freq_millis")); + } +} diff --git a/src/main/java/org/apache/cassandra/sidecar/routes/HealthCheck.java b/src/main/java/org/apache/cassandra/sidecar/routes/HealthCheck.java new file mode 100644 index 0000000..d2ac58e --- /dev/null +++ b/src/main/java/org/apache/cassandra/sidecar/routes/HealthCheck.java @@ -0,0 +1,122 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.cassandra.sidecar.routes; + +import com.datastax.driver.core.Cluster; +import com.datastax.driver.core.ResultSet; +import com.datastax.driver.core.Session; +import com.datastax.driver.core.policies.RoundRobinPolicy; +import com.datastax.driver.core.policies.WhiteListPolicy; +import io.vertx.core.logging.Logger; +import io.vertx.core.logging.LoggerFactory; + +import java.net.InetSocketAddress; +import java.util.Collections; +import java.util.List; +import java.util.function.Supplier; + +public class HealthCheck implements Supplier<Boolean> +{ + private static final Logger logger = LoggerFactory.getLogger(HealthCheck.class); + private final String cassandraHost; + private final int cassandraPort; + private Cluster cluster; + private Session session; + + /** + * Constructor + * + * @param cassandraHost + * @param cassandraPort + */ + public HealthCheck(String cassandraHost, int cassandraPort) + { + this.cassandraHost = cassandraHost; + this.cassandraPort = cassandraPort; + this.cluster = createCluster(cassandraHost, cassandraPort); + } + + /** + * The actual health check + * + * @return + */ + private boolean check() + { + + try + { + if (cluster == null) + cluster = createCluster(cassandraHost, cassandraPort); + + if (cluster == null) + return false; + + if (session == null) + session = cluster.connect(); + + ResultSet rs = session.execute("SELECT release_version FROM system.local"); + return (rs.one() != null); + } + catch (Exception e) + { + logger.debug("Failed to reach Cassandra.", e); + session = null; + cluster = null; + return false; + } + } + + /** + * Get the check value + * + * @return true or false based on whether check was successful + */ + @Override + public Boolean get() + { + return check(); + } + + /** + * Creates a cluster object which ensures that the requests go only to the specified C* node + * + * @param cassandraHost + * @param cassandraPort + * @return + */ + final private synchronized Cluster createCluster(String cassandraHost, int cassandraPort) + { + try + { + List<InetSocketAddress> wl = Collections.singletonList(InetSocketAddress.createUnresolved(cassandraHost, cassandraPort)); + cluster = Cluster.builder() + .addContactPointsWithPorts(InetSocketAddress.createUnresolved(cassandraHost, cassandraPort)) + .withoutMetrics() + .withLoadBalancingPolicy(new WhiteListPolicy(new RoundRobinPolicy(), wl)) + .build(); + } + catch (Exception e) + { + logger.error("Failed to create Cluster object", e); + } + + return cluster; + } +} diff --git a/src/main/java/org/apache/cassandra/sidecar/routes/HealthService.java b/src/main/java/org/apache/cassandra/sidecar/routes/HealthService.java new file mode 100644 index 0000000..53903b2 --- /dev/null +++ b/src/main/java/org/apache/cassandra/sidecar/routes/HealthService.java @@ -0,0 +1,90 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.cassandra.sidecar.routes; + +import com.google.common.collect.ImmutableMap; + +import io.netty.handler.codec.http.HttpHeaderValues; +import io.netty.handler.codec.http.HttpResponseStatus; +import io.vertx.core.http.HttpHeaders; +import io.vertx.core.json.Json; +import io.vertx.core.logging.Logger; +import io.vertx.core.logging.LoggerFactory; +import io.vertx.ext.web.RoutingContext; + +import java.util.concurrent.Executors; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.TimeUnit; +import java.util.function.Supplier; + +public class HealthService +{ + private static final Logger logger = LoggerFactory.getLogger(HealthService.class); + private final int CHECK_PERIOD_MS; + private final Supplier<Boolean> check; + + private final ScheduledExecutorService executor = Executors.newSingleThreadScheduledExecutor(); + private volatile boolean lastKnownStatus = false; + + public HealthService(int checkPeriodMillis, Supplier<Boolean> check) + { + this.CHECK_PERIOD_MS = checkPeriodMillis; + this.check = check; + } + + synchronized public void start() + { + logger.info("Starting health check"); + executor.scheduleWithFixedDelay(this::refreshNow, 0, CHECK_PERIOD_MS, TimeUnit.MILLISECONDS); + } + + synchronized public void refreshNow() + { + try + { + lastKnownStatus = this.check.get(); + } + catch (Exception e) + { + logger.error("Error while performing health check", e); + } + } + + synchronized public void stop() + { + logger.info("Stopping health check"); + executor.shutdown(); + } + + public void handleHealth(RoutingContext rc) + { + try + { + rc.response() + .putHeader(HttpHeaders.CONTENT_TYPE, HttpHeaderValues.APPLICATION_JSON) + .setStatusCode(lastKnownStatus ? HttpResponseStatus.OK.code() : HttpResponseStatus.SERVICE_UNAVAILABLE.code()) + .end(Json.encode(ImmutableMap.of("status", lastKnownStatus ? "OK" : "NOT_OK"))); + } + catch (Exception e) + { + logger.error("Caught exception", e); + rc.response().setStatusCode(400).end(); + } + } +} diff --git a/src/test/java/org/apache/cassandra/sidecar/HealthServiceTest.java b/src/test/java/org/apache/cassandra/sidecar/HealthServiceTest.java new file mode 100644 index 0000000..9a39c44 --- /dev/null +++ b/src/test/java/org/apache/cassandra/sidecar/HealthServiceTest.java @@ -0,0 +1,105 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.cassandra.sidecar; + +import com.google.inject.Guice; +import com.google.inject.Injector; +import io.vertx.core.Vertx; +import io.vertx.core.http.HttpServer; +import io.vertx.ext.web.Router; +import io.vertx.ext.web.client.WebClient; +import io.vertx.ext.web.codec.BodyCodec; +import io.vertx.junit5.VertxExtension; +import io.vertx.junit5.VertxTestContext; +import org.apache.cassandra.sidecar.mocks.MockHealthCheck; +import org.apache.cassandra.sidecar.routes.HealthService; + +import org.junit.Assert; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; + +@DisplayName("Health Service Test") +@ExtendWith(VertxExtension.class) +public class HealthServiceTest +{ + private MockHealthCheck check; + private HealthService service; + private Vertx vertx; + private Configuration config; + + @BeforeEach + void setUp() + { + Injector injector = Guice.createInjector(new TestModule(Vertx.vertx())); + HttpServer server = injector.getInstance(HttpServer.class); + Router router = injector.getInstance(Router.class); + + check = injector.getInstance(MockHealthCheck.class); + service = injector.getInstance(HealthService.class); + vertx = injector.getInstance(Vertx.class); + config = injector.getInstance(Configuration.class); + + server.listen(config.getPort()); + } + + @AfterEach + void tearDown() + { + vertx.close(); + } + + @DisplayName("Should return HTTP 200 OK when check=True") + @Test + public void testHealthCheckReturns200OK(VertxTestContext testContext) + { + check.setStatus(true); + service.refreshNow(); + + WebClient client = WebClient.create(vertx); + + client.get(config.getPort(), "localhost", "/api/v1/__health") + .as(BodyCodec.string()) + .send(testContext.succeeding(response -> testContext.verify(() -> { + System.out.println(response.statusCode()); + Assert.assertEquals(200, response.statusCode()); + testContext.completeNow(); + }))); + } + + @DisplayName("Should return HTTP 503 Failure when check=False") + @Test + public void testHealthCheckReturns503Failure(VertxTestContext testContext) + { + check.setStatus(false); + service.refreshNow(); + + WebClient client = WebClient.create(vertx); + + client.get(config.getPort(), "localhost", "/api/v1/__health") + .as(BodyCodec.string()) + .send(testContext.succeeding(response -> testContext.verify(() -> { + System.out.println(response.statusCode()); + Assert.assertEquals(503, response.statusCode()); + testContext.completeNow(); + }))); + } +} diff --git a/src/test/java/org/apache/cassandra/sidecar/TestModule.java b/src/test/java/org/apache/cassandra/sidecar/TestModule.java new file mode 100644 index 0000000..01061ba --- /dev/null +++ b/src/test/java/org/apache/cassandra/sidecar/TestModule.java @@ -0,0 +1,99 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.cassandra.sidecar; + +import com.google.inject.AbstractModule; +import com.google.inject.Provides; +import com.google.inject.Singleton; +import io.vertx.core.Vertx; +import io.vertx.core.http.HttpServer; +import io.vertx.core.http.HttpServerOptions; +import io.vertx.ext.web.Router; +import io.vertx.ext.web.handler.LoggerHandler; +import org.apache.cassandra.sidecar.mocks.MockHealthCheck; +import org.apache.cassandra.sidecar.routes.HealthService; + +public class TestModule extends AbstractModule +{ + private Vertx vertx; + + public TestModule(Vertx vertx) + { + this.vertx = vertx; + } + + @Override + protected void configure() + { + bind(CassandraSidecarDaemon.class).in(Singleton.class); + } + + @Provides + @Singleton + public Vertx getVertx() + { + return vertx; + } + + @Provides + @Singleton + public HealthService healthService(Configuration config, MockHealthCheck check) + { + return new HealthService(config.getHealthCheckFrequencyMillis(), check); + } + + @Provides + @Singleton + public MockHealthCheck healthCheck() + { + return new MockHealthCheck(); + } + + @Provides + @Singleton + public HttpServer vertxServer(Vertx vertx, Configuration config, Router router) + { + HttpServer server = vertx.createHttpServer(new HttpServerOptions() + .setPort(config.getPort()) + .setLogActivity(true)); + server.requestHandler(router); + return server; + } + + @Provides + @Singleton + public Router vertxRouter(Vertx vertx, HealthService healthService) + { + Router router = Router.router(vertx); + router.route().handler(LoggerHandler.create()); + router.route().path("/api/v1/__health").handler(healthService::handleHealth); + return router; + } + + @Provides + @Singleton + public Configuration configuration() + { + return new Configuration( + "INVALID_FOR_TEST", + 0, + 6475, + 1000); + } +} diff --git a/src/test/java/org/apache/cassandra/sidecar/mocks/MockHealthCheck.java b/src/test/java/org/apache/cassandra/sidecar/mocks/MockHealthCheck.java new file mode 100644 index 0000000..76a7280 --- /dev/null +++ b/src/test/java/org/apache/cassandra/sidecar/mocks/MockHealthCheck.java @@ -0,0 +1,37 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.cassandra.sidecar.mocks; + +import java.util.function.Supplier; + +public class MockHealthCheck implements Supplier<Boolean> +{ + private volatile boolean status; + + @Override + public Boolean get() + { + return status; + } + + public void setStatus(boolean status) + { + this.status = status; + } +} --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org