| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| package org.apache.brooklyn.entity.nosql.cassandra; |
| |
| import java.math.BigInteger; |
| import java.util.Set; |
| |
| import com.google.common.reflect.TypeToken; |
| |
| import org.apache.brooklyn.api.catalog.Catalog; |
| import org.apache.brooklyn.api.effector.Effector; |
| import org.apache.brooklyn.api.entity.Entity; |
| import org.apache.brooklyn.api.entity.ImplementedBy; |
| import org.apache.brooklyn.api.sensor.AttributeSensor; |
| import org.apache.brooklyn.config.ConfigKey; |
| import org.apache.brooklyn.core.config.ConfigKeys; |
| import org.apache.brooklyn.core.entity.BrooklynConfigKeys; |
| import org.apache.brooklyn.core.location.PortRanges; |
| import org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey; |
| import org.apache.brooklyn.core.sensor.BasicAttributeSensorAndConfigKey; |
| import org.apache.brooklyn.core.sensor.PortAttributeSensorAndConfigKey; |
| import org.apache.brooklyn.core.sensor.Sensors; |
| import org.apache.brooklyn.entity.database.DatastoreMixins; |
| import org.apache.brooklyn.entity.java.UsesJavaMXBeans; |
| import org.apache.brooklyn.entity.java.UsesJmx; |
| import org.apache.brooklyn.entity.software.base.SoftwareProcess; |
| import org.apache.brooklyn.util.core.flags.SetFromFlag; |
| import org.apache.brooklyn.util.time.Duration; |
| |
| /** |
| * An {@link org.apache.brooklyn.api.entity.Entity} that represents a Cassandra node in a {@link CassandraDatacenter}. |
| */ |
| @Catalog(name="Apache Cassandra Node", description="Cassandra is a highly scalable, eventually " + |
| "consistent, distributed, structured key-value store which provides a ColumnFamily-based data model " + |
| "richer than typical key/value systems", iconUrl="classpath:///cassandra-logo.jpeg") |
| @ImplementedBy(CassandraNodeImpl.class) |
| public interface CassandraNode extends DatastoreMixins.DatastoreCommon, SoftwareProcess, UsesJmx, UsesJavaMXBeans, DatastoreMixins.HasDatastoreUrl, DatastoreMixins.CanExecuteScript { |
| |
| @SetFromFlag("version") |
| ConfigKey<String> SUGGESTED_VERSION = ConfigKeys.newConfigKeyWithDefault(SoftwareProcess.SUGGESTED_VERSION, "1.2.16"); |
| // when this changes remember to put a copy under releng2:/var/www/developer/brooklyn/repository/ ! |
| // TODO experiment with supporting 2.0.x |
| |
| @SetFromFlag("archiveNameFormat") |
| ConfigKey<String> ARCHIVE_DIRECTORY_NAME_FORMAT = ConfigKeys.newConfigKeyWithDefault(SoftwareProcess.ARCHIVE_DIRECTORY_NAME_FORMAT, "apache-cassandra-%s"); |
| |
| @SetFromFlag("downloadUrl") |
| AttributeSensorAndConfigKey<String, String> DOWNLOAD_URL = ConfigKeys.newSensorAndConfigKeyWithDefault(SoftwareProcess.DOWNLOAD_URL, |
| "${driver.mirrorUrl}/${version}/apache-cassandra-${version}-bin.tar.gz"); |
| |
| /** download mirror, if desired */ |
| @SetFromFlag("mirrorUrl") |
| ConfigKey<String> MIRROR_URL = ConfigKeys.newStringConfigKey("cassandra.install.mirror.url", "URL of mirror", |
| "http://www.mirrorservice.org/sites/ftp.apache.org/cassandra" |
| // for older versions, but slower: |
| // "http://archive.apache.org/dist/cassandra/" |
| ); |
| |
| @SetFromFlag("tgzUrl") |
| ConfigKey<String> TGZ_URL = ConfigKeys.newStringConfigKey("cassandra.install.tgzUrl", "URL of TGZ download file"); |
| |
| @SetFromFlag("clusterName") |
| BasicAttributeSensorAndConfigKey<String> CLUSTER_NAME = CassandraDatacenter.CLUSTER_NAME; |
| |
| @SetFromFlag("snitchName") |
| ConfigKey<String> ENDPOINT_SNITCH_NAME = CassandraDatacenter.ENDPOINT_SNITCH_NAME; |
| |
| @SetFromFlag("gossipPort") |
| PortAttributeSensorAndConfigKey GOSSIP_PORT = ConfigKeys.newPortSensorAndConfigKey("cassandra.gossip.port", "Cassandra Gossip communications port", PortRanges.fromString("7000+")); |
| |
| @SetFromFlag("sslGgossipPort") |
| PortAttributeSensorAndConfigKey SSL_GOSSIP_PORT = ConfigKeys.newPortSensorAndConfigKey("cassandra.ssl-gossip.port", "Cassandra Gossip SSL communications port", PortRanges.fromString("7001+")); |
| |
| @SetFromFlag("thriftPort") |
| PortAttributeSensorAndConfigKey THRIFT_PORT = ConfigKeys.newPortSensorAndConfigKey("cassandra.thrift.port", "Cassandra Thrift RPC port", PortRanges.fromString("9160+")); |
| |
| @SetFromFlag("nativePort") |
| PortAttributeSensorAndConfigKey NATIVE_TRANSPORT_PORT = ConfigKeys.newPortSensorAndConfigKey("cassandra.native.port", "Cassandra Native Transport port", PortRanges.fromString("9042+")); |
| |
| @SetFromFlag("rmiRegistryPort") |
| // cassandra nodetool and others want 7199 - not required, but useful |
| PortAttributeSensorAndConfigKey RMI_REGISTRY_PORT = ConfigKeys.newPortSensorAndConfigKeyWithDefault(UsesJmx.RMI_REGISTRY_PORT, |
| PortRanges.fromInteger(7199)); |
| |
| // some of the cassandra tooing (eg nodetool) use RMI, but we want JMXMP, so do both! |
| ConfigKey<JmxAgentModes> JMX_AGENT_MODE = ConfigKeys.newConfigKeyWithDefault(UsesJmx.JMX_AGENT_MODE, JmxAgentModes.JMXMP_AND_RMI); |
| |
| // TODO the multicloud-snitch has to be built manually, it is available in the brooklyn sandbox |
| @SetFromFlag("customSnitchJarUrl") |
| ConfigKey<String> CUSTOM_SNITCH_JAR_URL = ConfigKeys.newStringConfigKey("cassandra.config.customSnitchUrl", |
| "URL for a jar file to be uploaded (e.g. \"classpath://org/apache/brooklyn/entity/nosql/cassandra/cassandra-multicloud-snitch.jar\"); defaults to null which means nothing to upload", |
| null); |
| |
| @SetFromFlag("cassandraConfigTemplateUrl") |
| ConfigKey<String> CASSANDRA_CONFIG_TEMPLATE_URL = ConfigKeys.newStringConfigKey( |
| "cassandra.config.templateUrl", "A URL (in freemarker format) for a cassandra.yaml config file (in freemarker format)", |
| "classpath://org/apache/brooklyn/entity/nosql/cassandra/cassandra-${entity.majorMinorVersion}.yaml"); |
| |
| @SetFromFlag("cassandraConfigFileName") |
| ConfigKey<String> CASSANDRA_CONFIG_FILE_NAME = ConfigKeys.newStringConfigKey( |
| "cassandra.config.fileName", "Name for the copied config file", "cassandra.yaml"); |
| |
| @SetFromFlag("cassandraRackdcConfigTemplateUrl") |
| ConfigKey<String> CASSANDRA_RACKDC_CONFIG_TEMPLATE_URL = ConfigKeys.newStringConfigKey( |
| "cassandra.config.rackdc.templateUrl", "Template file (in freemarker format) for the cassandra-rackdc.properties config file", |
| "classpath://org/apache/brooklyn/entity/nosql/cassandra/cassandra-rackdc.properties"); |
| |
| @SetFromFlag("cassandraRackdcConfigFileName") |
| ConfigKey<String> CASSANDRA_RACKDC_CONFIG_FILE_NAME = ConfigKeys.newStringConfigKey( |
| "cassandra.config.rackdc.fileName", "Name for the copied rackdc config file (used for configuring replication, when a suitable snitch is used)", "cassandra-rackdc.properties"); |
| |
| @SetFromFlag("datacenterName") |
| AttributeSensorAndConfigKey<String, String> DATACENTER_NAME = ConfigKeys.newStringSensorAndConfigKey( |
| "cassandra.replication.datacenterName", "Datacenter name (used for configuring replication, when a suitable snitch is used)"); |
| |
| @SetFromFlag("rackName") |
| AttributeSensorAndConfigKey<String, String> RACK_NAME = ConfigKeys.newStringSensorAndConfigKey( |
| "cassandra.replication.rackName", "Rack name (used for configuring replication, when a suitable snitch is used)"); |
| |
| ConfigKey<Integer> NUM_TOKENS_PER_NODE = ConfigKeys.newIntegerConfigKey("cassandra.numTokensPerNode", |
| "Number of tokens per node; if using vnodes, should set this to a value like 256", |
| 1); |
| |
| @SetFromFlag("tokens") |
| @SuppressWarnings("serial") |
| AttributeSensorAndConfigKey<Set<BigInteger>, Set<BigInteger>> TOKENS = ConfigKeys.newSensorAndConfigKey( |
| new TypeToken<Set<BigInteger>>() {}, "cassandra.tokens", "Cassandra Tokens"); |
| |
| @SetFromFlag("useThriftMonitoring") |
| ConfigKey<Boolean> USE_THRIFT_MONITORING = ConfigKeys.newConfigKey("thriftMonitoring.enabled", "Thrift-port monitoring enabled", Boolean.TRUE); |
| |
| AttributeSensor<Integer> PEERS = Sensors.newIntegerSensor("cassandra.peers", "Number of peers in cluster"); |
| |
| AttributeSensor<Integer> LIVE_NODE_COUNT = Sensors.newIntegerSensor("cassandra.liveNodeCount", "Number of live nodes in cluster"); |
| |
| /* Metrics for read/write performance. */ |
| |
| AttributeSensor<Long> READ_PENDING = Sensors.newLongSensor("cassandra.read.pending", "Current pending ReadStage tasks"); |
| AttributeSensor<Integer> READ_ACTIVE = Sensors.newIntegerSensor("cassandra.read.active", "Current active ReadStage tasks"); |
| AttributeSensor<Long> READ_COMPLETED = Sensors.newLongSensor("cassandra.read.completed", "Total completed ReadStage tasks"); |
| AttributeSensor<Long> WRITE_PENDING = Sensors.newLongSensor("cassandra.write.pending", "Current pending MutationStage tasks"); |
| AttributeSensor<Integer> WRITE_ACTIVE = Sensors.newIntegerSensor("cassandra.write.active", "Current active MutationStage tasks"); |
| AttributeSensor<Long> WRITE_COMPLETED = Sensors.newLongSensor("cassandra.write.completed", "Total completed MutationStage tasks"); |
| |
| AttributeSensor<Boolean> SERVICE_UP_JMX = Sensors.newBooleanSensor("cassandra.service.jmx.up", "Whether JMX is up for this service"); |
| AttributeSensor<Long> THRIFT_PORT_LATENCY = Sensors.newLongSensor("cassandra.thrift.latency", "Latency for thrift port connection (ms) or null if down"); |
| |
| AttributeSensor<Double> READS_PER_SECOND_LAST = Sensors.newDoubleSensor("cassandra.reads.perSec.last", "Reads/sec (last datapoint)"); |
| AttributeSensor<Double> WRITES_PER_SECOND_LAST = Sensors.newDoubleSensor("cassandra.write.perSec.last", "Writes/sec (last datapoint)"); |
| |
| AttributeSensor<Double> THRIFT_PORT_LATENCY_IN_WINDOW = Sensors.newDoubleSensor("cassandra.thrift.latency.windowed", "Latency for thrift port (ms, averaged over time window)"); |
| AttributeSensor<Double> READS_PER_SECOND_IN_WINDOW = Sensors.newDoubleSensor("cassandra.reads.perSec.windowed", "Reads/sec (over time window)"); |
| AttributeSensor<Double> WRITES_PER_SECOND_IN_WINDOW = Sensors.newDoubleSensor("cassandra.writes.perSec.windowed", "Writes/sec (over time window)"); |
| |
| @SuppressWarnings({ "rawtypes", "unchecked" }) |
| ConfigKey<Set<Entity>> INITIAL_SEEDS = (ConfigKey)ConfigKeys.newConfigKey(Set.class, "cassandra.cluster.seeds.initial", |
| "List of cluster nodes to seed this node"); |
| |
| ConfigKey<Duration> START_TIMEOUT = ConfigKeys.newConfigKeyWithDefault(BrooklynConfigKeys.START_TIMEOUT, Duration.FIVE_MINUTES); |
| |
| ConfigKey<String> LISTEN_ADDRESS_SENSOR = ConfigKeys.newStringConfigKey("cassandra.listenAddressSensor", "sensor name from which to take the listen address; default (null) is a smart lookup"); |
| ConfigKey<String> BROADCAST_ADDRESS_SENSOR = ConfigKeys.newStringConfigKey("cassandra.broadcastAddressSensor", "sensor name from which to take the broadcast address; default (null) is a smart lookup"); |
| ConfigKey<String> RPC_ADDRESS_SENSOR = ConfigKeys.newStringConfigKey("cassandra.rpcAddressSensor", "sensor name from which to take the RPC address; default (null) is 0.0.0.0"); |
| |
| Effector<String> EXECUTE_SCRIPT = CassandraDatacenter.EXECUTE_SCRIPT; |
| |
| /* Accessors used from template */ |
| |
| String getMajorMinorVersion(); |
| Integer getGossipPort(); |
| Integer getSslGossipPort(); |
| Integer getThriftPort(); |
| Integer getNativeTransportPort(); |
| String getClusterName(); |
| String getListenAddress(); |
| String getBroadcastAddress(); |
| String getRpcAddress(); |
| String getSeeds(); |
| |
| String getPrivateIp(); |
| String getPublicIp(); |
| |
| int getNumTokensPerNode(); |
| |
| /** |
| * Returns the set of tokens. |
| * Each is in the range 0 to (2^127)-1. |
| * Returns null if there are no tokens. |
| */ |
| Set<BigInteger> getTokens(); |
| |
| /** string value of comma-separated tokens; or blank if none */ |
| String getTokensAsString(); |
| |
| /* For configuration */ |
| |
| void setToken(String token); |
| |
| /* Using Cassandra */ |
| |
| String executeScript(String commands); |
| |
| } |