Skip to content

Platform Monitoring

Abstract

This chapter explains how to enable the platform monitoring service.

Overview

The punch platform monitoring service is in charge of monitoring Kafka, Shiva, Storm, ElasticSearch, Zookeeper, Spark and Health Document.

Configuration

The PunchPlatform Platform 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
16
17
18
19
20
{
    "version" : "5.0",
    "start_by_tenant" : true,
    "stop_by_tenant" : true,
    "jobs" : [  
        { 
            "type" : "shiva",
            "name" : "monitoring",
            "command" : "platform-monitoring",
            "args": [
                "platform-monitoring-configuration.json"
            ],
            "resources": [
                "platform-monitoring-configuration.json"
            ],
            "cluster" : "common",
            "shiva_runner_tags" : ["standalone"]
        }
    ]
}

Along with an platform-monitoring-configuration.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,
  "services": [
    "kafka", "shiva", "storm", "elasticsearch", "zookeeper", "spark"
  ],
  "credentials": {
    "es_search": {
      "user": "admin",
      "password": "admin"
    },
    "another_cluster": {
      ...
    }
  }
}

This sample configuration means that Kafka, Shiva, Storm, ElasticSearch, Zookeeper, Spark and Health Document 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.

  • services (string array)

    The list of service we want to monitor.
    values: "kafka", "shiva", "storm", "elasticsearch", "zookeeper" or "spark"

Optional

  • 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 Platform monitoring service is included in the configuration of the admin channel. To activate the Platform Monitoring service, you must ensure that the admin channel is started.

1
punchctl --tenant mytenant start --channel admin