diff --git a/.github/workflows/test-v3.yml b/.github/workflows/test-v3.yml index 4af10d7eb68..05e6c080c21 100644 --- a/.github/workflows/test-v3.yml +++ b/.github/workflows/test-v3.yml @@ -52,6 +52,7 @@ jobs: - name: receiver-zipkin-kafka - name: receiver-zipkin-rabbitmq - name: receiver-zipkin-scribe + - name: storage-cassandra steps: - name: Checkout Repository uses: actions/checkout@v2 diff --git a/zipkin-server/pom.xml b/zipkin-server/pom.xml index 8422d345faa..f2bd95d2cf2 100644 --- a/zipkin-server/pom.xml +++ b/zipkin-server/pom.xml @@ -67,6 +67,7 @@ receiver-zipkin-activemq receiver-zipkin-rabbitmq receiver-zipkin-scribe + storage-cassandra http-query-plugin health-query-plugin telemetry-zipkin diff --git a/zipkin-server/server-starter/pom.xml b/zipkin-server/server-starter/pom.xml index b5471748397..3aa26c46441 100644 --- a/zipkin-server/server-starter/pom.xml +++ b/zipkin-server/server-starter/pom.xml @@ -55,6 +55,11 @@ storage-elasticsearch-plugin ${skywalking.version} + + io.zipkin + storage-cassandra + ${project.version} + @@ -72,6 +77,11 @@ zipkin-dependency-storage-banyandb ${project.version} + + io.zipkin + zipkin-dependency-storage-cassandra + ${project.version} + diff --git a/zipkin-server/server-starter/src/main/resources/application.yml b/zipkin-server/server-starter/src/main/resources/application.yml index 10b6fc569ff..1bafe4e3b14 100644 --- a/zipkin-server/server-starter/src/main/resources/application.yml +++ b/zipkin-server/server-starter/src/main/resources/application.yml @@ -146,6 +146,23 @@ storage: &storage superDatasetBlockIntervalHours: ${ZIPKIN_STORAGE_BANYANDB_SUPER_DATASET_BLOCK_INTERVAL_HOURS:4} # Unit is hour superDatasetSegmentIntervalDays: ${ZIPKIN_STORAGE_BANYANDB_SUPER_DATASET_SEGMENT_INTERVAL_DAYS:1} # Unit is day specificGroupSettings: ${ZIPKIN_STORAGE_BANYANDB_SPECIFIC_GROUP_SETTINGS:""} # For example, {"group1": {"blockIntervalHours": 4, "segmentIntervalDays": 1}} + cassandra: + keyspace: ${ZIPKIN_STORAGE_CASSANDRA_KEYSPACE:zipkin} + # Comma separated list of host addresses part of Cassandra cluster. Ports default to 9042 but you can also specify a custom port with 'host:port'. + contactPoints: ${ZIPKIN_STORAGE_CASSANDRA_CONTACT_POINTS:localhost} + # Name of the datacenter that will be considered "local" for load balancing. + localDc: ${ZIPKIN_STORAGE_CASSANDRA_LOCAL_DC:datacenter1} + # Will throw an exception on startup if authentication fails. + username: ${ZIPKIN_STORAGE_CASSANDRA_USERNAME:} + password: ${ZIPKIN_STORAGE_CASSANDRA_PASSWORD:} + # Ensuring that schema exists, if enabled tries to execute script /zipkin-server/storage-cassandra/resources/zipkin-schemas.cql. + ensureSchema: ${ZIPKIN_STORAGE_CASSANDRA_ENSURE_SCHEMA:true} + # Max pooled connections per datacenter-local host. + maxConnections: ${ZIPKIN_STORAGE_CASSANDRA_MAX_CONNECTIONS:8} + # Using ssl for connection, rely on Keystore + use-ssl: ${ZIPKIN_STORAGE_CASSANDRA_USE_SSL:false} + maxSizeOfBatchCql: ${ZIPKIN_STORAGE_CASSANDRA_MAX_SIZE_OF_BATCH_CQL:2000} + asyncBatchPersistentPoolSize: ${ZIPKIN_STORAGE_CASSANDRA_ASYNC_BATCH_PERSISTENT_POOL_SIZE:4} zipkin-dependency-storage-ext: *storage diff --git a/zipkin-server/storage-cassandra/pom.xml b/zipkin-server/storage-cassandra/pom.xml new file mode 100644 index 00000000000..3c96072f802 --- /dev/null +++ b/zipkin-server/storage-cassandra/pom.xml @@ -0,0 +1,73 @@ + + + 4.0.0 + + + zipkin-server-parent + io.zipkin + 2.24.4-SNAPSHOT + + + storage-cassandra + Storage: Cassandra + + + + io.zipkin + zipkin-server-core + ${project.version} + + + org.apache.skywalking + storage-jdbc-hikaricp-plugin + ${skywalking.version} + + + + io.zipkin + zipkin-server-core + ${project.version} + + + + com.google.auto.value + auto-value-annotations + ${auto-value.version} + + + com.google.auto.value + auto-value + ${auto-value.version} + provided + + + + com.datastax.oss + java-driver-core + ${java-driver.version} + + + + com.esri.geometry + * + + + org.apache.tinkerpop + * + + + + + + + org.apache.skywalking + cluster-standalone-plugin + ${skywalking.version} + test + + + + \ No newline at end of file diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CQLExecutor.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CQLExecutor.java new file mode 100644 index 00000000000..46ea7c34ea4 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CQLExecutor.java @@ -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. + * + */ + +package zipkin.server.storage.cassandra; + +import org.apache.skywalking.oap.server.core.storage.SessionCacheCallback; +import org.apache.skywalking.oap.server.library.client.request.InsertRequest; +import org.apache.skywalking.oap.server.library.client.request.UpdateRequest; + +import java.util.ArrayList; +import java.util.List; + +public class CQLExecutor implements InsertRequest, UpdateRequest { + private final String cql; + private final List params; + private final SessionCacheCallback callback; + private List additionalCQLs; + + public CQLExecutor(String cql, List params, SessionCacheCallback callback, List additionalCQLs) { + this.cql = cql; + this.params = params; + this.callback = callback; + this.additionalCQLs = additionalCQLs; + } + + public void appendAdditionalCQLs(List cqlExecutors) { + if (additionalCQLs == null) { + additionalCQLs = new ArrayList<>(); + } + additionalCQLs.addAll(cqlExecutors); + } + + @Override + public String toString() { + return cql; + } + + @Override + public void onInsertCompleted() { + if (callback != null) + callback.onInsertCompleted(); + } + + @Override + public void onUpdateFailure() { + if (callback != null) + callback.onUpdateFailure(); + } + + public List getAdditionalCQLs() { + return additionalCQLs; + } + + public String getCql() { + return cql; + } + + public List getParams() { + return params; + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CassandraClient.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CassandraClient.java new file mode 100644 index 00000000000..11f7c881611 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CassandraClient.java @@ -0,0 +1,163 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.storage.cassandra; + +import com.datastax.oss.driver.api.core.CqlIdentifier; +import com.datastax.oss.driver.api.core.CqlSession; +import com.datastax.oss.driver.api.core.auth.AuthProvider; +import com.datastax.oss.driver.api.core.config.DriverOption; +import com.datastax.oss.driver.api.core.cql.AsyncResultSet; +import com.datastax.oss.driver.api.core.cql.BoundStatement; +import com.datastax.oss.driver.api.core.cql.ResultSet; +import com.datastax.oss.driver.api.core.cql.Row; +import com.datastax.oss.driver.api.core.metadata.schema.KeyspaceMetadata; +import com.datastax.oss.driver.api.core.metadata.schema.TableMetadata; +import com.datastax.oss.driver.internal.core.auth.ProgrammaticPlainTextAuthProvider; +import org.apache.skywalking.oap.server.library.client.Client; +import org.apache.skywalking.oap.server.library.client.healthcheck.DelegatedHealthChecker; +import org.apache.skywalking.oap.server.library.util.HealthChecker; +import org.apache.skywalking.oap.server.library.util.StringUtil; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import zipkin.server.storage.cassandra.internal.SessionBuilder; + +import java.io.IOException; +import java.util.Arrays; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.concurrent.CompletionStage; +import java.util.stream.Collectors; +import java.util.stream.StreamSupport; + +import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.CONNECTION_MAX_REQUESTS; +import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.CONNECTION_POOL_LOCAL_SIZE; + +public class CassandraClient implements Client { + static final Logger LOG = LoggerFactory.getLogger(CassandraClient.class); + + public static final String RECORD_UNIQUE_UUID_COLUMN = "uuid_unique"; + + private final CassandraConfig config; + private final DelegatedHealthChecker healthChecker; + + private volatile CqlSession cqlSession; + + public CassandraClient(CassandraConfig config) { + this.config = config; + this.healthChecker = new DelegatedHealthChecker(); + } + + public KeyspaceMetadata getMetadata() { + return cqlSession.getMetadata().getKeyspace(config.getKeyspace()).orElse(null); + } + + public CqlSession getSession() { + return cqlSession; + } + + public int getDefaultTtl(String table) { + return (int) getMetadata().getTable(table) + .map(TableMetadata::getOptions) + .flatMap(o -> Optional.ofNullable(o.get(CqlIdentifier.fromCql("default_time_to_live")))) + .orElse(0); + } + + public List executeQuery(String cql, ResultHandler resultHandler, Object... params) { + if (LOG.isDebugEnabled()) { + LOG.debug("Executing CQL: {}", cql); + LOG.debug("CQL parameters: {}", Arrays.toString(params)); + } + final BoundStatement stmt = cqlSession.prepare(cql).bind(params); + final ResultSet resultSet = cqlSession.execute(stmt); + healthChecker.health(); + if (resultHandler != null) { + return StreamSupport.stream(resultSet.spliterator(), false) + .map(resultHandler::handle).collect(Collectors.toList()); + } + return null; + } + + public CompletionStage> executeAsyncQuery(String cql, ResultHandler resultHandler, Object... params) { + if (LOG.isDebugEnabled()) { + LOG.debug("Executing CQL: {}", cql); + LOG.debug("CQL parameters: {}", Arrays.toString(params)); + } + final BoundStatement stmt = cqlSession.prepare(cql).bind(params); + final CompletionStage resultSet = cqlSession.executeAsync(stmt); + healthChecker.health(); + if (resultHandler != null) { + return resultSet.thenApply(s -> StreamSupport.stream(s.currentPage().spliterator(), false) + .map(resultHandler::handle).collect(Collectors.toList())); + } + return null; + } + + public void execute(String cql) { + if (LOG.isDebugEnabled()) { + LOG.debug("Executing CQL: {}", cql); + } + cqlSession.execute(cql); + healthChecker.health(); + } + + public void registerChecker(HealthChecker healthChecker) { + this.healthChecker.register(healthChecker); + } + + @Override + public void connect() throws Exception { + AuthProvider authProvider = null; + if (StringUtil.isNotEmpty(config.getUsername())) { + authProvider = new ProgrammaticPlainTextAuthProvider(config.getUsername(), config.getPassword()); + } + this.cqlSession = SessionBuilder.buildSession(config.getContactPoints(), + config.getLocalDc(), + poolingOptions(), + authProvider, + config.getUseSsl()); + + // create keyspace if needs + final String keyspace = config.getKeyspace(); + KeyspaceMetadata keyspaceMetadata = this.cqlSession.getMetadata().getKeyspace(keyspace).orElse(null); + if (keyspaceMetadata == null) { + String createKeyspaceCql = String.format( + "CREATE KEYSPACE IF NOT EXISTS %s " + + "WITH replication = {'class': 'SimpleStrategy', 'replication_factor': '1'} " + + "AND durable_writes = false;", + keyspace); + this.cqlSession.execute(createKeyspaceCql); + } + + this.cqlSession.execute("USE " + keyspace); + } + + @Override + public void shutdown() throws IOException { + } + + private Map poolingOptions() { + Map result = new LinkedHashMap<>(); + result.put(CONNECTION_POOL_LOCAL_SIZE, config.getMaxConnections()); + result.put(CONNECTION_MAX_REQUESTS, 40960 / config.getMaxConnections()); + return result; + } + + @FunctionalInterface + public interface ResultHandler { + T handle(Row resultSet); + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CassandraConfig.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CassandraConfig.java new file mode 100644 index 00000000000..6c1d1a55faf --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CassandraConfig.java @@ -0,0 +1,119 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.storage.cassandra; + +import org.apache.skywalking.oap.server.library.module.ModuleConfig; + +public class CassandraConfig extends ModuleConfig { + + private String keyspace = "zipkin3"; + private String contactPoints = "localhost"; + private String localDc = "datacenter1"; + private int maxConnections = 8; + private boolean useSsl = false; + private String username; + private String password; + + private boolean ensureSchema = true; + + /** + * The maximum size of batch size of CQL execution + */ + protected int maxSizeOfBatchCql = 2000; + /** + * async batch execute pool size + */ + protected int asyncBatchPersistentPoolSize = 4; + + public String getKeyspace() { + return keyspace; + } + + public void setKeyspace(String keyspace) { + this.keyspace = keyspace; + } + + public String getContactPoints() { + return contactPoints; + } + + public void setContactPoints(String contactPoints) { + this.contactPoints = contactPoints; + } + + public String getLocalDc() { + return localDc; + } + + public void setLocalDc(String localDc) { + this.localDc = localDc; + } + + public int getMaxConnections() { + return maxConnections; + } + + public void setMaxConnections(int maxConnections) { + this.maxConnections = maxConnections; + } + + public boolean getUseSsl() { + return useSsl; + } + + public void setUseSsl(boolean useSsl) { + this.useSsl = useSsl; + } + + public String getUsername() { + return username; + } + + public void setUsername(String username) { + this.username = username; + } + + public String getPassword() { + return password; + } + + public void setPassword(String password) { + this.password = password; + } + + public int getMaxSizeOfBatchCql() { + return maxSizeOfBatchCql; + } + + public void setMaxSizeOfBatchCql(int maxSizeOfBatchCql) { + this.maxSizeOfBatchCql = maxSizeOfBatchCql; + } + + public int getAsyncBatchPersistentPoolSize() { + return asyncBatchPersistentPoolSize; + } + + public void setAsyncBatchPersistentPoolSize(int asyncBatchPersistentPoolSize) { + this.asyncBatchPersistentPoolSize = asyncBatchPersistentPoolSize; + } + + public boolean getEnsureSchema() { + return ensureSchema; + } + + public void setEnsureSchema(boolean ensureSchema) { + this.ensureSchema = ensureSchema; + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CassandraProvider.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CassandraProvider.java new file mode 100644 index 00000000000..9803fb0303b --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CassandraProvider.java @@ -0,0 +1,180 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.storage.cassandra; + +import org.apache.skywalking.oap.server.core.CoreModule; +import org.apache.skywalking.oap.server.core.storage.IBatchDAO; +import org.apache.skywalking.oap.server.core.storage.IHistoryDeleteDAO; +import org.apache.skywalking.oap.server.core.storage.StorageBuilderFactory; +import org.apache.skywalking.oap.server.core.storage.StorageDAO; +import org.apache.skywalking.oap.server.core.storage.StorageModule; +import org.apache.skywalking.oap.server.core.storage.cache.INetworkAddressAliasDAO; +import org.apache.skywalking.oap.server.core.storage.management.UIMenuManagementDAO; +import org.apache.skywalking.oap.server.core.storage.management.UITemplateManagementDAO; +import org.apache.skywalking.oap.server.core.storage.model.ModelCreator; +import org.apache.skywalking.oap.server.core.storage.profiling.continuous.IContinuousProfilingPolicyDAO; +import org.apache.skywalking.oap.server.core.storage.profiling.ebpf.IEBPFProfilingDataDAO; +import org.apache.skywalking.oap.server.core.storage.profiling.ebpf.IEBPFProfilingScheduleDAO; +import org.apache.skywalking.oap.server.core.storage.profiling.ebpf.IEBPFProfilingTaskDAO; +import org.apache.skywalking.oap.server.core.storage.profiling.ebpf.IServiceLabelDAO; +import org.apache.skywalking.oap.server.core.storage.profiling.trace.IProfileTaskLogQueryDAO; +import org.apache.skywalking.oap.server.core.storage.profiling.trace.IProfileTaskQueryDAO; +import org.apache.skywalking.oap.server.core.storage.profiling.trace.IProfileThreadSnapshotQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.IAggregationQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.IAlarmQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.IBrowserLogQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.IEventQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.ILogQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.IMetadataQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.IMetricsQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.IRecordsQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.ISpanAttachedEventQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.ITagAutoCompleteQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.ITopologyQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.ITraceQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.IZipkinQueryDAO; +import org.apache.skywalking.oap.server.library.module.ModuleConfig; +import org.apache.skywalking.oap.server.library.module.ModuleDefine; +import org.apache.skywalking.oap.server.library.module.ModuleProvider; +import org.apache.skywalking.oap.server.library.module.ModuleStartException; +import org.apache.skywalking.oap.server.library.module.ServiceNotProvidedException; +import org.apache.skywalking.oap.server.telemetry.TelemetryModule; +import org.apache.skywalking.oap.server.telemetry.api.HealthCheckMetrics; +import org.apache.skywalking.oap.server.telemetry.api.MetricsCreator; +import org.apache.skywalking.oap.server.telemetry.api.MetricsTag; +import zipkin.server.storage.cassandra.dao.CassandraBatchDAO; +import zipkin.server.storage.cassandra.dao.CassandraHistoryDeleteDAO; +import zipkin.server.storage.cassandra.dao.CassandraSpanAttachedEventRecordDAO; +import zipkin.server.storage.cassandra.dao.CassandraStorageDAO; +import zipkin.server.storage.cassandra.dao.CassandraTagAutocompleteDAO; +import zipkin.server.storage.cassandra.dao.CassandraZipkinQueryDAO; +import zipkin.server.storage.cassandra.dao.EmptyDAO; + +public class CassandraProvider extends ModuleProvider { + private CassandraConfig moduleConfig; + private CassandraClient client; + private CassandraTableInstaller modelInstaller; + private CassandraTableHelper tableHelper; + + @Override + public String name() { + return "cassandra"; + } + + @Override + public Class module() { + return StorageModule.class; + } + + @Override + public ConfigCreator newConfigCreator() { + return new ConfigCreator() { + @Override + public Class type() { + return CassandraConfig.class; + } + + @Override + public void onInitialized(CassandraConfig initialized) { + moduleConfig = initialized; + } + }; + } + + @Override + public void prepare() throws ServiceNotProvidedException, ModuleStartException { + client = new CassandraClient(moduleConfig); + modelInstaller = new CassandraTableInstaller(client, moduleConfig); + tableHelper = new CassandraTableHelper(getManager(), client); + + this.registerServiceImplementation( + StorageBuilderFactory.class, + new StorageBuilderFactory.Default()); + this.registerServiceImplementation( + IBatchDAO.class, + new CassandraBatchDAO(client, moduleConfig.getMaxSizeOfBatchCql(), moduleConfig.getAsyncBatchPersistentPoolSize()) + ); + this.registerServiceImplementation( + StorageDAO.class, + new CassandraStorageDAO(client) + ); + + final EmptyDAO emptyDAO = new EmptyDAO(); + this.registerServiceImplementation(INetworkAddressAliasDAO.class, emptyDAO); + this.registerServiceImplementation(ITopologyQueryDAO.class, emptyDAO); + this.registerServiceImplementation(ITraceQueryDAO.class, emptyDAO); + this.registerServiceImplementation(IMetricsQueryDAO.class, emptyDAO); + this.registerServiceImplementation(ILogQueryDAO.class, emptyDAO); + this.registerServiceImplementation(IMetadataQueryDAO.class, emptyDAO); + this.registerServiceImplementation(IAggregationQueryDAO.class, emptyDAO); + this.registerServiceImplementation(IAlarmQueryDAO.class, emptyDAO); + this.registerServiceImplementation(IRecordsQueryDAO.class, emptyDAO); + this.registerServiceImplementation(IBrowserLogQueryDAO.class, emptyDAO); + this.registerServiceImplementation(IProfileTaskQueryDAO.class, emptyDAO); + this.registerServiceImplementation(IProfileTaskLogQueryDAO.class, emptyDAO); + this.registerServiceImplementation(IProfileThreadSnapshotQueryDAO.class, emptyDAO); + this.registerServiceImplementation(UITemplateManagementDAO.class, emptyDAO); + this.registerServiceImplementation(UIMenuManagementDAO.class, emptyDAO); + this.registerServiceImplementation(IEventQueryDAO.class, emptyDAO); + this.registerServiceImplementation(IEBPFProfilingTaskDAO.class, emptyDAO); + this.registerServiceImplementation(IEBPFProfilingScheduleDAO.class, emptyDAO); + this.registerServiceImplementation(IEBPFProfilingDataDAO.class, emptyDAO); + this.registerServiceImplementation(IContinuousProfilingPolicyDAO.class, emptyDAO); + this.registerServiceImplementation(IServiceLabelDAO.class, emptyDAO); + this.registerServiceImplementation(ISpanAttachedEventQueryDAO.class, new CassandraSpanAttachedEventRecordDAO()); + + this.registerServiceImplementation(IHistoryDeleteDAO.class, new CassandraHistoryDeleteDAO()); + this.registerServiceImplementation(IZipkinQueryDAO.class, new CassandraZipkinQueryDAO(client, tableHelper)); + this.registerServiceImplementation(ITagAutoCompleteQueryDAO.class, new CassandraTagAutocompleteDAO(client, tableHelper, getManager())); + + } + + @Override + public void start() throws ServiceNotProvidedException, ModuleStartException { + MetricsCreator metricCreator = + getManager() + .find(TelemetryModule.NAME) + .provider() + .getService(MetricsCreator.class); + HealthCheckMetrics healthChecker = + metricCreator.createHealthCheckerGauge( + "storage_" + name(), + MetricsTag.EMPTY_KEY, + MetricsTag.EMPTY_VALUE); + client.registerChecker(healthChecker); + try { + client.connect(); + modelInstaller.start(); + + getManager() + .find(CoreModule.NAME) + .provider() + .getService(ModelCreator.class) + .addModelListener(modelInstaller); + } catch (Exception e) { + throw new ModuleStartException(e.getMessage(), e); + } + } + + @Override + public void notifyAfterCompleted() throws ServiceNotProvidedException, ModuleStartException { + + } + + @Override + public String[] requiredModules() { + return new String[] {CoreModule.NAME}; + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CassandraTableHelper.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CassandraTableHelper.java new file mode 100644 index 00000000000..d53d865a6a5 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CassandraTableHelper.java @@ -0,0 +1,42 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.storage.cassandra; + +import org.apache.skywalking.oap.server.core.CoreModule; +import org.apache.skywalking.oap.server.core.config.ConfigService; +import org.apache.skywalking.oap.server.core.storage.model.Model; +import org.apache.skywalking.oap.server.library.module.ModuleManager; +import org.apache.skywalking.oap.server.storage.plugin.jdbc.TableMetaInfo; +import org.apache.skywalking.oap.server.storage.plugin.jdbc.common.TableHelper; + +public class CassandraTableHelper extends TableHelper { + private ModuleManager moduleManager; + private final CassandraClient client; + + public CassandraTableHelper(ModuleManager moduleManager, CassandraClient client) { + super(moduleManager, null); + this.moduleManager = moduleManager; + this.client = client; + } + + public String getTableForRead(String modelName) { + final Model model = TableMetaInfo.get(modelName); + return getTableName(model); + } + + ConfigService getConfigService() { + return moduleManager.find(CoreModule.NAME).provider().getService(ConfigService.class); + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CassandraTableInstaller.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CassandraTableInstaller.java new file mode 100644 index 00000000000..3d64bcfc78a --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/CassandraTableInstaller.java @@ -0,0 +1,48 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.storage.cassandra; + +import org.apache.skywalking.oap.server.core.storage.StorageException; +import org.apache.skywalking.oap.server.core.storage.model.Model; +import org.apache.skywalking.oap.server.core.storage.model.ModelCreator; +import org.apache.skywalking.oap.server.storage.plugin.jdbc.TableMetaInfo; + +public class CassandraTableInstaller implements ModelCreator.CreatingListener { + private final CassandraClient client; + private final CassandraConfig config; + + public CassandraTableInstaller(CassandraClient client, CassandraConfig config) { + this.client = client; + this.config = config; + } + + public void start() { + try { + if (!config.getEnsureSchema()) { + return; + } + + Schema.ensureExists(config.getKeyspace(), client.getSession()); + } finally { + client.getSession().execute("USE " + config.getKeyspace()); + Schema.check(client.getSession(), config.getKeyspace()); + } + } + + @Override + public void whenCreating(Model model) throws StorageException { + TableMetaInfo.addModel(model); + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/Resources.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/Resources.java new file mode 100644 index 00000000000..90b8ab645d6 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/Resources.java @@ -0,0 +1,41 @@ +/* + * Copyright 2015-2020 The OpenZipkin Authors + * + * 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. + */ +package zipkin.server.storage.cassandra; + +import java.io.IOException; +import java.io.InputStreamReader; +import java.io.Reader; +import java.io.UncheckedIOException; + +import static java.nio.charset.StandardCharsets.UTF_8; + +public final class Resources { + public static String resourceToString(String resource) { + try ( + Reader reader = new InputStreamReader(Resources.class.getResourceAsStream(resource), UTF_8)) { + char[] buf = new char[2048]; + StringBuilder builder = new StringBuilder(); + int read; + while ((read = reader.read(buf)) != -1) { + builder.append(buf, 0, read); + } + return builder.toString(); + } catch (IOException ex) { + throw new UncheckedIOException(ex); + } + } + + Resources() { + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/Schema.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/Schema.java new file mode 100644 index 00000000000..fa264c06d2f --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/Schema.java @@ -0,0 +1,115 @@ +/* + * Copyright 2015-2020 The OpenZipkin Authors + * + * 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. + */ +package zipkin.server.storage.cassandra; + +import com.datastax.oss.driver.api.core.CqlSession; +import com.datastax.oss.driver.api.core.Version; +import com.datastax.oss.driver.api.core.metadata.Node; +import com.datastax.oss.driver.api.core.metadata.schema.KeyspaceMetadata; +import org.apache.skywalking.oap.server.core.zipkin.ZipkinSpanRecord; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.Map; +import java.util.UUID; + +import static zipkin.server.storage.cassandra.Resources.resourceToString; + +final class Schema { + static final Logger LOG = LoggerFactory.getLogger(Schema.class); + + static final String DEFAULT_KEYSPACE = "zipkin2"; + static final String SCHEMA_RESOURCE = "/zipkin-schemas.cql"; + + static void check(CqlSession session, String keyspace) { + KeyspaceMetadata keyspaceMetadata = ensureKeyspaceMetadata(session, keyspace); + + Map replication = keyspaceMetadata.getReplication(); + final String replicationClass = replication.get("class"); + if (replicationClass != null && replicationClass.endsWith("SimpleStrategy")) { + if ("1".equals(replication.get("replication_factor"))) { + LOG.warn("running with RF=1, this is not suitable for production. Optimal is 3+"); + } + } + } + + static final class Metadata { + final boolean hasAutocompleteTags, hasRemoteService; + + Metadata(boolean hasAutocompleteTags, boolean hasRemoteService) { + this.hasAutocompleteTags = hasAutocompleteTags; + this.hasRemoteService = hasRemoteService; + } + } + + static KeyspaceMetadata ensureKeyspaceMetadata(CqlSession session, String keyspace) { + ensureVersion(session.getMetadata()); + KeyspaceMetadata keyspaceMetadata = session.getMetadata().getKeyspace(keyspace).orElse(null); + if (keyspaceMetadata == null) { + throw new IllegalStateException( + String.format( + "Cannot read keyspace metadata for keyspace: %s and cluster: %s", + keyspace, session.getMetadata().getClusterName())); + } + return keyspaceMetadata; + } + + static Version ensureVersion(com.datastax.oss.driver.api.core.metadata.Metadata metadata) { + Version version = null; + for (Map.Entry entry : metadata.getNodes().entrySet()) { + version = entry.getValue().getCassandraVersion(); + if (version == null) throw new RuntimeException("node had no version: " + entry.getValue()); + if (Version.parse("3.11.3").compareTo(version) > 0) { + throw new RuntimeException(String.format( + "Node %s is running Cassandra %s, but minimum version is 3.11.3", + entry.getKey(), entry.getValue().getCassandraVersion())); + } + } + if (version == null) throw new RuntimeException("No nodes in the cluster"); + return version; + } + + static KeyspaceMetadata ensureExists(String keyspace, CqlSession session) { + KeyspaceMetadata result = session.getMetadata().getKeyspace(keyspace).orElse(null); + if (result == null || !result.getTable(ZipkinSpanRecord.INDEX_NAME).isPresent()) { + LOG.info("Installing schema {} for keyspace {}", SCHEMA_RESOURCE, keyspace); + applyCqlFile(keyspace, session, SCHEMA_RESOURCE); + // refresh metadata since we've installed the schema + result = ensureKeyspaceMetadata(session, keyspace); + } + return result; + } + + static void applyCqlFile(String keyspace, CqlSession session, String resource) { + Version version = ensureVersion(session.getMetadata()); + for (String cmd : resourceToString(resource).split(";", 100)) { + cmd = cmd.trim().replace(" " + DEFAULT_KEYSPACE, " " + keyspace); + if (cmd.isEmpty()) continue; + cmd = reviseCQL(version, cmd); + session.execute(cmd); + } + } + + static String reviseCQL(Version version, String cql) { + if (version.getMajor() == 4) { + // read_repair_chance options were removed and make Cassandra crash starting in v4 + // See https://cassandra.apache.org/doc/latest/operating/read_repair.html#background-read-repair + cql = cql.replaceAll(" *AND [^\\s]*read_repair_chance = 0\n", ""); + } + return cql; + } + + Schema() { + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraBatchDAO.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraBatchDAO.java new file mode 100644 index 00000000000..c82216fe269 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraBatchDAO.java @@ -0,0 +1,133 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ +package zipkin.server.storage.cassandra.dao; + +import com.datastax.oss.driver.api.core.cql.BoundStatement; +import org.apache.skywalking.oap.server.core.storage.IBatchDAO; +import org.apache.skywalking.oap.server.library.client.request.InsertRequest; +import org.apache.skywalking.oap.server.library.client.request.PrepareRequest; +import org.apache.skywalking.oap.server.library.client.request.UpdateRequest; +import org.apache.skywalking.oap.server.library.datacarrier.DataCarrier; +import org.apache.skywalking.oap.server.library.datacarrier.consumer.IConsumer; +import org.apache.skywalking.oap.server.library.util.CollectionUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import zipkin.server.storage.cassandra.CQLExecutor; +import zipkin.server.storage.cassandra.CassandraClient; + +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.CompletableFuture; + +public class CassandraBatchDAO implements IBatchDAO { + static final Logger LOG = LoggerFactory.getLogger(CassandraBatchDAO.class); + + private CassandraClient client; + private final DataCarrier dataCarrier; + private final int maxBatchSqlSize; + + public CassandraBatchDAO(CassandraClient client, int maxBatchCqlSize, int asyncBatchPersistentPoolSize) { + this.client = client; + String name = "CASSANDRA_ASYNCHRONOUS_BATCH_PERSISTENT"; + if (LOG.isDebugEnabled()) { + LOG.debug("CASSANDRA_ASYNCHRONOUS_BATCH_PERSISTENT poolSize: {}, maxBatchCqlSize:{}", asyncBatchPersistentPoolSize, maxBatchCqlSize); + } + this.maxBatchSqlSize = maxBatchCqlSize; + this.dataCarrier = new DataCarrier<>(name, asyncBatchPersistentPoolSize, 10000); + this.dataCarrier.consume(new CassandraBatchConsumer(this), asyncBatchPersistentPoolSize, 20); + } + + @Override + public void insert(InsertRequest insertRequest) { + this.dataCarrier.produce(insertRequest); + } + + @Override + public CompletableFuture flush(List prepareRequests) { + if (CollectionUtils.isEmpty(prepareRequests)) { + return CompletableFuture.completedFuture(null); + } + + List cqls = new ArrayList<>(); + prepareRequests.forEach(prepareRequest -> { + cqls.add(prepareRequest); + CQLExecutor cqlExecutor = (CQLExecutor) prepareRequest; + if (!CollectionUtils.isEmpty(cqlExecutor.getAdditionalCQLs())) { + cqls.addAll(cqlExecutor.getAdditionalCQLs()); + } + }); + + if (LOG.isDebugEnabled()) { + LOG.debug("to execute sql statements execute, data size: {}, maxBatchSqlSize: {}", cqls.size(), maxBatchSqlSize); + } + if (CollectionUtils.isEmpty(cqls)) { + return CompletableFuture.completedFuture(null); + } + + final long start = System.currentTimeMillis(); + boolean success = true; + try { + for (PrepareRequest cql : cqls) { + final CQLExecutor executor = (CQLExecutor) cql; + if (LOG.isDebugEnabled()) { + LOG.debug("Executing CQL: {}", executor.getCql()); + LOG.debug("CQL parameters: {}", executor.getParams()); + } + + final BoundStatement stmt = client.getSession().prepare(executor.getCql()) + .bind(((CQLExecutor) cql).getParams().toArray()); + client.getSession().execute(stmt); + } + } catch (Exception e) { + // Just to avoid one execution failure makes the rest of batch failure. + LOG.error(e.getMessage(), e); + success = false; + } + + final boolean isInsert = cqls.get(0) instanceof InsertRequest; + for (PrepareRequest executor : cqls) { + if (isInsert) { + ((InsertRequest) executor).onInsertCompleted(); + } else if (!success) { + ((UpdateRequest) executor).onUpdateFailure(); + } + } + if (LOG.isDebugEnabled()) { + long end = System.currentTimeMillis(); + long cost = end - start; + LOG.debug("execute sql statements done, data size: {}, maxBatchSqlSize: {}, cost:{}ms", prepareRequests.size(), maxBatchSqlSize, cost); + } + return CompletableFuture.completedFuture(null); + } + + + private static class CassandraBatchConsumer implements IConsumer { + + private final CassandraBatchDAO batchDAO; + + private CassandraBatchConsumer(CassandraBatchDAO batchDAO) { + this.batchDAO = batchDAO; + } + + @Override + public void consume(List prepareRequests) { + batchDAO.flush(prepareRequests); + } + + @Override + public void onError(List prepareRequests, Throwable t) { + LOG.error(t.getMessage(), t); + } + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraCqlExecutor.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraCqlExecutor.java new file mode 100644 index 00000000000..2ff081b5dce --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraCqlExecutor.java @@ -0,0 +1,248 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.storage.cassandra.dao; + +import com.datastax.oss.driver.api.core.CqlIdentifier; +import com.datastax.oss.driver.api.core.cql.Row; +import org.apache.skywalking.oap.server.core.storage.SessionCacheCallback; +import org.apache.skywalking.oap.server.core.storage.StorageData; +import org.apache.skywalking.oap.server.core.storage.model.ColumnName; +import org.apache.skywalking.oap.server.core.storage.model.Model; +import org.apache.skywalking.oap.server.core.storage.model.ModelColumn; +import org.apache.skywalking.oap.server.core.storage.model.SQLDatabaseModelExtension; +import org.apache.skywalking.oap.server.core.storage.type.Convert2Storage; +import org.apache.skywalking.oap.server.core.storage.type.HashMapConverter; +import org.apache.skywalking.oap.server.core.storage.type.StorageBuilder; +import org.apache.skywalking.oap.server.core.storage.type.StorageDataComplexObject; +import org.apache.skywalking.oap.server.core.zipkin.ZipkinSpanRecord; +import org.apache.skywalking.oap.server.library.util.CollectionUtils; +import org.apache.skywalking.oap.server.storage.plugin.jdbc.TableMetaInfo; +import org.apache.skywalking.oap.server.storage.plugin.jdbc.common.JDBCTableInstaller; +import org.apache.skywalking.oap.server.storage.plugin.jdbc.common.TableHelper; +import zipkin.server.storage.cassandra.CQLExecutor; +import zipkin.server.storage.cassandra.CassandraClient; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.UUID; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import static org.apache.skywalking.oap.server.storage.plugin.jdbc.common.JDBCTableInstaller.ID_COLUMN; + +public class CassandraCqlExecutor { + + protected List getByIDs(CassandraClient client, + String modelName, + List ids, + StorageBuilder storageBuilder) { + List storageDataList = new ArrayList<>(); + + final String cql = "SELECT * FROM " + getModelTables(client, modelName) + " WHERE id in " + + ids.stream().map(it -> "?").collect(Collectors.joining(",", "(", ") ALLOW FILTERING")); + storageDataList.addAll(client.executeQuery(cql, resultSet -> toStorageData(resultSet, modelName, storageBuilder), ids.toArray())); + + return storageDataList; + } + + protected CQLExecutor getInsertExecutor(Model model, T metrics, long timeBucket, + StorageBuilder storageBuilder, + Convert2Storage> converter, + SessionCacheCallback callback) { + storageBuilder.entity2Storage(metrics, converter); + // adding the uuid column + Map objectMap = converter.obtain(); + //build main table cql + Map mainEntity = new HashMap<>(); + model.getColumns().forEach(column -> { + mainEntity.put(column.getColumnName().getName(), objectMap.get(column.getColumnName().getName())); + }); + CQLExecutor sqlExecutor = buildInsertExecutor( + model, metrics, timeBucket, mainEntity, callback); + //build additional table cql + for (final SQLDatabaseModelExtension.AdditionalTable additionalTable : model.getSqlDBModelExtension().getAdditionalTables().values()) { + Map additionalEntity = new HashMap<>(); + additionalTable.getColumns().forEach(column -> { + additionalEntity.put(column.getColumnName().getName(), objectMap.get(column.getColumnName().getName())); + }); + + List additionalSQLExecutors = buildAdditionalInsertExecutor( + model, additionalTable.getName(), additionalTable.getColumns(), metrics, + timeBucket, additionalEntity, callback + ); + sqlExecutor.appendAdditionalCQLs(additionalSQLExecutors); + } + + // extension the span tables for query + if (metrics instanceof ZipkinSpanRecord) { + sqlExecutor.appendAdditionalCQLs(CassandraTableExtension.buildExtensionsForSpan((ZipkinSpanRecord) metrics, callback)); + } + return sqlExecutor; + } + + protected CQLExecutor getUpdateExecutor(Model model, T metrics, + long timeBucket, + StorageBuilder storageBuilder, + SessionCacheCallback callback) { + final Convert2Storage> toStorage = new HashMapConverter.ToStorage(); + storageBuilder.entity2Storage(metrics, toStorage); + final Map objectMap = toStorage.obtain(); + final String table = TableHelper.getTable(model, timeBucket); + final StringBuilder sqlBuilder = new StringBuilder("UPDATE " + table + " SET "); + final List columns = model.getColumns(); + final List queries = new ArrayList<>(); + final List param = new ArrayList<>(); + for (final ModelColumn column : columns) { + final String columnName = column.getColumnName().getName(); + queries.add(column.getColumnName().getStorageName() + " = ?"); + + final Object value = objectMap.get(columnName); + if (value instanceof StorageDataComplexObject) { + param.add(((StorageDataComplexObject) value).toStorageData()); + } else { + param.add(value); + } + } + sqlBuilder.append(queries.stream().collect(Collectors.joining(", "))); + sqlBuilder.append(" WHERE id = ?"); + param.add(TableHelper.generateId(model, metrics.id().build())); + + return new CQLExecutor(sqlBuilder.toString(), param, callback, null); + } + + private List buildAdditionalInsertExecutor(Model model, String tableName, + List columns, + T metrics, + long timeBucket, + Map objectMap, + SessionCacheCallback callback) { + + List sqlExecutors = new ArrayList<>(); + List columnNames = new ArrayList<>(); + List values = new ArrayList<>(); + List param = new ArrayList<>(); + final StringBuilder cqlBuilder = new StringBuilder("INSERT INTO ").append(tableName); + + columnNames.add(ID_COLUMN); + values.add("?"); + param.add(TableHelper.generateId(model, metrics.id().build())); + + int position = 0; + List valueList = new ArrayList(); + for (int i = 0; i < columns.size(); i++) { + ModelColumn column = columns.get(i); + if (List.class.isAssignableFrom(column.getType())) { + valueList = (List) objectMap.get(column.getColumnName().getName()); + + columnNames.add(column.getColumnName().getStorageName()); + values.add("?"); + param.add(null); + + position = i + 1; + } else { + columnNames.add(column.getColumnName().getStorageName()); + values.add("?"); + + Object value = objectMap.get(column.getColumnName().getName()); + if (value instanceof StorageDataComplexObject) { + param.add(((StorageDataComplexObject) value).toStorageData()); + } else { + param.add(value); + } + } + } + + cqlBuilder.append("(").append(columnNames.stream().collect(Collectors.joining(", "))).append(")") + .append(" VALUES (").append(values.stream().collect(Collectors.joining(", "))).append(")"); + String sql = cqlBuilder.toString(); + if (!CollectionUtils.isEmpty(valueList)) { + for (Object object : valueList) { + List paramCopy = new ArrayList<>(param); + paramCopy.set(position, object); + sqlExecutors.add(new CQLExecutor(sql, paramCopy, callback, null)); + } + } else { + // if not query data, then ignore the data insert + if ("zipkin_query".equals(tableName)) { + return sqlExecutors; + } + sqlExecutors.add(new CQLExecutor(sql, param, callback, null)); + } + + return sqlExecutors; + } + + private CQLExecutor buildInsertExecutor(Model model, + T metrics, + long timeBucket, + Map objectMap, + SessionCacheCallback onCompleteCallback) { + final String table = TableHelper.getTableName(model); + final StringBuilder cqlBuilder = new StringBuilder("INSERT INTO ").append(table); + final List columns = model.getColumns(); + final List columnNames = + Stream.concat( + Stream.of(ID_COLUMN, JDBCTableInstaller.TABLE_COLUMN), + columns + .stream() + .map(ModelColumn::getColumnName) + .map(ColumnName::getStorageName)) + .collect(Collectors.toList()); + if (model.isRecord()) { + columnNames.add(CassandraClient.RECORD_UNIQUE_UUID_COLUMN); + } + cqlBuilder.append(columnNames.stream().collect(Collectors.joining(",", "(", ")"))); + cqlBuilder.append(" VALUES "); + cqlBuilder.append(columnNames.stream().map(it -> "?").collect(Collectors.joining(",", "(", ")"))); + + final List params = Stream.concat( + Stream.of(TableHelper.generateId(model, metrics.id().build()), model.getName()), + columns + .stream() + .map(ModelColumn::getColumnName) + .map(ColumnName::getName) + .map(objectMap::get) + .map(it -> { + if (it instanceof StorageDataComplexObject) { + return ((StorageDataComplexObject) it).toStorageData(); + } + return it; + })) + .collect(Collectors.toList()); + if (model.isRecord()) { + params.add(UUID.randomUUID().toString()); + } + + return new CQLExecutor(cqlBuilder.toString(), params, onCompleteCallback, null); + } + + + protected StorageData toStorageData(Row row, String modelName, + StorageBuilder storageBuilder) { + Map data = new HashMap<>(); + List columns = TableMetaInfo.get(modelName).getColumns(); + for (ModelColumn column : columns) { + data.put(column.getColumnName().getName(), row.getObject(column.getColumnName().getStorageName())); + } + return storageBuilder.storage2Entity(new HashMapConverter.ToEntity(data)); + } + + private static String getModelTables(CassandraClient client, String modelName) { + final Model model = TableMetaInfo.get(modelName); + return TableHelper.getTableName(model); + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraHistoryDeleteDAO.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraHistoryDeleteDAO.java new file mode 100644 index 00000000000..3c03279f087 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraHistoryDeleteDAO.java @@ -0,0 +1,27 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.storage.cassandra.dao; + +import org.apache.skywalking.oap.server.core.storage.IHistoryDeleteDAO; +import org.apache.skywalking.oap.server.core.storage.model.Model; + +import java.io.IOException; + +// Use the cassandra table `time_to_live` to clean the history data. +public class CassandraHistoryDeleteDAO implements IHistoryDeleteDAO { + @Override + public void deleteHistory(Model model, String timeBucketColumnName, int ttl) throws IOException { + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraMetricsDAO.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraMetricsDAO.java new file mode 100644 index 00000000000..3a8b9761740 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraMetricsDAO.java @@ -0,0 +1,64 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.storage.cassandra.dao; + +import org.apache.skywalking.oap.server.core.analysis.metrics.Metrics; +import org.apache.skywalking.oap.server.core.storage.IMetricsDAO; +import org.apache.skywalking.oap.server.core.storage.SessionCacheCallback; +import org.apache.skywalking.oap.server.core.storage.StorageData; +import org.apache.skywalking.oap.server.core.storage.model.Model; +import org.apache.skywalking.oap.server.core.storage.type.HashMapConverter; +import org.apache.skywalking.oap.server.core.storage.type.StorageBuilder; +import org.apache.skywalking.oap.server.library.client.request.InsertRequest; +import org.apache.skywalking.oap.server.library.client.request.UpdateRequest; +import org.apache.skywalking.oap.server.storage.plugin.jdbc.common.TableHelper; +import zipkin.server.storage.cassandra.CassandraClient; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +import static java.util.stream.Collectors.toList; + +public class CassandraMetricsDAO extends CassandraCqlExecutor implements IMetricsDAO { + private final CassandraClient client; + private final StorageBuilder storageBuilder; + + public CassandraMetricsDAO(CassandraClient client, StorageBuilder storageBuilder) { + this.client = client; + this.storageBuilder = storageBuilder; + } + + @Override + public List multiGet(Model model, List metrics) throws Exception { + final List ids = metrics.stream().map(m -> TableHelper.generateId(model, m.id().build())).collect(toList()); + final List storageDataList = getByIDs(client, model.getName(), ids, storageBuilder); + final List result = new ArrayList<>(storageDataList.size()); + for (StorageData storageData : storageDataList) { + result.add((Metrics) storageData); + } + return result; + } + + @Override + public InsertRequest prepareBatchInsert(Model model, Metrics metrics, SessionCacheCallback callback) throws IOException { + return getInsertExecutor(model, metrics, metrics.getTimeBucket(), storageBuilder, new HashMapConverter.ToStorage(), callback); + } + + @Override + public UpdateRequest prepareBatchUpdate(Model model, Metrics metrics, SessionCacheCallback callback) throws IOException { + return getUpdateExecutor(model, metrics, metrics.getTimeBucket(), storageBuilder, callback); + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraRecordDAO.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraRecordDAO.java new file mode 100644 index 00000000000..b4c90d56833 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraRecordDAO.java @@ -0,0 +1,37 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.storage.cassandra.dao; + +import org.apache.skywalking.oap.server.core.analysis.record.Record; +import org.apache.skywalking.oap.server.core.storage.IRecordDAO; +import org.apache.skywalking.oap.server.core.storage.model.Model; +import org.apache.skywalking.oap.server.core.storage.type.HashMapConverter; +import org.apache.skywalking.oap.server.core.storage.type.StorageBuilder; +import org.apache.skywalking.oap.server.library.client.request.InsertRequest; + +import java.io.IOException; + +public class CassandraRecordDAO extends CassandraCqlExecutor implements IRecordDAO { + private final StorageBuilder storageBuilder; + + public CassandraRecordDAO(StorageBuilder storageBuilder) { + this.storageBuilder = storageBuilder; + } + + @Override + public InsertRequest prepareBatchInsert(Model model, Record record) throws IOException { + return getInsertExecutor(model, record, record.getTimeBucket(), storageBuilder, new HashMapConverter.ToStorage(), null); + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraSpanAttachedEventRecordDAO.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraSpanAttachedEventRecordDAO.java new file mode 100644 index 00000000000..6f20062bfb6 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraSpanAttachedEventRecordDAO.java @@ -0,0 +1,29 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ +package zipkin.server.storage.cassandra.dao; + +import org.apache.skywalking.oap.server.core.analysis.manual.spanattach.SpanAttachedEventRecord; +import org.apache.skywalking.oap.server.core.analysis.manual.spanattach.SpanAttachedEventTraceType; +import org.apache.skywalking.oap.server.core.storage.query.ISpanAttachedEventQueryDAO; + +import java.io.IOException; +import java.util.Collections; +import java.util.List; + +public class CassandraSpanAttachedEventRecordDAO implements ISpanAttachedEventQueryDAO { + @Override + public List querySpanAttachedEvents(SpanAttachedEventTraceType type, List traceIds) throws IOException { + return Collections.emptyList(); + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraStorageDAO.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraStorageDAO.java new file mode 100644 index 00000000000..8b1e2d46c10 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraStorageDAO.java @@ -0,0 +1,51 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.storage.cassandra.dao; + +import org.apache.skywalking.oap.server.core.storage.IManagementDAO; +import org.apache.skywalking.oap.server.core.storage.IMetricsDAO; +import org.apache.skywalking.oap.server.core.storage.INoneStreamDAO; +import org.apache.skywalking.oap.server.core.storage.IRecordDAO; +import org.apache.skywalking.oap.server.core.storage.StorageDAO; +import org.apache.skywalking.oap.server.core.storage.type.StorageBuilder; +import zipkin.server.storage.cassandra.CassandraClient; + +public class CassandraStorageDAO implements StorageDAO { + private final CassandraClient client; + + public CassandraStorageDAO(CassandraClient client) { + this.client = client; + } + + @Override + public IMetricsDAO newMetricsDao(StorageBuilder storageBuilder) { + return new CassandraMetricsDAO(client, storageBuilder); + } + + @Override + public IRecordDAO newRecordDao(StorageBuilder storageBuilder) { + return new CassandraRecordDAO(storageBuilder); + } + + @Override + public INoneStreamDAO newNoneStreamDao(StorageBuilder storageBuilder) { + throw new IllegalStateException("Cassandra does not support NoneStreamDAO"); + } + + @Override + public IManagementDAO newManagementDao(StorageBuilder storageBuilder) { + throw new IllegalStateException("Cassandra does not support ManagementDAO"); + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraTableExtension.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraTableExtension.java new file mode 100644 index 00000000000..eec4d8afa63 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraTableExtension.java @@ -0,0 +1,85 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.storage.cassandra.dao; + +import com.datastax.oss.driver.api.core.uuid.Uuids; +import io.micrometer.common.util.StringUtils; +import org.apache.skywalking.oap.server.core.storage.SessionCacheCallback; +import org.apache.skywalking.oap.server.core.zipkin.ZipkinSpanRecord; +import zipkin.server.storage.cassandra.CQLExecutor; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.UUID; + +/** + * Help to adding the extension tables for the Cassandra table query. + */ +public class CassandraTableExtension { + public static final String TABLE_TRACE_BY_SERVICE_SPAN = "zipkin_trace_by_service_span"; + public static final String TABLE_TRACE_BY_SERVICE_REMOTE_SERVICE = "zipkin_trace_by_service_remote_service"; + + /** + * Time window covered by a single bucket of the {@link CassandraTableExtension#TABLE_TRACE_BY_SERVICE_SPAN} and + * {@link CassandraTableExtension#TABLE_TRACE_BY_SERVICE_REMOTE_SERVICE}, in seconds. Default: 1 day + */ + private static final long DURATION_INDEX_BUCKET_WINDOW_SECONDS = + Long.getLong("zipkin.store.cassandra.internal.durationIndexBucket", 24 * 60 * 60); + + public static List buildExtensionsForSpan(ZipkinSpanRecord span, SessionCacheCallback callback) { + long ts_milli = span.getTimestampMillis(); + UUID ts_uuid = + new UUID( + Uuids.startOf(ts_milli != 0L ? (ts_milli) : System.currentTimeMillis()) + .getMostSignificantBits(), + Uuids.random().getLeastSignificantBits()); + int bucket = durationIndexBucket(ts_milli); + + final ArrayList result = new ArrayList<>(3); + + long durationMilli = span.getDuration() / 1000; + result.add(buildServiceSpan(span.getLocalEndpointServiceName(), span.getName(), bucket, ts_uuid, span.getTraceId(), durationMilli, callback)); + // Allows lookup without the span name) + result.add(buildServiceSpan(span.getLocalEndpointServiceName(), "", bucket, ts_uuid, span.getTraceId(), durationMilli, callback)); + + if (StringUtils.isNotEmpty(span.getRemoteEndpointServiceName())) { + result.add(buildServiceRemoteService(span.getLocalEndpointServiceName(), span.getRemoteEndpointServiceName(), + bucket, ts_uuid, span.getTraceId(), callback)); + } + + return result; + } + + public static int durationIndexBucket(long ts_milli) { + // if the window constant has microsecond precision, the division produces negative getValues + return (int) (ts_milli / (DURATION_INDEX_BUCKET_WINDOW_SECONDS)); + } + + private static CQLExecutor buildServiceSpan(String service, String span, int bucket, UUID ts, String trace_id, long durationMillis, + SessionCacheCallback callback) { + return new CQLExecutor("insert into " + TABLE_TRACE_BY_SERVICE_SPAN + + " (service, span, bucket, ts, trace_id, duration) values (?, ?, ?, ?, ?, ?)", + Arrays.asList(service, span, bucket, ts, trace_id, durationMillis), callback, null); + } + + private static CQLExecutor buildServiceRemoteService(String service, String remoteService, int bucket, UUID ts, String trace_id, + SessionCacheCallback callback) { + return new CQLExecutor("insert into " + TABLE_TRACE_BY_SERVICE_REMOTE_SERVICE + + " (service, remote_service, bucket, ts, trace_id) values (?, ?, ?, ?, ?)", + Arrays.asList(service, remoteService, bucket, ts, trace_id), callback, null); + } + +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraTagAutocompleteDAO.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraTagAutocompleteDAO.java new file mode 100644 index 00000000000..f4d761e6dd7 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraTagAutocompleteDAO.java @@ -0,0 +1,84 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.storage.cassandra.dao; + +import org.apache.skywalking.oap.server.core.Const; +import org.apache.skywalking.oap.server.core.CoreModule; +import org.apache.skywalking.oap.server.core.analysis.manual.searchtag.TagAutocompleteData; +import org.apache.skywalking.oap.server.core.analysis.manual.searchtag.TagType; +import org.apache.skywalking.oap.server.core.config.ConfigService; +import org.apache.skywalking.oap.server.core.query.input.Duration; +import org.apache.skywalking.oap.server.library.module.ModuleManager; +import org.apache.skywalking.oap.server.storage.plugin.jdbc.common.dao.JDBCTagAutoCompleteQueryDAO; +import zipkin.server.core.services.ZipkinConfigService; +import zipkin.server.storage.cassandra.CassandraClient; +import zipkin.server.storage.cassandra.CassandraTableHelper; + +import java.util.HashSet; +import java.util.Set; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import static java.util.Objects.nonNull; + +public class CassandraTagAutocompleteDAO extends JDBCTagAutoCompleteQueryDAO { + private final CassandraClient client; + private final CassandraTableHelper tableHelper; + private final ModuleManager moduleManager; + private Set tagAutocompleteKeys; + + public CassandraTagAutocompleteDAO(CassandraClient client, CassandraTableHelper tableHelper, ModuleManager moduleManager) { + super(null, tableHelper); + this.client = client; + this.tableHelper = tableHelper; + this.moduleManager = moduleManager; + this.tagAutocompleteKeys = null; + } + + private Set getTagAutocompleteKeys() { + if (tagAutocompleteKeys != null) { + return tagAutocompleteKeys; + } + final ConfigService service = moduleManager.find(CoreModule.NAME).provider().getService(ConfigService.class); + tagAutocompleteKeys = Stream.of((((ZipkinConfigService) service).toZipkinReceiverConfig().getSearchableTracesTags()) + .split(Const.COMMA)).collect(Collectors.toSet()); + return tagAutocompleteKeys; + } + + @Override + public Set queryTagAutocompleteKeys(TagType tagType, int limit, Duration duration) { + return getTagAutocompleteKeys().stream().limit(limit).collect(Collectors.toSet()); + } + + @Override + public Set queryTagAutocompleteValues(TagType tagType, String tagKey, int limit, Duration duration) { + String cql = "select " + TagAutocompleteData.TAG_VALUE + " from " + tableHelper.getTableForRead(TagAutocompleteData.INDEX_NAME) + + " where " + TagAutocompleteData.TAG_KEY + " = ? and " + + TagAutocompleteData.TIME_BUCKET + " >= ? and " + TagAutocompleteData.TIME_BUCKET + " <= ? limit ?"; + + long startSecondTB = 0; + long endSecondTB = 0; + if (nonNull(duration)) { + startSecondTB = duration.getStartTimeBucketInSec(); + endSecondTB = duration.getEndTimeBucketInSec(); + } + + long startTB = startSecondTB / 1000000 * 10000; + long endTB = endSecondTB / 1000000 * 10000 + 2359; + + return new HashSet<>(client.executeQuery(cql, + row -> row.getString(TagAutocompleteData.TAG_VALUE), tagKey, startTB, endTB, limit)); + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraZipkinQueryDAO.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraZipkinQueryDAO.java new file mode 100644 index 00000000000..ce041621e48 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/CassandraZipkinQueryDAO.java @@ -0,0 +1,296 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.storage.cassandra.dao; + +import com.datastax.oss.driver.api.core.cql.Row; +import com.datastax.oss.driver.api.core.uuid.Uuids; +import com.google.gson.Gson; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import org.apache.skywalking.oap.server.core.query.input.Duration; +import org.apache.skywalking.oap.server.core.storage.query.IZipkinQueryDAO; +import org.apache.skywalking.oap.server.core.zipkin.ZipkinServiceRelationTraffic; +import org.apache.skywalking.oap.server.core.zipkin.ZipkinServiceSpanTraffic; +import org.apache.skywalking.oap.server.core.zipkin.ZipkinServiceTraffic; +import org.apache.skywalking.oap.server.core.zipkin.ZipkinSpanRecord; +import org.apache.skywalking.oap.server.library.util.CollectionUtils; +import org.apache.skywalking.oap.server.library.util.StringUtil; +import zipkin.server.storage.cassandra.CassandraClient; +import zipkin.server.storage.cassandra.CassandraTableHelper; +import zipkin2.Endpoint; +import zipkin2.Span; +import zipkin2.storage.QueryRequest; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.HashSet; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.UUID; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionStage; +import java.util.stream.Collectors; + +import static java.util.stream.Collectors.toList; +import static zipkin.server.storage.cassandra.dao.CassandraTableExtension.durationIndexBucket; + +public class CassandraZipkinQueryDAO implements IZipkinQueryDAO { + private final static int NAME_QUERY_MAX_SIZE = Integer.MAX_VALUE; + private static final Gson GSON = new Gson(); + + private final CassandraClient client; + private final CassandraTableHelper tableHelper; + private int indexTtl; + + public CassandraZipkinQueryDAO(CassandraClient client, CassandraTableHelper tableHelper) { + this.client = client; + this.tableHelper = tableHelper; + } + + private int getIndexTtl() { + if (this.indexTtl > 0) { + return this.indexTtl; + } + this.indexTtl = client.getDefaultTtl(ZipkinSpanRecord.INDEX_NAME); + return this.indexTtl; + } + + @Override + public List getServiceNames() throws IOException { + return client.executeQuery("select " + ZipkinServiceTraffic.SERVICE_NAME + " from " + + tableHelper.getTableForRead(ZipkinServiceTraffic.INDEX_NAME) + " limit " + NAME_QUERY_MAX_SIZE, + row -> row.getString(ZipkinServiceTraffic.SERVICE_NAME)); + } + + @Override + public List getRemoteServiceNames(String serviceName) throws IOException { + return client.executeQuery("select " + ZipkinServiceRelationTraffic.REMOTE_SERVICE_NAME + + " from " + tableHelper.getTableForRead(ZipkinServiceRelationTraffic.INDEX_NAME) + + " where " + ZipkinServiceRelationTraffic.SERVICE_NAME + " = ?" + + " limit " + NAME_QUERY_MAX_SIZE, + row -> row.getString(ZipkinServiceRelationTraffic.REMOTE_SERVICE_NAME), + serviceName); + } + + @Override + public List getSpanNames(String serviceName) throws IOException { + return client.executeQuery("select " + ZipkinServiceSpanTraffic.SPAN_NAME + + " from " + tableHelper.getTableForRead(ZipkinServiceSpanTraffic.INDEX_NAME) + + " where " + ZipkinServiceSpanTraffic.SERVICE_NAME + " = ?" + + " limit " + NAME_QUERY_MAX_SIZE, + row -> row.getString(ZipkinServiceSpanTraffic.SPAN_NAME), + serviceName); + } + + @Override + public List getTrace(String traceId) { + return client.executeQuery("select * from " + tableHelper.getTableForRead(ZipkinSpanRecord.INDEX_NAME) + + " where " + ZipkinSpanRecord.TRACE_ID + " = ?" + + " limit " + NAME_QUERY_MAX_SIZE, + this::buildSpan, traceId); + } + + @Override + public List> getTraces(QueryRequest request, Duration duration) throws IOException { + List>> completionTraceIds = new ArrayList<>(); + if (CollectionUtils.isNotEmpty(request.annotationQuery())) { + for (Map.Entry entry : request.annotationQuery().entrySet()) { + completionTraceIds.add(client.executeAsyncQuery("select " + ZipkinSpanRecord.TRACE_ID + + " from " + ZipkinSpanRecord.ADDITIONAL_QUERY_TABLE + + " where " + ZipkinSpanRecord.QUERY + " = ?" + + " and " + ZipkinSpanRecord.TIME_BUCKET + " >= ?" + + " and " + ZipkinSpanRecord.TIME_BUCKET + " <= ?", + row -> row.getString(ZipkinSpanRecord.TRACE_ID), + entry.getValue().isEmpty() ? entry.getKey() : entry.getKey() + "=" + entry.getValue(), + duration.getStartTimeBucket(), duration.getEndTimeBucket())); + } + } + + // Bucketed calls can be expensive when service name isn't specified. This guards against abuse. + if (request.remoteServiceName() != null + || request.spanName() != null + || request.minDuration() != null + || completionTraceIds.isEmpty()) { + completionTraceIds.add(newBucketedTraceIdCall(request)); + } + + final Set traceIdSet = retainTraceIdList(completionTraceIds); + return getTraces(request.limit() > 0 ? traceIdSet.stream().limit(request.limit()).collect(Collectors.toSet()) : traceIdSet); + } + + private CompletionStage> newBucketedTraceIdCall(QueryRequest request) throws IOException { + final List>> result = new ArrayList<>(); + + TimestampRange timestampRange = timestampRange(request); + int startBucket = durationIndexBucket(timestampRange.startMillis); + int endBucket = durationIndexBucket(timestampRange.endMillis); + if (startBucket > endBucket) { + throw new IllegalArgumentException( + "Start bucket (" + startBucket + ") > end bucket (" + endBucket + ")"); + } + + String remoteService = request.remoteServiceName(); + List serviceNames = StringUtil.isEmpty(request.serviceName()) ? getServiceNames() : Arrays.asList(request.serviceName()); + String spanName = null != request.spanName() ? request.spanName() : ""; + Long minDuration = request.minDuration(), maxDuration = request.maxDuration(); + + Long start_duration = null, end_duration = null; + if (minDuration != null) { + start_duration = minDuration / 1000L; + end_duration = maxDuration != null ? maxDuration / 1000L : Long.MAX_VALUE; + } + + String traceByServiceSpanBaseCql = "select trace_id from " + CassandraTableExtension.TABLE_TRACE_BY_SERVICE_SPAN + + " where service=? and span=? and bucket=? and ts>=? and ts<=?"; + // each service names + for (String serviceName : serviceNames) { + for (int bucket = endBucket; bucket >= startBucket; bucket--) { + boolean addSpanQuery = true; + if (remoteService != null) { + result.add(client.executeAsyncQuery("select trace_id from " + CassandraTableExtension.TABLE_TRACE_BY_SERVICE_REMOTE_SERVICE + + " where service=? and remote_service=? and bucket=? and ts>=? and ts<=?", + resultSet -> resultSet.getString(0), + serviceName, remoteService, bucket, timestampRange.startUUID, timestampRange.endUUID)); + // If the remote service query can satisfy the request, don't make a redundant span query + addSpanQuery = !spanName.isEmpty() || minDuration != null; + } + if (!addSpanQuery) continue; + + if (start_duration != null) { + result.add(client.executeAsyncQuery(traceByServiceSpanBaseCql + " and duration>=? and duration<=?", + resultSet -> resultSet.getString(0), + serviceName, spanName, bucket, timestampRange.startUUID, timestampRange.endUUID, start_duration, end_duration) + ); + } else { + result.add(client.executeAsyncQuery(traceByServiceSpanBaseCql, + resultSet -> resultSet.getString(0), + serviceName, spanName, bucket, timestampRange.startUUID, timestampRange.endUUID)); + } + } + } + + return CompletableFuture.allOf(result.toArray(new CompletableFuture[0])) + .thenApplyAsync(ignored -> + result.stream() + .map(CompletionStage::toCompletableFuture) + .map(CompletableFuture::join) + .collect(ArrayList::new, ArrayList::addAll, (list1, list2) -> { + })); + } + + private Set retainTraceIdList(List>> completionStages) { + Iterator>> iterator = completionStages.iterator(); + if (!iterator.hasNext()) return Collections.emptySet(); + Set result = new HashSet<>(iterator.next().toCompletableFuture().join()); + while (iterator.hasNext() && result.size() > 0) { + Set nextSet = new HashSet<>(iterator.next().toCompletableFuture().join()); + result.retainAll(nextSet); + } + + return result; + } + + @Override + public List> getTraces(Set traceIds) throws IOException { + if (CollectionUtils.isEmpty(traceIds)) { + return Collections.emptyList(); + } + + String table = tableHelper.getTableForRead(ZipkinSpanRecord.INDEX_NAME); + return traceIds.stream().map(traceId -> + client.executeAsyncQuery("select * from " + table + " where " + ZipkinSpanRecord.TRACE_ID + " = ?", this::buildSpan, traceId) + ).map(CompletionStage::toCompletableFuture).map(CompletableFuture::join).collect(toList()); + } + + private Span buildSpan(Row row) { + Span.Builder span = Span.newBuilder(); + span.traceId(row.getString(ZipkinSpanRecord.TRACE_ID)); + span.id(row.getString(ZipkinSpanRecord.SPAN_ID)); + span.parentId(row.getString(ZipkinSpanRecord.PARENT_ID)); + String kind = row.getString(ZipkinSpanRecord.KIND); + if (!StringUtil.isEmpty(kind)) { + span.kind(Span.Kind.valueOf(kind)); + } + span.timestamp(row.getLong(ZipkinSpanRecord.TIMESTAMP)); + span.duration(row.getLong(ZipkinSpanRecord.DURATION)); + span.name(row.getString(ZipkinSpanRecord.NAME)); + + if (row.getInt(ZipkinSpanRecord.DEBUG) > 0) { + span.debug(Boolean.TRUE); + } + if (row.getInt(ZipkinSpanRecord.SHARED) > 0) { + span.shared(Boolean.TRUE); + } + //Build localEndpoint + Endpoint.Builder localEndpoint = Endpoint.newBuilder(); + localEndpoint.serviceName(row.getString(ZipkinSpanRecord.LOCAL_ENDPOINT_SERVICE_NAME)); + if (!StringUtil.isEmpty(row.getString(ZipkinSpanRecord.LOCAL_ENDPOINT_IPV4))) { + localEndpoint.parseIp(row.getString(ZipkinSpanRecord.LOCAL_ENDPOINT_IPV4)); + } else { + localEndpoint.parseIp(row.getString(ZipkinSpanRecord.LOCAL_ENDPOINT_IPV6)); + } + localEndpoint.port(row.getInt(ZipkinSpanRecord.LOCAL_ENDPOINT_PORT)); + span.localEndpoint(localEndpoint.build()); + //Build remoteEndpoint + Endpoint.Builder remoteEndpoint = Endpoint.newBuilder(); + remoteEndpoint.serviceName(row.getString(ZipkinSpanRecord.REMOTE_ENDPOINT_SERVICE_NAME)); + if (!StringUtil.isEmpty(row.getString(ZipkinSpanRecord.REMOTE_ENDPOINT_IPV4))) { + remoteEndpoint.parseIp(row.getString(ZipkinSpanRecord.REMOTE_ENDPOINT_IPV4)); + } else { + remoteEndpoint.parseIp(row.getString(ZipkinSpanRecord.REMOTE_ENDPOINT_IPV6)); + } + remoteEndpoint.port(row.getInt(ZipkinSpanRecord.REMOTE_ENDPOINT_PORT)); + span.remoteEndpoint(remoteEndpoint.build()); + + //Build tags + String tagsString = row.getString(ZipkinSpanRecord.TAGS); + if (!StringUtil.isEmpty(tagsString)) { + JsonObject tagsJson = GSON.fromJson(tagsString, JsonObject.class); + for (Map.Entry tag : tagsJson.entrySet()) { + span.putTag(tag.getKey(), tag.getValue().getAsString()); + } + } + //Build annotation + String annotationString = row.getString(ZipkinSpanRecord.ANNOTATIONS); + if (!StringUtil.isEmpty(annotationString)) { + JsonObject annotationJson = GSON.fromJson(annotationString, JsonObject.class); + for (Map.Entry annotation : annotationJson.entrySet()) { + span.addAnnotation(Long.parseLong(annotation.getKey()), annotation.getValue().getAsString()); + } + } + return span.build(); + } + + static final class TimestampRange { + long startMillis; + UUID startUUID; + long endMillis; + UUID endUUID; + } + + TimestampRange timestampRange(QueryRequest request) { + long oldestData = Math.max(System.currentTimeMillis() - getIndexTtl() * 1000, 0); // >= 1970 + TimestampRange result = new TimestampRange(); + result.startMillis = Math.max((request.endTs() - request.lookback()), oldestData); + result.startUUID = Uuids.startOf(result.startMillis); + result.endMillis = Math.max(request.endTs(), oldestData); + result.endUUID = Uuids.endOf(result.endMillis); + return result; + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/EmptyDAO.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/EmptyDAO.java new file mode 100644 index 00000000000..41e3dab59fb --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/dao/EmptyDAO.java @@ -0,0 +1,470 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.storage.cassandra.dao; + +import org.apache.skywalking.oap.server.core.analysis.manual.networkalias.NetworkAddressAlias; +import org.apache.skywalking.oap.server.core.analysis.manual.searchtag.Tag; +import org.apache.skywalking.oap.server.core.analysis.manual.searchtag.TagType; +import org.apache.skywalking.oap.server.core.analysis.manual.segment.SegmentRecord; +import org.apache.skywalking.oap.server.core.analysis.manual.spanattach.SpanAttachedEventRecord; +import org.apache.skywalking.oap.server.core.analysis.manual.spanattach.SpanAttachedEventTraceType; +import org.apache.skywalking.oap.server.core.analysis.metrics.Metrics; +import org.apache.skywalking.oap.server.core.analysis.record.Record; +import org.apache.skywalking.oap.server.core.browser.source.BrowserErrorCategory; +import org.apache.skywalking.oap.server.core.management.ui.menu.UIMenu; +import org.apache.skywalking.oap.server.core.profiling.continuous.storage.ContinuousProfilingPolicy; +import org.apache.skywalking.oap.server.core.profiling.ebpf.storage.EBPFProfilingDataRecord; +import org.apache.skywalking.oap.server.core.profiling.ebpf.storage.EBPFProfilingTargetType; +import org.apache.skywalking.oap.server.core.profiling.ebpf.storage.EBPFProfilingTaskRecord; +import org.apache.skywalking.oap.server.core.profiling.ebpf.storage.EBPFProfilingTriggerType; +import org.apache.skywalking.oap.server.core.profiling.trace.ProfileThreadSnapshotRecord; +import org.apache.skywalking.oap.server.core.query.enumeration.Order; +import org.apache.skywalking.oap.server.core.query.enumeration.ProfilingSupportStatus; +import org.apache.skywalking.oap.server.core.query.input.DashboardSetting; +import org.apache.skywalking.oap.server.core.query.input.Duration; +import org.apache.skywalking.oap.server.core.query.input.MetricsCondition; +import org.apache.skywalking.oap.server.core.query.input.RecordCondition; +import org.apache.skywalking.oap.server.core.query.input.TopNCondition; +import org.apache.skywalking.oap.server.core.query.input.TraceScopeCondition; +import org.apache.skywalking.oap.server.core.query.type.Alarms; +import org.apache.skywalking.oap.server.core.query.type.BrowserErrorLog; +import org.apache.skywalking.oap.server.core.query.type.BrowserErrorLogs; +import org.apache.skywalking.oap.server.core.query.type.Call; +import org.apache.skywalking.oap.server.core.query.type.DashboardConfiguration; +import org.apache.skywalking.oap.server.core.query.type.EBPFProfilingSchedule; +import org.apache.skywalking.oap.server.core.query.type.Endpoint; +import org.apache.skywalking.oap.server.core.query.type.HeatMap; +import org.apache.skywalking.oap.server.core.query.type.KeyValue; +import org.apache.skywalking.oap.server.core.query.type.Logs; +import org.apache.skywalking.oap.server.core.query.type.MetricsValues; +import org.apache.skywalking.oap.server.core.query.type.NullableValue; +import org.apache.skywalking.oap.server.core.query.type.Process; +import org.apache.skywalking.oap.server.core.query.type.ProfileTask; +import org.apache.skywalking.oap.server.core.query.type.ProfileTaskLog; +import org.apache.skywalking.oap.server.core.query.type.QueryOrder; +import org.apache.skywalking.oap.server.core.query.type.SelectedRecord; +import org.apache.skywalking.oap.server.core.query.type.Service; +import org.apache.skywalking.oap.server.core.query.type.ServiceInstance; +import org.apache.skywalking.oap.server.core.query.type.Span; +import org.apache.skywalking.oap.server.core.query.type.TemplateChangeStatus; +import org.apache.skywalking.oap.server.core.query.type.TraceBrief; +import org.apache.skywalking.oap.server.core.query.type.TraceState; +import org.apache.skywalking.oap.server.core.query.type.event.EventQueryCondition; +import org.apache.skywalking.oap.server.core.query.type.event.Events; +import org.apache.skywalking.oap.server.core.storage.IMetricsDAO; +import org.apache.skywalking.oap.server.core.storage.IRecordDAO; +import org.apache.skywalking.oap.server.core.storage.SessionCacheCallback; +import org.apache.skywalking.oap.server.core.storage.cache.INetworkAddressAliasDAO; +import org.apache.skywalking.oap.server.core.storage.management.UIMenuManagementDAO; +import org.apache.skywalking.oap.server.core.storage.management.UITemplateManagementDAO; +import org.apache.skywalking.oap.server.core.storage.model.Model; +import org.apache.skywalking.oap.server.core.storage.profiling.continuous.IContinuousProfilingPolicyDAO; +import org.apache.skywalking.oap.server.core.storage.profiling.ebpf.IEBPFProfilingDataDAO; +import org.apache.skywalking.oap.server.core.storage.profiling.ebpf.IEBPFProfilingScheduleDAO; +import org.apache.skywalking.oap.server.core.storage.profiling.ebpf.IEBPFProfilingTaskDAO; +import org.apache.skywalking.oap.server.core.storage.profiling.ebpf.IServiceLabelDAO; +import org.apache.skywalking.oap.server.core.storage.profiling.trace.IProfileTaskLogQueryDAO; +import org.apache.skywalking.oap.server.core.storage.profiling.trace.IProfileTaskQueryDAO; +import org.apache.skywalking.oap.server.core.storage.profiling.trace.IProfileThreadSnapshotQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.IAggregationQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.IAlarmQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.IBrowserLogQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.IEventQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.ILogQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.IMetadataQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.IMetricsQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.IRecordsQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.ISpanAttachedEventQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.ITagAutoCompleteQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.ITopologyQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.ITraceQueryDAO; +import org.apache.skywalking.oap.server.library.client.request.InsertRequest; +import org.apache.skywalking.oap.server.library.client.request.UpdateRequest; + +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import java.util.Set; + +public class EmptyDAO implements + INetworkAddressAliasDAO, + ITopologyQueryDAO, + IMetricsDAO, + ILogQueryDAO, + ITraceQueryDAO, + IMetricsQueryDAO, + IAggregationQueryDAO, + IAlarmQueryDAO, + IRecordsQueryDAO, + IRecordDAO, + IBrowserLogQueryDAO, + IMetadataQueryDAO, + IProfileTaskQueryDAO, + IProfileTaskLogQueryDAO, + IProfileThreadSnapshotQueryDAO, + UITemplateManagementDAO, + UIMenuManagementDAO, + IEventQueryDAO, + IEBPFProfilingTaskDAO, + IEBPFProfilingScheduleDAO, + IEBPFProfilingDataDAO, + IContinuousProfilingPolicyDAO, + IServiceLabelDAO +{ + @Override + public List loadLastUpdate(long timeBucket) { + throw new IllegalStateException("Not implemented"); + } + + @Override + public InsertRequest prepareBatchInsert(Model model, Record record) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public UIMenu getMenu(String id) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public void saveMenu(UIMenu menu) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public DashboardConfiguration getTemplate(String id) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List getAllTemplates(Boolean includingDisabled) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public TemplateChangeStatus addTemplate(DashboardSetting setting) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public TemplateChangeStatus changeTemplate(DashboardSetting setting) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public TemplateChangeStatus disableTemplate(String id) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public void savePolicy(ContinuousProfilingPolicy policy) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List queryPolicies(List serviceIdList) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List queryData(List scheduleIdList, long beginTime, long endTime) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List querySchedules(String taskId) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List queryTasksByServices(List serviceIdList, EBPFProfilingTriggerType triggerType, long taskStartTime, long latestUpdateTime) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List queryTasksByTargets(String serviceId, String serviceInstanceId, List targetTypes, EBPFProfilingTriggerType triggerType, long taskStartTime, long latestUpdateTime) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List getTaskRecord(String id) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List queryAllLabels(String serviceId) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List getTaskLogList() throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List queryProfiledSegmentIdList(String taskId) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public int queryMinSequence(String segmentId, long start, long end) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public int queryMaxSequence(String segmentId, long start, long end) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List queryRecords(String segmentId, int minSequence, int maxSequence) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List sortMetrics(TopNCondition condition, String valueColumnName, Duration duration, List additionalConditions) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public Alarms getAlarm(Integer scopeId, String keyword, int limit, int from, Duration duration, List tags) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public void parserDataBinaryBase64(String dataBinaryBase64, List tags) { + throw new IllegalStateException("Not implemented"); + } + + @Override + public BrowserErrorLogs queryBrowserErrorLogs(String serviceId, String serviceVersionId, String pagePathId, BrowserErrorCategory category, Duration duration, int limit, int from) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public BrowserErrorLog parserDataBinary(String dataBinaryBase64) { + throw new IllegalStateException("Not implemented"); + } + + @Override + public BrowserErrorLog parserDataBinary(byte[] dataBinary) { + throw new IllegalStateException("Not implemented"); + } + + @Override + public Events queryEvents(EventQueryCondition condition) throws Exception { + throw new IllegalStateException("Not implemented"); + } + + @Override + public Events queryEvents(List conditionList) throws Exception { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List loadServiceRelationsDetectedAtServerSide(Duration duration, List serviceIds) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List loadServiceRelationDetectedAtClientSide(Duration duration, List serviceIds) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List loadServiceRelationsDetectedAtServerSide(Duration duration) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List loadServiceRelationDetectedAtClientSide(Duration duration) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List loadInstanceRelationDetectedAtServerSide(String clientServiceId, String serverServiceId, Duration duration) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List loadInstanceRelationDetectedAtClientSide(String clientServiceId, String serverServiceId, Duration duration) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List loadEndpointRelation(Duration duration, String destEndpointId) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List loadProcessRelationDetectedAtClientSide(String serviceInstanceId, Duration duration) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List loadProcessRelationDetectedAtServerSide(String serviceInstanceId, Duration duration) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public TraceBrief queryBasicTraces(Duration duration, long minDuration, long maxDuration, String serviceId, String serviceInstanceId, String endpointId, String traceId, int limit, int from, TraceState traceState, QueryOrder queryOrder, List tags) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List queryByTraceId(String traceId) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List queryBySegmentIdList(List segmentIdList) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List queryByTraceIdWithInstanceId(List traceIdList, List instanceIdList) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List doFlexibleTraceQuery(String traceId) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List getTaskList(String serviceId, String endpointName, Long startTimeBucket, Long endTimeBucket, Integer limit) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public ProfileTask getById(String id) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List multiGet(Model model, List metrics) throws Exception { + throw new IllegalStateException("Not implemented"); + } + + @Override + public InsertRequest prepareBatchInsert(Model model, Metrics metrics, SessionCacheCallback callback) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public UpdateRequest prepareBatchUpdate(Model model, Metrics metrics, SessionCacheCallback callback) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List listServices() throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List listInstances(Duration duration, String serviceId) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public ServiceInstance getInstance(String instanceId) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List getInstances(List instanceIds) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List findEndpoint(String keyword, String serviceId, int limit) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List listProcesses(String serviceId, ProfilingSupportStatus supportStatus, long lastPingStartTimeBucket, long lastPingEndTimeBucket) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List listProcesses(String serviceInstanceId, Duration duration, boolean includeVirtual) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List listProcesses(String agentId) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public long getProcessCount(String serviceId, ProfilingSupportStatus profilingSupportStatus, long lastPingStartTimeBucket, long lastPingEndTimeBucket) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public long getProcessCount(String instanceId) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public Process getProcess(String processId) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List readRecords(RecordCondition condition, String valueColumnName, Duration duration) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public NullableValue readMetricsValue(MetricsCondition condition, String valueColumnName, Duration duration) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public MetricsValues readMetricsValues(MetricsCondition condition, String valueColumnName, Duration duration) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public List readLabeledMetricsValues(MetricsCondition condition, String valueColumnName, List labels, Duration duration) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public HeatMap readHeatMap(MetricsCondition condition, String valueColumnName, Duration duration) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public boolean supportQueryLogsByKeywords() { + throw new IllegalStateException("Not implemented"); + } + + @Override + public Logs queryLogs(String serviceId, String serviceInstanceId, String endpointId, TraceScopeCondition relatedTrace, Order queryOrder, int from, int limit, Duration duration, List tags, List keywordsOfContent, List excludingKeywordsOfContent) throws IOException { + throw new IllegalStateException("Not implemented"); + } + + @Override + public void parserDataBinary(String dataBinaryBase64, List tags) { + throw new IllegalStateException("Not implemented"); + } + + @Override + public void parserDataBinary(byte[] dataBinary, List tags) { + throw new IllegalStateException("Not implemented"); + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/internal/HostAndPort.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/internal/HostAndPort.java new file mode 100644 index 00000000000..593621cb3b7 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/internal/HostAndPort.java @@ -0,0 +1,102 @@ +/* + * Copyright 2015-2019 The OpenZipkin Authors + * + * 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. + */ +package zipkin.server.storage.cassandra.internal; + +import zipkin2.Endpoint; + +// Similar to com.google.common.net.HostAndPort, but no guava dep +public final class HostAndPort { + final String host; + final int port; + + HostAndPort(String host, int port) { + this.host = host; + this.port = port; + } + + /** Returns the unvalidated hostname or IP literal */ + public String getHost() { + return host; + } + + /** Returns the port */ + public int getPort() { + return port; + } + + @Override public boolean equals(Object o) { + if (o == this) return true; + if (!(o instanceof HostAndPort)) return false; + HostAndPort that = (HostAndPort) o; + return host.equals(that.host) && port == that.port; + } + + @Override public int hashCode() { + int h = 1; + h *= 1000003; + h ^= (host == null) ? 0 : host.hashCode(); + h *= 1000003; + h ^= port; + return h; + } + + @Override public String toString() { + return "HostAndPort{host=" + host + ", port=" + port + "}"; + } + + /** + * Constructs a host-port pair from the given string, defaulting to the indicated port if absent + */ + public static HostAndPort fromString(String hostPort, int defaultPort) { + if (hostPort == null) throw new NullPointerException("hostPort == null"); + + String host = hostPort; + int endHostIndex = hostPort.length(); + if (hostPort.startsWith("[")) { // Bracketed IPv6 + endHostIndex = hostPort.lastIndexOf(']') + 1; + host = hostPort.substring(1, endHostIndex == 0 ? 1 : endHostIndex - 1); + if (!Endpoint.newBuilder().parseIp(host)) { // reuse our IPv6 validator + throw new IllegalArgumentException(hostPort + " contains an invalid IPv6 literal"); + } + } else { + int colonIndex = hostPort.indexOf(':'), nextColonIndex = hostPort.lastIndexOf(':'); + if (colonIndex >= 0) { + if (colonIndex == nextColonIndex) { // only 1 colon + host = hostPort.substring(0, colonIndex); + endHostIndex = colonIndex; + } else if (!Endpoint.newBuilder().parseIp(hostPort)) { // reuse our IPv6 validator + throw new IllegalArgumentException(hostPort + " is an invalid IPv6 literal"); + } + } + } + if (host.isEmpty()) throw new IllegalArgumentException(hostPort + " has an empty host"); + if (endHostIndex + 1 < hostPort.length() && hostPort.charAt(endHostIndex) == ':') { + return new HostAndPort(host, validatePort(hostPort.substring(endHostIndex + 1), hostPort)); + } + return new HostAndPort(host, defaultPort); + } + + static int validatePort(String portString, String hostPort) { + for (int i = 0, length = portString.length(); i < length; i++) { + char c = portString.charAt(i); + if (c >= '0' && c <= '9') continue; // isDigit + throw new IllegalArgumentException(hostPort + " has an invalid port"); + } + int result = Integer.parseInt(portString); + if (result == 0 || result > 0xffff) { + throw new IllegalArgumentException(hostPort + " has an invalid port"); + } + return result; + } +} diff --git a/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/internal/SessionBuilder.java b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/internal/SessionBuilder.java new file mode 100644 index 00000000000..f050f28333f --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/java/zipkin/server/storage/cassandra/internal/SessionBuilder.java @@ -0,0 +1,105 @@ +/* + * Copyright 2015-2020 The OpenZipkin Authors + * + * 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. + */ +package zipkin.server.storage.cassandra.internal; + +import com.datastax.oss.driver.api.core.CqlSession; +import com.datastax.oss.driver.api.core.CqlSessionBuilder; +import com.datastax.oss.driver.api.core.auth.AuthProvider; +import com.datastax.oss.driver.api.core.config.DriverConfigLoader; +import com.datastax.oss.driver.api.core.config.DriverOption; +import com.datastax.oss.driver.api.core.config.ProgrammaticDriverConfigLoaderBuilder; +import com.datastax.oss.driver.internal.core.ssl.DefaultSslEngineFactory; +import com.datastax.oss.driver.internal.core.tracker.RequestLogger; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import zipkin2.internal.Nullable; + +import java.net.InetSocketAddress; +import java.time.Duration; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.REQUEST_CONSISTENCY; +import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.REQUEST_DEFAULT_IDEMPOTENCE; +import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.REQUEST_LOGGER_SUCCESS_ENABLED; +import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.REQUEST_LOGGER_VALUES; +import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.REQUEST_TIMEOUT; +import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.REQUEST_TRACKER_CLASS; +import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.REQUEST_WARN_IF_SET_KEYSPACE; +import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.SSL_ENGINE_FACTORY_CLASS; + +public final class SessionBuilder { + /** Returns a connected session. Closes the cluster if any exception occurred. */ + public static CqlSession buildSession( + String contactPoints, + String localDc, + Map poolingOptions, + @Nullable AuthProvider authProvider, + boolean useSsl + ) { + // Some options aren't supported by builder methods. In these cases, we use driver config + // See https://groups.google.com/a/lists.datastax.com/forum/#!topic/java-driver-user/Z8HrCDX47Q0 + ProgrammaticDriverConfigLoaderBuilder config = + // We aren't reading any resources from the classpath, but this prevents errors running in the + // server, where Thread.currentThread().getContextClassLoader() returns null + DriverConfigLoader.programmaticBuilder(SessionBuilder.class.getClassLoader()); + + // Ported from java-driver v3 PoolingOptions.setPoolTimeoutMillis as request timeout includes that + config.withDuration(REQUEST_TIMEOUT, Duration.ofMinutes(1)); + + CqlSessionBuilder builder = CqlSession.builder(); + builder.addContactPoints(parseContactPoints(contactPoints)); + if (authProvider != null) builder.withAuthProvider(authProvider); + + // In java-driver v3, we used LatencyAwarePolicy(DCAwareRoundRobinPolicy|RoundRobinPolicy) + // where DCAwareRoundRobinPolicy was used if localDc != null + // + // In java-driver v4, the default policy is token-aware and localDc is required. Hence, we + // use the default load balancing policy + // * https://github.com/datastax/java-driver/blob/master/manual/core/load_balancing/README.md + builder.withLocalDatacenter(localDc); + config = config.withString(REQUEST_CONSISTENCY, "LOCAL_ONE"); + // Pooling options changed dramatically from v3->v4. This is a close match. + poolingOptions.forEach(config::withInt); + + // All Zipkin CQL writes are idempotent + config = config.withBoolean(REQUEST_DEFAULT_IDEMPOTENCE, true); + + if (useSsl) config = config.withClass(SSL_ENGINE_FACTORY_CLASS, DefaultSslEngineFactory.class); + + // Log categories can enable query logging + Logger requestLogger = LoggerFactory.getLogger(RequestLogger.class); + if (requestLogger.isDebugEnabled()) { + config = config.withClass(REQUEST_TRACKER_CLASS, RequestLogger.class); + config = config.withBoolean(REQUEST_LOGGER_SUCCESS_ENABLED, true); + // Only show bodies when TRACE is enabled + config = config.withBoolean(REQUEST_LOGGER_VALUES, requestLogger.isTraceEnabled()); + } + + // Don't warn: ensureSchema creates the keyspace. Hence, we need to "use" it later. + config = config.withBoolean(REQUEST_WARN_IF_SET_KEYSPACE, false); + + return builder.withConfigLoader(config.build()).build(); + } + + static List parseContactPoints(String contactPoints) { + List result = new ArrayList<>(); + for (String contactPoint : contactPoints.split(",", 100)) { + HostAndPort parsed = HostAndPort.fromString(contactPoint, 9042); + result.add(new InetSocketAddress(parsed.getHost(), parsed.getPort())); + } + return result; + } +} diff --git a/zipkin-server/storage-cassandra/src/main/resources/META-INF/services/org.apache.skywalking.oap.server.library.module.ModuleProvider b/zipkin-server/storage-cassandra/src/main/resources/META-INF/services/org.apache.skywalking.oap.server.library.module.ModuleProvider new file mode 100755 index 00000000000..38538a46d12 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/resources/META-INF/services/org.apache.skywalking.oap.server.library.module.ModuleProvider @@ -0,0 +1,19 @@ +# +# 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. +# +# + +zipkin.server.storage.cassandra.CassandraProvider \ No newline at end of file diff --git a/zipkin-server/storage-cassandra/src/main/resources/zipkin-schemas.cql b/zipkin-server/storage-cassandra/src/main/resources/zipkin-schemas.cql new file mode 100644 index 00000000000..508ced3c89f --- /dev/null +++ b/zipkin-server/storage-cassandra/src/main/resources/zipkin-schemas.cql @@ -0,0 +1,176 @@ +CREATE KEYSPACE IF NOT EXISTS zipkin2 + WITH replication = {'class': 'SimpleStrategy', 'replication_factor': '1'} + AND durable_writes = false; + +CREATE TABLE IF NOT EXISTS zipkin_span ( + id text, + table_name text, + trace_id text, + span_id text, + parent_id text, + name text, + duration BIGINT, + kind text, + timestamp_millis BIGINT, + TIMESTAMP BIGINT, + local_endpoint_service_name text, + local_endpoint_ipv4 text, + local_endpoint_ipv6 text, + local_endpoint_port INT, + remote_endpoint_service_name text, + remote_endpoint_ipv4 text, + remote_endpoint_ipv6 text, + remote_endpoint_port INT, + annotations text, + tags text, + debug INT, + shared INT, + time_bucket BIGINT, + uuid_unique text, + PRIMARY KEY(trace_id, uuid_unique) +) + WITH CLUSTERING ORDER BY (uuid_unique DESC) + AND compaction = {'class': 'org.apache.cassandra.db.compaction.TimeWindowCompactionStrategy'} + AND default_time_to_live = 604800 + AND gc_grace_seconds = 3600 + AND read_repair_chance = 0 + AND dclocal_read_repair_chance = 0 + AND speculative_retry = '95percentile' + AND comment = 'Primary table for holding trace data'; + +CREATE TABLE IF NOT EXISTS zipkin_service_relation_traffic ( + id text, + table_name text, + service_name text, + remote_service_name text, + time_bucket BIGINT, + PRIMARY KEY(service_name, remote_service_name) +) + WITH compaction = {'class': 'org.apache.cassandra.db.compaction.LeveledCompactionStrategy', 'unchecked_tombstone_compaction': 'true', 'tombstone_threshold': '0.2'} + AND caching = {'rows_per_partition': 'ALL'} + AND default_time_to_live = 259200 + AND gc_grace_seconds = 3600 + AND read_repair_chance = 0 + AND dclocal_read_repair_chance = 0 + AND speculative_retry = '95percentile' + AND comment = 'Secondary table for looking up remote service names by a service name.'; + +CREATE TABLE IF NOT EXISTS zipkin_service_span_traffic ( + id text, + table_name text, + service_name text, + span_name text, + time_bucket BIGINT, + PRIMARY KEY(service_name, span_name) +) + WITH compaction = {'class': 'org.apache.cassandra.db.compaction.LeveledCompactionStrategy', 'unchecked_tombstone_compaction': 'true', 'tombstone_threshold': '0.2'} + AND caching = {'rows_per_partition': 'ALL'} + AND default_time_to_live = 604800 + AND gc_grace_seconds = 3600 + AND read_repair_chance = 0 + AND dclocal_read_repair_chance = 0 + AND speculative_retry = '95percentile' + AND comment = 'Secondary table for looking up span names by a service name.'; + +CREATE TABLE IF NOT EXISTS zipkin_service_traffic ( + id text, + table_name text, + service_name text, + time_bucket BIGINT, + PRIMARY KEY(service_name, time_bucket) +) + WITH compaction = {'class': 'org.apache.cassandra.db.compaction.TimeWindowCompactionStrategy'} + AND default_time_to_live = 604800 + AND gc_grace_seconds = 3600 + AND read_repair_chance = 0 + AND dclocal_read_repair_chance = 0 + AND speculative_retry = '95percentile' + AND comment = 'Secondary table for looking up all services'; + +CREATE TABLE IF NOT EXISTS zipkin_query ( + id text, + trace_id text, + query text, + time_bucket BIGINT, + PRIMARY KEY(query, time_bucket, trace_id) +) + WITH CLUSTERING ORDER BY (time_bucket DESC, trace_id DESC) + AND compaction = {'class': 'org.apache.cassandra.db.compaction.TimeWindowCompactionStrategy'} + AND default_time_to_live = 604800 + AND gc_grace_seconds = 3600 + AND read_repair_chance = 0 + AND dclocal_read_repair_chance = 0 + AND speculative_retry = '95percentile' + AND comment = 'Secondary table for looking up traces by annotation query'; + +CREATE TABLE IF NOT EXISTS tag_autocomplete ( + id text, + table_name text, + tag_key text, + tag_value text, + tag_type text, + time_bucket BIGINT, + PRIMARY KEY(tag_key, time_bucket, tag_value) +) + WITH compaction = {'class': 'org.apache.cassandra.db.compaction.LeveledCompactionStrategy', 'unchecked_tombstone_compaction': 'true', 'tombstone_threshold': '0.2'} + AND caching = {'rows_per_partition': 'ALL'} + AND default_time_to_live = 259200 + AND gc_grace_seconds = 3600 + AND read_repair_chance = 0 + AND dclocal_read_repair_chance = 0 + AND speculative_retry = '95percentile' + AND comment = 'Secondary table for looking up span tag values for auto-complete purposes.'; + + +CREATE TABLE IF NOT EXISTS zipkin_trace_by_service_span ( + service text, //-- service name + span text, //-- span name, or blank for queries without span name + bucket int, //-- time bucket, calculated as ts/interval (in microseconds), for some pre-configured interval like 1 day. + ts timeuuid, //-- start timestamp of the span, truncated to millisecond precision + trace_id text, //-- trace ID + duration bigint, //-- span duration, in milliseconds + PRIMARY KEY ((service, span, bucket), ts) +) + WITH CLUSTERING ORDER BY (ts DESC) + AND compaction = {'class': 'org.apache.cassandra.db.compaction.TimeWindowCompactionStrategy'} + AND default_time_to_live = 259200 + AND gc_grace_seconds = 3600 + AND read_repair_chance = 0 + AND dclocal_read_repair_chance = 0 + AND speculative_retry = '95percentile' + AND comment = 'Secondary table for looking up a trace by a service, or service and span. span column may be blank (when only looking up by service). bucket column adds time bucketing to the partition key, values are microseconds rounded to a pre-configured interval (typically one day). ts column is start timestamp of the span as time-uuid, truncated to millisecond precision. duration column is span duration, rounded up to tens of milliseconds (or hundredths of seconds)'; + +CREATE CUSTOM INDEX IF NOT EXISTS ON zipkin_trace_by_service_span (duration) USING 'org.apache.cassandra.index.sasi.SASIIndex' + WITH OPTIONS = {'mode': 'PREFIX'}; + +CREATE TABLE IF NOT EXISTS zipkin_trace_by_service_remote_service ( + service text, //-- service name + remote_service text, //-- remote servie name + bucket int, //-- time bucket, calculated as ts/interval (in microseconds), for some pre-configured interval like 1 day. + ts timeuuid, //-- start timestamp of the span, truncated to millisecond precision + trace_id text, //-- trace ID + PRIMARY KEY ((service, remote_service, bucket), ts) +) + WITH CLUSTERING ORDER BY (ts DESC) + AND compaction = {'class': 'org.apache.cassandra.db.compaction.TimeWindowCompactionStrategy'} + AND default_time_to_live = 259200 + AND gc_grace_seconds = 3600 + AND read_repair_chance = 0 + AND dclocal_read_repair_chance = 0 + AND speculative_retry = '95percentile' + AND comment = 'Secondary table for looking up a trace by a remote service. bucket column adds time bucketing to the partition key, values are microseconds rounded to a pre-configured interval (typically one day). ts column is start timestamp of the span as time-uuid, truncated to millisecond precision.'; + +CREATE TABLE IF NOT EXISTS zipkin_dependency ( + analyze_day date, + parent text, + child text, + error_count bigint, + call_count bigint, + PRIMARY KEY (analyze_day, parent, child) +) + WITH compaction = {'class': 'org.apache.cassandra.db.compaction.LeveledCompactionStrategy', 'unchecked_tombstone_compaction': 'true', 'tombstone_threshold': '0.2'} + AND default_time_to_live = 259200 + AND gc_grace_seconds = 3600 + AND read_repair_chance = 0 + AND dclocal_read_repair_chance = 0 + AND comment = 'Holder for each days generation of zipkin2.DependencyLink'; \ No newline at end of file diff --git a/zipkin-server/storage-cassandra/src/test/java/zipkin/server/storage/cassandra/ApplicationConfigLoader.java b/zipkin-server/storage-cassandra/src/test/java/zipkin/server/storage/cassandra/ApplicationConfigLoader.java new file mode 100644 index 00000000000..fa536c3c099 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/test/java/zipkin/server/storage/cassandra/ApplicationConfigLoader.java @@ -0,0 +1,215 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ +package zipkin.server.storage.cassandra; + +import org.apache.skywalking.oap.server.library.module.ApplicationConfiguration; +import org.apache.skywalking.oap.server.library.module.ProviderNotFoundException; +import org.apache.skywalking.oap.server.library.util.CollectionUtils; +import org.apache.skywalking.oap.server.library.util.PropertyPlaceholderHelper; +import org.apache.skywalking.oap.server.library.util.ResourceUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.yaml.snakeyaml.Yaml; + +import java.io.FileNotFoundException; +import java.io.Reader; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.Map; +import java.util.Properties; + +/** + * Initialize collector settings with following sources. Use application.yml as primary setting, and fix missing setting + * by default settings in application-default.yml. + *

+ * At last, override setting by system.properties and system.envs if the key matches moduleName.provideName.settingKey. + */ +public class ApplicationConfigLoader { + static final Logger log = LoggerFactory.getLogger(ApplicationConfigLoader.class.getName()); + + private static final String DISABLE_SELECTOR = "-"; + private static final String SELECTOR = "selector"; + + private final Yaml yaml = new Yaml(); + + public ApplicationConfiguration load() { + ApplicationConfiguration configuration = new ApplicationConfiguration(); + this.loadConfig(configuration); + this.overrideConfigBySystemEnv(configuration); + return configuration; + } + + @SuppressWarnings("unchecked") + private void loadConfig(ApplicationConfiguration configuration) { + try { + Reader applicationReader = ResourceUtils.read("application.yml"); + Map> moduleConfig = yaml.loadAs(applicationReader, Map.class); + if (CollectionUtils.isNotEmpty(moduleConfig)) { + selectConfig(moduleConfig); + moduleConfig.forEach((moduleName, providerConfig) -> { + if (providerConfig.size() > 0) { + log.info("Get a module define from application.yml, module name: {}", moduleName); + ApplicationConfiguration.ModuleConfiguration moduleConfiguration = configuration.addModule( + moduleName); + providerConfig.forEach((providerName, config) -> { + log.info( + "Get a provider define belong to {} module, provider name: {}", moduleName, + providerName + ); + final Map propertiesConfig = (Map) config; + final Properties properties = new Properties(); + if (propertiesConfig != null) { + propertiesConfig.forEach((propertyName, propertyValue) -> { + if (propertyValue instanceof Map) { + Properties subProperties = new Properties(); + ((Map) propertyValue).forEach((key, value) -> { + subProperties.put(key, value); + replacePropertyAndLog(key, value, subProperties, providerName); + }); + properties.put(propertyName, subProperties); + } else { + properties.put(propertyName, propertyValue); + replacePropertyAndLog(propertyName, propertyValue, properties, providerName); + } + }); + } + moduleConfiguration.addProviderConfiguration(providerName, properties); + }); + } else { + log.warn( + "Get a module define from application.yml, but no provider define, use default, module name: {}", + moduleName + ); + } + }); + } + } catch (FileNotFoundException e) { + throw new IllegalStateException(e); + } + } + + private void replacePropertyAndLog(final String propertyName, final Object propertyValue, final Properties target, + final Object providerName) { + final String valueString = PropertyPlaceholderHelper.INSTANCE + .replacePlaceholders(String.valueOf(propertyValue), target); + if (valueString.trim().length() == 0) { + target.replace(propertyName, valueString); + log.info("Provider={} config={} has been set as an empty string", providerName, propertyName); + } else { + // Use YAML to do data type conversion. + final Object replaceValue = convertValueString(valueString); + if (replaceValue != null) { + target.replace(propertyName, replaceValue); + } + } + } + + private Object convertValueString(String valueString) { + try { + Object replaceValue = yaml.load(valueString); + if (replaceValue instanceof String || replaceValue instanceof Integer || replaceValue instanceof Long || replaceValue instanceof Boolean || replaceValue instanceof ArrayList) { + return replaceValue; + } else { + return valueString; + } + } catch (Exception e) { + log.warn("yaml convert value type error, use origin values string. valueString={}", valueString, e); + return valueString; + } + } + + private void overrideConfigBySystemEnv(ApplicationConfiguration configuration) { + for (Map.Entry prop : System.getProperties().entrySet()) { + overrideModuleSettings(configuration, prop.getKey().toString(), prop.getValue().toString()); + } + } + + private void selectConfig(final Map> moduleConfiguration) { + Iterator>> moduleIterator = moduleConfiguration.entrySet().iterator(); + while (moduleIterator.hasNext()) { + Map.Entry> entry = moduleIterator.next(); + final String moduleName = entry.getKey(); + final Map providerConfig = entry.getValue(); + if (!providerConfig.containsKey(SELECTOR)) { + continue; + } + final String selector = (String) providerConfig.get(SELECTOR); + final String resolvedSelector = PropertyPlaceholderHelper.INSTANCE.replacePlaceholders( + selector, System.getProperties() + ); + providerConfig.entrySet().removeIf(e -> !resolvedSelector.equals(e.getKey())); + + if (!providerConfig.isEmpty()) { + continue; + } + + if (!DISABLE_SELECTOR.equals(resolvedSelector)) { + throw new ProviderNotFoundException( + "no provider found for module " + moduleName + ", " + + "if you're sure it's not required module and want to remove it, " + + "set the selector to -" + ); + } + + // now the module can be safely removed + moduleIterator.remove(); + log.info("Remove module {} without any provider", moduleName); + } + } + + private void overrideModuleSettings(ApplicationConfiguration configuration, String key, String value) { + int moduleAndConfigSeparator = key.indexOf('.'); + if (moduleAndConfigSeparator <= 0) { + return; + } + String moduleName = key.substring(0, moduleAndConfigSeparator); + String providerSettingSubKey = key.substring(moduleAndConfigSeparator + 1); + ApplicationConfiguration.ModuleConfiguration moduleConfiguration = configuration.getModuleConfiguration( + moduleName); + if (moduleConfiguration == null) { + return; + } + int providerAndConfigSeparator = providerSettingSubKey.indexOf('.'); + if (providerAndConfigSeparator <= 0) { + return; + } + String providerName = providerSettingSubKey.substring(0, providerAndConfigSeparator); + String settingKey = providerSettingSubKey.substring(providerAndConfigSeparator + 1); + if (!moduleConfiguration.has(providerName)) { + return; + } + Properties providerSettings = moduleConfiguration.getProviderConfiguration(providerName); + if (!providerSettings.containsKey(settingKey)) { + return; + } + Object originValue = providerSettings.get(settingKey); + Class type = originValue.getClass(); + if (type.equals(int.class) || type.equals(Integer.class)) + providerSettings.put(settingKey, Integer.valueOf(value)); + else if (type.equals(String.class)) + providerSettings.put(settingKey, value); + else if (type.equals(long.class) || type.equals(Long.class)) + providerSettings.put(settingKey, Long.valueOf(value)); + else if (type.equals(boolean.class) || type.equals(Boolean.class)) { + providerSettings.put(settingKey, Boolean.valueOf(value)); + } else { + return; + } + + log.info( + "The setting has been override by key: {}, value: {}, in {} provider of {} module through {}", settingKey, + value, providerName, moduleName, "System.properties" + ); + } +} diff --git a/zipkin-server/storage-cassandra/src/test/java/zipkin/server/storage/cassandra/CassandraExtension.java b/zipkin-server/storage-cassandra/src/test/java/zipkin/server/storage/cassandra/CassandraExtension.java new file mode 100644 index 00000000000..137dffe87de --- /dev/null +++ b/zipkin-server/storage-cassandra/src/test/java/zipkin/server/storage/cassandra/CassandraExtension.java @@ -0,0 +1,71 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.storage.cassandra; + +import org.junit.jupiter.api.extension.AfterAllCallback; +import org.junit.jupiter.api.extension.BeforeAllCallback; +import org.junit.jupiter.api.extension.ExtensionContext; +import org.opentest4j.TestAbortedException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.testcontainers.containers.BindMode; +import org.testcontainers.containers.GenericContainer; +import org.testcontainers.containers.InternetProtocol; +import org.testcontainers.containers.output.Slf4jLogConsumer; +import org.testcontainers.containers.wait.strategy.Wait; + +import java.time.Duration; + +import static org.testcontainers.utility.DockerImageName.parse; + +public class CassandraExtension implements BeforeAllCallback, AfterAllCallback { + static final Logger LOGGER = LoggerFactory.getLogger(CassandraExtension.class); + static final int CASSANDRA_PORT = 9042; + + final CassandraContainer container = new CassandraContainer(); + + @Override + public void afterAll(ExtensionContext context) throws Exception { + container.stop(); + } + + @Override + public void beforeAll(ExtensionContext context) throws Exception { + if (context.getRequiredTestClass().getEnclosingClass() != null) { + // Only run once in outermost scope. + return; + } + + container.start(); + LOGGER.info("Using bootstrapServer " + bootstrapServer()); + } + + String bootstrapServer() { + return container.getHost() + ":" + container.getMappedPort(CASSANDRA_PORT); + } + + static final class CassandraContainer extends GenericContainer { + CassandraContainer() { + super(parse("cassandra:4.1.3")); + if ("true".equals(System.getProperty("docker.skip"))) { + throw new TestAbortedException("${docker.skip} == true"); + } + waitStrategy = Wait.forSuccessfulCommand("cqlsh -e \"describe keyspaces\"").withStartupTimeout(Duration.ofMinutes(5)); + addFixedExposedPort(CASSANDRA_PORT, CASSANDRA_PORT, InternetProtocol.TCP); + addFileSystemBind("src/test/resources/cassandra.yaml", "/etc/cassandra/cassandra.yaml", BindMode.READ_WRITE); + withLogConsumer(new Slf4jLogConsumer(LOGGER)); + } + } +} diff --git a/zipkin-server/storage-cassandra/src/test/java/zipkin/server/storage/cassandra/ITCassandraStorage.java b/zipkin-server/storage-cassandra/src/test/java/zipkin/server/storage/cassandra/ITCassandraStorage.java new file mode 100644 index 00000000000..bb66f3df247 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/test/java/zipkin/server/storage/cassandra/ITCassandraStorage.java @@ -0,0 +1,131 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.storage.cassandra; + +import org.apache.skywalking.oap.server.core.analysis.manual.searchtag.TagType; +import org.apache.skywalking.oap.server.core.query.enumeration.Step; +import org.apache.skywalking.oap.server.core.query.input.Duration; +import org.apache.skywalking.oap.server.core.storage.StorageModule; +import org.apache.skywalking.oap.server.core.storage.query.ITagAutoCompleteQueryDAO; +import org.apache.skywalking.oap.server.core.storage.query.IZipkinQueryDAO; +import org.apache.skywalking.oap.server.library.module.ModuleConfigException; +import org.apache.skywalking.oap.server.library.module.ModuleManager; +import org.apache.skywalking.oap.server.library.module.ModuleNotFoundException; +import org.apache.skywalking.oap.server.library.module.ModuleStartException; +import org.apache.skywalking.oap.server.receiver.zipkin.ZipkinReceiverConfig; +import org.apache.skywalking.oap.server.receiver.zipkin.trace.SpanForward; +import org.joda.time.DateTime; +import org.junit.Assert; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.TestInstance; +import org.junit.jupiter.api.Timeout; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.jupiter.api.extension.RegisterExtension; +import org.mockito.junit.jupiter.MockitoExtension; +import zipkin2.Span; +import zipkin2.TestObjects; +import zipkin2.storage.QueryRequest; + +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import java.util.Set; +import java.util.concurrent.TimeUnit; +import java.util.stream.Collectors; + +@TestInstance(TestInstance.Lifecycle.PER_CLASS) +@Timeout(120) +@ExtendWith(MockitoExtension.class) +public class ITCassandraStorage { + @RegisterExtension + CassandraExtension cassandra = new CassandraExtension(); + + private final ModuleManager moduleManager = new ModuleManager(); + private SpanForward forward; + private ITagAutoCompleteQueryDAO tagAutoCompleteQueryDAO; + private IZipkinQueryDAO zipkinQueryDAO; + @BeforeAll + public void setup() throws ModuleNotFoundException, ModuleConfigException, ModuleStartException { + final ApplicationConfigLoader loader = new ApplicationConfigLoader(); + moduleManager.init(loader.load()); + final ZipkinReceiverConfig config = new ZipkinReceiverConfig(); + config.setSearchableTracesTags("http.path"); + this.forward = new SpanForward(config, moduleManager); + this.tagAutoCompleteQueryDAO = moduleManager.find(StorageModule.NAME).provider().getService(ITagAutoCompleteQueryDAO.class); + this.zipkinQueryDAO = moduleManager.find(StorageModule.NAME).provider().getService(IZipkinQueryDAO.class); + } + + @Test + public void test() throws InterruptedException, IOException { + final List traceSpans = TestObjects.newTrace(""); + forward.send(traceSpans); + Thread.sleep(TimeUnit.SECONDS.toMillis(5)); + + // service names + final List serviceNames = zipkinQueryDAO.getServiceNames(); + Assert.assertEquals(2, serviceNames.size()); + Assert.assertTrue(serviceNames.contains(TestObjects.FRONTEND.serviceName())); + Assert.assertTrue(serviceNames.contains(TestObjects.BACKEND.serviceName())); + + // remote service names + final List remoteServiceNames = zipkinQueryDAO.getRemoteServiceNames(TestObjects.FRONTEND.serviceName()); + Assert.assertEquals(1, remoteServiceNames.size()); + Assert.assertEquals(TestObjects.BACKEND.serviceName(), remoteServiceNames.get(0)); + + // span names + final List spanNames = zipkinQueryDAO.getSpanNames(TestObjects.BACKEND.serviceName()); + Assert.assertEquals(2, spanNames.size()); + Assert.assertTrue(spanNames.contains("query")); + Assert.assertTrue(spanNames.contains("get")); + + // search traces + final QueryRequest query = QueryRequest.newBuilder() + .lookback(86400000L) + .endTs(System.currentTimeMillis()) + .minDuration(1000L) + .annotationQuery(Collections.singletonMap("http.path", "/api")) + .limit(10).build(); + Duration duration = new Duration(); + duration.setStep(Step.SECOND); + DateTime endTime = new DateTime(query.endTs()); + DateTime startTime = endTime.minus(org.joda.time.Duration.millis(query.lookback())); + duration.setStart(startTime.toString("yyyy-MM-dd HHmmss")); + duration.setEnd(endTime.toString("yyyy-MM-dd HHmmss")); + final List> traces = zipkinQueryDAO.getTraces(query, duration); + Assert.assertEquals(1, traces.size()); + final List needsSpans = traceSpans.stream().filter(s -> s.duration() > 1000L).collect(Collectors.toList()); + Assert.assertEquals(needsSpans.size(), traces.get(0).size()); + for (Span needSpan : needsSpans) { + Assert.assertTrue(traces.get(0).stream().anyMatch(needSpan::equals)); + } + + // get trace + final List trace = zipkinQueryDAO.getTrace(traceSpans.get(0).traceId()); + Assert.assertEquals(traceSpans.size(), trace.size()); + for (Span span : traceSpans) { + Assert.assertTrue(trace.stream().anyMatch(span::equals)); + } + + final Set keys = tagAutoCompleteQueryDAO.queryTagAutocompleteKeys(TagType.ZIPKIN, 10, duration); + Assert.assertEquals(1, keys.size()); + Assert.assertTrue(keys.contains("http.path")); + + final Set values = tagAutoCompleteQueryDAO.queryTagAutocompleteValues(TagType.ZIPKIN, "http.path", 10, duration); + Assert.assertEquals(1, values.size()); + Assert.assertTrue(values.contains("/api")); + } + +} diff --git a/zipkin-server/storage-cassandra/src/test/resources/application.yml b/zipkin-server/storage-cassandra/src/test/resources/application.yml new file mode 100644 index 00000000000..df0e4c489a8 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/test/resources/application.yml @@ -0,0 +1,83 @@ +# 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. + +core: + selector: zipkin + zipkin: + # The max length of service + instance names should be less than 200 + serviceNameMaxLength: ${ZIPKIN_SERVICE_NAME_MAX_LENGTH:70} + # The period(in seconds) of refreshing the service cache. Default value is 10s. + serviceCacheRefreshInterval: ${ZIPKIN_SERVICE_CACHE_REFRESH_INTERVAL:10} + instanceNameMaxLength: ${ZIPKIN_INSTANCE_NAME_MAX_LENGTH:70} + # The max length of service + endpoint names should be less than 240 + endpointNameMaxLength: ${ZIPKIN_ENDPOINT_NAME_MAX_LENGTH:150} + recordDataTTL: ${ZIPKIN_CORE_RECORD_DATA_TTL:3} # Unit is day + metricsDataTTL: ${ZIPKIN_CORE_METRICS_DATA_TTL:7} # Unit is day + # The period of L1 aggregation flush to L2 aggregation. Unit is ms. + l1FlushPeriod: ${ZIPKIN_CORE_L1_AGGREGATION_FLUSH_PERIOD:500} + # The threshold of session time. Unit is ms. Default value is 70s. + storageSessionTimeout: ${ZIPKIN_CORE_STORAGE_SESSION_TIMEOUT:70000} + # Defines a set of span tag keys which are searchable. + # The max length of key=value should be less than 256 or will be dropped. + searchableTracesTags: ${ZIPKIN_SEARCHABLE_TAG_KEYS:http.path} + # The trace sample rate precision is 1/10000, should be between 0 and 10000 + traceSampleRate: ${ZIPKIN_SAMPLE_RATE:10000} + # The number of threads used to prepare metrics data to the storage. + prepareThreads: ${ZIPKIN_PREPARE_THREADS:2} + # The period of doing data persistence. Unit is second.Default value is 25s + persistentPeriod: ${ZIPKIN_PERSISTENT_PERIOD:1} + gRPCHost: ${ZIPKIN_GRPC_HOST:0.0.0.0} + gRPCPort: ${ZIPKIN_GRPC_PORT:11800} + gRPCThreadPoolQueueSize: ${ZIPKIN_GRPC_POOL_QUEUE_SIZE:-1} + gRPCThreadPoolSize: ${ZIPKIN_GRPC_THREAD_POOL_SIZE:-1} + gRPCSslEnabled: ${ZIPKIN_GRPC_SSL_ENABLED:false} + gRPCSslKeyPath: ${ZIPKIN_GRPC_SSL_KEY_PATH:""} + gRPCSslCertChainPath: ${ZIPKIN_GRPC_SSL_CERT_CHAIN_PATH:""} + gRPCSslTrustedCAPath: ${ZIPKIN_GRPC_SSL_TRUSTED_CA_PATH:""} + gRPCMaxConcurrentCallsPerConnection: ${ZIPKIN_GRPC_MAX_CONCURRENT_CALL:0} + gRPCMaxMessageSize: ${ZIPKIN_GRPC_MAX_MESSAGE_SIZE:0} + restHost: ${ZIPKIN_REST_HOST:0.0.0.0} + restPort: ${ZIPKIN_REST_PORT:9411} + restContextPath: ${ZIPKIN_REST_CONTEXT_PATH:/} + restMaxThreads: ${ZIPKIN_REST_MAX_THREADS:200} + restIdleTimeOut: ${ZIPKIN_REST_IDLE_TIMEOUT:30000} + restAcceptQueueSize: ${ZIPKIN_REST_QUEUE_SIZE:0} + restMaxRequestHeaderSize: ${ZIPKIN_REST_MAX_REQUEST_HEADER_SIZE:8192} + +storage: + selector: ${ZIPKIN_STORAGE:cassandra} + cassandra: + keyspace: ${ZIPKIN_STORAGE_CASSANDRA_KEYSPACE:zipkin} + # Comma separated list of host addresses part of Cassandra cluster. Ports default to 9042 but you can also specify a custom port with 'host:port'. + contactPoints: ${ZIPKIN_STORAGE_CASSANDRA_CONTACT_POINTS:localhost} + # Name of the datacenter that will be considered "local" for load balancing. + localDc: ${ZIPKIN_STORAGE_CASSANDRA_LOCAL_DC:datacenter1} + # Will throw an exception on startup if authentication fails. + username: ${ZIPKIN_STORAGE_CASSANDRA_USERNAME:} + password: ${ZIPKIN_STORAGE_CASSANDRA_PASSWORD:} + # Max pooled connections per datacenter-local host. + maxConnections: ${ZIPKIN_STORAGE_CASSANDRA_MAX_CONNECTIONS:8} + # Using ssl for connection, rely on Keystore + use-ssl: ${ZIPKIN_STORAGE_CASSANDRA_USE_SSL:false} + maxSizeOfBatchCql: ${ZIPKIN_STORAGE_CASSANDRA_MAX_SIZE_OF_BATCH_CQL:2000} + asyncBatchPersistentPoolSize: ${ZIPKIN_STORAGE_CASSANDRA_ASYNC_BATCH_PERSISTENT_POOL_SIZE:4} + +telemetry: + selector: ${ZIPKIN_TELEMETRY:none} + none: + +cluster: + selector: standalone + standalone: \ No newline at end of file diff --git a/zipkin-server/storage-cassandra/src/test/resources/cassandra.yaml b/zipkin-server/storage-cassandra/src/test/resources/cassandra.yaml new file mode 100644 index 00000000000..1e2144fcd3e --- /dev/null +++ b/zipkin-server/storage-cassandra/src/test/resources/cassandra.yaml @@ -0,0 +1,1818 @@ +# Cassandra storage config YAML + +# NOTE: +# See https://cassandra.apache.org/doc/latest/configuration/ 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' + +# This defines the number of tokens randomly assigned to this node on the ring +# The more tokens, relative to other nodes, the larger the proportion of data +# that this node will store. You probably want all nodes to have the same number +# of tokens assuming they have equal hardware capability. +# +# If you leave this unspecified, Cassandra will use the default of 1 token for legacy compatibility, +# and will use the initial_token as described below. +# +# Specifying initial_token will override this setting on the node's initial start, +# on subsequent starts, this setting will apply even if initial token is set. +# +# See https://cassandra.apache.org/doc/latest/getting_started/production.html#tokens for +# best practice information about num_tokens. +# +num_tokens: 16 + +# Triggers automatic allocation of num_tokens tokens for this node. The allocation +# algorithm attempts to choose tokens in a way that optimizes replicated load over +# the nodes in the datacenter for the replica factor. +# +# The load assigned to each node will be close to proportional to its number of +# vnodes. +# +# Only supported with the Murmur3Partitioner. + +# Replica factor is determined via the replication strategy used by the specified +# keyspace. +# allocate_tokens_for_keyspace: KEYSPACE + +# Replica factor is explicitly set, regardless of keyspace or datacenter. +# This is the replica factor within the datacenter, like NTS. +allocate_tokens_for_local_replication_factor: 3 + +# initial_token allows you to specify tokens manually. While you can use it with +# vnodes (num_tokens > 1, above) -- in which case you should provide a +# comma-separated list -- it's primarily used when adding nodes to legacy clusters +# that do not have vnodes enabled. +# initial_token: + +# May either be "true" or "false" to enable globally +hinted_handoff_enabled: true + +# When hinted_handoff_enabled is true, a black list of data centers that will not +# perform hinted handoff +# hinted_handoff_disabled_datacenters: +# - DC1 +# - DC2 + +# 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. +# Min unit: ms +max_hint_window: 3h + +# Maximum throttle in KiBs 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.) +# Min unit: KiB +hinted_handoff_throttle: 1024KiB + +# 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 + +# Directory where Cassandra should store hints. +# If not set, the default directory is $CASSANDRA_HOME/data/hints. +# hints_directory: /var/lib/cassandra/hints + +# How often hints should be flushed from the internal buffers to disk. +# Will *not* trigger fsync. +# Min unit: ms +hints_flush_period: 10000ms + +# Maximum size for a single hints file, in mebibytes. +# Min unit: MiB +max_hints_file_size: 128MiB + +# The file size limit to store hints for an unreachable host, in mebibytes. +# Once the local hints files have reached the limit, no more new hints will be created. +# Set a non-positive value will disable the size limit. +# max_hints_size_per_host: 0MiB + +# Enable / disable automatic cleanup for the expired and orphaned hints file. +# Disable the option in order to preserve those hints on the disk. +auto_hints_cleanup_enabled: false + +# Compression to apply to the hint files. If omitted, hints files +# will be written uncompressed. LZ4, Snappy, and Deflate compressors +# are supported. +#hints_compression: +# - class_name: LZ4Compressor +# parameters: +# - + +# Enable / disable persistent hint windows. +# +# If set to false, a hint will be stored only in case a respective node +# that hint is for is down less than or equal to max_hint_window. +# +# If set to true, a hint will be stored in case there is not any +# hint which was stored earlier than max_hint_window. This is for cases +# when a node keeps to restart and hints are not delivered yet, we would be saving +# hints for that node indefinitely. +# +# Defaults to true. +# +# hint_window_persistent_enabled: true + +# Maximum throttle in KiBs per second, total. This will be +# reduced proportionally to the number of nodes in the cluster. +# Min unit: KiB +batchlog_replay_throttle: 1024KiB + +# 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.roles table. +# Please increase system_auth keyspace replication factor if you use this authenticator. +# If using PasswordAuthenticator, CassandraRoleManager must also be used (see below) +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.role_permissions table. Please +# increase system_auth keyspace replication factor if you use this authorizer. +authorizer: AllowAllAuthorizer + +# Part of the Authentication & Authorization backend, implementing IRoleManager; used +# to maintain grants and memberships between roles. +# Out of the box, Cassandra provides org.apache.cassandra.auth.CassandraRoleManager, +# which stores role information in the system_auth keyspace. Most functions of the +# IRoleManager require an authenticated login, so unless the configured IAuthenticator +# actually implements authentication, most of this functionality will be unavailable. +# +# - CassandraRoleManager stores role data in the system_auth keyspace. Please +# increase system_auth keyspace replication factor if you use this role manager. +role_manager: CassandraRoleManager + +# Network authorization backend, implementing INetworkAuthorizer; used to restrict user +# access to certain DCs +# Out of the box, Cassandra provides org.apache.cassandra.auth.{AllowAllNetworkAuthorizer, +# CassandraNetworkAuthorizer}. +# +# - AllowAllNetworkAuthorizer allows access to any DC to any user - set it to disable authorization. +# - CassandraNetworkAuthorizer stores permissions in system_auth.network_permissions table. Please +# increase system_auth keyspace replication factor if you use this authorizer. +network_authorizer: AllowAllNetworkAuthorizer + +# Depending on the auth strategy of the cluster, it can be beneficial to iterate +# from root to table (root -> ks -> table) instead of table to root (table -> ks -> root). +# As the auth entries are whitelisting, once a permission is found you know it to be +# valid. We default to false as the legacy behavior is to query at the table level then +# move back up to the root. See CASSANDRA-17016 for details. +# traverse_auth_from_root: false + +# Validity period for roles cache (fetching granted roles can be an expensive +# operation depending on the role manager, CassandraRoleManager is one example) +# Granted roles are cached for authenticated sessions in AuthenticatedUser and +# after the period specified here, become eligible for (async) reload. +# Defaults to 2000, set to 0 to disable caching entirely. +# Will be disabled automatically for AllowAllAuthenticator. +# For a long-running cache using roles_cache_active_update, consider +# setting to something longer such as a daily validation: 86400000 +# Min unit: ms +roles_validity: 2000ms + +# Refresh interval for roles cache (if enabled). +# After this interval, cache entries become eligible for refresh. Upon next +# access, an async reload is scheduled and the old value returned until it +# completes. If roles_validity is non-zero, then this must be +# also. +# This setting is also used to inform the interval of auto-updating if +# using roles_cache_active_update. +# Defaults to the same value as roles_validity. +# For a long-running cache, consider setting this to 60000 (1 hour) etc. +# Min unit: ms +# roles_update_interval: 2000ms + +# If true, cache contents are actively updated by a background task at the +# interval set by roles_update_interval. If false, cache entries +# become eligible for refresh after their update interval. Upon next access, +# an async reload is scheduled and the old value returned until it completes. +# roles_cache_active_update: false + +# 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. +# For a long-running cache using permissions_cache_active_update, consider +# setting to something longer such as a daily validation: 86400000ms +# Min unit: ms +permissions_validity: 2000ms + +# Refresh interval for permissions cache (if enabled). +# After this interval, cache entries become eligible for refresh. Upon next +# access, an async reload is scheduled and the old value returned until it +# completes. If permissions_validity is non-zero, then this must be +# also. +# This setting is also used to inform the interval of auto-updating if +# using permissions_cache_active_update. +# Defaults to the same value as permissions_validity. +# For a longer-running permissions cache, consider setting to update hourly (60000) +# Min unit: ms +# permissions_update_interval: 2000ms + +# If true, cache contents are actively updated by a background task at the +# interval set by permissions_update_interval. If false, cache entries +# become eligible for refresh after their update interval. Upon next access, +# an async reload is scheduled and the old value returned until it completes. +# permissions_cache_active_update: false + +# Validity period for credentials cache. This cache is tightly coupled to +# the provided PasswordAuthenticator implementation of IAuthenticator. If +# another IAuthenticator implementation is configured, this cache will not +# be automatically used and so the following settings will have no effect. +# Please note, credentials are cached in their encrypted form, so while +# activating this cache may reduce the number of queries made to the +# underlying table, it may not bring a significant reduction in the +# latency of individual authentication attempts. +# Defaults to 2000, set to 0 to disable credentials caching. +# For a long-running cache using credentials_cache_active_update, consider +# setting to something longer such as a daily validation: 86400000 +# Min unit: ms +credentials_validity: 2000ms + +# Refresh interval for credentials cache (if enabled). +# After this interval, cache entries become eligible for refresh. Upon next +# access, an async reload is scheduled and the old value returned until it +# completes. If credentials_validity is non-zero, then this must be +# also. +# This setting is also used to inform the interval of auto-updating if +# using credentials_cache_active_update. +# Defaults to the same value as credentials_validity. +# For a longer-running permissions cache, consider setting to update hourly (60000) +# Min unit: ms +# credentials_update_interval: 2000ms + +# If true, cache contents are actively updated by a background task at the +# interval set by credentials_update_interval. If false (default), cache entries +# become eligible for refresh after their update interval. Upon next access, +# an async reload is scheduled and the old value returned until it completes. +# credentials_cache_active_update: false + +# The partitioner is responsible for distributing groups of rows (by +# partition key) across nodes in the cluster. The partitioner can NOT be +# changed without reloading all data. If you are adding nodes or upgrading, +# you should set this to the same partitioner that you are currently using. +# +# The default partitioner is the Murmur3Partitioner. Older partitioners +# such as the RandomPartitioner, ByteOrderedPartitioner, and +# OrderPreservingPartitioner have been included for backward compatibility only. +# For new clusters, you should NOT change this value. +# +partitioner: org.apache.cassandra.dht.Murmur3Partitioner + +# Directories where Cassandra should store data on disk. If multiple +# directories are specified, Cassandra will spread data evenly across +# them by partitioning the token ranges. +# If not set, the default directory is $CASSANDRA_HOME/data/data. +# data_file_directories: +# - /var/lib/cassandra/data + +# Directory were Cassandra should store the data of the local system keyspaces. +# By default Cassandra will store the data of the local system keyspaces in the first of the data directories specified +# by data_file_directories. +# This approach ensures that if one of the other disks is lost Cassandra can continue to operate. For extra security +# this setting allows to store those data on a different directory that provides redundancy. +# local_system_data_file_directory: + +# commit log. when running on magnetic HDD, this should be a +# separate spindle than the data directories. +# If not set, the default directory is $CASSANDRA_HOME/data/commitlog. +# commitlog_directory: /var/lib/cassandra/commitlog + +# Enable / disable CDC functionality on a per-node basis. This modifies the logic used +# for write path allocation rejection (standard: never reject. cdc: reject Mutation +# containing a CDC-enabled table if at space limit in cdc_raw_directory). +cdc_enabled: false + +# CommitLogSegments are moved to this directory on flush if cdc_enabled: true and the +# segment contains mutations for a CDC-enabled table. This should be placed on a +# separate spindle than the data directories. If not set, the default directory is +# $CASSANDRA_HOME/data/cdc_raw. +# cdc_raw_directory: /var/lib/cassandra/cdc_raw + +# Policy for data disk failures: +# +# die +# shut down gossip and client transports and kill the JVM for any fs errors or +# single-sstable errors, so the node can be replaced. +# +# stop_paranoid +# shut down gossip and client transports even for single-sstable errors, +# kill the JVM for errors during startup. +# +# stop +# shut down gossip and client transports, leaving the node effectively dead, but +# can still be inspected via JMX, kill the JVM for errors during startup. +# +# 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 + +# Policy for commit disk failures: +# +# die +# shut down the node and kill the JVM, so the node can be replaced. +# +# stop +# shut down the node, leaving the node effectively dead, but +# can still be inspected via JMX. +# +# stop_commit +# shutdown the commit log, letting writes collect but +# continuing to service reads, as in pre-2.0.5 Cassandra +# +# ignore +# ignore fatal errors and let the batches fail +commit_failure_policy: stop + +# Maximum size of the native protocol prepared statement cache +# +# Valid values are either "auto" (omitting the value) or a value greater 0. +# +# Note that specifying a too large value will result in long running GCs and possbily +# out-of-memory errors. Keep the value at a small fraction of the heap. +# +# If you constantly see "prepared statements discarded in the last minute because +# cache limit reached" messages, the first step is to investigate the root cause +# of these messages and check whether prepared statements are used correctly - +# i.e. use bind markers for variable parts. +# +# Do only change the default value, if you really have more prepared statements than +# fit in the cache. In most cases it is not neccessary to change this value. +# Constantly re-preparing statements is a performance penalty. +# +# Default value ("auto") is 1/256th of the heap or 10MiB, whichever is greater +# Min unit: MiB +prepared_statements_cache_size: + +# 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 contain the entire row, +# 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 MiB), 100MiB)). Set to 0 to disable key cache. +# Min unit: MiB +key_cache_size: + +# Duration in seconds after which Cassandra should +# save the key 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. +# Min unit: s +key_cache_save_period: 4h + +# 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 + +# Row cache implementation class name. Available implementations: +# +# org.apache.cassandra.cache.OHCProvider +# Fully off-heap row cache implementation (default). +# +# org.apache.cassandra.cache.SerializingCacheProvider +# This is the row cache implementation availabile +# in previous releases of Cassandra. +# row_cache_class_name: org.apache.cassandra.cache.OHCProvider + +# Maximum size of the row cache in memory. +# Please note that OHC cache implementation requires some additional off-heap memory to manage +# the map structures and some in-flight memory during operations before/after cache entries can be +# accounted against the cache capacity. This overhead is usually small compared to the whole capacity. +# Do not specify more memory that the system can afford in the worst usual situation and leave some +# headroom for OS block level cache. Do never allow your system to swap. +# +# Default value is 0, to disable row caching. +# Min unit: MiB +row_cache_size: 0MiB + +# Duration in seconds after which Cassandra should save 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. +# Min unit: s +row_cache_save_period: 0s + +# Number of keys from the row cache to save. +# Specify 0 (which is the default), meaning all keys are going to be saved +# row_cache_keys_to_save: 100 + +# Maximum size of the counter cache in memory. +# +# Counter cache helps to reduce counter locks' contention for hot counter cells. +# In case of RF = 1 a counter cache hit will cause Cassandra to skip the read before +# write entirely. With RF > 1 a counter cache hit will still help to reduce the duration +# of the lock hold, helping with hot counter cell updates, but will not allow skipping +# the read entirely. Only the local (clock, count) tuple of a counter cell is kept +# in memory, not the whole counter, so it's relatively cheap. +# +# 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(2.5% of Heap (in MiB), 50MiB)). Set to 0 to disable counter cache. +# NOTE: if you perform counter deletes and rely on low gcgs, you should disable the counter cache. +# Min unit: MiB +counter_cache_size: + +# Duration in seconds after which Cassandra should +# save the counter cache (keys only). Caches are saved to saved_caches_directory as +# specified in this configuration file. +# +# Default is 7200 or 2 hours. +# Min unit: s +counter_cache_save_period: 7200s + +# Number of keys from the counter cache to save +# Disabled by default, meaning all keys are going to be saved +# counter_cache_keys_to_save: 100 + +# saved caches +# If not set, the default directory is $CASSANDRA_HOME/data/saved_caches. +# saved_caches_directory: /var/lib/cassandra/saved_caches + +# Number of seconds the server will wait for each cache (row, key, etc ...) to load while starting +# the Cassandra process. Setting this to zero is equivalent to disabling all cache loading on startup +# while still having the cache during runtime. +# Min unit: s +# cache_load_timeout: 30s + +# commitlog_sync may be either "periodic", "group", or "batch." +# +# When in batch mode, Cassandra won't ack writes until the commit log +# has been flushed to disk. Each incoming write will trigger the flush task. +# commitlog_sync_batch_window_in_ms is a deprecated value. Previously it had +# almost no value, and is being removed. +# +# commitlog_sync_batch_window_in_ms: 2 +# +# group mode is similar to batch mode, where Cassandra will not ack writes +# until the commit log has been flushed to disk. The difference is group +# mode will wait up to commitlog_sync_group_window between flushes. +# +# Min unit: ms +# commitlog_sync_group_window: 1000ms +# +# the default option is "periodic" where writes may be acked immediately +# and the CommitLog is simply synced every commitlog_sync_period +# milliseconds. +commitlog_sync: periodic +# Min unit: ms +commitlog_sync_period: 10000ms + +# When in periodic commitlog mode, the number of milliseconds to block writes +# while waiting for a slow disk flush to complete. +# Min unit: ms +# periodic_commitlog_sync_lag_block: + +# 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. +# Max mutation size is also configurable via max_mutation_size setting in +# cassandra.yaml. The default is half the size commitlog_segment_size in bytes. +# This should be positive and less than 2048. +# +# NOTE: If max_mutation_size is set explicitly then commitlog_segment_size must +# be set to at least twice the size of max_mutation_size +# +# Min unit: MiB +commitlog_segment_size: 32MiB + +# Compression to apply to the commit log. If omitted, the commit log +# will be written uncompressed. LZ4, Snappy, and Deflate compressors +# are supported. +# commitlog_compression: +# - class_name: LZ4Compressor +# parameters: +# - + +# Compression to apply to SSTables as they flush for compressed tables. +# Note that tables without compression enabled do not respect this flag. +# +# As high ratio compressors like LZ4HC, Zstd, and Deflate can potentially +# block flushes for too long, the default is to flush with a known fast +# compressor in those cases. Options are: +# +# none : Flush without compressing blocks but while still doing checksums. +# fast : Flush with a fast compressor. If the table is already using a +# fast compressor that compressor is used. +# table: Always flush with the same compressor that the table uses. This +# was the pre 4.0 behavior. +# +# flush_compression: fast + +# 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: "172.17.0.4" + +# 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. Same applies to +# "concurrent_counter_writes", since counter writes read the current +# values before incrementing and writing them back. +# +# 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 +concurrent_counter_writes: 32 + +# For materialized view writes, as there is a read involved, so this should +# be limited by the less of concurrent reads or concurrent writes. +concurrent_materialized_view_writes: 32 + +# Maximum memory to use for inter-node and client-server networking buffers. +# +# Defaults to the smaller of 1/16 of heap or 128MB. This pool is allocated off-heap, +# so is in addition to the memory allocated for heap. The cache also has on-heap +# overhead which is roughly 128 bytes per chunk (i.e. 0.2% of the reserved size +# if the default 64k chunk size is used). +# Memory is only allocated when needed. +# Min unit: MiB +# networking_cache_size: 128MiB + +# Enable the sstable chunk cache. The chunk cache will store recently accessed +# sections of the sstable in-memory as uncompressed buffers. +# file_cache_enabled: false + +# Maximum memory to use for sstable chunk cache and buffer pooling. +# 32MB of this are reserved for pooling buffers, the rest is used for chunk cache +# that holds uncompressed sstable chunks. +# Defaults to the smaller of 1/4 of heap or 512MB. This pool is allocated off-heap, +# so is in addition to the memory allocated for heap. The cache also has on-heap +# overhead which is roughly 128 bytes per chunk (i.e. 0.2% of the reserved size +# if the default 64k chunk size is used). +# Memory is only allocated when needed. +# Min unit: MiB +# file_cache_size: 512MiB + +# Flag indicating whether to allocate on or off heap when the sstable buffer +# pool is exhausted, that is when it has exceeded the maximum memory +# file_cache_size, beyond which it will not cache buffers but allocate on request. + +# buffer_pool_use_heap_if_exhausted: true + +# The strategy for optimizing disk read +# Possible values are: +# ssd (for solid state disks, the default) +# spinning (for spinning disks) +# disk_optimization_strategy: ssd + +# Total permitted memory to use for memtables. Cassandra will stop +# accepting writes when the limit is exceeded until a flush completes, +# and will trigger a flush based on memtable_cleanup_threshold +# If omitted, Cassandra will set both to 1/4 the size of the heap. +# Min unit: MiB +# memtable_heap_space: 2048MiB +# Min unit: MiB +# memtable_offheap_space: 2048MiB + +# memtable_cleanup_threshold is deprecated. The default calculation +# is the only reasonable choice. See the comments on memtable_flush_writers +# for more information. +# +# Ratio of occupied non-flushing memtable size to total permitted size +# that will trigger a flush of the largest memtable. Larger mct will +# mean larger flushes and hence less compaction, but also less concurrent +# flush activity which can make it difficult to keep your disks fed +# under heavy write load. +# +# memtable_cleanup_threshold defaults to 1 / (memtable_flush_writers + 1) +# memtable_cleanup_threshold: 0.11 + +# Specify the way Cassandra allocates and manages memtable memory. +# Options are: +# +# heap_buffers +# on heap nio buffers +# +# offheap_buffers +# off heap (direct) nio buffers +# +# offheap_objects +# off heap objects +memtable_allocation_type: heap_buffers + +# Limit memory usage for Merkle tree calculations during repairs. The default +# is 1/16th of the available heap. The main tradeoff is that smaller trees +# have less resolution, which can lead to over-streaming data. If you see heap +# pressure during repairs, consider lowering this, but you cannot go below +# one mebibyte. If you see lots of over-streaming, consider raising +# this or using subrange repair. +# +# For more details see https://issues.apache.org/jira/browse/CASSANDRA-14096. +# +# Min unit: MiB +# repair_session_space: + +# Total space to use for commit logs on disk. +# +# If space gets above this value, Cassandra will flush every dirty CF +# in the oldest segment and remove it. So a small total commitlog space +# will tend to cause more flush activity on less-active columnfamilies. +# +# The default value is the smaller of 8192, and 1/4 of the total space +# of the commitlog volume. +# +# commitlog_total_space: 8192MiB + +# This sets the number of memtable flush writer threads per disk +# as well as the total number of memtables that can be flushed concurrently. +# These are generally a combination of compute and IO bound. +# +# Memtable flushing is more CPU efficient than memtable ingest and a single thread +# can keep up with the ingest rate of a whole server on a single fast disk +# until it temporarily becomes IO bound under contention typically with compaction. +# At that point you need multiple flush threads. At some point in the future +# it may become CPU bound all the time. +# +# You can tell if flushing is falling behind using the MemtablePool.BlockedOnAllocation +# metric which should be 0, but will be non-zero if threads are blocked waiting on flushing +# to free memory. +# +# memtable_flush_writers defaults to two for a single data directory. +# This means that two memtables can be flushed concurrently to the single data directory. +# If you have multiple data directories the default is one memtable flushing at a time +# but the flush will use a thread per data directory so you will get two or more writers. +# +# Two is generally enough to flush on a fast disk [array] mounted as a single data directory. +# Adding more flush writers will result in smaller more frequent flushes that introduce more +# compaction overhead. +# +# There is a direct tradeoff between number of memtables that can be flushed concurrently +# and flush size and frequency. More is not better you just need enough flush writers +# to never stall waiting for flushing to free memory. +# +# memtable_flush_writers: 2 + +# Total space to use for change-data-capture logs on disk. +# +# If space gets above this value, Cassandra will throw WriteTimeoutException +# on Mutations including tables with CDC enabled. A CDCCompactor is responsible +# for parsing the raw CDC logs and deleting them when parsing is completed. +# +# The default value is the min of 4096 MiB and 1/8th of the total space +# of the drive where cdc_raw_directory resides. +# Min unit: MiB +# cdc_total_space: 4096MiB + +# When we hit our cdc_raw limit and the CDCCompactor is either running behind +# or experiencing backpressure, we check at the following interval to see if any +# new space for cdc-tracked tables has been made available. Default to 250ms +# Min unit: ms +# cdc_free_space_check_interval: 250ms + +# A fixed memory pool size in MB for for SSTable index summaries. If left +# empty, this will default to 5% of the heap size. If the memory usage of +# all index summaries exceeds this limit, SSTables with low read rates will +# shrink their index summaries in order to meet this limit. However, this +# is a best-effort process. In extreme conditions Cassandra may need to use +# more than this amount of memory. +# Min unit: KiB +index_summary_capacity: + +# How frequently index summaries should be resampled. This is done +# periodically to redistribute memory from the fixed-size pool to sstables +# proportional their recent read rates. Setting to null value will disable this +# process, leaving existing index summaries at their current sampling level. +# Min unit: m +index_summary_resize_interval: 60m + +# 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 SSDs; not +# necessarily on platters. +trickle_fsync: false +# Min unit: KiB +trickle_fsync_interval: 10240KiB + +# TCP port, for commands and data +# For security reasons, you should not expose this port to the internet. Firewall it if needed. +storage_port: 7000 + +# SSL port, for legacy encrypted communication. This property is unused unless enabled in +# server_encryption_options (see below). As of cassandra 4.0, this property is deprecated +# as a single port can be used for either/both secure and insecure connections. +# For security reasons, you should not expose this port to the internet. Firewall it if needed. +ssl_storage_port: 7001 + +# Address or interface 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! +# +# Set listen_address OR listen_interface, not both. +# +# 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). If unresolvable +# it will fall back to InetAddress.getLoopbackAddress(), which is wrong for production systems. +# +# Setting listen_address to 0.0.0.0 is always wrong. +# +listen_address: 172.17.0.4 + +# Set listen_address OR listen_interface, not both. Interfaces must correspond +# to a single address, IP aliasing is not supported. +# listen_interface: eth0 + +# If you choose to specify the interface by name and the interface has an ipv4 and an ipv6 address +# you can specify which should be chosen using listen_interface_prefer_ipv6. If false the first ipv4 +# address will be used. If true the first ipv6 address will be used. Defaults to false preferring +# ipv4. If there is only one address it will be selected regardless of ipv4/ipv6. +# listen_interface_prefer_ipv6: false + +# Address to broadcast to other Cassandra nodes +# Leaving this blank will set it to the same value as listen_address +broadcast_address: 172.17.0.4 + +# When using multiple physical network interfaces, set this +# to true to listen on broadcast_address in addition to +# the listen_address, allowing nodes to communicate in both +# interfaces. +# Ignore this property if the network configuration automatically +# routes between the public and private networks such as EC2. +# listen_on_broadcast_address: false + +# Internode authentication backend, implementing IInternodeAuthenticator; +# used to allow/disallow connections from peer nodes. +# internode_authenticator: org.apache.cassandra.auth.AllowAllInternodeAuthenticator + +# Whether to start the native transport server. +# The address on which the native transport is bound is defined by rpc_address. +start_native_transport: true +# port for the CQL native transport to listen for clients on +# For security reasons, you should not expose this port to the internet. Firewall it if needed. +native_transport_port: 9042 +# Enabling native transport encryption in client_encryption_options allows you to either use +# encryption for the standard port or to use a dedicated, additional port along with the unencrypted +# standard native_transport_port. +# Enabling client encryption and keeping native_transport_port_ssl disabled will use encryption +# for native_transport_port. Setting native_transport_port_ssl to a different value +# from native_transport_port will use encryption for native_transport_port_ssl while +# keeping native_transport_port unencrypted. +# native_transport_port_ssl: 9142 +# The maximum threads for handling requests (note that idle threads are stopped +# after 30 seconds so there is not corresponding minimum setting). +# native_transport_max_threads: 128 +# +# The maximum size of allowed frame. Frame (requests) larger than this will +# be rejected as invalid. The default is 16MiB. If you're changing this parameter, +# you may want to adjust max_value_size accordingly. This should be positive and less than 2048. +# Min unit: MiB +# native_transport_max_frame_size: 16MiB + +# The maximum number of concurrent client connections. +# The default is -1, which means unlimited. +# native_transport_max_concurrent_connections: -1 + +# The maximum number of concurrent client connections per source ip. +# The default is -1, which means unlimited. +# native_transport_max_concurrent_connections_per_ip: -1 + +# Controls whether Cassandra honors older, yet currently supported, protocol versions. +# The default is true, which means all supported protocols will be honored. +native_transport_allow_older_protocols: true + +# Controls when idle client connections are closed. Idle connections are ones that had neither reads +# nor writes for a time period. +# +# Clients may implement heartbeats by sending OPTIONS native protocol message after a timeout, which +# will reset idle timeout timer on the server side. To close idle client connections, corresponding +# values for heartbeat intervals have to be set on the client side. +# +# Idle connection timeouts are disabled by default. +# Min unit: ms +# native_transport_idle_timeout: 60000ms + +# When enabled, limits the number of native transport requests dispatched for processing per second. +# Behavior once the limit has been breached depends on the value of THROW_ON_OVERLOAD specified in +# the STARTUP message sent by the client during connection establishment. (See section "4.1.1. STARTUP" +# in "CQL BINARY PROTOCOL v5".) With the THROW_ON_OVERLOAD flag enabled, messages that breach the limit +# are dropped, and an OverloadedException is thrown for the client to handle. When the flag is not +# enabled, the server will stop consuming messages from the channel/socket, putting backpressure on +# the client while already dispatched messages are processed. +# native_transport_rate_limiting_enabled: false +# native_transport_max_requests_per_second: 1000000 + +# The address or interface to bind the native transport server to. +# +# Set rpc_address OR rpc_interface, not both. +# +# Leaving rpc_address blank has the same effect as on listen_address +# (i.e. it will be based on the configured hostname of the node). +# +# Note that unlike listen_address, you can specify 0.0.0.0, but you must also +# set broadcast_rpc_address to a value other than 0.0.0.0. +# +# For security reasons, you should not expose this port to the internet. Firewall it if needed. +rpc_address: 0.0.0.0 + +# Set rpc_address OR rpc_interface, not both. Interfaces must correspond +# to a single address, IP aliasing is not supported. +# rpc_interface: eth1 + +# If you choose to specify the interface by name and the interface has an ipv4 and an ipv6 address +# you can specify which should be chosen using rpc_interface_prefer_ipv6. If false the first ipv4 +# address will be used. If true the first ipv6 address will be used. Defaults to false preferring +# ipv4. If there is only one address it will be selected regardless of ipv4/ipv6. +# rpc_interface_prefer_ipv6: false + +# RPC address to broadcast to drivers and other Cassandra nodes. This cannot +# be set to 0.0.0.0. If left blank, this will be set to the value of +# rpc_address. If rpc_address is set to 0.0.0.0, broadcast_rpc_address must +# be set. +broadcast_rpc_address: 172.17.0.4 + +# enable or disable keepalive on rpc/native connections +rpc_keepalive: true + +# Uncomment to set socket buffer size for internode communication +# Note that when setting this, the buffer size is limited by net.core.wmem_max +# and when not setting it it is defined by net.ipv4.tcp_wmem +# See also: +# /proc/sys/net/core/wmem_max +# /proc/sys/net/core/rmem_max +# /proc/sys/net/ipv4/tcp_wmem +# /proc/sys/net/ipv4/tcp_wmem +# and 'man tcp' +# Min unit: B +# internode_socket_send_buffer_size: + +# Uncomment to set socket buffer size for internode communication +# Note that when setting this, the buffer size is limited by net.core.wmem_max +# and when not setting it it is defined by net.ipv4.tcp_wmem +# Min unit: B +# internode_socket_receive_buffer_size: + +# 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: true + +# Adds a time-to-live (TTL) to auto snapshots generated by table +# truncation or drop (when enabled). +# After the TTL is elapsed, the snapshot is automatically cleared. +# By default, auto snapshots *do not* have TTL, uncomment the property below +# to enable TTL on auto snapshots. +# Accepted units: d (days), h (hours) or m (minutes) +# auto_snapshot_ttl: 30d + +# The act of creating or clearing a snapshot involves creating or removing +# potentially tens of thousands of links, which can cause significant performance +# impact, especially on consumer grade SSDs. A non-zero value here can +# be used to throttle these links to avoid negative performance impact of +# taking and clearing snapshots +snapshot_links_per_second: 0 + +# Granularity of the collation index of rows within a partition. +# Increase if your rows are large, or if you have a very large +# number of rows per partition. The competing goals are these: +# +# - a smaller granularity means more index entries are generated +# and looking up rows withing the partition by collation column +# is faster +# - but, Cassandra will keep the collation index in memory for hot +# rows (as part of the key cache), so a larger granularity means +# you can cache more hot rows +# Min unit: KiB +column_index_size: 64KiB + +# Per sstable indexed key cache entries (the collation index in memory +# mentioned above) exceeding this size will not be held on heap. +# This means that only partition information is held on heap and the +# index entries are read from disk. +# +# Note that this size refers to the size of the +# serialized index information and not the size of the partition. +# Min unit: KiB +column_index_cache_size: 2KiB + +# 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 first. +# +# concurrent_compactors defaults to the smaller of (number of disks, +# number of cores), with a minimum of 2 and a maximum of 8. +# +# If your data directories are backed by SSD, you should increase this +# to the number of cores. +# concurrent_compactors: 1 + +# Number of simultaneous repair validations to allow. If not set or set to +# a value less than 1, it defaults to the value of concurrent_compactors. +# To set a value greeater than concurrent_compactors at startup, the system +# property cassandra.allow_unlimited_concurrent_validations must be set to +# true. To dynamically resize to a value > concurrent_compactors on a running +# node, first call the bypassConcurrentValidatorsLimit method on the +# org.apache.cassandra.db:type=StorageService mbean +# concurrent_validations: 0 + +# Number of simultaneous materialized view builder tasks to allow. +concurrent_materialized_view_builders: 1 + +# 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 accounts for all types +# of compaction, including validation compaction (building Merkle trees +# for repairs). +compaction_throughput: 64MiB/s + +# When compacting, the replacement sstable(s) can be opened before they +# are completely written, and used in place of the prior sstables for +# any range that has been written. This helps to smoothly transfer reads +# between the sstables, reducing page cache churn and keeping hot rows hot +# Set sstable_preemptive_open_interval to null for disabled which is equivalent to +# sstable_preemptive_open_interval_in_mb being negative +# Min unit: MiB +sstable_preemptive_open_interval: 50MiB + +# Starting from 4.1 sstables support UUID based generation identifiers. They are disabled by default +# because once enabled, there is no easy way to downgrade. When the node is restarted with this option +# set to true, each newly created sstable will have a UUID based generation identifier and such files are +# not readable by previous Cassandra versions. At some point, this option will become true by default +# and eventually get removed from the configuration. +uuid_sstable_identifiers_enabled: false + +# When enabled, permits Cassandra to zero-copy stream entire eligible +# SSTables between nodes, including every component. +# This speeds up the network transfer significantly subject to +# throttling specified by entire_sstable_stream_throughput_outbound, +# and entire_sstable_inter_dc_stream_throughput_outbound +# for inter-DC transfers. +# Enabling this will reduce the GC pressure on sending and receiving node. +# When unset, the default is enabled. While this feature tries to keep the +# disks balanced, it cannot guarantee it. This feature will be automatically +# disabled if internode encryption is enabled. +# stream_entire_sstables: true + +# Throttles entire SSTable outbound streaming file transfers on +# this node to the given total throughput in Mbps. +# Setting this value to 0 it disables throttling. +# When unset, the default is 200 Mbps or 24 MiB/s. +# entire_sstable_stream_throughput_outbound: 24MiB/s + +# Throttles entire SSTable file streaming between datacenters. +# Setting this value to 0 disables throttling for entire SSTable inter-DC file streaming. +# When unset, the default is 200 Mbps or 24 MiB/s. +# entire_sstable_inter_dc_stream_throughput_outbound: 24MiB/s + +# 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 24 MiB/s. +# stream_throughput_outbound: 24MiB/s + +# Throttles all streaming file transfer between the datacenters, +# this setting allows users to throttle inter dc stream throughput in addition +# to throttling all network stream traffic as configured with +# stream_throughput_outbound_megabits_per_sec +# When unset, the default is 200 Mbps or 24 MiB/s. +# inter_dc_stream_throughput_outbound: 24MiB/s + +# Server side timeouts for requests. The server will return a timeout exception +# to the client if it can't complete an operation within the corresponding +# timeout. Those settings are a protection against: +# 1) having client wait on an operation that might never terminate due to some +# failures. +# 2) operations that use too much CPU/read too much data (leading to memory build +# up) by putting a limit to how long an operation will execute. +# For this reason, you should avoid putting these settings too high. In other words, +# if you are timing out requests because of underlying resource constraints then +# increasing the timeout will just cause more problems. Of course putting them too +# low is equally ill-advised since clients could get timeouts even for successful +# operations just because the timeout setting is too tight. + +# How long the coordinator should wait for read operations to complete. +# Lowest acceptable value is 10 ms. +# Min unit: ms +read_request_timeout: 5000ms +# How long the coordinator should wait for seq or index scans to complete. +# Lowest acceptable value is 10 ms. +# Min unit: ms +range_request_timeout: 10000ms +# How long the coordinator should wait for writes to complete. +# Lowest acceptable value is 10 ms. +# Min unit: ms +write_request_timeout: 2000ms +# How long the coordinator should wait for counter writes to complete. +# Lowest acceptable value is 10 ms. +# Min unit: ms +counter_write_request_timeout: 5000ms +# How long a coordinator should continue to retry a CAS operation +# that contends with other proposals for the same row. +# Lowest acceptable value is 10 ms. +# Min unit: ms +cas_contention_timeout: 1000ms +# 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.) +# Lowest acceptable value is 10 ms. +# Min unit: ms +truncate_request_timeout: 60000ms +# The default timeout for other, miscellaneous operations. +# Lowest acceptable value is 10 ms. +# Min unit: ms +request_timeout: 10000ms + +# Defensive settings for protecting Cassandra from true network partitions. +# See (CASSANDRA-14358) for details. +# +# The amount of time to wait for internode tcp connections to establish. +# Min unit: ms +# internode_tcp_connect_timeout: 2000ms +# +# The amount of time unacknowledged data is allowed on a connection before we throw out the connection +# Note this is only supported on Linux + epoll, and it appears to behave oddly above a setting of 30000 +# (it takes much longer than 30s) as of Linux 4.12. If you want something that high set this to 0 +# which picks up the OS default and configure the net.ipv4.tcp_retries2 sysctl to be ~8. +# Min unit: ms +# internode_tcp_user_timeout: 30000ms + +# The amount of time unacknowledged data is allowed on a streaming connection. +# The default is 5 minutes. Increase it or set it to 0 in order to increase the timeout. +# Min unit: ms +# internode_streaming_tcp_user_timeout: 300000ms + +# Global, per-endpoint and per-connection limits imposed on messages queued for delivery to other nodes +# and waiting to be processed on arrival from other nodes in the cluster. These limits are applied to the on-wire +# size of the message being sent or received. +# +# The basic per-link limit is consumed in isolation before any endpoint or global limit is imposed. +# Each node-pair has three links: urgent, small and large. So any given node may have a maximum of +# N*3*(internode_application_send_queue_capacity+internode_application_receive_queue_capacity) +# messages queued without any coordination between them although in practice, with token-aware routing, only RF*tokens +# nodes should need to communicate with significant bandwidth. +# +# The per-endpoint limit is imposed on all messages exceeding the per-link limit, simultaneously with the global limit, +# on all links to or from a single node in the cluster. +# The global limit is imposed on all messages exceeding the per-link limit, simultaneously with the per-endpoint limit, +# on all links to or from any node in the cluster. +# +# Min unit: B +# internode_application_send_queue_capacity: 4MiB +# internode_application_send_queue_reserve_endpoint_capacity: 128MiB +# internode_application_send_queue_reserve_global_capacity: 512MiB +# internode_application_receive_queue_capacity: 4MiB +# internode_application_receive_queue_reserve_endpoint_capacity: 128MiB +# internode_application_receive_queue_reserve_global_capacity: 512MiB + + +# How long before a node logs slow queries. Select queries that take longer than +# this timeout to execute, will generate an aggregated log message, so that slow queries +# can be identified. Set this value to zero to disable slow query logging. +# Min unit: ms +slow_query_log_timeout: 500ms + +# 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: It is generally assumed that users have setup NTP on their clusters, and that clocks are modestly in sync, +# since this is a requirement for general correctness of last write wins. +# internode_timeout: true + +# Set period for idle state control messages for earlier detection of failed streams +# This node will send a keep-alive message periodically on the streaming's control channel. +# This ensures that any eventual SocketTimeoutException will occur within 2 keep-alive cycles +# If the node cannot send, or timeouts sending, the keep-alive message on the netty control channel +# the stream session is closed. +# Default value is 300s (5 minutes), which means stalled streams +# are detected within 10 minutes +# Specify 0 to disable. +# Min unit: s +# streaming_keep_alive_period: 300s + +# Limit number of connections per host for streaming +# Increase this when you notice that joins are CPU-bound rather that network +# bound (for example a few nodes with big files). +# streaming_connections_per_host: 1 + +# Settings for stream stats tracking; used by system_views.streaming table +# How long before a stream is evicted from tracking; this impacts both historic and currently running +# streams. +# streaming_state_expires: 3d +# How much memory may be used for tracking before evicting session from tracking; once crossed +# historic and currently running streams maybe impacted. +# streaming_state_size: 40MiB +# Enable/Disable tracking of streaming stats +# streaming_stats_enabled: true + +# Allows denying configurable access (rw/rr) to operations on configured ks, table, and partitions, intended for use by +# operators to manage cluster health vs application access. See CASSANDRA-12106 and CEP-13 for more details. +# partition_denylist_enabled: false + +# denylist_writes_enabled: true +# denylist_reads_enabled: true +# denylist_range_reads_enabled: true + +# The interval at which keys in the cache for denylisting will "expire" and async refresh from the backing DB. +# Note: this serves only as a fail-safe, as the usage pattern is expected to be "mutate state, refresh cache" on any +# changes to the underlying denylist entries. See documentation for details. +# Min unit: s +# denylist_refresh: 600s + +# In the event of errors on attempting to load the denylist cache, retry on this interval. +# Min unit: s +# denylist_initial_load_retry: 5s + +# We cap the number of denylisted keys allowed per table to keep things from growing unbounded. Nodes will warn above +# this limit while allowing new denylisted keys to be inserted. Denied keys are loaded in natural query / clustering +# ordering by partition key in case of overflow. +# denylist_max_keys_per_table: 1000 + +# We cap the total number of denylisted keys allowed in the cluster to keep things from growing unbounded. +# Nodes will warn on initial cache load that there are too many keys and be direct the operator to trim down excess +# entries to within the configured limits. +# denylist_max_keys_total: 10000 + +# Since the denylist in many ways serves to protect the health of the cluster from partitions operators have identified +# as being in a bad state, we usually want more robustness than just CL.ONE on operations to/from these tables to +# ensure that these safeguards are in place. That said, we allow users to configure this if they're so inclined. +# denylist_consistency_level: QUORUM + +# 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) +# +# CASSANDRA WILL NOT ALLOW YOU TO SWITCH TO AN INCOMPATIBLE SNITCH +# ONCE DATA IS INSERTED INTO THE CLUSTER. This would cause data loss. +# This means that if you start with the default SimpleSnitch, which +# locates every node on "rack1" in "datacenter1", your only options +# if you need to add another datacenter are GossipingPropertyFileSnitch +# (and the older PFS). From there, if you want to migrate to an +# incompatible snitch like Ec2Snitch you can do it by adding new nodes +# under Ec2Snitch (which will locate them in a new "datacenter") and +# decommissioning the old ones. +# +# Out of the box, Cassandra provides: +# +# SimpleSnitch: +# Treats Strategy order as proximity. This can improve cache +# locality when disabling read repair. Only appropriate for +# single-datacenter deployments. +# +# GossipingPropertyFileSnitch +# This should be your go-to snitch for production use. The rack +# and datacenter for the local node are defined in +# cassandra-rackdc.properties and propagated to other nodes via +# gossip. If cassandra-topology.properties exists, it is used as a +# fallback, allowing migration from the PropertyFileSnitch. +# +# PropertyFileSnitch: +# Proximity is determined by rack and data center, which are +# explicitly configured in cassandra-topology.properties. +# +# 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.) +# +# 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, this is best used as an example of +# writing a custom Snitch class and is provided in that spirit. +# +# 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 +# Min unit: ms +dynamic_snitch_update_interval: 100ms +# controls how often to reset all host scores, allowing a bad host to +# possibly recover +# Min unit: ms +dynamic_snitch_reset_interval: 600000ms +# if set greater than zero, 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: 1.0 + +# Configure server-to-server internode encryption +# +# JVM and netty defaults for supported SSL socket protocols and cipher suites can +# be replaced using custom encryption options. This is not recommended +# unless you have policies in place that dictate certain settings, or +# need to disable vulnerable ciphers or protocols in case the JVM cannot +# be updated. +# +# FIPS compliant settings can be configured at JVM level and should not +# involve changing encryption settings here: +# https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/FIPS.html +# +# **NOTE** this default configuration is an insecure configuration. If you need to +# enable server-to-server encryption generate server keystores (and truststores for mutual +# authentication) per: +# http://download.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html#CreateKeystore +# Then perform the following configuration changes: +# +# Step 1: Set internode_encryption= and explicitly set optional=true. Restart all nodes +# +# Step 2: Set optional=false (or remove it) and if you generated truststores and want to use mutual +# auth set require_client_auth=true. Restart all nodes +server_encryption_options: + # On outbound connections, determine which type of peers to securely connect to. + # The available options are : + # none : Do not encrypt outgoing connections + # dc : Encrypt connections to peers in other datacenters but not within datacenters + # rack : Encrypt connections to peers in other racks but not within racks + # all : Always use encrypted connections + internode_encryption: none + # When set to true, encrypted and unencrypted connections are allowed on the storage_port + # This should _only be true_ while in unencrypted or transitional operation + # optional defaults to true if internode_encryption is none + # optional: true + # If enabled, will open up an encrypted listening socket on ssl_storage_port. Should only be used + # during upgrade to 4.0; otherwise, set to false. + legacy_ssl_storage_port_enabled: false + # Set to a valid keystore if internode_encryption is dc, rack or all + keystore: conf/.keystore + keystore_password: cassandra + # Configure the way Cassandra creates SSL contexts. + # To use PEM-based key material, see org.apache.cassandra.security.PEMBasedSslContextFactory + # ssl_context_factory: + # # Must be an instance of org.apache.cassandra.security.ISslContextFactory + # class_name: org.apache.cassandra.security.DefaultSslContextFactory + # Verify peer server certificates + require_client_auth: false + # Set to a valid trustore if require_client_auth is true + truststore: conf/.truststore + truststore_password: cassandra + # Verify that the host name in the certificate matches the connected host + require_endpoint_verification: false + # More advanced defaults: + # protocol: TLS + # store_type: JKS + # cipher_suites: [ + # TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, + # TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, + # TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA, + # TLS_RSA_WITH_AES_256_CBC_SHA + # ] + +# Configure client-to-server encryption. +# +# **NOTE** this default configuration is an insecure configuration. If you need to +# enable client-to-server encryption generate server keystores (and truststores for mutual +# authentication) per: +# http://download.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html#CreateKeystore +# Then perform the following configuration changes: +# +# Step 1: Set enabled=true and explicitly set optional=true. Restart all nodes +# +# Step 2: Set optional=false (or remove it) and if you generated truststores and want to use mutual +# auth set require_client_auth=true. Restart all nodes +client_encryption_options: + # Enable client-to-server encryption + enabled: false + # When set to true, encrypted and unencrypted connections are allowed on the native_transport_port + # This should _only be true_ while in unencrypted or transitional operation + # optional defaults to true when enabled is false, and false when enabled is true. + # optional: true + # Set keystore and keystore_password to valid keystores if enabled is true + keystore: conf/.keystore + keystore_password: cassandra + # Configure the way Cassandra creates SSL contexts. + # To use PEM-based key material, see org.apache.cassandra.security.PEMBasedSslContextFactory + # ssl_context_factory: + # # Must be an instance of org.apache.cassandra.security.ISslContextFactory + # class_name: org.apache.cassandra.security.DefaultSslContextFactory + # Verify client certificates + require_client_auth: false + # Set trustore and truststore_password if require_client_auth is true + # truststore: conf/.truststore + # truststore_password: cassandra + # More advanced defaults: + # protocol: TLS + # store_type: JKS + # cipher_suites: [ + # TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, + # TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, + # TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA, + # TLS_RSA_WITH_AES_256_CBC_SHA + # ] + +# internode_compression controls whether traffic between nodes is +# compressed. +# Can be: +# +# all +# all traffic is compressed +# +# dc +# traffic between different datacenters is compressed +# +# none +# nothing is compressed. +internode_compression: dc + +# Enable or disable tcp_nodelay for inter-dc communication. +# Disabling it will result in larger (but fewer) network packets being sent, +# reducing overhead from the TCP protocol itself, at the cost of increasing +# latency if you block for cross-datacenter responses. +inter_dc_tcp_nodelay: false + +# TTL for different trace types used during logging of the repair process. +# Min unit: s +trace_type_query_ttl: 1d +# Min unit: s +trace_type_repair_ttl: 7d + +# If unset, all GC Pauses greater than gc_log_threshold will log at +# INFO level +# UDFs (user defined functions) are disabled by default. +# As of Cassandra 3.0 there is a sandbox in place that should prevent execution of evil code. +user_defined_functions_enabled: false + +# Enables scripted UDFs (JavaScript UDFs). +# Java UDFs are always enabled, if user_defined_functions_enabled is true. +# Enable this option to be able to use UDFs with "language javascript" or any custom JSR-223 provider. +# This option has no effect, if user_defined_functions_enabled is false. +scripted_user_defined_functions_enabled: false + +# Enables encrypting data at-rest (on disk). Different key providers can be plugged in, but the default reads from +# a JCE-style keystore. A single keystore can hold multiple keys, but the one referenced by +# the "key_alias" is the only key that will be used for encrypt opertaions; previously used keys +# can still (and should!) be in the keystore and will be used on decrypt operations +# (to handle the case of key rotation). +# +# It is strongly recommended to download and install Java Cryptography Extension (JCE) +# Unlimited Strength Jurisdiction Policy Files for your version of the JDK. +# (current link: http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html) +# +# Currently, only the following file types are supported for transparent data encryption, although +# more are coming in future cassandra releases: commitlog, hints +transparent_data_encryption_options: + enabled: false + chunk_length_kb: 64 + cipher: AES/CBC/PKCS5Padding + key_alias: testing:1 + # CBC IV length for AES needs to be 16 bytes (which is also the default size) + # iv_length: 16 + key_provider: + - class_name: org.apache.cassandra.security.JKSKeyProvider + parameters: + - keystore: conf/.keystore + keystore_password: cassandra + store_type: JCEKS + key_password: cassandra + + +##################### +# SAFETY THRESHOLDS # +##################### + +# When executing a scan, within or across a partition, we need to keep the +# tombstones seen in memory so we can return them to the coordinator, which +# will use them to make sure other replicas also know about the deleted rows. +# With workloads that generate a lot of tombstones, this can cause performance +# problems and even exaust the server heap. +# (http://www.datastax.com/dev/blog/cassandra-anti-patterns-queues-and-queue-like-datasets) +# Adjust the thresholds here if you understand the dangers and want to +# scan more tombstones anyway. These thresholds may also be adjusted at runtime +# using the StorageService mbean. +tombstone_warn_threshold: 1000 +tombstone_failure_threshold: 100000 + +# Filtering and secondary index queries at read consistency levels above ONE/LOCAL_ONE use a +# mechanism called replica filtering protection to ensure that results from stale replicas do +# not violate consistency. (See CASSANDRA-8272 and CASSANDRA-15907 for more details.) This +# mechanism materializes replica results by partition on-heap at the coordinator. The more possibly +# stale results returned by the replicas, the more rows materialized during the query. +replica_filtering_protection: + # These thresholds exist to limit the damage severely out-of-date replicas can cause during these + # queries. They limit the number of rows from all replicas individual index and filtering queries + # can materialize on-heap to return correct results at the desired read consistency level. + # + # "cached_replica_rows_warn_threshold" is the per-query threshold at which a warning will be logged. + # "cached_replica_rows_fail_threshold" is the per-query threshold at which the query will fail. + # + # These thresholds may also be adjusted at runtime using the StorageService mbean. + # + # If the failure threshold is breached, it is likely that either the current page/fetch size + # is too large or one or more replicas is severely out-of-sync and in need of repair. + cached_rows_warn_threshold: 2000 + cached_rows_fail_threshold: 32000 + +# Log WARN on any multiple-partition batch size exceeding this value. 5KiB per batch by default. +# Caution should be taken on increasing the size of this threshold as it can lead to node instability. +# Min unit: KiB +batch_size_warn_threshold: 5KiB + +# Fail any multiple-partition batch exceeding this value. 50KiB (10x warn threshold) by default. +# Min unit: KiB +batch_size_fail_threshold: 50KiB + +# Log WARN on any batches not of type LOGGED than span across more partitions than this limit +unlogged_batch_across_partitions_warn_threshold: 10 + +# Log a warning when compacting partitions larger than this value +compaction_large_partition_warning_threshold: 100MiB + +# Log a warning when writing more tombstones than this value to a partition +compaction_tombstone_warning_threshold: 100000 + +# GC Pauses greater than 200 ms will be logged at INFO level +# This threshold can be adjusted to minimize logging if necessary +# Min unit: ms +# gc_log_threshold: 200ms + +# GC Pauses greater than gc_warn_threshold will be logged at WARN level +# Adjust the threshold based on your application throughput requirement. Setting to 0 +# will deactivate the feature. +# Min unit: ms +# gc_warn_threshold: 1000ms + +# Maximum size of any value in SSTables. Safety measure to detect SSTable corruption +# early. Any value size larger than this threshold will result into marking an SSTable +# as corrupted. This should be positive and less than 2GiB. +# Min unit: MiB +# max_value_size: 256MiB + +# ** Impact on keyspace creation ** +# If replication factor is not mentioned as part of keyspace creation, default_keyspace_rf would apply. +# Changing this configuration would only take effect for keyspaces created after the change, but does not impact +# existing keyspaces created prior to the change. +# ** Impact on keyspace alter ** +# When altering a keyspace from NetworkTopologyStrategy to SimpleStrategy, default_keyspace_rf is applied if rf is not +# explicitly mentioned. +# ** Impact on system keyspaces ** +# This would also apply for any system keyspaces that need replication factor. +# A further note about system keyspaces - system_traces and system_distributed keyspaces take RF of 2 or default, +# whichever is higher, and system_auth keyspace takes RF of 1 or default, whichever is higher. +# Suggested value for use in production: 3 +# default_keyspace_rf: 1 + +# Track a metric per keyspace indicating whether replication achieved the ideal consistency +# level for writes without timing out. This is different from the consistency level requested by +# each write which may be lower in order to facilitate availability. +# ideal_consistency_level: EACH_QUORUM + +# Automatically upgrade sstables after upgrade - if there is no ordinary compaction to do, the +# oldest non-upgraded sstable will get upgraded to the latest version +# automatic_sstable_upgrade: false +# Limit the number of concurrent sstable upgrades +# max_concurrent_automatic_sstable_upgrades: 1 + +# Audit logging - Logs every incoming CQL command request, authentication to a node. See the docs +# on audit_logging for full details about the various configuration options. +audit_logging_options: + enabled: false + logger: + - class_name: BinAuditLogger + # audit_logs_dir: + # included_keyspaces: + # excluded_keyspaces: system, system_schema, system_virtual_schema + # included_categories: + # excluded_categories: + # included_users: + # excluded_users: + # roll_cycle: HOURLY + # block: true + # max_queue_weight: 268435456 # 256 MiB + # max_log_size: 17179869184 # 16 GiB + ## archive command is "/path/to/script.sh %path" where %path is replaced with the file being rolled: + # archive_command: + # max_archive_retries: 10 + + + # default options for full query logging - these can be overridden from command line when executing + # nodetool enablefullquerylog + # full_query_logging_options: + # log_dir: + # roll_cycle: HOURLY + # block: true + # max_queue_weight: 268435456 # 256 MiB + # max_log_size: 17179869184 # 16 GiB + ## archive command is "/path/to/script.sh %path" where %path is replaced with the file being rolled: + # archive_command: + ## note that enabling this allows anyone with JMX/nodetool access to run local shell commands as the user running cassandra + # allow_nodetool_archive_command: false + # max_archive_retries: 10 + +# validate tombstones on reads and compaction +# can be either "disabled", "warn" or "exception" +# corrupted_tombstone_strategy: disabled + +# Diagnostic Events # +# If enabled, diagnostic events can be helpful for troubleshooting operational issues. Emitted events contain details +# on internal state and temporal relationships across events, accessible by clients via JMX. +diagnostic_events_enabled: false + +# Use native transport TCP message coalescing. If on upgrade to 4.0 you found your throughput decreasing, and in +# particular you run an old kernel or have very fewer client connections, this option might be worth evaluating. +#native_transport_flush_in_batches_legacy: false + +# Enable tracking of repaired state of data during reads and comparison between replicas +# Mismatches between the repaired sets of replicas can be characterized as either confirmed +# or unconfirmed. In this context, unconfirmed indicates that the presence of pending repair +# sessions, unrepaired partition tombstones, or some other condition means that the disparity +# cannot be considered conclusive. Confirmed mismatches should be a trigger for investigation +# as they may be indicative of corruption or data loss. +# There are separate flags for range vs partition reads as single partition reads are only tracked +# when CL > 1 and a digest mismatch occurs. Currently, range queries don't use digests so if +# enabled for range reads, all range reads will include repaired data tracking. As this adds +# some overhead, operators may wish to disable it whilst still enabling it for partition reads +repaired_data_tracking_for_range_reads_enabled: false +repaired_data_tracking_for_partition_reads_enabled: false +# If false, only confirmed mismatches will be reported. If true, a separate metric for unconfirmed +# mismatches will also be recorded. This is to avoid potential signal:noise issues are unconfirmed +# mismatches are less actionable than confirmed ones. +report_unconfirmed_repaired_data_mismatches: false + +# Having many tables and/or keyspaces negatively affects performance of many operations in the +# cluster. When the number of tables/keyspaces in the cluster exceeds the following thresholds +# a client warning will be sent back to the user when creating a table or keyspace. +# As of cassandra 4.1, these properties are deprecated in favor of keyspaces_warn_threshold and tables_warn_threshold +# table_count_warn_threshold: 150 +# keyspace_count_warn_threshold: 40 + +# configure the read and write consistency levels for modifications to auth tables +# auth_read_consistency_level: LOCAL_QUORUM +# auth_write_consistency_level: EACH_QUORUM + +# Delays on auth resolution can lead to a thundering herd problem on reconnects; this option will enable +# warming of auth caches prior to node completing startup. See CASSANDRA-16958 +# auth_cache_warming_enabled: false + +######################### +# EXPERIMENTAL FEATURES # +######################### + +# Enables materialized view creation on this node. +# Materialized views are considered experimental and are not recommended for production use. +materialized_views_enabled: false + +# Enables SASI index creation on this node. +# SASI indexes are considered experimental and are not recommended for production use. +sasi_indexes_enabled: true + +# Enables creation of transiently replicated keyspaces on this node. +# Transient replication is experimental and is not recommended for production use. +transient_replication_enabled: false + +# Enables the used of 'ALTER ... DROP COMPACT STORAGE' statements on this node. +# 'ALTER ... DROP COMPACT STORAGE' is considered experimental and is not recommended for production use. +drop_compact_storage_enabled: false + +# Whether or not USE is allowed. This is enabled by default to avoid failure on upgrade. +#use_statements_enabled: true + +# When the client triggers a protocol exception or unknown issue (Cassandra bug) we increment +# a client metric showing this; this logic will exclude specific subnets from updating these +# metrics +#client_error_reporting_exclusions: +# subnets: +# - 127.0.0.1 +# - 127.0.0.0/31 + +# Enables read thresholds (warn/fail) across all replicas for reporting back to the client. +# See: CASSANDRA-16850 +# read_thresholds_enabled: false # scheduled to be set true in 4.2 +# When read_thresholds_enabled: true, this tracks the materialized size of a query on the +# coordinator. If coordinator_read_size_warn_threshold is defined, this will emit a warning +# to clients with details on what query triggered this as well as the size of the result set; if +# coordinator_read_size_fail_threshold is defined, this will fail the query after it +# has exceeded this threshold, returning a read error to the user. +# coordinator_read_size_warn_threshold: +# coordinator_read_size_fail_threshold: +# When read_thresholds_enabled: true, this tracks the size of the local read (as defined by +# heap size), and will warn/fail based off these thresholds; undefined disables these checks. +# local_read_size_warn_threshold: +# local_read_size_fail_threshold: +# When read_thresholds_enabled: true, this tracks the expected memory size of the RowIndexEntry +# and will warn/fail based off these thresholds; undefined disables these checks +# row_index_read_size_warn_threshold: +# row_index_read_size_fail_threshold: + +# Guardrail to warn or fail when creating more user keyspaces than threshold. +# The two thresholds default to -1 to disable. +# keyspaces_warn_threshold: -1 +# keyspaces_fail_threshold: -1 +# Guardrail to warn or fail when creating more user tables than threshold. +# The two thresholds default to -1 to disable. +# tables_warn_threshold: -1 +# tables_fail_threshold: -1 +# Guardrail to enable or disable the ability to create uncompressed tables +# uncompressed_tables_enabled: true +# Guardrail to warn or fail when creating/altering a table with more columns per table than threshold. +# The two thresholds default to -1 to disable. +# columns_per_table_warn_threshold: -1 +# columns_per_table_fail_threshold: -1 +# Guardrail to warn or fail when creating more secondary indexes per table than threshold. +# The two thresholds default to -1 to disable. +# secondary_indexes_per_table_warn_threshold: -1 +# secondary_indexes_per_table_fail_threshold: -1 +# Guardrail to enable or disable the creation of secondary indexes +# secondary_indexes_enabled: true +# Guardrail to warn or fail when creating more materialized views per table than threshold. +# The two thresholds default to -1 to disable. +# materialized_views_per_table_warn_threshold: -1 +# materialized_views_per_table_fail_threshold: -1 +# Guardrail to warn about, ignore or reject properties when creating tables. By default all properties are allowed. +# table_properties_warned: [] +# table_properties_ignored: [] +# table_properties_disallowed: [] +# Guardrail to allow/disallow user-provided timestamps. Defaults to true. +# user_timestamps_enabled: true +# Guardrail to allow/disallow GROUP BY functionality. +# group_by_enabled: true +# Guardrail to allow/disallow TRUNCATE and DROP TABLE statements +# drop_truncate_table_enabled: true +# Guardrail to warn or fail when using a page size greater than threshold. +# The two thresholds default to -1 to disable. +# page_size_warn_threshold: -1 +# page_size_fail_threshold: -1 +# Guardrail to allow/disallow list operations that require read before write, i.e. setting list element by index and +# removing list elements by either index or value. Defaults to true. +# read_before_write_list_operations_enabled: true +# Guardrail to warn or fail when querying with an IN restriction selecting more partition keys than threshold. +# The two thresholds default to -1 to disable. +# partition_keys_in_select_warn_threshold: -1 +# partition_keys_in_select_fail_threshold: -1 +# Guardrail to warn or fail when an IN query creates a cartesian product with a size exceeding threshold, +# eg. "a in (1,2,...10) and b in (1,2...10)" results in cartesian product of 100. +# The two thresholds default to -1 to disable. +# in_select_cartesian_product_warn_threshold: -1 +# in_select_cartesian_product_fail_threshold: -1 +# Guardrail to warn about or reject read consistency levels. By default, all consistency levels are allowed. +# read_consistency_levels_warned: [] +# read_consistency_levels_disallowed: [] +# Guardrail to warn about or reject write consistency levels. By default, all consistency levels are allowed. +# write_consistency_levels_warned: [] +# write_consistency_levels_disallowed: [] +# Guardrail to warn or fail when encountering larger size of collection data than threshold. +# At query time this guardrail is applied only to the collection fragment that is being writen, even though in the case +# of non-frozen collections there could be unaccounted parts of the collection on the sstables. This is done this way to +# prevent read-before-write. The guardrail is also checked at sstable write time to detect large non-frozen collections, +# although in that case exceeding the fail threshold will only log an error message, without interrupting the operation. +# The two thresholds default to null to disable. +# Min unit: B +# collection_size_warn_threshold: +# Min unit: B +# collection_size_fail_threshold: +# Guardrail to warn or fail when encountering more elements in collection than threshold. +# At query time this guardrail is applied only to the collection fragment that is being writen, even though in the case +# of non-frozen collections there could be unaccounted parts of the collection on the sstables. This is done this way to +# prevent read-before-write. The guardrail is also checked at sstable write time to detect large non-frozen collections, +# although in that case exceeding the fail threshold will only log an error message, without interrupting the operation. +# The two thresholds default to -1 to disable. +# items_per_collection_warn_threshold: -1 +# items_per_collection_fail_threshold: -1 +# Guardrail to allow/disallow querying with ALLOW FILTERING. Defaults to true. +# allow_filtering_enabled: true +# Guardrail to warn or fail when creating a user-defined-type with more fields in than threshold. +# Default -1 to disable. +# fields_per_udt_warn_threshold: -1 +# fields_per_udt_fail_threshold: -1 +# Guardrail to warn or fail when local data disk usage percentage exceeds threshold. Valid values are in [1, 100]. +# This is only used for the disks storing data directories, so it won't count any separate disks used for storing +# the commitlog, hints nor saved caches. The disk usage is the ratio between the amount of space used by the data +# directories and the addition of that same space and the remaining free space on disk. The main purpose of this +# guardrail is rejecting user writes when the disks are over the defined usage percentage, so the writes done by +# background processes such as compaction and streaming don't fail due to a full disk. The limits should be defined +# accordingly to the expected data growth due to those background processes, so for example a compaction strategy +# doubling the size of the data would require to keep the disk usage under 50%. +# The two thresholds default to -1 to disable. +# data_disk_usage_percentage_warn_threshold: -1 +# data_disk_usage_percentage_fail_threshold: -1 +# Allows defining the max disk size of the data directories when calculating thresholds for +# disk_usage_percentage_warn_threshold and disk_usage_percentage_fail_threshold, so if this is greater than zero they +# become percentages of a fixed size on disk instead of percentages of the physically available disk size. This should +# be useful when we have a large disk and we only want to use a part of it for Cassandra's data directories. +# Valid values are in [1, max available disk size of all data directories]. +# Defaults to null to disable and use the physically available disk size of data directories during calculations. +# Min unit: B +# data_disk_usage_max_disk_size: +# Guardrail to warn or fail when the minimum replication factor is lesser than threshold. +# This would also apply to system keyspaces. +# Suggested value for use in production: 2 or higher +# minimum_replication_factor_warn_threshold: -1 +# minimum_replication_factor_fail_threshold: -1 + +# Startup Checks are executed as part of Cassandra startup process, not all of them +# are configurable (so you can disable them) but these which are enumerated bellow. +# Uncomment the startup checks and configure them appropriately to cover your needs. +# +#startup_checks: +# Verifies correct ownership of attached locations on disk at startup. See CASSANDRA-16879 for more details. +# check_filesystem_ownership: +# enabled: false +# ownership_token: "sometoken" # (overriden by "CassandraOwnershipToken" system property) +# ownership_filename: ".cassandra_fs_ownership" # (overriden by "cassandra.fs_ownership_filename") +# Prevents a node from starting if snitch's data center differs from previous data center. +# check_dc: +# enabled: true # (overriden by cassandra.ignore_dc system property) +# Prevents a node from starting if snitch's rack differs from previous rack. +# check_rack: +# enabled: true # (overriden by cassandra.ignore_rack system property) +# Enable this property to fail startup if the node is down for longer than gc_grace_seconds, to potentially +# prevent data resurrection on tables with deletes. By default, this will run against all keyspaces and tables +# except the ones specified on excluded_keyspaces and excluded_tables. +# check_data_resurrection: +# enabled: false +# file where Cassandra periodically writes the last time it was known to run +# heartbeat_file: /var/lib/cassandra/data/cassandra-heartbeat +# excluded_keyspaces: # comma separated list of keyspaces to exclude from the check +# excluded_tables: # comma separated list of keyspace.table pairs to exclude from the check \ No newline at end of file diff --git a/zipkin-server/storage-cassandra/src/test/resources/log4j2.xml b/zipkin-server/storage-cassandra/src/test/resources/log4j2.xml new file mode 100644 index 00000000000..9340cc127e9 --- /dev/null +++ b/zipkin-server/storage-cassandra/src/test/resources/log4j2.xml @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/zipkin-server/zipkin-storage-ext/pom.xml b/zipkin-server/zipkin-storage-ext/pom.xml index 66c0033b42c..2a28a6d637e 100644 --- a/zipkin-server/zipkin-storage-ext/pom.xml +++ b/zipkin-server/zipkin-storage-ext/pom.xml @@ -17,6 +17,7 @@ zipkin-dependency-storage-jdbc zipkin-dependency-storage-elasticsearch zipkin-dependency-storage-banyandb + zipkin-dependency-storage-cassandra diff --git a/zipkin-server/zipkin-storage-ext/zipkin-dependency-storage-cassandra/pom.xml b/zipkin-server/zipkin-storage-ext/zipkin-dependency-storage-cassandra/pom.xml new file mode 100644 index 00000000000..608e090ce3d --- /dev/null +++ b/zipkin-server/zipkin-storage-ext/zipkin-dependency-storage-cassandra/pom.xml @@ -0,0 +1,22 @@ + + + + zipkin-storage-ext + io.zipkin + 2.24.4-SNAPSHOT + + 4.0.0 + + zipkin-dependency-storage-cassandra + Zipkin Dependency Cassandra Extension + + + + io.zipkin + storage-cassandra + ${project.version} + + + \ No newline at end of file diff --git a/zipkin-server/zipkin-storage-ext/zipkin-dependency-storage-cassandra/src/main/java/zipkin/server/dependency/storage/cassandra/ZipkinDependencyCassandraQueryDAO.java b/zipkin-server/zipkin-storage-ext/zipkin-dependency-storage-cassandra/src/main/java/zipkin/server/dependency/storage/cassandra/ZipkinDependencyCassandraQueryDAO.java new file mode 100644 index 00000000000..2bade9c37b6 --- /dev/null +++ b/zipkin-server/zipkin-storage-ext/zipkin-dependency-storage-cassandra/src/main/java/zipkin/server/dependency/storage/cassandra/ZipkinDependencyCassandraQueryDAO.java @@ -0,0 +1,56 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.dependency.storage.cassandra; + +import org.apache.skywalking.zipkin.dependency.entity.ZipkinDependency; +import zipkin.server.dependency.IZipkinDependencyQueryDAO; +import zipkin.server.storage.cassandra.CassandraClient; +import zipkin2.DependencyLink; +import zipkin2.internal.DateUtil; +import zipkin2.internal.DependencyLinker; +import zipkin2.internal.Nullable; + +import java.io.IOException; +import java.time.Instant; +import java.time.LocalDate; +import java.time.ZoneOffset; +import java.util.ArrayList; +import java.util.List; + +public class ZipkinDependencyCassandraQueryDAO implements IZipkinDependencyQueryDAO { + private CassandraClient client; + @Override + public List getDependencies(long endTs, long lookback) throws IOException { + return DependencyLinker.merge(client.executeQuery("SELECT parent,child,call_count,error_count from " + ZipkinDependency.INDEX_NAME + + " where " + ZipkinDependency.DAY + " in ? ", r -> DependencyLink.newBuilder() + .parent(r.getString(ZipkinDependency.PARENT)) + .child(r.getString(ZipkinDependency.CHILD)) + .callCount(r.getLong(ZipkinDependency.CALL_COUNT)) + .errorCount(r.getLong(ZipkinDependency.ERROR_COUNT)).build(), getDays(endTs, lookback))); + } + + public void setClient(CassandraClient client) { + this.client = client; + } + + List getDays(long endTs, @Nullable Long lookback) { + List result = new ArrayList<>(); + for (long epochMillis : DateUtil.epochDays(endTs, lookback)) { + result.add(Instant.ofEpochMilli(epochMillis).atZone(ZoneOffset.UTC).toLocalDate()); + } + return result; + } + +} diff --git a/zipkin-server/zipkin-storage-ext/zipkin-dependency-storage-cassandra/src/main/java/zipkin/server/dependency/storage/cassandra/ZipkinDependencyCassandraStorageProvider.java b/zipkin-server/zipkin-storage-ext/zipkin-dependency-storage-cassandra/src/main/java/zipkin/server/dependency/storage/cassandra/ZipkinDependencyCassandraStorageProvider.java new file mode 100644 index 00000000000..f5d3ab56cad --- /dev/null +++ b/zipkin-server/zipkin-storage-ext/zipkin-dependency-storage-cassandra/src/main/java/zipkin/server/dependency/storage/cassandra/ZipkinDependencyCassandraStorageProvider.java @@ -0,0 +1,90 @@ +/* + * Copyright 2015-2023 The OpenZipkin Authors + * + * 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. + */ + +package zipkin.server.dependency.storage.cassandra; + +import org.apache.skywalking.oap.server.core.CoreModule; +import org.apache.skywalking.oap.server.core.storage.StorageModule; +import org.apache.skywalking.oap.server.library.module.ModuleConfig; +import org.apache.skywalking.oap.server.library.module.ModuleDefine; +import org.apache.skywalking.oap.server.library.module.ModuleProvider; +import org.apache.skywalking.oap.server.library.module.ModuleStartException; +import org.apache.skywalking.oap.server.library.module.ServiceNotProvidedException; +import zipkin.server.dependency.IZipkinDependencyQueryDAO; +import zipkin.server.dependency.ZipkinDependencyModule; +import zipkin.server.storage.cassandra.CassandraClient; +import zipkin.server.storage.cassandra.CassandraConfig; +import zipkin.server.storage.cassandra.CassandraProvider; + +import java.lang.reflect.Field; + +public class ZipkinDependencyCassandraStorageProvider extends ModuleProvider { + private CassandraConfig config; + private ZipkinDependencyCassandraQueryDAO queryDAO; + + @Override + public String name() { + return "cassandra"; + } + + @Override + public Class module() { + return ZipkinDependencyModule.class; + } + + @Override + public ConfigCreator newConfigCreator() { + return new ConfigCreator() { + + @Override + public Class type() { + return CassandraConfig.class; + } + + @Override + public void onInitialized(CassandraConfig initialized) { + config = initialized; + } + }; + } + + @Override + public void prepare() throws ServiceNotProvidedException, ModuleStartException { + this.queryDAO = new ZipkinDependencyCassandraQueryDAO(); + this.registerServiceImplementation(IZipkinDependencyQueryDAO.class, queryDAO); + } + + @Override + public void start() throws ServiceNotProvidedException, ModuleStartException { + } + + @Override + public void notifyAfterCompleted() throws ServiceNotProvidedException, ModuleStartException { + CassandraProvider provider = + (CassandraProvider) getManager().find(StorageModule.NAME).provider(); + try { + Field field = CassandraProvider.class.getDeclaredField("client"); + field.setAccessible(true); + CassandraClient client = (CassandraClient) field.get(provider); + queryDAO.setClient(client); + } catch (NoSuchFieldException | IllegalAccessException e) { + throw new ModuleStartException("Failed to get CassandraStorageClient.", e); + } + } + + @Override + public String[] requiredModules() { + return new String[] {CoreModule.NAME, StorageModule.NAME}; + } +} diff --git a/zipkin-server/zipkin-storage-ext/zipkin-dependency-storage-cassandra/src/main/resources/META-INF/services/org.apache.skywalking.oap.server.library.module.ModuleProvider b/zipkin-server/zipkin-storage-ext/zipkin-dependency-storage-cassandra/src/main/resources/META-INF/services/org.apache.skywalking.oap.server.library.module.ModuleProvider new file mode 100644 index 00000000000..fd4f7427cc9 --- /dev/null +++ b/zipkin-server/zipkin-storage-ext/zipkin-dependency-storage-cassandra/src/main/resources/META-INF/services/org.apache.skywalking.oap.server.library.module.ModuleProvider @@ -0,0 +1,19 @@ +# +# 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. +# +# + +zipkin.server.dependency.storage.cassandra.ZipkinDependencyCassandraStorageProvider \ No newline at end of file