Monitor client application consumption using baseline-based evaluations

Introduction

Some client applications might be consuming services at some specific times over a daytime period, which means that you can expect peaks or dips at certain points in time, given the time frame observed. In that specific case, you might want to detect any abnormal situation in accordance with the activity usually observed. An abnormally low activity could be a weak signal that a client application is not working properly or that a client application is no longer consuming a service for other reasons. By default, this kind of evaluation is not activated, since not all client applications do actually have a meaningful activity pattern and thus do not have to be monitored for that purpose.

This topic:

  • explains how to idenitfy activity patterns for a client application
  • walks you through the steps to activate baseline evaluation for a client application

Identify client application consumption pattern 

The Client application - Activity profile dashboard is focusing on the consumption profile of a given client application.

  • The Intraday activity profile section displays the current day traffic as well as the traffic related to the previous week.
  • A baseline representing the typical hour of the week is also displayed and can then be visually compared with the current day traffic.

A pattern of activity can be identified as long as you can notice that the traffic is following more or less the same curve from one typical day of the week to another.

Add the client application as a "special care" application

When you detected an activity pattern, you can choose to monitor the client application activity to detect any potential low traffic.

This step involves adding this client application as a "monitored application" that will require a special care in terms of consumption monitoring.

Just like other configuration data (such as thresholds and user-related data), you must create a configuration file and put it in a dedicated file directory, then absorb it by running a route. 

Step 1 - Prepare the configuration file

 

The content of the configuration file should contain:

  • The client application name,
  • The creation time from which the activity will be evaluated. This creation time can either correspond to a point in time in the past or in the future.

Client app;Creation time
Plexus Suite - Surgery Center;2016-10-01T00:00:00.000

 

The configuration file to use must be located in the file directory specified by the In_ConfigurationFiles_ClientApp_BaselineAnalysis property defined in the 07-API-Configuration space. 

 

Step 2 - Run the route to absorb the file

Routes intended to update configuration data are located in the 07-API-Configuration space.

Start the createUpdateClientAppBaselineAnalysis route if not already started. When properly absorbed by the route, the configuration file is then moved to a .camel directory. 

Step 3 - Recompute old data (optional)

If the creation time specified in the configuration file is further back in the past, and if you wish to reevaluate the client applications consumption over a past period, you must flush the recomputing events manually or wait around 15 minutes for the changes to take effect. 

Go to Configure & Manage >> Platform >> Computing, then flush (using the "Flush all" button) the pending events to trigger recalculation.

Monitor client application consumption

You can access the list of monitored client application from the Client Application Health Cockpit dashboard, by following the Client applications activity... link at the bottom right .

 

 

 

 

Related Links