- Home
- Unravel 4.5 Documentation
- Advanced topics
- Unravel properties
- Sensor properties
Sensor properties
Note
Most Sensor properties are set via JVM arguments; the file name is noted when the properties can be set in a file.
Specified by adding -D<propertyName>=<propertyValue> to the list of JVM args, e.g.-Dclient.rest.conntimeout.ms=0
Property/Description | Set by user | Unit | Default |
|---|---|---|---|
com.unraveldata.client.rest.queue The queue length for outgoing REST HTTP requests. | 20000 | ||
com.unraveldata.client.rest.retryfail Cool-down period after unsuccessful attempt to make REST HTTP request in nanoseconds. | ns | 30 sec | |
com.unraveldata.client.rest.conn.timeout.ms REST HTTP request timeout in milliseconds. | ms | 100 | |
com.unraveldata.client.rest.shutdown.ms Maximum time to wait for orderly shutdown of the REST client (if exceeded some messages still in the queue will be lost). | ms | 10 | |
com.unraveldata.client.rest.dns.ttl The period to refresh the DNS info in milliseconds - IP is pre-resolved and kept until the next refresh if no failures are observed. | ms | 6 hours | |
com.unraveldata.client.rest.priority.retries Certain critical messages have priority flag and their transmission will be reattempted this many times. | 5 | ||
unravel.server.hostport Unravel server host:port information. | - |
Specified in hive-conf, or in the hive CLI or beeline session. (CDH 5.14 only.)
Property/Description | Set by user | Unit | Default |
|---|---|---|---|
com.unraveldata.com.hive.spark.enabled Set to true to allow Hive and Spark applications to be linked. Only available for CDH 5.14. | boolean | true |
Specified by adding -D<propertyName>=<propertyValue> to the list of JVM args, e.g.-Dclient.rest.conntimeout.ms=0
Property/Description | Set by user | Unit | Default |
|---|---|---|---|
com.unraveldata.agent.metrics.enabled_keys Comma separated list of metric type names which are enabled for collection. | CSL | availableMemory,cpuUtilization,processCpuLoad,systemCpuLoad,maxHeap,usedHeap,vmRss,gcLoad | |
unravel.metrics.factor Sampling period scale down factor. | 1 |
Agent arguments are added directly to the agent definition - anything after -javaagent:btrace-agent.jar= is considered to be the agent argument. The arguments are delimited by comma with no extra space.
Agent argument/definition | Set by user | Unit | Default |
|---|---|---|---|
metricsCaptureFilter Format allow specifying single ordinals for component IDs as well as ranges and enumerations. Fore example: metricsCaptureFilter=1,2,5-10,turns on metrics collection for components 1, 2, 5 to 10. | 0-1500 |
Specified in spark-defaults.conf.
Property/Description | Set by user | Unit | Default |
|---|---|---|---|
com.unraveldata.spark.shutdown.delay.ms Amount of time to delay shutdown so the last messages are processed (allows Btrace sensor to send all the data before the spark driver exits). | ms | 30 |
Specified by adding -D<propertyName>=<propertyValue>; to the list of JVM args, e.g.-Dclient.rest.conntimeout.ms=0
Property/Description | Set by user | Unit | Default |
|---|---|---|---|
com.unraveldata.spark.sensor.enableLiveUpdates Enable live updates for Spark apps. | boolean | False | |
com.unraveldata.spark.sensor.enableCachingInfo Enable tracking caching info for Spark apps. | boolean | False | |
com.unraveldata.spark.sensor.enableSampling Enable data sampling between operators for Spark apps. | boolean | False |
Agent arguments are added directly to the agent definition - anything after -javaagent:btrace-agent.jar= is considered to be the agent argument. The arguments are delimited by comma with no extra space.
Agent argument/definition | Set by user | Unit | Default |
|---|---|---|---|
com.unraveldata.spark.sensor.clusterID The cluster ID;, currently only used in Spark. | string | - |