-
Agent
- profiles (folder)
- DBExtractor (folder)
- hpa_calypso_flags_override.pbd - valid until HPA agent 4.03
- flag_settings (folder) - valid from HPA agent 4.04
- configuration_export_config.yml
- configuration_wkf_rules_attributes.yml
- calypso_alerts_replacement_patterns.yml
- automatic_st_monitoring.list
- hpa_agent_config.sh
- hpadump (folder)
- Portal
.template files are not described as being an original default version provided by HPA aiming to be copied and modified to reflect each specific client configuration.
Agent
hpa_agent_dir is the top folder the agent files have been deployed to.
It is typically the folder named uniqueagent.
uniqueagent
├── default_config
│ ├── DBExtractor
│ │ └── requests
│ │ │ └── default-calypso-requests.yml
│ │ └── db_extractor_config.yml
│ └── automatic_st_monitoring.list
│ ├── configuration_export_config.yml
│ ├── configuration_rum.yml
│ ├── configuration_stall.yml
│ ├── configuration_wkf_rules_attributes.yml
│ ├── calypso_alerts_replacement_patterns.yml
├── override_config
│ ├── profiles
│ │ └── *.profile
│ ├── hpa_calypso_flags_override.pbd
│ ├── flag_settings
│ │ └── *.pbd
├── wily
│ └── hpadump
│ ├── debugSessions
│ ├── configExport
│ └── dbExtractor
└── hpa_agent_config.sh
The default configuration is in default_config directory. It must not be modified.
Any customer-specific configuration is in override_config directory.
The default configuration can be overridden by copying and pasting, in override_config directory, any of the following configuration files from default_config directory:
-
DBExtractor/db_extractor_config.yml -
automatic_st_monitoring.list -
configuration_export_config.yml -
configuration_rum.yml -
configuration_stall.yml -
configuration_wkf_rules_attributes.yml -
calypso_alerts_replacement_patterns.yml
Note that these files are hot reloaded. There’s no need to restart any service when overriding these configuration files.
In case of agent upgrade, the override_config folder is not modified.
profiles (folder)
- No sub folder
- Contains all the
.profilesfiles created by the client, and overriding those delivered by default in HPA - Those files are enriched also after modifications made with Agents settings (services only)
DBExtractor (folder)
- Used by Data collection session - DB Extractor
hpa_calypso_flags_override.pbd - valid until HPA agent 4.03
- Does persist the changes of HPA agents behaviour made from the UI in the Agents settings (flags only)
flag_settings (folder) - valid from HPA agent 4.04
- Does persist the changes of HPA agents behaviour made from the UI in the Agents settings (services only)
- One
pbdfile is created by agent having settings modified by the UI
configuration_export_config.yml
configuration_wkf_rules_attributes.yml
- Used by Dataserver’s Rules and Workflow step execution
calypso_alerts_replacement_patterns.yml
- Used by Calypso alerts
automatic_st_monitoring.list
- Enables to configure the nature of Calypso scheduled tasks monitoring
- Only valid when ST are running via the Calypso scheduler
hpa_agent_config.sh
- Enables to configure the Calypso environment name shared with the portal
- And the EM internal address
hpadump (folder)
- Is the root folder of files used by the Data collection session
- By default
uniqueagent\wily\hpadump - Either generated automatically like DB Extractor or configuration exporter
- Or generated by the Data collection session itself
- By default
- This folder can be moved by setup
- DB Extractor and configuration exporter export folder paths defined in their respective configuration files are relative to this root folder
Portal
hpa_base_dir is the top folder the portal files have been deployed.
It is typically the folder named hpa
In case of agent upgrade, the var folder is not modified by the controller.
hpa
├── environment.yml
├── environment.config
├── security.config
├── default_config
│ ├── traces
│ │ └── trace-configuration.yml
│ ├── metrics_export.yml
├── override_config
├── var
│ └── hpadumpsessions
│ ├── debugSessions
│ ├── dbextractor
│ └── config
└── modules
└── hpa-extractor-x.yz
└── config
└── application.yml
The default configuration is in default_config directory. It must not be modified.
Any customer-specific configuration is in override_config directory.
The default configuration can be overridden by copying and pasting, in override_config directory, any of the following configuration files from default_config directory (keeping same tree structure):
-
traces/trace-configuration.yml -
metrics_export.yml
Note that only the traces/trace-configuration.yml file supports hot reload. The portal must be restarted if any of the other files is modified.
In case of upgrade, the override_config folder is not modified.
environment.yml
- Is the file where all the monitored Calypso environments are described
- Fully described here
environment.config
- Is the file where all the HPA portal network is described
- Fully described here
security.config
- Is the file dedicated to
.httpsconfiguration - Fully described here
metrics_export.yml
- Used by Data collection session - Processing data
hpadumpsessions (folder)
- Is the root folder for all the data coming from the agents and relative to data collection sessions
- This folder can be changed by configuration by modifying
environment.config
# Dump directory (data collection session, config exports, dbrequests)
# Uncomment to set another directory than default one (./var/hpadumpsessions)
# export BASEDIR_DUMPSESSION=
You must specify an ABSOLUTE path. This change will require a new HPA install (same version than current one then) and an HPA restart to be taken into account.
application.yml from hpa-extractor
- Is the standard
application.ymlfor this HPA portal component - Does contain the dedicated section to Data collection session - Processing data
Variables
| Variable | Path |
|---|---|
$BASEDIR_EXPORT |
var/export |
$EM_BASEDIR |
var/em |
$BASEDIR_DUMPSESSION |
var/hpadumpsessions (by default) |