From 1f18ddbe722f895ad4220f6c5d87a01696048e64 Mon Sep 17 00:00:00 2001 From: Adrian Cole Date: Fri, 12 May 2017 18:17:07 +0800 Subject: [PATCH] Adds Cassandra server integration This contains tracing instrumentation for [Cassandra](https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/tracing/Tracing.java). `brave.cassandra.Tracing` extracts trace state from the custom payload of incoming requests. How long each request takes, each suboperation, and relevant tags like the session ID are reported to Zipkin. --- instrumentation/cassandra/README.md | 52 ++ instrumentation/cassandra/pom.xml | 69 ++ .../main/java/brave/cassandra/Tracing.java | 123 ++++ .../brave/cassandra/TracingComponent.java | 50 ++ .../test/java/brave/mysql/CassandraRule.java | 110 ++++ .../src/test/java/brave/mysql/ITTracing.java | 154 +++++ .../src/test/resources/log4j2.properties | 8 + .../src/test/resources/test-cassandra.yaml | 590 ++++++++++++++++++ instrumentation/pom.xml | 1 + 9 files changed, 1157 insertions(+) create mode 100644 instrumentation/cassandra/README.md create mode 100644 instrumentation/cassandra/pom.xml create mode 100644 instrumentation/cassandra/src/main/java/brave/cassandra/Tracing.java create mode 100644 instrumentation/cassandra/src/main/java/brave/cassandra/TracingComponent.java create mode 100644 instrumentation/cassandra/src/test/java/brave/mysql/CassandraRule.java create mode 100644 instrumentation/cassandra/src/test/java/brave/mysql/ITTracing.java create mode 100755 instrumentation/cassandra/src/test/resources/log4j2.properties create mode 100644 instrumentation/cassandra/src/test/resources/test-cassandra.yaml diff --git a/instrumentation/cassandra/README.md b/instrumentation/cassandra/README.md new file mode 100644 index 0000000000..e2ee6bb861 --- /dev/null +++ b/instrumentation/cassandra/README.md @@ -0,0 +1,52 @@ +# brave-instrumentation-cassandra +This contains tracing instrumentation for [Cassandra](https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/tracing/Tracing.java). + +`brave.cassandra.Tracing` extracts trace state from the custom payload +of incoming requests. How long each request takes, each suboperation, +and relevant tags like the session ID are reported to Zipkin. + +## Client side requirements +Clients must enable tracing. If they want to continue an existing trace, +they must add propagation fields to the custom payload of a statement. + +```java +// minimally, you need to prepare a statement and enable tracing +preparedStatement.enableTracing(); + +// By default, B3 style is used, so instrumented clients do something like this +Map payload = new LinkedHashMap<>(); +payload.set("X-B3-TraceId", byteBuffer("463ac35c9f6413ad")); +payload.set("X-B3-ParentSpanId", byteBuffer("463ac35c9f6413ad")); +payload.set("X-B3-SpanId", byteBuffer("72485a3953bb6124")); +payload.set("X-B3-Sampled", byteBuffer("1")); +preparedStatement.setOutgoingPayload(payload); +``` + +## Server Integration +For this to work, you must add classes to your cassandra classpath. It +then needs the system property "cassandra.custom_tracing_class" set to +"brave.cassandra.Tracing". + +### Http +The easiest way to get started is to place this project's "all" jar in +cassandra's lib directory and start cassandra with java options like this: + +```bash +$ JVM_OPTS='-Dzipkin.http_endpoint=http://localhost:9411/api/v1/spans -Dcassandra.custom_tracing_class=brave.cassandra.Tracing' cassandra +``` + +Note this jar is about 200KiB and does not depend on any classes besides +Brave and Zipkin. It has limited configuration to the below: + +System property | Default | Description +--- | --- | --- +zipkin.http_endpoint | none | The url to Zipkin's POST endpoint. Ex. http://myhost:9411/api/v1/spans +zipkin.service_name | cassandra | The name that shows up in Zipkin's search and dependency graph + +### Custom + +Some may want to make a custom jar that includes explicit configuration +for their site's Zipkin service. Others may want to relegate that to yaml +or configuration. This plugin can use either an implicit `brave.Tracing` +component setup elsewhere in the JVM, or one explicitly called via the +constructor. diff --git a/instrumentation/cassandra/pom.xml b/instrumentation/cassandra/pom.xml new file mode 100644 index 0000000000..2304b1f53c --- /dev/null +++ b/instrumentation/cassandra/pom.xml @@ -0,0 +1,69 @@ + + + + io.zipkin.brave + brave-instrumentation-parent + 4.3.1-SNAPSHOT + + 4.0.0 + + brave-instrumentation-cassandra + Brave Instrumentation: Cassandra + + + ${project.basedir}/../.. + + + + + org.apache.cassandra + cassandra-all + 3.10 + + + org.slf4j + * + + + ch.qos.logback + logback-classic + + + provided + + + io.zipkin.reporter + zipkin-sender-urlconnection + ${zipkin-reporter.version} + + + com.datastax.cassandra + cassandra-driver-core + 3.2.0 + test + + + + + + maven-shade-plugin + + + package + + shade + + + true + true + all + false + + + + + + + diff --git a/instrumentation/cassandra/src/main/java/brave/cassandra/Tracing.java b/instrumentation/cassandra/src/main/java/brave/cassandra/Tracing.java new file mode 100644 index 0000000000..5588b57963 --- /dev/null +++ b/instrumentation/cassandra/src/main/java/brave/cassandra/Tracing.java @@ -0,0 +1,123 @@ +package brave.cassandra; + +import brave.Span; +import brave.Tracer; +import brave.propagation.SamplingFlags; +import brave.propagation.TraceContextOrSamplingFlags; +import java.net.InetAddress; +import java.nio.ByteBuffer; +import java.util.Map; +import java.util.UUID; +import org.apache.cassandra.tracing.TraceState; +import org.apache.cassandra.utils.FBUtilities; +import zipkin.Endpoint; +import zipkin.reporter.AsyncReporter; +import zipkin.reporter.urlconnection.URLConnectionSender; + +/** + * This creates Zipkin server spans for incoming cassandra requests. Spans are created when there's + * a tracing component available, and the incoming payload is not explicitly unsampled. + * + *

Configuring a tracing component

+ * If the system property "zipkin.http_endpoint" is set, a basic tracing component is setup. + * + *

Otherwise, {@link brave.Tracing#current()} is used. This relies on external bootstrapping of + * {@link brave.Tracing}. + * + *

Alternatively, you can subclass this and fix configuration to your favorite mechanism. + */ +public class Tracing extends org.apache.cassandra.tracing.Tracing { + final InetAddress coordinator = FBUtilities.getLocalAddress(); + final TracingComponent component; + + public Tracing(brave.Tracing tracing) { // subclassable to pin configuration + component = new TracingComponent.Explicit(tracing); + } + + public Tracing() { + String endpoint = System.getProperty("zipkin.http_endpoint"); + if (endpoint == null) { + component = new TracingComponent.Current(); + return; + } + brave.Tracing tracing = brave.Tracing.newBuilder() + .localServiceName(System.getProperty("zipkin.service_name", "cassandra")) + .reporter(AsyncReporter.create(URLConnectionSender.create(endpoint))) + .build(); + component = new TracingComponent.Explicit(tracing); + } + + /** + * When tracing is enabled and available, this tries to extract trace keys from the custom + * payload. If that's possible, it re-uses the trace identifiers and starts a server span. + * Otherwise, a new trace is created. + */ + @Override protected final UUID newSession(UUID sessionId, TraceType traceType, + Map customPayload) { + Tracer tracer = component.tracer(); + if (tracer == null || traceType == TraceType.NONE) { + return super.newSession(sessionId, traceType, customPayload); + } + Span span = spanFromPayload(tracer, customPayload); + + // override instead of call from super as otherwise we cannot store a reference to the span + assert get() == null; + TraceState state = new ZipkinTraceState(coordinator, sessionId, traceType, span); + set(state); + sessions.put(sessionId, state); + return sessionId; + } + + /** This extracts the RPC span encoded in the custom payload, or starts a new trace */ + Span spanFromPayload(Tracer tracer, Map payload) { + TraceContextOrSamplingFlags contextOrFlags = payload == null + ? TraceContextOrSamplingFlags.create(SamplingFlags.EMPTY) + : component.extractor().extract(payload); + return contextOrFlags.context() != null + ? tracer.joinSpan(contextOrFlags.context()) + : tracer.newTrace(contextOrFlags.samplingFlags()); + } + + @Override protected final void stopSessionImpl() { + ZipkinTraceState state = (ZipkinTraceState) get(); + if (state != null) state.incoming.finish(); + } + + @Override public final TraceState begin(String request, InetAddress client, + Map parameters) { + ZipkinTraceState state = ((ZipkinTraceState) get()); + Span span = state.incoming; + if (span.isNoop()) return state; + + span.name(request).kind(Span.Kind.SERVER); + span.tag("cassandra.session_id", state.sessionId.toString()); + Endpoint.Builder remoteEndpoint = Endpoint.builder().serviceName(""); + remoteEndpoint.parseIp(client); + span.remoteEndpoint(remoteEndpoint.build()); + span.start(); + return state; + } + + @Override protected final TraceState newTraceState(InetAddress coordinator, UUID sessionId, + TraceType traceType) { + throw new AssertionError(); + } + + @Override public final void trace(ByteBuffer sessionId, String message, int ttl) { + // not current tracing outbound messages + } + + static final class ZipkinTraceState extends TraceState { + final Span incoming; + + ZipkinTraceState(InetAddress coordinator, UUID sessionId, TraceType traceType, + Span incoming) { + super(coordinator, sessionId, traceType); + this.incoming = incoming; + } + + @Override protected void traceImpl(String message) { + incoming.annotate(message); // skip creating local spans for now + } + } +} diff --git a/instrumentation/cassandra/src/main/java/brave/cassandra/TracingComponent.java b/instrumentation/cassandra/src/main/java/brave/cassandra/TracingComponent.java new file mode 100644 index 0000000000..11b55d4308 --- /dev/null +++ b/instrumentation/cassandra/src/main/java/brave/cassandra/TracingComponent.java @@ -0,0 +1,50 @@ +package brave.cassandra; + +import brave.Tracer; +import brave.propagation.Propagation; +import brave.propagation.TraceContext; +import java.nio.ByteBuffer; +import java.util.Map; +import zipkin.internal.Util; + +abstract class TracingComponent { + /** Getter that pulls trace fields from ascii values */ + static final Propagation.Getter, String> GETTER = (carrier, key) -> { + ByteBuffer buf = carrier.get(key); + return buf != null ? Util.UTF_8.decode(buf).toString() : null; + }; + + abstract Tracer tracer(); + + abstract TraceContext.Extractor> extractor(); + + static final class Current extends TracingComponent { + @Override Tracer tracer() { + return brave.Tracing.currentTracer(); + } + + @Override TraceContext.Extractor> extractor() { + brave.Tracing tracing = brave.Tracing.current(); + return tracing != null ? tracing.propagation().extractor(GETTER) : null; + } + } + + static final class Explicit extends TracingComponent { + final Tracer tracer; + final TraceContext.Extractor> extractor; + + Explicit(brave.Tracing tracing) { + if (tracing == null) throw new NullPointerException("tracing == null"); + this.tracer = tracing.tracer(); + this.extractor = tracing.propagation().extractor(GETTER); + } + + @Override Tracer tracer() { + return tracer; + } + + @Override TraceContext.Extractor> extractor() { + return extractor; + } + } +} diff --git a/instrumentation/cassandra/src/test/java/brave/mysql/CassandraRule.java b/instrumentation/cassandra/src/test/java/brave/mysql/CassandraRule.java new file mode 100644 index 0000000000..7760ce85a7 --- /dev/null +++ b/instrumentation/cassandra/src/test/java/brave/mysql/CassandraRule.java @@ -0,0 +1,110 @@ +package brave.mysql; + +import java.io.File; +import java.io.IOException; +import java.net.InetAddress; +import java.net.InetSocketAddress; +import java.net.ServerSocket; +import org.apache.cassandra.config.DatabaseDescriptor; +import org.apache.cassandra.db.Keyspace; +import org.apache.cassandra.db.SystemKeyspace; +import org.apache.cassandra.db.commitlog.CommitLog; +import org.apache.cassandra.io.util.FileUtils; +import org.apache.cassandra.service.StorageService; +import org.apache.cassandra.transport.Server; +import org.junit.rules.ExternalResource; + +/** This is a simplified version of code that exists in org.apache.cassandra.cql3.CQLTester */ +public class CassandraRule extends ExternalResource { + private static Server server; + private static final int nativePort; + private static final InetAddress nativeAddr; + + public InetSocketAddress contactPoint() { + return new InetSocketAddress(nativeAddr.getHostAddress(), nativePort); + } + + static { + System.setProperty("cassandra.config", + "file://" + CassandraRule.class.getResource("/test-cassandra.yaml").getFile()); + DatabaseDescriptor.daemonInitialization(); + nativeAddr = InetAddress.getLoopbackAddress(); + + try { + try (ServerSocket serverSocket = new ServerSocket(0)) { + nativePort = serverSocket.getLocalPort(); + } + Thread.sleep(250); + } catch (Exception e) { + throw new RuntimeException(e); + } + } + + private static void cleanupAndLeaveDirs() throws IOException { + CommitLog.instance.stopUnsafe(true); + DatabaseDescriptor.createAllDirectories(); + cleanup(); + DatabaseDescriptor.createAllDirectories(); + CommitLog.instance.restartUnsafe(); + } + + private static void cleanup() { + // clean up commitlog + String[] directoryNames = {DatabaseDescriptor.getCommitLogLocation(),}; + for (String dirName : directoryNames) { + File dir = new File(dirName); + if (!dir.exists()) { + throw new RuntimeException("No such directory: " + dir.getAbsolutePath()); + } + FileUtils.deleteRecursive(dir); + } + + File cdcDir = new File(DatabaseDescriptor.getCDCLogLocation()); + if (cdcDir.exists()) { + FileUtils.deleteRecursive(cdcDir); + } + + cleanupSavedCaches(); + + // clean up data directory which are stored as data directory/keyspace/data files + for (String dirName : DatabaseDescriptor.getAllDataFileLocations()) { + File dir = new File(dirName); + if (!dir.exists()) { + throw new RuntimeException("No such directory: " + dir.getAbsolutePath()); + } + FileUtils.deleteRecursive(dir); + } + } + + private static void cleanupSavedCaches() { + File cachesDir = new File(DatabaseDescriptor.getSavedCachesLocation()); + if (!cachesDir.exists() || !cachesDir.isDirectory()) return; + + FileUtils.delete(cachesDir.listFiles()); + } + + @Override protected void before() throws Throwable { + if (server != null) return; + + DatabaseDescriptor.daemonInitialization(); + + // Cleanup first + try { + cleanupAndLeaveDirs(); + } catch (IOException e) { + throw new RuntimeException("Failed to cleanup and recreate directories.", e); + } + + Keyspace.setInitialized(); + SystemKeyspace.persistLocalMetadata(); + SystemKeyspace.finishStartup(); + StorageService.instance.initServer(); + + server = new Server.Builder().withHost(nativeAddr).withPort(nativePort).build(); + server.start(); + } + + @Override protected void after() { + if (server != null) server.stop(); + } +} diff --git a/instrumentation/cassandra/src/test/java/brave/mysql/ITTracing.java b/instrumentation/cassandra/src/test/java/brave/mysql/ITTracing.java new file mode 100644 index 0000000000..a89f873b69 --- /dev/null +++ b/instrumentation/cassandra/src/test/java/brave/mysql/ITTracing.java @@ -0,0 +1,154 @@ +package brave.mysql; + +import brave.cassandra.Tracing; +import brave.internal.HexCodec; +import com.datastax.driver.core.BoundStatement; +import com.datastax.driver.core.Cluster; +import com.datastax.driver.core.Session; +import java.io.IOException; +import java.nio.ByteBuffer; +import java.util.Collections; +import java.util.LinkedHashMap; +import java.util.Map; +import java.util.concurrent.ConcurrentLinkedDeque; +import java.util.function.Function; +import org.junit.After; +import org.junit.ClassRule; +import org.junit.Test; +import zipkin.Constants; +import zipkin.Span; + +import static org.assertj.core.api.Assertions.assertThat; + +public class ITTracing { + static { + System.setProperty("cassandra.custom_tracing_class", Tracing.class.getName()); + } + + @ClassRule public static CassandraRule cassandra = new CassandraRule(); + + ConcurrentLinkedDeque spans = new ConcurrentLinkedDeque(); + brave.Tracing tracing = brave.Tracing.newBuilder() + .localServiceName("cassandra") + .reporter(spans::add) + .build(); + + @After public void after() { + tracing.close(); + } + + @Test public void doesntTraceWhenTracingDisabled() throws IOException { + execute(session -> session + .prepare("SELECT * from system.schema_keyspaces").bind()); + + assertThat(spans).isEmpty(); + } + + @Test public void startsNewTraceWhenTracingEnabled() throws IOException { + execute(session -> session + .prepare("SELECT * from system.schema_keyspaces") + .enableTracing().setOutgoingPayload(new LinkedHashMap<>()).bind()); + + assertThat(spans).hasSize(1); + } + + @Test public void startsNewTraceWhenTracingEnabled_noPayload() throws IOException { + execute(session -> session + .prepare("SELECT * from system.schema_keyspaces") + .enableTracing().bind()); + + assertThat(spans).hasSize(1); + } + + @Test public void samplingDisabled() throws IOException { + Map payload = new LinkedHashMap<>(); + inject(payload, "X-B3-Sampled", "0"); // sampled false + + execute(session -> session + .prepare("SELECT * from system.schema_keyspaces") + .enableTracing().setOutgoingPayload(payload).bind()); + + assertThat(spans).isEmpty(); + } + + @Test public void usesExistingTraceId() throws Exception { + final String traceId = "463ac35c9f6413ad"; + final String parentId = traceId; + final String spanId = "48485a3953bb6124"; + + Map payload = new LinkedHashMap<>(); + inject(payload, "X-B3-TraceId", traceId); + inject(payload, "X-B3-ParentSpanId", parentId); + inject(payload, "X-B3-SpanId", spanId); + + execute(session -> session + .prepare("SELECT * from system.schema_keyspaces") + .enableTracing().setOutgoingPayload(payload).bind()); + + assertThat(spans).allSatisfy(s -> { + assertThat(HexCodec.toLowerHex(s.traceId)).isEqualTo(traceId); + assertThat(HexCodec.toLowerHex(s.parentId)).isEqualTo(parentId); + assertThat(HexCodec.toLowerHex(s.id)).isEqualTo(spanId); + }); + } + + @Test public void reportsServerAnnotationsToZipkin() throws Exception { + execute(session -> session + .prepare("SELECT * from system.schema_keyspaces") + .enableTracing().bind()); + + assertThat(spans) + .flatExtracting(s -> s.annotations) + .extracting(a -> a.value) + .contains("sr", "ss"); + } + + @Test public void defaultSpanNameIsMethodName() throws Exception { + execute(session -> session + .prepare("SELECT * from system.schema_keyspaces") + .enableTracing().bind()); + + assertThat(spans) + .extracting(s -> s.name) + .containsExactly("execute cql3 prepared query"); + } + + @Test public void addsSessionId() throws Exception { + execute(session -> session + .prepare("SELECT * from system.schema_keyspaces") + .enableTracing().bind()); + + assertThat(spans) + .flatExtracting(s -> s.binaryAnnotations) + .extracting(b -> b.key) + .contains("cassandra.session_id"); + } + + @Test public void reportsClientAddress() throws Exception { + execute(session -> session + .prepare("SELECT * from system.schema_keyspaces") + .enableTracing().bind()); + + assertThat(spans) + .flatExtracting(s -> s.binaryAnnotations) + .extracting(b -> b.key) + .contains(Constants.CLIENT_ADDR); + } + + void execute(Function statement) { + try (Cluster cluster = Cluster.builder() + .addContactPointsWithPorts(Collections.singleton(cassandra.contactPoint())) + .build(); Session session = cluster.connect()) { + session.execute(statement.apply(session)); + } + } + + static void inject(Map carrier, String key, String value) { + int length = value.length(); // all values are ascii + byte[] buf = new byte[length]; + for (int i = 0; i < length; i++) { + buf[i] = (byte) value.charAt(i); + } + carrier.put(key, ByteBuffer.wrap(buf)); + } +} diff --git a/instrumentation/cassandra/src/test/resources/log4j2.properties b/instrumentation/cassandra/src/test/resources/log4j2.properties new file mode 100755 index 0000000000..20b51873e7 --- /dev/null +++ b/instrumentation/cassandra/src/test/resources/log4j2.properties @@ -0,0 +1,8 @@ +appenders=console +appender.console.type=Console +appender.console.name=STDOUT +appender.console.layout.type=PatternLayout +appender.console.layout.pattern=%d{ABSOLUTE} %-5p [%t] %C{2} (%F:%L) - %m%n +rootLogger.level=warn +rootLogger.appenderRefs=stdout +rootLogger.appenderRef.stdout.ref=STDOUT diff --git a/instrumentation/cassandra/src/test/resources/test-cassandra.yaml b/instrumentation/cassandra/src/test/resources/test-cassandra.yaml new file mode 100644 index 0000000000..c56da549eb --- /dev/null +++ b/instrumentation/cassandra/src/test/resources/test-cassandra.yaml @@ -0,0 +1,590 @@ +# Cassandra storage config YAML + +# NOTE: +# See http://wiki.apache.org/cassandra/StorageConfiguration for +# full explanations of configuration directives +# /NOTE + +# The name of the cluster. This is mainly used to prevent machines in +# one logical cluster from joining another. +cluster_name: 'Test Cluster' + +# You should always specify InitialToken when setting up a production +# cluster for the first time, and often when adding capacity later. +# The principle is that each node should be given an equal slice of +# the token ring; see http://wiki.apache.org/cassandra/Operations +# for more details. +# +# If blank, Cassandra will request a token bisecting the range of +# the heaviest-loaded existing node. If there is no load information +# available, such as is the case with a new cluster, it will pick +# a random token, which will lead to hot spots. +#initial_token: + +# See http://wiki.apache.org/cassandra/HintedHandoff +hinted_handoff_enabled: true +# this defines the maximum amount of time a dead host will have hints +# generated. After it has been dead this long, new hints for it will not be +# created until it has been seen alive and gone down again. +max_hint_window_in_ms: 10800000 # 3 hours +# Maximum throttle in KBs per second, per delivery thread. This will be +# reduced proportionally to the number of nodes in the cluster. (If there +# are two nodes in the cluster, each delivery thread will use the maximum +# rate; if there are three, each will throttle to half of the maximum, +# since we expect two nodes to be delivering hints simultaneously.) +hinted_handoff_throttle_in_kb: 1024 +# Number of threads with which to deliver hints; +# Consider increasing this number when you have multi-dc deployments, since +# cross-dc handoff tends to be slower +max_hints_delivery_threads: 2 + +hints_directory: target/embeddedCassandra/hints + +# The following setting populates the page cache on memtable flush and compaction +# WARNING: Enable this setting only when the whole node's data fits in memory. +# Defaults to: false +# populate_io_cache_on_flush: false + +# Authentication backend, implementing IAuthenticator; used to identify users +# Out of the box, Cassandra provides org.apache.cassandra.auth.{AllowAllAuthenticator, +# PasswordAuthenticator}. +# +# - AllowAllAuthenticator performs no checks - set it to disable authentication. +# - PasswordAuthenticator relies on username/password pairs to authenticate +# users. It keeps usernames and hashed passwords in system_auth.credentials table. +# Please increase system_auth keyspace replication factor if you use this authenticator. +authenticator: AllowAllAuthenticator + +# Authorization backend, implementing IAuthorizer; used to limit access/provide permissions +# Out of the box, Cassandra provides org.apache.cassandra.auth.{AllowAllAuthorizer, +# CassandraAuthorizer}. +# +# - AllowAllAuthorizer allows any action to any user - set it to disable authorization. +# - CassandraAuthorizer stores permissions in system_auth.permissions table. Please +# increase system_auth keyspace replication factor if you use this authorizer. +authorizer: AllowAllAuthorizer + +# Validity period for permissions cache (fetching permissions can be an +# expensive operation depending on the authorizer, CassandraAuthorizer is +# one example). Defaults to 2000, set to 0 to disable. +# Will be disabled automatically for AllowAllAuthorizer. +permissions_validity_in_ms: 2000 + + +# The partitioner is responsible for distributing rows (by key) across +# nodes in the cluster. Any IPartitioner may be used, including your/m +# own as long as it is on the classpath. Out of the box, Cassandra +# provides org.apache.cassandra.dht.{Murmur3Partitioner, RandomPartitioner +# ByteOrderedPartitioner, OrderPreservingPartitioner (deprecated)}. +# +# - RandomPartitioner distributes rows across the cluster evenly by md5. +# This is the default prior to 1.2 and is retained for compatibility. +# - Murmur3Partitioner is similar to RandomPartioner but uses Murmur3_128 +# Hash Function instead of md5. When in doubt, this is the best option. +# - ByteOrderedPartitioner orders rows lexically by key bytes. BOP allows +# scanning rows in key order, but the ordering can generate hot spots +# for sequential insertion workloads. +# - OrderPreservingPartitioner is an obsolete form of BOP, that stores +# - keys in a less-efficient format and only works with keys that are +# UTF8-encoded Strings. +# - CollatingOPP collates according to EN,US rules rather than lexical byte +# ordering. Use this as an example if you need custom collation. +# +# See http://wiki.apache.org/cassandra/Operations for more on +# partitioners and token selection. +partitioner: org.apache.cassandra.dht.Murmur3Partitioner + +# directories where Cassandra should store data on disk. +data_file_directories: + - target/embeddedCassandra/data + +# commit log +commitlog_directory: target/embeddedCassandra/commitlog + +cdc_raw_directory: target/embeddedCassandra/cdc + +# policy for data disk failures: +# stop: shut down gossip and Thrift, leaving the node effectively dead, but +# can still be inspected via JMX. +# best_effort: stop using the failed disk and respond to requests based on +# remaining available sstables. This means you WILL see obsolete +# data at CL.ONE! +# ignore: ignore fatal errors and let requests fail, as in pre-1.2 Cassandra +disk_failure_policy: stop + + +# Maximum size of the key cache in memory. +# +# Each key cache hit saves 1 seek and each row cache hit saves 2 seeks at the +# minimum, sometimes more. The key cache is fairly tiny for the amount of +# time it saves, so it's worthwhile to use it at large numbers. +# The row cache saves even more time, but must store the whole values of +# its rows, so it is extremely space-intensive. It's best to only use the +# row cache if you have hot rows or static rows. +# +# NOTE: if you reduce the size, you may not get you hottest keys loaded on startup. +# +# Default value is empty to make it "auto" (min(5% of Heap (in MB), 100MB)). Set to 0 to disable key cache. +key_cache_size_in_mb: + +# Duration in seconds after which Cassandra should +# safe the keys cache. Caches are saved to saved_caches_directory as +# specified in this configuration file. +# +# Saved caches greatly improve cold-start speeds, and is relatively cheap in +# terms of I/O for the key cache. Row cache saving is much more expensive and +# has limited use. +# +# Default is 14400 or 4 hours. +key_cache_save_period: 14400 + +# Number of keys from the key cache to save +# Disabled by default, meaning all keys are going to be saved +# key_cache_keys_to_save: 100 + +# Maximum size of the row cache in memory. +# NOTE: if you reduce the size, you may not get you hottest keys loaded on startup. +# +# Default value is 0, to disable row caching. +row_cache_size_in_mb: 0 + +# Duration in seconds after which Cassandra should +# safe the row cache. Caches are saved to saved_caches_directory as specified +# in this configuration file. +# +# Saved caches greatly improve cold-start speeds, and is relatively cheap in +# terms of I/O for the key cache. Row cache saving is much more expensive and +# has limited use. +# +# Default is 0 to disable saving the row cache. +row_cache_save_period: 0 + +# Number of keys from the row cache to save +# Disabled by default, meaning all keys are going to be saved +# row_cache_keys_to_save: 100 + +# saved caches +saved_caches_directory: target/embeddedCassandra/saved_caches + +# commitlog_sync may be either "periodic" or "batch." +# When in batch mode, Cassandra won't ack writes until the commit log +# has been fsynced to disk. It will wait up to +# commitlog_sync_batch_window_in_ms milliseconds for other writes, before +# performing the sync. +# +# commitlog_sync: batch +# commitlog_sync_batch_window_in_ms: 50 +# +# the other option is "periodic" where writes may be acked immediately +# and the CommitLog is simply synced every commitlog_sync_period_in_ms +# milliseconds. +commitlog_sync: periodic +commitlog_sync_period_in_ms: 10000 + +# The size of the individual commitlog file segments. A commitlog +# segment may be archived, deleted, or recycled once all the data +# in it (potentially from each columnfamily in the system) has been +# flushed to sstables. +# +# The default size is 32, which is almost always fine, but if you are +# archiving commitlog segments (see commitlog_archiving.properties), +# then you probably want a finer granularity of archiving; 8 or 16 MB +# is reasonable. +commitlog_segment_size_in_mb: 32 + +# any class that implements the SeedProvider interface and has a +# constructor that takes a Map of parameters will do. +seed_provider: + # Addresses of hosts that are deemed contact points. + # Cassandra nodes use this list of hosts to find each other and learn + # the topology of the ring. You must change this if you are running + # multiple nodes! + - class_name: org.apache.cassandra.locator.SimpleSeedProvider + parameters: + # seeds is actually a comma-delimited list of addresses. + # Ex: ",," + - seeds: "127.0.0.1" + + +# For workloads with more data than can fit in memory, Cassandra's +# bottleneck will be reads that need to fetch data from +# disk. "concurrent_reads" should be set to (16 * number_of_drives) in +# order to allow the operations to enqueue low enough in the stack +# that the OS and drives can reorder them. +# +# On the other hand, since writes are almost never IO bound, the ideal +# number of "concurrent_writes" is dependent on the number of cores in +# your system; (8 * number_of_cores) is a good rule of thumb. +concurrent_reads: 32 +concurrent_writes: 32 + +# Total memory to use for memtables. Cassandra will flush the largest +# memtable when this much memory is used. +# If omitted, Cassandra will set it to 1/3 of the heap. +# memtable_total_space_in_mb: 2048 + +# Total space to use for commitlogs. +# If space gets above this value (it will round up to the next nearest +# segment multiple), Cassandra will flush every dirty CF in the oldest +# segment and remove it. +# commitlog_total_space_in_mb: 4096 + +# This sets the amount of memtable flush writer threads. These will +# be blocked by disk io, and each one will hold a memtable in memory +# while blocked. If you have a large heap and many data directories, +# you can increase this value for better flush performance. +# By default this will be set to the amount of data directories defined. +#memtable_flush_writers: 1 + +# the number of full memtables to allow pending flush, that is, +# waiting for a writer thread. At a minimum, this should be set to +# the maximum number of secondary indexes created on a single CF. +#memtable_flush_queue_size: 4 + +# Whether to, when doing sequential writing, fsync() at intervals in +# order to force the operating system to flush the dirty +# buffers. Enable this to avoid sudden dirty buffer flushing from +# impacting read latencies. Almost always a good idea on SSD:s; not +# necessarily on platters. +trickle_fsync: false +trickle_fsync_interval_in_kb: 10240 + +# TCP port, for commands and data +storage_port: 7010 + +# SSL port, for encrypted communication. Unused unless enabled in +# encryption_options +ssl_storage_port: 7011 + +# Address to bind to and tell other Cassandra nodes to connect to. You +# _must_ change this if you want multiple nodes to be able to +# communicate! +# +# Leaving it blank leaves it up to InetAddress.getLocalHost(). This +# will always do the Right Thing *if* the node is properly configured +# (hostname, name resolution, etc), and the Right Thing is to use the +# address associated with the hostname (it might not be). +# +# Setting this to 0.0.0.0 is always wrong. +listen_address: 127.0.0.1 + +start_native_transport: true +# port for the CQL native transport to listen for clients on +native_transport_port: 9142 + +# Whether to start the thrift rpc server. +start_rpc: true + +# Address to broadcast to other Cassandra nodes +# Leaving this blank will set it to the same value as listen_address +# broadcast_address: 1.2.3.4 + +# The address to bind the Thrift RPC service to -- clients connect +# here. Unlike ListenAddress above, you *can* specify 0.0.0.0 here if +# you want Thrift to listen on all interfaces. +# +# Leaving this blank has the same effect it does for ListenAddress, +# (i.e. it will be based on the configured hostname of the node). +rpc_address: localhost +# port for Thrift to listen for clients on +rpc_port: 9171 + +# enable or disable keepalive on rpc connections +rpc_keepalive: true + +# Cassandra provides three options for the RPC Server: +# +# sync -> One connection per thread in the rpc pool (see below). +# For a very large number of clients, memory will be your limiting +# factor; on a 64 bit JVM, 128KB is the minimum stack size per thread. +# Connection pooling is very, very strongly recommended. +# +# async -> Nonblocking server implementation with one thread to serve +# rpc connections. This is not recommended for high throughput use +# cases. Async has been tested to be about 50% slower than sync +# or hsha and is deprecated: it will be removed in the next major release. +# +# hsha -> Stands for "half synchronous, half asynchronous." The rpc thread pool +# (see below) is used to manage requests, but the threads are multiplexed +# across the different clients. +# +# The default is sync because on Windows hsha is about 30% slower. On Linux, +# sync/hsha performance is about the same, with hsha of course using less memory. +rpc_server_type: sync + +# Uncomment rpc_min|max|thread to set request pool size. +# You would primarily set max for the sync server to safeguard against +# misbehaved clients; if you do hit the max, Cassandra will block until one +# disconnects before accepting more. The defaults for sync are min of 16 and max +# unlimited. +# +# For the Hsha server, the min and max both default to quadruple the number of +# CPU cores. +# +# This configuration is ignored by the async server. +# +# rpc_min_threads: 16 +# rpc_max_threads: 2048 + +# uncomment to set socket buffer sizes on rpc connections +# rpc_send_buff_size_in_bytes: +# rpc_recv_buff_size_in_bytes: + +# Frame size for thrift (maximum field length). +# 0 disables TFramedTransport in favor of TSocket. This option +# is deprecated; we strongly recommend using Framed mode. +thrift_framed_transport_size_in_mb: 15 + +# The max length of a thrift message, including all fields and +# internal thrift overhead. +thrift_max_message_length_in_mb: 16 + +# Set to true to have Cassandra create a hard link to each sstable +# flushed or streamed locally in a backups/ subdirectory of the +# Keyspace data. Removing these links is the operator's +# responsibility. +incremental_backups: false + +# Whether or not to take a snapshot before each compaction. Be +# careful using this option, since Cassandra won't clean up the +# snapshots for you. Mostly useful if you're paranoid when there +# is a data format change. +snapshot_before_compaction: false + +# Whether or not a snapshot is taken of the data before keyspace truncation +# or dropping of column families. The STRONGLY advised default of true +# should be used to provide data safety. If you set this flag to false, you will +# lose data on truncation or drop. +auto_snapshot: false + +# Add column indexes to a row after its contents reach this size. +# Increase if your column values are large, or if you have a very large +# number of columns. The competing causes are, Cassandra has to +# deserialize this much of the row to read a single column, so you want +# it to be small - at least if you do many partial-row reads - but all +# the index data is read for each access, so you don't want to generate +# that wastefully either. +column_index_size_in_kb: 64 + +# Size limit for rows being compacted in memory. Larger rows will spill +# over to disk and use a slower two-pass compaction process. A message +# will be logged specifying the row key. +#in_memory_compaction_limit_in_mb: 64 + +# Number of simultaneous compactions to allow, NOT including +# validation "compactions" for anti-entropy repair. Simultaneous +# compactions can help preserve read performance in a mixed read/write +# workload, by mitigating the tendency of small sstables to accumulate +# during a single long running compactions. The default is usually +# fine and if you experience problems with compaction running too +# slowly or too fast, you should look at +# compaction_throughput_mb_per_sec first. +# +# This setting has no effect on LeveledCompactionStrategy. +# +# concurrent_compactors defaults to the number of cores. +# Uncomment to make compaction mono-threaded, the pre-0.8 default. +#concurrent_compactors: 1 + +# Multi-threaded compaction. When enabled, each compaction will use +# up to one thread per core, plus one thread per sstable being merged. +# This is usually only useful for SSD-based hardware: otherwise, +# your concern is usually to get compaction to do LESS i/o (see: +# compaction_throughput_mb_per_sec), not more. +#multithreaded_compaction: false + +# Throttles compaction to the given total throughput across the entire +# system. The faster you insert data, the faster you need to compact in +# order to keep the sstable count down, but in general, setting this to +# 16 to 32 times the rate you are inserting data is more than sufficient. +# Setting this to 0 disables throttling. Note that this account for all types +# of compaction, including validation compaction. +compaction_throughput_mb_per_sec: 16 + +# Track cached row keys during compaction, and re-cache their new +# positions in the compacted sstable. Disable if you use really large +# key caches. +#compaction_preheat_key_cache: true + +# Throttles all outbound streaming file transfers on this node to the +# given total throughput in Mbps. This is necessary because Cassandra does +# mostly sequential IO when streaming data during bootstrap or repair, which +# can lead to saturating the network connection and degrading rpc performance. +# When unset, the default is 200 Mbps or 25 MB/s. +# stream_throughput_outbound_megabits_per_sec: 200 + +# How long the coordinator should wait for read operations to complete +read_request_timeout_in_ms: 5000 +# How long the coordinator should wait for seq or index scans to complete +range_request_timeout_in_ms: 10000 +# How long the coordinator should wait for writes to complete +write_request_timeout_in_ms: 2000 +# How long a coordinator should continue to retry a CAS operation +# that contends with other proposals for the same row +cas_contention_timeout_in_ms: 1000 +# How long the coordinator should wait for truncates to complete +# (This can be much longer, because unless auto_snapshot is disabled +# we need to flush first so we can snapshot before removing the data.) +truncate_request_timeout_in_ms: 60000 +# The default timeout for other, miscellaneous operations +request_timeout_in_ms: 10000 + +# Enable operation timeout information exchange between nodes to accurately +# measure request timeouts. If disabled, replicas will assume that requests +# were forwarded to them instantly by the coordinator, which means that +# under overload conditions we will waste that much extra time processing +# already-timed-out requests. +# +# Warning: before enabling this property make sure to ntp is installed +# and the times are synchronized between the nodes. +cross_node_timeout: false + +# Enable socket timeout for streaming operation. +# When a timeout occurs during streaming, streaming is retried from the start +# of the current file. This _can_ involve re-streaming an important amount of +# data, so you should avoid setting the value too low. +# Default value is 0, which never timeout streams. +# streaming_socket_timeout_in_ms: 0 + +# phi value that must be reached for a host to be marked down. +# most users should never need to adjust this. +# phi_convict_threshold: 8 + +# endpoint_snitch -- Set this to a class that implements +# IEndpointSnitch. The snitch has two functions: +# - it teaches Cassandra enough about your network topology to route +# requests efficiently +# - it allows Cassandra to spread replicas around your cluster to avoid +# correlated failures. It does this by grouping machines into +# "datacenters" and "racks." Cassandra will do its best not to have +# more than one replica on the same "rack" (which may not actually +# be a physical location) +# +# IF YOU CHANGE THE SNITCH AFTER DATA IS INSERTED INTO THE CLUSTER, +# YOU MUST RUN A FULL REPAIR, SINCE THE SNITCH AFFECTS WHERE REPLICAS +# ARE PLACED. +# +# Out of the box, Cassandra provides +# - SimpleSnitch: +# Treats Strategy order as proximity. This improves cache locality +# when disabling read repair, which can further improve throughput. +# Only appropriate for single-datacenter deployments. +# - PropertyFileSnitch: +# Proximity is determined by rack and data center, which are +# explicitly configured in cassandra-topology.properties. +# - RackInferringSnitch: +# Proximity is determined by rack and data center, which are +# assumed to correspond to the 3rd and 2nd octet of each node's +# IP address, respectively. Unless this happens to match your +# deployment conventions (as it did Facebook's), this is best used +# as an example of writing a custom Snitch class. +# - Ec2Snitch: +# Appropriate for EC2 deployments in a single Region. Loads Region +# and Availability Zone information from the EC2 API. The Region is +# treated as the Datacenter, and the Availability Zone as the rack. +# Only private IPs are used, so this will not work across multiple +# Regions. +# - Ec2MultiRegionSnitch: +# Uses public IPs as broadcast_address to allow cross-region +# connectivity. (Thus, you should set seed addresses to the public +# IP as well.) You will need to open the storage_port or +# ssl_storage_port on the public IP firewall. (For intra-Region +# traffic, Cassandra will switch to the private IP after +# establishing a connection.) +# +# You can use a custom Snitch by setting this to the full class name +# of the snitch, which will be assumed to be on your classpath. +endpoint_snitch: SimpleSnitch + +# controls how often to perform the more expensive part of host score +# calculation +dynamic_snitch_update_interval_in_ms: 100 +# controls how often to reset all host scores, allowing a bad host to +# possibly recover +dynamic_snitch_reset_interval_in_ms: 600000 +# if set greater than zero and read_repair_chance is < 1.0, this will allow +# 'pinning' of replicas to hosts in order to increase cache capacity. +# The badness threshold will control how much worse the pinned host has to be +# before the dynamic snitch will prefer other replicas over it. This is +# expressed as a double which represents a percentage. Thus, a value of +# 0.2 means Cassandra would continue to prefer the static snitch values +# until the pinned host was 20% worse than the fastest. +dynamic_snitch_badness_threshold: 0.1 + +# request_scheduler -- Set this to a class that implements +# RequestScheduler, which will schedule incoming client requests +# according to the specific policy. This is useful for multi-tenancy +# with a single Cassandra cluster. +# NOTE: This is specifically for requests from the client and does +# not affect inter node communication. +# org.apache.cassandra.scheduler.NoScheduler - No scheduling takes place +# org.apache.cassandra.scheduler.RoundRobinScheduler - Round robin of +# client requests to a node with a separate queue for each +# request_scheduler_id. The scheduler is further customized by +# request_scheduler_options as described below. +request_scheduler: org.apache.cassandra.scheduler.NoScheduler + +# Scheduler Options vary based on the type of scheduler +# NoScheduler - Has no options +# RoundRobin +# - throttle_limit -- The throttle_limit is the number of in-flight +# requests per client. Requests beyond +# that limit are queued up until +# running requests can complete. +# The value of 80 here is twice the number of +# concurrent_reads + concurrent_writes. +# - default_weight -- default_weight is optional and allows for +# overriding the default which is 1. +# - weights -- Weights are optional and will default to 1 or the +# overridden default_weight. The weight translates into how +# many requests are handled during each turn of the +# RoundRobin, based on the scheduler id. +# +# request_scheduler_options: +# throttle_limit: 80 +# default_weight: 5 +# weights: +# Keyspace1: 1 +# Keyspace2: 5 + +# request_scheduler_id -- An identifer based on which to perform +# the request scheduling. Currently the only valid option is keyspace. +# request_scheduler_id: keyspace + +# index_interval controls the sampling of entries from the primrary +# row index in terms of space versus time. The larger the interval, +# the smaller and less effective the sampling will be. In technicial +# terms, the interval coresponds to the number of index entries that +# are skipped between taking each sample. All the sampled entries +# must fit in memory. Generally, a value between 128 and 512 here +# coupled with a large key cache size on CFs results in the best trade +# offs. This value is not often changed, however if you have many +# very small rows (many to an OS page), then increasing this will +# often lower memory usage without a impact on performance. +index_interval: 128 + +# Enable or disable inter-node encryption +# Default settings are TLS v1, RSA 1024-bit keys (it is imperative that +# users generate their own keys) TLS_RSA_WITH_AES_128_CBC_SHA as the cipher +# suite for authentication, key exchange and encryption of the actual data transfers. +# NOTE: No custom encryption options are enabled at the moment +# The available internode options are : all, none, dc, rack +# +# If set to dc cassandra will encrypt the traffic between the DCs +# If set to rack cassandra will encrypt the traffic between the racks +# +# The passwords used in these options must match the passwords used when generating +# the keystore and truststore. For instructions on generating these files, see: +# http://download.oracle.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html#CreateKeystore +# +encryption_options: + internode_encryption: none + keystore: conf/.keystore + keystore_password: cassandra + truststore: conf/.truststore + truststore_password: cassandra + # More advanced defaults below: + # protocol: TLS + # algorithm: SunX509 + # store_type: JKS + # cipher_suites: [TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA] \ No newline at end of file diff --git a/instrumentation/pom.xml b/instrumentation/pom.xml index 66c8862b20..c988d087cf 100644 --- a/instrumentation/pom.xml +++ b/instrumentation/pom.xml @@ -20,6 +20,7 @@ http-tests benchmarks grpc + cassandra httpasyncclient httpclient jaxrs2