HPA Portal sections Data collection Data collection sessions HPA metrics export

A set of HPA metrics are exported during each data collection session.

The main configuration of this functionality is reachable in application.yml of the exporter.

Please find the default configuration, modifiable according to customer expectations.

directory: $BASEDIR_DUMPSESSION/metrics
replacement-char: "@"
extract-period-in-hour: 8
sub-char: ":"
forbidden-chars:
 - "'"
 - "\""
 - ";"
 - ","
 - "."
 - "|"
 - "`"
 - "\\"
 - "@"
anonymization-keys-file: $BASEDIR_EXPORT/anonymization/anonymizationKeys.txt

An anonymisation mechanism is available to hide sensitive data potentially present in HPA metric names paths.

All the dates relative to processing export data are shared in UTC only.

A metrics_export.yml is provided by default and is matching with Nasdaq Calypso expectations.

It can be customized by copying it to the override_config directory (see Configuration overview). A modification is taken into account within one minute, without restart. A dump already running keeps the metrics it started with. An invalid file is ignored and the previous configuration is kept, the error being written in the extractor log.

hpa.metrics-export.metrics:
  - name: HpaTradeSave
    agent-name: DataServer%
    metric-path: Hpa|RulesWorkflow|%
    metric-attribute: "%"
    end-point-name: Average Response Time
    levels:
      - level: 1
        replace: true
        replace-value: Trade saver
      - level: 2
        anonymization: true
      - level: 4
        anonymization: true
      - level: 5
        sub: true
  - name: HpaWorkflowRule
    agent-name: DataServer%
    metric-path: Hpa|Rules|%
    metric-attribute: "%"
    end-point-name: Average Response Time
    levels:
      - level: 3
        anonymization: true
      - level: 5
        anonymization: true
      - level: 8
        sub: true
  - name: DataServerFrontEnd
    agent-name: DataServer%
    metric-path: Frontends|%Average Response%
    metric-attribute: "%"
    end-point-name: Average Response Time
    levels:
      - level: 1
        remove: true
      - level: 2
        sub: true
      - level: 3
        sub: true
  - name: PendingEvents
    agent-name: EngineServer%
    metric-path: Frontends|%JMX TotalUnconsumedCount%
    metric-attribute: "%"
    end-point-name: Number of pending events
    levels:
      - level: 0
        remove: true
      - level: 1
        remove: true
      - level: 2
        sub: true
  - name: BadEvents
    agent-name: EngineServer%
    metric-path: Frontends|%JMX BadEventsCount%
    metric-attribute: "%"
    end-point-name: Number of bad events
    levels:
      - level: 0
        remove: true
      - level: 1
        remove: true
      - level: 2
        sub: true
  - name: ProcessedEvents
    agent-name: EngineServer%
    metric-path: Frontends|%JMX ConsumedCount%
    metric-attribute: "%"
    end-point-name: Number of bad events
    levels:
      - level: 0
        remove: true
      - level: 1
        remove: true
      - level: 2
        sub: true
  - name: ProcessCPUTime
    agent-name: "%"
    metric-path: Hpa|%processCpuTime%
    metric-attribute: "%"
    end-point-name: Process CPU time
    levels:
      - level: 2
        sub: true
  - name: AliveProcessTime
    agent-name: "%"
    metric-path: Hpa|%aliveProcessTime%
    metric-attribute: "%"
    end-point-name: Alive process time
    levels:
      - level: 2
        remove: true
  - name: NavigatorsUsage
    agent-name: "Navigator%"
    metric-path: Hpa|NavigatorSessions%
    metric-attribute: "%"
    end-point-name: Count
    levels:
      - level: 0
        remove: true
      - level: 1
        remove: true
      - level: 2
        anonymization: true
      - level: 7
        sub: true
  - name: WebUIUsageCount
    agent-name: "Hpa%"
    metric-path: Hpa|NavigatorSessions%
    metric-attribute: "count"
    end-point-name: Count
    levels:
      - level: 0
        remove: true
      - level: 1
        remove: true
      - level: 2
        anonymization: true
      - level: -1
        sub: true
  - name: WebUIUsage
    agent-name: "Hpa%"
    metric-path: Hpa|NavigatorSessions%
    metric-attribute: "Average Response%"
    end-point-name: Average Response Time
    levels:
      - level: 0
        remove: true
      - level: 1
        remove: true
      - level: 2
        anonymization: true
      - level: -1
        sub: true

HPA metrics names are transformed to a Nasdaq Calypso expected format.

Keyword Definition
name Label present in the output file, e.g. metrics_data_<name>_2026-10-01T112500_2026-10-01T113000.csv
agent-name Name of the agent. Use “%” as wildcard character
metric-path Path of the metric (pipe-separated fields, until the colon char). Use “%” as wildcard character
metric-attribute Attribute of the metric (i.e. the last element of the metric full name, after the colon character “:”). Use “%” as wildcard character
end-point-name User-defined name for the metric written in the CSV file. It can be the same string as the metric attribute
levels See below

Each level (fields separated by ‘|’ character) of the metric full name can be configured via specific keywords.

Keyword Value(s) Impact
level integer Numerical index of the field to select.
First field is index 0, second one is 1, etc.
You can use a negative number to select a field from the end (-1 being the last field, -2 the second-to-last, etc.)
anonymization true The values of those fields will be replaced by consistent random labels
remove true This level will be removed from the exported data
sub true Only the start of the value, before the sub-char will be exported
end true Only the end of the value, after the sub-char will be exported
replace true Will replace the value by the one defined in replace-value
replace-value any Constant value