OpenTSDBTSDExtendedHelp.md

2015-03-15 16:51:26,848 INFO  [main] Main: Built on 2015/03/08 20:49:56 +0000 by nwhitehead@tpmint:/home/nwhitehead/hprojects/opentsdb

tsd extended usage:
  --async-io=BOOL             Whether or not to use NIO or tradditional blocking IO
  --auto-metric=BOOL          Whether or not a data point with a new metric will assign a UID to the metric. When false, a data point with a metric that is not in the database will be rejected and an exception will be thrown
  --auto-tagk=BOOL            Whether or not a data point with a new tag name will assign a UID to the tagk. When false, a data point with a tag name that is not in the database will be rejected and an exception will be thrown
  --auto-tagv=BOOL            Whether or not a data point with a new tag value will assign a UID to the tagv. When false, a data point with a tag value that is not in the database will be rejected and an exception will be thrown
  --backlog=GTZEROINT         The connection queue depth for completed or incomplete connection requests depending on OS. The default may be limited by the 'somaxconn' kernel setting or set by Netty to 3072
  --bind=ADDR                 An IPv4 address to bind to for incoming requests. The default is to listen on all interfaces. e.g. 127.0.0.1
  --cachedir=DIR              The full path to a location where temporary files can be written. e.g. /tmp/opentsdb
  --compaction=BOOL           Whether or not to enable compactions
  --config=URLORFILE          The core config file overlayed on this default
  --cors-domains=LIST         A comma separated list of domain names to allow access to OpenTSDB when the Origin header is specified by the client. If empty, CORS requests are passed through without validation. The list may not contain the public wildcard * and specific domains at the same time
  --cors-headers=LIST         A comma separated list of headers sent to clients when executing a CORs request. The literal value of this option will be passed to clients
  --enable-chunked=BOOL       Whether or not to enable incoming chunk support for the HTTP RPC
  --enable-tree=BOOL          Whether or not to enable processing new/edited TSMeta through tree rule sets
  --fixdups=BOOL              Whether or not to accept the last written value when parsing data points with duplicate timestamps. When enabled in conjunction with compactions, a compacted column will be written with the latest data points
  --flush-interval=GTZEROINT  How often, in milliseconds, to flush the data point storage write buffer
  --help                      Prints the default command line usage options, or the extended if 'extended' is passed as an arg
  --ignore-existing-pid=BOOL  If true, ignores and overwrites an existing pid file on startup
  --include=URLORFILE         An additional config overlay useful when the --config file is fairly static
  --keep-alive=BOOL           Whether or not to allow keep-alive connections
  --logback=EDIRFILE          The file name that the tsd will log to using logback
  --logback-config=EFILE      The file name of an external logback configuration
  --logback-console=BOOL      If specified, logback will log to the configured file and keep logging to the console
  --logback-roll              The pattern specifying the rolling file pattern, inserted between the file name base and extension
  --max-chunk=GTZEROINT       The maximum request body size to support for incoming HTTP requests when chunking is enabled
  --metatable=TABLE           Name of the HBase table where meta data are stored
  --no-uiexport=BOOL          Skips the boot time export of static UI content to tsd.http.staticroot
  --pid-file=FILE             The file to write the process PID to. Defaults to [${user.home}.tsdb/opentsdb.pid]
  --plugin-path=EDIR          A path to search for plugins when the TSD starts. If the path is invalid, the TSD will fail to start. Plugins can still be enabled if they are in the class path
  --port=POSINT               The TCP port to use for accepting connections
  --realtime-ts=BOOL          Whether or not to enable real-time TSMeta object creation
  --realtime-uid=BOOL         Whether or not to enable real-time UIDMeta object creation
  --reuse-address=BOOL        Whether or not to allow reuse of the bound port within Netty
  --rpc-plugins=LIST          A comma delimited list of RPC plugins to load when starting a TSD. Must contain the entire class name
  --rtplublisher=BOOL         Whether or not to enable a real time publishing plugin. If true, you must supply a valid tsd.rtpublisher.plugin class name
  --rtplublisher-plugin=CLASS The class name of a real time publishing plugin to instantiate. If tsd.rtpublisher.enable is set to false, this value is ignored. e.g. net.opentsdb.tsd.RabbitMQPublisher
  --search=BOOL               Whether or not to enable search functionality. If true, you must supply a valid tsd.search.plugin class name
  --search-plugin=CLASS       The class name of a search plugin to instantiate. If tsd.search.enable is set to false, this value is ignored. e.g. net.opentsdb.search.ElasticSearch
  --show-stack=BOOL           Whether or not to return the stack trace with an API query response when an exception occurs
  --socket-timeout=POSINT     The idle time timeout for allocated sockets (seconds)
  --staticroot=DIR            Location of a directory where static files, such as JavaScript files for the web interface, are located. e.g. /opt/opentsdb/staticroot
  --stats-canonical=BOOL      Whether or not the FQDN should be returned with statistics requests. The default stats are returned with host=<hostname> which is not guaranteed to perform a lookup and return the FQDN. Setting this to true will perform a name lookup and return the FQDN if found, otherwise it may return the IP. The stats output should be fqdn=<hostname>
  --table=TABLE               Name of the HBase table where data points are stored
  --tcp-no-delay=BOOL         Whether or not to disable TCP buffering before sending data
  --treetable=TABLE           Name of the HBase table where tree data are stored
  --tsd-maxuids=POSINT        The number of rows to scan for UID pre-loading
  --tsd-mode=RWMODE           Whether or not the TSD will allow writing data points. Must be either rw to allow writing data or ro to block writes
  --tsd-nodie=BOOL            Enable or disable the diediedie HTML and ASCII commands to shutdown a TSD
  --tsd-preloaduids=BOOL      Enables pre-population of the UID caches when starting a TSD
  --tsd-timezone=TIMEZONE     A localized timezone identification string used to override the local system timezone used when converting absolute times to UTC when executing a query. This does not affect incoming data timestamps. E.g. America/Los_Angeles
  --tsuid-incr=BOOL           Whether or not to enable tracking of TSUIDs by incrementing a counter every time a data point is recorded. (Overrides tsd.core.meta.enable_tsuid_tracking)
  --tsuid-tracking=BOOL       Whether or not to enable tracking of TSUIDs by storing a 1 with the current timestamp every time a data point is recorded
  --uidtable=TABLE            Name of the HBase table where UID information is stored
  --worker-threads=GTZEROINT  The number of asynchronous IO worker threads for Netty
  --zkbasedir=ZPATH           Path under which is the znode for the -ROOT- region (default: /hbase)
  --zkquorum=SPEC             A comma-separated list of ZooKeeper hosts to connect to, with or without port specifiers. e.g. 192.168.1.1:2181,192.168.1.2:2181 (default: localhost)