Config

java.lang.Object
- net.opentsdb.utils.Config

```
public class Config
extends Object
```
OpenTSDB Configuration Class This handles all of the user configurable variables for a TSD. On initialization default values are configured for all variables. Then implementations should call the loadConfig() methods to search for a default configuration or try to load one provided by the user. To add a configuration, simply set a default value in setDefaults(). Wherever you need to access the config value, use the proper helper to fetch the value, accounting for exceptions that may be thrown if necessary. The get number helpers will return NumberFormatExceptions if the requested property is null or unparseable. The getString(String) helper will return a NullPointerException if the property isn't found.
Plugins can extend this class and copy the properties from the main TSDB.config instance. Plugins should never change the main TSD's config properties, rather a plugin should use the Config(final Config parent) constructor to get a copy of the parent's properties and then work with the values locally.

Since:

2.0

Field Summary

Fields
Modifier and Type	Field and Description
`protected static HashMap<String,String>`	`default_map` Holds default values for the config
`static boolean`	`IS_WINDOWS` Flag to determine if we're running under Windows or not
`protected HashMap<String,String>`	`properties` The list of properties configured to their defaults or modified by users

Constructor Summary

Constructors
Constructor and Description
`Config(boolean auto_load_config)` Constructor that initializes default configuration values.
`Config(Config parent)` Constructor for plugins or overloaders who want a copy of the parent properties but without the ability to modify them This constructor will not re-read the file, but it will copy the location so if a child wants to reload the properties periodically, they may do so
`Config(String file)` Constructor that initializes default values and attempts to load the given properties file

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`auto_metric()`
`String`	`dumpConfiguration()` Returns a simple string with the configured properties for debugging
`boolean`	`enable_chunked_requests()`
`boolean`	`enable_compactions()`
`boolean`	`enable_realtime_ts()`
`boolean`	`enable_realtime_uid()`
`boolean`	`enable_tree_processing()`
`boolean`	`enable_tsuid_incrementing()`
`boolean`	`enable_tsuid_tracking()`
`boolean`	`getBoolean(String property)` Returns the given property as a boolean Property values are case insensitive and the following values will result in a True return value: - 1 - True - Yes Any other values, including an empty string, will result in a False
`String`	`getDirectoryName(String property)` Returns the directory name, making sure the end is an OS dependent slash
`double`	`getDouble(String property)` Returns the given property as a double
`float`	`getFloat(String property)` Returns the given property as a float
`int`	`getInt(String property)` Returns the given property as an integer
`long`	`getLong(String property)` Returns the given property as a long
`Map<String,String>`	`getMap()`
`short`	`getShort(String property)` Returns the given property as a short
`String`	`getString(String property)` Returns the given property as a String
`boolean`	`hasProperty(String property)` Determines if the given propery is in the map
`protected void`	`loadConfig()` Searches a list of locations for a valid opentsdb.conf file The config file must be a standard JAVA properties formatted file.
`protected void`	`loadConfig(String file)` Attempts to load the configuration from the given location
`int`	`max_chunked_requests()`
`void`	`overrideConfig(String property, String value)` Allows for modifying properties after loading WARNING: This should only be used on initialization and is meant for command line overrides
`void`	`setAutoMetric(boolean auto_metric)`
`protected void`	`setDefaults()` Loads default entries that were not provided by a file or command line This should be called in the constructor

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - IS_WINDOWS
```
public static final boolean IS_WINDOWS
```
    Flag to determine if we're running under Windows or not
  - properties
```
protected final HashMap<String,String> properties
```
    The list of properties configured to their defaults or modified by users
  - default_map
```
protected static final HashMap<String,String> default_map
```
    Holds default values for the config
- Constructor Detail
  - Config
```
public Config(boolean auto_load_config)
       throws IOException
```
    Constructor that initializes default configuration values. May attempt to search for a config file if configured.
    
    Parameters:
    auto_load_config - When set to true, attempts to search for a config file in the default locations
    
    Throws:
    
    IOException - Thrown if unable to read or parse one of the default config files
  - Config
```
public Config(String file)
       throws IOException
```
    Constructor that initializes default values and attempts to load the given properties file
    
    Parameters:
    file - Path to the file to load
    
    Throws:
    
    IOException - Thrown if unable to read or parse the file
  - Config
```
public Config(Config parent)
```
    Constructor for plugins or overloaders who want a copy of the parent properties but without the ability to modify them This constructor will not re-read the file, but it will copy the location so if a child wants to reload the properties periodically, they may do so
    
    Parameters:
    parent - Parent configuration object to load from
- Method Detail
  - auto_metric
```
public boolean auto_metric()
```
    Returns:
    the auto_metric value
  - setAutoMetric
```
public void setAutoMetric(boolean auto_metric)
```
    Parameters:
    auto_metric - whether or not to auto create metrics
  - enable_compactions
```
public boolean enable_compactions()
```
    Returns:
    the enable_compaction value
  - enable_realtime_ts
```
public boolean enable_realtime_ts()
```
    Returns:
    whether or not to record new TSMeta objects in real time
  - enable_realtime_uid
```
public boolean enable_realtime_uid()
```
    Returns:
    whether or not record new UIDMeta objects in real time
  - enable_tsuid_incrementing
```
public boolean enable_tsuid_incrementing()
```
    Returns:
    whether or not to increment TSUID counters
  - enable_tsuid_tracking
```
public boolean enable_tsuid_tracking()
```
    Returns:
    whether or not to record a 1 for every TSUID
  - enable_chunked_requests
```
public boolean enable_chunked_requests()
```
    Returns:
    whether or not chunked requests are supported
  - max_chunked_requests
```
public int max_chunked_requests()
```
    Returns:
    max incoming chunk size in bytes
  - enable_tree_processing
```
public boolean enable_tree_processing()
```
    Returns:
    whether or not to process new or updated TSMetas through trees
  - overrideConfig
```
public void overrideConfig(String property,
                  String value)
```
    Allows for modifying properties after loading WARNING: This should only be used on initialization and is meant for command line overrides
    
    Parameters:
    property - The name of the property to override
    value - The value to store
  - getString
```
public final String getString(String property)
```
    Returns the given property as a String
    
    Parameters:
    property - The property to load
    
    Returns:
    The property value as a string
    
    Throws:
    
    NullPointerException - if the property did not exist
  - getInt
```
public final int getInt(String property)
```
    Returns the given property as an integer
    
    Parameters:
    property - The property to load
    
    Returns:
    A parsed integer or an exception if the value could not be parsed
    
    Throws:
    
    NumberFormatException - if the property could not be parsed
    
    NullPointerException - if the property did not exist
  - getShort
```
public final short getShort(String property)
```
    Returns the given property as a short
    
    Parameters:
    property - The property to load
    
    Returns:
    A parsed short or an exception if the value could not be parsed
    
    Throws:
    
    NumberFormatException - if the property could not be parsed
    
    NullPointerException - if the property did not exist
  - getLong
```
public final long getLong(String property)
```
    Returns the given property as a long
    
    Parameters:
    property - The property to load
    
    Returns:
    A parsed long or an exception if the value could not be parsed
    
    Throws:
    
    NumberFormatException - if the property could not be parsed
    
    NullPointerException - if the property did not exist
  - getFloat
```
public final float getFloat(String property)
```
    Returns the given property as a float
    
    Parameters:
    property - The property to load
    
    Returns:
    A parsed float or an exception if the value could not be parsed
    
    Throws:
    
    NumberFormatException - if the property could not be parsed
    
    NullPointerException - if the property did not exist
  - getDouble
```
public final double getDouble(String property)
```
    Returns the given property as a double
    
    Parameters:
    property - The property to load
    
    Returns:
    A parsed double or an exception if the value could not be parsed
    
    Throws:
    
    NumberFormatException - if the property could not be parsed
    
    NullPointerException - if the property did not exist
  - getBoolean
```
public final boolean getBoolean(String property)
```
    Returns the given property as a boolean Property values are case insensitive and the following values will result in a True return value: - 1 - True - Yes Any other values, including an empty string, will result in a False
    
    Parameters:
    property - The property to load
    
    Returns:
    A parsed boolean
    
    Throws:
    
    NullPointerException - if the property was not found
  - getDirectoryName
```
public final String getDirectoryName(String property)
```
    Returns the directory name, making sure the end is an OS dependent slash
    
    Parameters:
    property - The property to load
    
    Returns:
    The property value with a forward or back slash appended
    
    Throws:
    
    NullPointerException - if the property was not found
  - hasProperty
```
public final boolean hasProperty(String property)
```
    Determines if the given propery is in the map
    
    Parameters:
    property - The property to search for
    
    Returns:
    True if the property exists and has a value, not an empty string
  - dumpConfiguration
```
public final String dumpConfiguration()
```
    Returns a simple string with the configured properties for debugging
    
    Returns:
    A string with information about the config
  - getMap
```
public final Map<String,String> getMap()
```
    Returns:
    An immutable copy of the configuration map
  - setDefaults
```
protected void setDefaults()
```
    Loads default entries that were not provided by a file or command line This should be called in the constructor
  - loadConfig
```
protected void loadConfig()
                   throws IOException
```
    Searches a list of locations for a valid opentsdb.conf file The config file must be a standard JAVA properties formatted file. If none of the locations have a config file, then the defaults or command line arguments will be used for the configuration Defaults for Linux based systems are: ./opentsdb.conf /etc/opentsdb.conf /etc/opentsdb/opentdsb.conf /opt/opentsdb/opentsdb.conf
    
    Throws:
    
    IOException - Thrown if there was an issue reading a file
  - loadConfig
```
protected void loadConfig(String file)
                   throws FileNotFoundException,
                          IOException
```
    Attempts to load the configuration from the given location
    
    Parameters:
    file - Path to the file to load
    
    Throws:
    
    IOException - Thrown if there was an issue reading the file
    
    FileNotFoundException - Thrown if the config file was not found

Class Config

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IS_WINDOWS

properties

default_map

Constructor Detail

Config

Config

Config

Method Detail

auto_metric

setAutoMetric

enable_compactions

enable_realtime_ts

enable_realtime_uid

enable_tsuid_incrementing

enable_tsuid_tracking

enable_chunked_requests

max_chunked_requests

enable_tree_processing

overrideConfig

getString

getInt

getShort

getLong

getFloat

getDouble

getBoolean

getDirectoryName

hasProperty

dumpConfiguration

getMap

setDefaults

loadConfig

loadConfig