com.comcast.xfinity.sirius.api.SiriusConfiguration.scala Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2012-2014 Comcast Cable Communications Management, LLC
*
* 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 com.comcast.xfinity.sirius.api
import scala.util.Try
object SiriusConfiguration {
/**
* Host to bind akka to (string)
*
* Takes precedence over all other akka configuration for host
*/
final val HOST = "sirius.akka.host"
/**
* Port to bind akka to (int)
*
* Takes precedence over all other akka configuration for port
*/
final val PORT = "sirius.akka.port"
/**
* Flag (boolean) to enable or disable SSL encryption support for akka
* If enabled all akka communications will be done over SSL providing
* the key store and trust store are configured correctly
*/
final val ENABLE_SSL = "sirius.akka.ssl"
/**
* Implementation of random number generator to use with SSL security. Defaults to
* the no-arg constructor of [[http://docs.oracle.com/javase/1.5.0/docs/api/java/security/SecureRandom.html java.security.SecureRandom]].
*
* Possible values include AES128CounterSecureRNG, AES256CounterSecureRNG, AES128CounterInetRNG,
* AES256CounterInetRNG, SHA1PRNG. See lines 457-470 of the [[http://doc.akka.io/docs/akka/2.2.1/general/configuration.html#akka-remote akka-remote reference configuration]] for more details;
* this option is simply passed through to Akka by Sirius.
*/
final val SSL_RANDOM_NUMBER_GENERATOR = "sirius.akka.ssl.rng"
/**
* Support for akka over SSL
* This is the configurable Java key store location and is used by the server connection
*/
final val KEY_STORE_LOCATION = "sirius.akka.ssl.key-store.location"
/**
* Support for akka over SSL
* This is the configurable Java key store password used for decrypting the key store
*/
final val KEY_STORE_PASSWORD = "sirius.akka.ssl.key-store.password"
/**
* Support for akka over SSL
* This is configurable Java key password used for decrypting the key
*/
final val KEY_PASSWORD = "sirius.akka.ssl.key.password"
/**
* Support for akka over SSL
* This is the configurable Java trust store location and is used by the client connection
*/
final val TRUST_STORE_LOCATION = "sirius.akka.ssl.trust-store.location"
/**
* Support for akka over SSL
* Configurable Java trust store password used to decrypt the trust store
*/
final val TRUST_STORE_PASSWORD = "sirius.akka.ssl.trust-store.password"
/**
* AkkaExternalAddressResolver
*/
final val AKKA_EXTERNAL_ADDRESS_RESOLVER = "sirius.akka.external-address-resolver"
/**
* External akka ActorSystem configuration. It this location exists
* on the file system it is loaded, else it is loaded from the
* classpath. (string)
*
* @see http://doc.akka.io/docs/akka/2.0.2/general/configuration.html
* for more information
*/
final val AKKA_EXTERN_CONFIG = "sirius.akka.system-config-overrides"
/**
* The name of the ActorSystem. Defaults to sirius-system. (string)
*
* End users will probably never override this, but it is convenient
* for when running multiple nodes on the same host sharing the same
* log, ie when testing :).
*/
final val AKKA_SYSTEM_NAME = "sirius.akka.actor-system.name"
/**
* Location of cluster membership configuration file (string)
*/
final val CLUSTER_CONFIG = "sirius.membership.config-path"
/**
* How often to check CLUSTER_CONFIG for updates, in seconds (int).
* Also is used to control how often Supervisor checks for updates to membership.
*/
final val MEMBERSHIP_CHECK_INTERVAL = "sirius.membership.check-interval-secs"
/**
* How often to ping the other members of the cluster, recording round-trip.
* Useful for determining cluster liveness.
*/
final val MEMBERSHIP_PING_INTERVAL = "sirius.membership.ping-interval-secs"
/**
* The allowed number of ping failures before a member of the cluster is
* considered dead. This is an estimate as opposed to a real number. The
* threshold for checking member health is actually based on time:
* threshold = allowedPingFailures * pingInterval + pingInterval / 2
*/
final val ALLOWED_PING_FAILURES = "sirius.membership.allowed-ping-failure"
/**
* How often to check the membershipAgent for updates, in seconds (int).
* Used by the supervisor when determining whether to keep paxos on or off.
*/
final val PAXOS_MEMBERSHIP_CHECK_INTERVAL = "sirius.supervisor.paxos-check-interval-secs"
/**
* How often the LeaderWatcher spawns a LeaderPinger to check on the currently elected leader.
*/
final val PAXOS_LEADERSHIP_PING_INTERVAL = "sirius.paxos.leadership-ping-interval"
/**
* How long to wait for a Pong response from the elected leader before declaring it "gone"
*/
final val PAXOS_LEADERSHIP_PING_TIMEOUT = "sirius.paxos.leadership-ping-timeout"
/**
* Directory to put UberStore in (string)
*/
final val LOG_LOCATION = "sirius.uberstore.dir"
/**
* Maximum events per Segment in a SegmentedUberStore. Determines how many events will be
* written before splitting off a new Segment on disk.
*/
final val LOG_EVENTS_PER_SEGMENT = "sirius.uberstore.max-events-per-segment"
/**
* Which SiriusLog implementation to use. See versionId method on classes that implement
* the SiriusLog trait for possible values. Empty defaults to legacy UberStore.
*/
final val LOG_VERSION_ID = "sirius.uberstore.impl-version-id"
/**
* True to use PersistedSeqIndex (write-through java.util.TreeMap fronted
* uberstore index file implementation), false to use DiskOnlySeqIndex
* (raw disk operation uberstore index file implementation). DiskOnlySeqIndex
* drastically reduces memory overhead (even in the order of gigabytes less
* consumption) at the expense of potentially less performant lookup
* operations (boolean)
*/
@deprecated("Not honored as of sirius-1.0.4, uses raw disk operations only", "2013-05-15")
final val LOG_USE_MEMORY_INDEX = "sirius.uberstore.use-in-memory-index"
/**
* Whether or not to use the write cache, which will cache the last
* LOG_WRITE_CACHE_SIZE entries written to the log since startup.
* May alleviate disk pressure and improve catch up speed, but at
* the expense of higher memory overhead and (likely) incompatibility
* with eventual live compaction (boolean)
*/
final val LOG_USE_WRITE_CACHE = "sirius.log.write-cache-enabled"
/**
* By default Sirius places a write through cache in front of the
* log, this property dictates its maximum size (int)
*/
final val LOG_WRITE_CACHE_SIZE = "sirius.log.write-cache-size"
/**
* Whether or not to use a buffered reader when reading through the log
*/
final val LOG_USE_READ_BUFFER = "sirius.log.read-buffer-enabled"
/**
* Indicates the size of the buffer in bytes when reading events from the log.
* The default buffer size is 8192 bytes. (int)
*/
final val LOG_READ_BUFFER_SIZE_BYTES = "sirius.log.read-buffer-size-bytes"
/**
* Minutes between triggering compaction. First trigger will happen this many minutes
* after boot. A value of 0 turns off compaction, and compaction is off by default.
*/
final val COMPACTION_SCHEDULE_MINS = "sirius.log.compaction-schedule-mins"
/**
* The maximum age for a Delete in hours that remains after compaction. Deletes
* that are older than this age will be purged during compaction. The default
* is that Deletes will not be purged during compaction.
*/
final val COMPACTION_MAX_DELETE_AGE_HOURS = "sirius.log.compaction-max-delete-age-hours"
/**
* Name of the sirius supervisor, typically we will not change this,
* but it's here just in case (string)
*/
final val SIRIUS_SUPERVISOR_NAME = "sirius.supervisor.name"
/**
* Number of milliseconds for a proposal to live with the possibility
* of being reproposed. This window is not 100% exact at this point-
* it's precision is REPROPOSAL_CLEANUP_FREQ (long)
*/
final val REPROPOSAL_WINDOW = "sirius.paxos.replica.reproposal-window-millis"
/**
* How often, in seconds, to reap old proposals (int)
*/
final val REPROPOSAL_CLEANUP_FREQ = "sirius.paxos.replica.reproposal-freq-secs"
/**
* Number of milliseconds for Acceptors to retain PValues. When cleaning up in
* the Acceptors we remove PValues from the acceptor in slot number order until
* we encounter one which is within the retention window. At this point we stop
* cleaning up. Note that it is possible that PValues outside of the this window
* may be retained if there is a PValue with a timestamp that is within the window
* before it. (long)
*
* Similar to REPROPOSAL_WINDOW, precision is ACCEPTOR_CLEANUP_FREQ
*/
final val ACCEPTOR_WINDOW = "sirius.paxos.acceptor.acceptor-window-millis"
/**
* How often, in seconds, to clean up the Acceptor (int)
*/
final val ACCEPTOR_CLEANUP_FREQ = "sirius.paxos.acceptor.acceptor-cleanup-freq-secs"
/**
* An MBeanServer, that if configured, will be used to expose metrics around Sirius
* (MBeanServer)
*/
final val MBEAN_SERVER = "sirius.monitoring.mbean-server"
/**
* Number of events to request from a remote node in a single chunk
*/
final val LOG_REQUEST_CHUNK_SIZE = "sirius.log-request.chunk-size"
/**
* How long (in seconds) to wait for a log chunk reply before considering it timed out
*/
final val LOG_REQUEST_RECEIVE_TIMEOUT_SECS = "sirius.log-request.receive-timeout-secs"
/**
* How long (in seconds) to wait between checking for gaps
*/
final val LOG_REQUEST_FREQ_SECS = "sirius.log-request.freq-secs"
/**
* How long (in seconds) to periodically check leader state
*/
final val CHECK_LEADER_STATE_FREQ_SECS = "sirius.check-leader-state.freq-secs"
/**
* How long (in milliseconds) for requests in SiriusImpl to wait for a response from
* the underlying actor (int)
*/
final val CLIENT_TIMEOUT_MS = "sirius.client.ask-timeout-ms"
/**
* Amount to increase catchup request timeout per event in window size, in seconds. Default 0.01. Type is Double.
*
* timeout = timeout_base + ( w * timeout_per_event )
*/
final val CATCHUP_TIMEOUT_INCREASE_PER_EVENT = "sirius.catchup.timeout-coefficient"
/**
* Base value of catchup request timeout in seconds. Default is 1.0. Type is double.
*
* timeout = timeout_base + ( w * timeout_per_event )
*/
final val CATCHUP_TIMEOUT_BASE = "sirius.catchup.timeout-constant"
/**
* Maximum catchup window size, in number of events. Default is 1000.
*/
final val CATCHUP_MAX_WINDOW_SIZE = "sirius.catchup.max-window-size"
/**
* Starting ssthresh, which is the point where catchup transitions from Slow Start to
* Congestion Avoidance. Default is 500.
*/
final val CATCHUP_DEFAULT_SSTHRESH = "sirius.catchup.default-ssthresh"
/*
* Maximum akka message size in KB. Default is 1024. Type is Integer.
*/
final val MAX_AKKA_MESSAGE_SIZE_KB = "sirius.akka.maximum-frame-size-kb"
}
/**
* Configuration object for Sirius. Encapsulates arbitrary String key/Any value data.
*
* @see SiriusConfiguration$ constants for information of fields.
*/
class SiriusConfiguration {
private var conf = Map[String, Any]()
/**
* Return the underlying Map[String, Any] configuring this instance
*
* Not Java API friendly, if we so find the need, we can add a conversion
*
* @return Map[String, Any] of all configuration
*/
def getConfigMap: Map[String, Any] = conf
/**
* Set an arbitrary property on this configuration
*
* @param name name of the property
* @param value value to associate with name
*/
def setProp(name: String, value: Any) {
conf += (name -> value)
}
/**
* Get a property from this configuration
*
* @param name property name to get
*
* @return Some(value) if it exists, or None if not
*/
def getProp[T](name: String): Option[T] = conf.get(name).map {
case value => value.asInstanceOf[T]
}
/**
* Get a property with a default fallback
*
* @param name property name to get
* @param default the value to return if the property doesn't exist
*
* @return the value stored under name, or the default if it's not found
*/
def getProp[T](name: String, default: => T): T = getProp[T](name).getOrElse(default)
def getDouble(name: String): Option[Double] = conf.get(name).map {
case value => Try(value.asInstanceOf[Double]).getOrElse(String.valueOf(value).toDouble)
}
def getDouble(name: String, default: => Double): Double = getDouble(name).getOrElse(default)
def getInt(name: String): Option[Int] = conf.get(name).map {
case value => Try(value.asInstanceOf[Int]).getOrElse(String.valueOf(value).toInt)
}
def getInt(name: String, default: => Int): Int = getInt(name).getOrElse(default)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy