Calypso environments

General structure

This file describes your monitored Calypso environments

An example of environment.yml is stored in {{hpa_base_dir}}/environment.yml.template

Multiple environments can be described in this file, each environment have a key and a name.

hpa.environments:
   example-key-envTesting2:
      name: description
      ....
      ....
   other_example-key_env-1:
      name: other description
      ....
      ....

The environment key can not have a space but name can (see example below)

The key must be unique and be present in environement.yml

For each monitored environment, rules about agents naming are described and used in the HPA portal to link metrics and screens/tiles to display them.

Agent naming

This file is then a descriptor for the HPA Agent. Agents are named with:

• server host, identified as agentHost, optional and by default '%' meaning “all servers”
• agent name, identified as agentName

The agentHost is the hostname of the Calypso platform where the agent is deployed.
Using an agentHost node is a way to not consider metrics coming from other hosts for this environment (in the HPA portal). Check into the Webview Investigator and expand the SuperDomain tree.

Warning ! HPA selector is %

By default the wizards use those default agent names, to ease the usage of the suggested pattern.

Keep HpaRisk prefix for risk components, see the reason above in Zoom on risk components

File example

hpa.environments:
   staging-v19:
      name: Staging
      dataservers:
         agentHost: SPARPRODCAL05
         agentName: DataServer
      dataservers-ro:
         agentName: DataServerRO
      eventserver:
         agentName: HpaGeneric-EventServer
      engines:
         agentName: '%Engine%'
      navigators:
         agentName: 'Navigator%'
      scheduledTasks:
         agentName: 'Schedule%'
      schedulerServer:
         agentName: 'SchedulerServer%'
      database:
         agentName: HpaInfrastructure
      riskComponents:
         agentName: 'HpaRisk%'
      calculators:
         agentName: 'HpaRisk-Calculator%'
      riskServers:
         agentName: 'HpaRiskServer%'
      generic:
         agentName: '%HpaGeneric%'

Zoom on risk components

Portal use the selectors to group and search information on risk components at the same time, so to make it work properly, it muse follow the pattern :

• calculators are identified by the pattern of calculators section
• riskServers are identified by the pattern of riskServers section

The last pattern includes all the risk components : dispatchers, calculators, risk servers. To make it work easily the pattern for this includes the calculators and riskserver patterns :

HpaRisk% is for all components and includes :

• calculators because HpaRisk-Calculator% is more precise
• and HpaRiskServer% for the same rease they both start with HpaRisk.

      riskComponents:
         agentName: 'HpaRisk%'
      calculators:
         agentName: 'HpaRisk-Calculator%'
      riskServers:
         agentName: 'HpaRiskServer%'