Channel Monitoring¶
Abstract
This chapter explains how to enable the channels monitoring service.
Overview¶
The punch platform channel monitoring service is in charge of monitoring all channels running.
Configuration¶
The PunchPlatform Channel Monitoring service is a task that
is run in the Shiva task scheduler. This requires first to add the following job to the channel channel_structure.json
descriptor file:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | { "type": "shiva", "name": "channels-monitoring", "command": "channels-monitoring", "args": [ "channels-monitoring.json" ], "resources": [ "channels-monitoring.json" ], "cluster": "common", "shiva_runner_tags": [ "standalone" ] } |
Along with an channels-monitoring.json
file to define your settings. This files contains the following fields:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | { "monitoring_interval": 10, "elasticsearch": { "es_cluster_id": "es_search", "es_platform_logs_index": "platform-logs-*", "es_topologies_metrics_index": "mytenant-metrics-*" }, "reporters": [ { "type": "elasticsearch", "cluster_name": "es_search", "index_name": "mytenant-channels-monitoring" } ] } |
This sample configuration means that all channels will be monitored every 10 seconds.
Tip
Remember that if you update your configuration, you must restart your channel and save your configuration.
Parameters¶
Mandatory¶
-
monitoring_interval
(integer)The interval in seconds between two health check of services.
-
elasticsearch.es_cluster_id
(string)The cluster where all logs and metrics datas are stored.
-
elasticsearch.es_platform_logs_index
(string)Indice where to get logs informations.
-
elasticsearch.es_topologies_metrics_index
(string array)Indice where to get metrics informations.
Optional¶
elasticsearch.credentials
(map of credentials)This is a map of credentials for one or many ElasticSearch clusters. You will need this extra configuration Opendistro Security is enabled on your platform.
Try It¶
On a standalone deployment, the Channel monitoring service is
included in the configuration of the admin channel. To
activate the Channel Monitoring service, you must ensure that the
admin
channel is started.
1 | punchctl --tenant mytenant start --channel admin |