Installation steps

Identify the script used to launch the component, it can be the default or a custom script. Default script is : <CALYPSO_HOME>/deploy-local/v15/dataServer.sh

You can use Help > Agent wizard in the portal to help you defining the right values

Add the following lines in the startup scripts :

Agent name : for example Dataserver
Agent profile : for example dataserver (see agent name and profile)

# HPA start modification
if [ -r {{hpa_agent_dir}}/hpa_agent_common.sh ]; then
    source {{hpa_agent_dir}}/hpa_agent_common.sh "<Agent name>" "<profile>"
fi
# HPA end modification

The lines must be included after JAVA_OPTS is set : the HPA scripts enrich this variable.

Agent Naming

Each agent should have a distinct name, otherwise metrics can not be separate and the view of a module will be wrong.

DataServer RO Agent Naming

DataServer read-only instances can be named DataServerRO and use the same profile dataserver_vXX

Engine servers

Simply name the engines servers from the function name with Engine in the name : EngineServer-One, EngineServer-Messaging

Scheduled tasks

The name of the agent for scheduled task is build like this : ScheduledTask-<external ref>

Others modules

The name of others components should contain HpaGeneric, for example : HpaGeneric-ArtifactServer, HpaGeneric-AuthServer…

Installation check

Once a module started, check the following to ensure the good installation of the agent.

Using ps -ef, check the Calypso Java process is launched with the java option -Dintroscope.agent.agentName.
In Webview investigator, check a Calypso DataServer node with name Dintroscope.agent.agentName is well mounted in the Investigator tree.