This chapter explains how to monitor channels.
The punch channel monitoring service is in charge of monitoring all the channels of a tenant. It computes and publishes an overall health status periodically in Elasticsearch documents, that can in turn be queried by an external supervision application. A standard Kibana dashboard is also available.
channels-monitoring application is a native punch application.
You can deploy in a standard channel and run it in shiva.
Here is the punch standalone example: the channel_structure.yaml file is as follows
version: '6.0' start_by_tenant: true stop_by_tenant: true applications: - name: channels-monitoring runtime: shiva cluster: common command: channels-monitoring args: - channels_monitoring.json resources: 
channels-monitoring application takes a single configuration file argument.
monitoring_interval: 30 elasticsearch: es_platform_logs_index: platform-*logs-* es_topologies_metrics_index: mytenant-metrics-* reporters: - type: kafka
This sample configuration means that all channels will be monitored every 60 seconds.
The interval in seconds between two health check of services.
The cluster where all logs and metrics data are stored.
Index where to get logs information.
Index where to get metrics information.
monitoring_interval: 10 elasticsearch: es_cluster_id: es_search es_platform_logs_index: platform-*logs-* es_topologies_metrics_index: mytenant-metrics-* credentials: user: bob password: pass ssl: false
Username to authenticate to ES cluster. Needs
Password to authenticate to ES cluster. Needs
Token string to authenticate to ES cluster. Needs
Token type used to authenticate to ES cluster. Needs
If true, encrypt the connection to the ES cluster with TLS
Path to the client's private key for TLS connection
Path to the client's public key for TLS connection
Path to the client's CA file for TLS connection
On a standalone , the channel monitoring service is included in the configuration of both the platform and mytenant tenants.
Simply start it as follows:
channelctl --tenant mytenant start --channel monitoring