Tips and guidelines

Edited on May 10, 2017

Indexes

The current version of RTM relies on an index for the primary dimension (time value). As of v2.0.1, this index is not yet added automatically. Here's how to add it:

db.measurements.ensureIndex({ 'begin" : 1})

If you create masses of small logical groups of measurements rather than pack many measurements in a single group, you might want to add the following index as well :

db.measurements.ensureIndex({ "eId" : 1, 'begin" : 1})

Custom configuration

Many things can be tweaked via the file rtm.properties. From timeouts to default values in the GUI to histogram precision values... So here's a list of the most important values which you might want to check out:

##################
# Server settings#
##################
rtm.port= http port number to access the web app and the ingestion servlet
ds.host= hostname of the mongodb instance
ds.port= port number of the mongodb instance
ds.dbname= database name inside the mongodb instance
ds.measurements.collectionName= collection name to be used
###############################
# Data model settings#
###############################
model.key.eId= default key for the logical grouping of measurements
model.key.begin= default key to use for the primary dimension (a number, representing time via epoch, in most use cases)
model.key.name= default key to use for the measurement name attribute
model.key.value= default key to use for storing the measurement's value
model.key.sId= obsolete, might be used again later when we start persisting aggregation results again
model.key.end= obsolete, had to do with aggregation results persistence as well
###############################
# Global service settings#
###############################
aggregateService.defaultStreamTimeoutSecs= default time out value after which a stream is cleared and an aggregation request pipeline aborted
aggregateService.defaultTargetDots= default number of buckets that RTM will try to shoot for when using the special intervalSize value "auto"
histogram.nbPairs= number of histogram buckets to be used per time bucket, by default. Increasing this value will increase memory usage and percentile precision
histogram.approxMs= minimum space between two histogram buckets, decrease this value if your standard deviation is an order of magnitude lower or more, increase it if your standard deviation is an order of magnitude higher or more
###############################
# Server-side service settings#
###############################

##################
# Client settings#
##################
client.debug= used for development purposes
client.splitChar= dev only

client.AggregateChartView.currentChartMetricChoice= default metric which the chart will display
client.AggregateChartView.chartBeginKey= obsolete/internal
client.AggregateChartView.chartGroupbyKey= obsolete/internal
client.AggregateChartView.chartMaxSeries= obsolete/internal
client.AggregateChartView.chartMaxDotsPerSeries= obsolete/internal
client.AggregateTableView.checkedAggTableMetrics=default list of comma-separated metric names to be displayed by default in the table view
client.AggregateTableView.dateMetrics=internal
client.AggregateTableView.excludeList= metrics list to be excluded from the list displayed in the table
client.AggregateTableView.switchedOn= unfold table view by default or not
client.AggSPControllerView.defaultSid= obsolete
client.AggSPControllerView.defaultGranularity= default intervalSize value to be inserted in the service parameter input field
client.AggSPControllerView.defaultGroupby= default groupby value to be inserted in the service parameter input field
client.AggSPControllerView.defaultCpu= default number of cpu cores to be inserted in the service parameter input field
client.AggSPControllerView.defaultPartition= default number of partitions to be inserted in the service parameter input field
client.MeasurementListView.checkedTableMetrics= default fields to display
client.MeasurementListView.dateMetrics= internal
client.MeasurementListView.excludeList= fields to exclude from display
client.MeasurementListView.pagingValue= default page size for browsing through measurements
########################
#Global domain settings#
########################
aggregateService.domain= internal
measurementService.domain= internal
domainSeparator= internal