Operating Any
Any architecture
See the Architecture chapter.
Start and stop the Any services
Start Any
- MongoDB, Elasticsearch and ActiveMQ must be started first.
- Once these services are started, you can start the Tomcat service running Any and JMS.
- Hazelcast is started with Any and JMS and requires no manual action.
If you have to restart ActiveMQ, you must restart Any and JMS right after to restore the connection with JMS.
The asynchronous processing relies on queues consumed by the Messaging Server. See Queues.
Stop Any
You must first stop Any and JMS, then MongoDB, Elasticsearch and ActiveMQ.
Monitoring the Any services
Any
Any embeds a URL to check in a single call whether every service is available. This URL checks whether MongoDB, Elasticsearch, the file storage and Hazelcast are reachable from the webapp.
The URL to use is:
GET /any/rest/default/system/check
Response status:
- 200 – OK: every service is available
- 500 – Error: Any does not work correctly
Elasticsearch
The status of Elasticsearch can be obtained through the following URL:
GET /_cluster/health
Response structure:
- cluster_name: name of the cluster.
- status: (string) health status of the cluster, based on the state of its primary and replica shards. The statuses are:
- Green: every shard is allocated.
- Yellow: every primary shard is allocated, but one or several replica shards are not. If a node of the cluster fails, some data may be unavailable until that node is repaired.
- Red: one or several primary shards are not allocated, so some data is not available. This can happen briefly during the start of the cluster, while the primary shards are being allocated.
MongoDB
Mongo embeds a free monitoring. To enable it, run the following command from the mongo shell:
db.enableFreeMonitoring()
This starts the registration process for the free monitoring. The method returns your monitoring status:
{
"state" : "enabled",
"message" : "To see your monitoring data, navigate to the unique URL below.\nAnyone you share the URL with will also be able to view this page.\n\nhttps://cloud.mongodb.com/freemonitoring/mongo/MSBjZTZhNTJmOS0yODg1\n\n You can disable monitoring at any time by running db.disableFreeMonitoring().",
"url" : "https://cloud.mongodb.com/freemonitoring/mongo/MSBjZTZhNTJmOS0yODg1",
"userReminder" : "",
"ok" : 1
}
Monitoring the Any performance
Any embeds URLs to monitor the runtime performance of the server. These services return no data, but allow monitoring the execution time and detecting performance problems.
Rooms list
This service simulates the display of a rooms list with the super administrator permission.
GET /any/rest/default/system/monitorGetRoomItems
Run search
This service runs a search without any criterion with the super administrator permission. The first 10,000 documents are processed with all their facets.
GET /any/rest/default/system/monitorSearchResults