Properties and configurations

Properties and configurations

MobileFirst properties

Set in worklight.properties. The server must be restarted for these properties to take effect. Properties in worklight.properties can also be set using JNDI properties.

JNDI properties

JNDI environment properties can bet Set up a production clusterset on the application server. For a clustered environment, some properties can be set only on the first node in the cluster. The Analytics runtime web application must be restarted for any changes in these properties to take effect. It is not necessary to restart the entire application server. All JNDI properties are namespaced with analytics/.
The following example shows how to set the datapath JNDI property in Liberty:
<jndiEntry jndiName="analytics/datapath" value="/opt/IBM/analytics/data" />

The following example shows how to set the datapath JNDI property in Tomcat:
<Environment name="analytics/datapath"
           value="/opt/IBM/analytics/data"
           type="java.lang.String"
           override="false" />
The following table shows the JNDI properties:

Property Name Default Value Description
nodetype None. Defines the node type. Valid values are master and data. If this JNDI property is not set, then the node acts as a master node and a data node by default.
shards 5 The number of shards that the cluster creates. This value can be set only by the first node in a cluster. This value can never be changed after the first node in the cluster starts.
replicas_per_shard 1 The number of replicas for each shard in the cluster. This value can be set only by the first node in a cluster.
masternodes None. A comma-delimited string containing the hostname and ports of the master nodes.
clustername worklight Name of the cluster. Set this value if you plan to have multiple clusters and want to uniquely identify them.
nodename Randomly generated. Name of a node in a cluster. A node that joins a cluster randomly generates a name to uniquely identify itself. We can specify our own name using this property.
datapath ./analyticsData The path that analytics data is saved to on the file system. By default, a folder named analyticsData is created.
settingspath None. Path to an extra settings file.
transportport 9600 Port used for node-to-node communication.
httpport 9500 Port used for HTTP communication to the MPF Operational Analytics.
app_activities_ttl None. The TTL for automatic deletion of app activities data.
notification_activities_ttl None. The TTL for automatic deletion of notification activities data.
client_logs_ttl None. The TTL for automatic deletion of client logs data.
server_logs_ttl None. The TTL for automatic deletion of server logs data.
serviceContext worklight-analytics-service Defines the context root for the analytics service if it is different from the default.
serviceProxyURL None This property enables the MPF Operational Analytics console to locate the Analytics REST services. The value of this property must be specified as the external address and context root of the worklight-analytics-service.war web application.

For Tomcat, the JNDI property must include the override="false" attribute to work properly.

Elasticsearch properties

Elasticsearch is the underlying technology used by the MPF Operational Analytics. Elasticsearch provides several extra properties for performance tuning. The JNDI properties exposed and documented here are abstractions around the properties provided by Elasticsearch. Normally, these properties are set in a custom settings file.
If we are familiar with Elasticsearch and the format of its properties files, we can specify the path to the settings file using the settingspath JNDI property:
<jndiEntry jndiName="analytics/settingspath"
           value="/home/system/elasticsearch.yml" />
All properties provided by Elasticsearch can also be set using a JNDI property with the analytics/ string added before the property name. For example, threadpool.search.queue_size is a property provided by Elasticsearch used for performance tuning. This property can be set using a JNDI property as follows:
<jndiEntry jndiName="analytics/threadpool.search.queue_size" value="100" />

Parent topic: Operational analytics

Property Name	Default Value	Description
nodetype	None.	Defines the node type. Valid values are master and data. If this JNDI property is not set, then the node acts as a master node and a data node by default.
shards	5	The number of shards that the cluster creates. This value can be set only by the first node in a cluster. This value can never be changed after the first node in the cluster starts.
replicas_per_shard	1	The number of replicas for each shard in the cluster. This value can be set only by the first node in a cluster.
masternodes	None.	A comma-delimited string containing the hostname and ports of the master nodes.
clustername	worklight	Name of the cluster. Set this value if you plan to have multiple clusters and want to uniquely identify them.
nodename	Randomly generated.	Name of a node in a cluster. A node that joins a cluster randomly generates a name to uniquely identify itself. We can specify our own name using this property.
datapath	./analyticsData	The path that analytics data is saved to on the file system. By default, a folder named analyticsData is created.
settingspath	None.	Path to an extra settings file.
transportport	9600	Port used for node-to-node communication.
httpport	9500	Port used for HTTP communication to the MPF Operational Analytics.
app_activities_ttl	None.	The TTL for automatic deletion of app activities data.
notification_activities_ttl	None.	The TTL for automatic deletion of notification activities data.
client_logs_ttl	None.	The TTL for automatic deletion of client logs data.
server_logs_ttl	None.	The TTL for automatic deletion of server logs data.
serviceContext	worklight-analytics-service	Defines the context root for the analytics service if it is different from the default.
serviceProxyURL	None	This property enables the MPF Operational Analytics console to locate the Analytics REST services. The value of this property must be specified as the external address and context root of the worklight-analytics-service.war web application.