Context parameters in metrics - Cloud

Talend Remote Engine User Guide for Linux

EnrichVersion
Cloud
EnrichProdName
Talend Cloud
EnrichPlatform
Talend Remote Engine
task
Design and Development
Installation and Upgrade

Metrics are uniquely identified by their name and context fields. Context parameters provide additional information enriching the functional meaning of metrics, depending on the metric category or name.

Some context parameters can be enabled/disabled in the <RemoteEngineInstallationDirectory>/etc/org.talend.ipaas.rt.observability.jobContextConfig.cfg file by setting their values to true or false.

The values in the Example column correspond to the labels used on the example screenshots you can find in the Context parameter examples section.

JMX metric context parameters

Parameter Default status Editable Example
area Enabled No heap / noheap

Business context parameters

Unless otherwise indicated, the context parameters below apply to all metric parameters in the Business metric categories.

All business context parameters are enabled by default and cannot be disabled.

Context parameters Metric category/name Example
job_id Components, Job “_Wbd_QKHmEeuqob1gixsx-Q”
job_name Components, Job -
job_version Components, Job -
connector_id component_start_time_seconds

component_execution_duration_milliseconds

“tMongoDBInput_2”
connector_label “tMongoDBInput_2”
connector_type "tJavaRow"
connection_name component_connection_rows_total "row1"
component_execution_duration_milliseconds
source_connector_type component_connection_rows_total "tRowGenerator"
source_label "tRowGenerator_1"
target_connector_type “tLogRow”
target_id “tLogRow_1
target_label “tLogRow_1"
connection_type component_execution_duration_milliseconds "output"

Common context parameters

The context parameters below are present by default or can be added to metrics in the following categories:
  • Business - Components
  • Business - Job
  • JMX (Jobs only)

The following context parameters are enabled by default and cannot be disabled.

Default common context parameters
Parameter Details Example
account_id - -
deprecated_id
Temporary solution to distinguish between Job and subjobs metrics (with similar context)
Note: Removed from Talend Studio 7.3 R2021-05 patch and Talend Remote Engine v2.10.3 and later versions.
-
father_pid Unique identifier of the first direct parent Job
Note: Minimum requirement is Talend Studio 7.3 R2021-02 patch and Talend Remote Engine v2.10.3.
"20210601200408_aMgz4"
pid Unique Job identifier for the current run
Note: Minimum requirement is Talend Studio 7.3 R2021-02 patch and Talend Remote Engine v2.10.3.
  • Main (root) Job: "20210601200408_aMgz4"
  • Child Job : "UIvFAe"
process_id JVM's UUID "0fc8c24d-133b-36c7-b917-5e171cc28201"
remote_engine_id - -
remote_engine_name - -
root_pid Unique identifier of the first root Job if there are several subjobs
Note: Minimum requirement is Talend Studio 7.3 R2021-02 patch and Talend Remote Engine v2.10.3.
“20210601200408_aMgz4”
source

remote-engine/id or remote-engine/id/task/id/execution/id

/remote-engine/bb733f36-f6ce-4771-8b46-86f7f77539ac/task/5f6cd065c3e872694f45c550/execution/eca2de79-5294-44e6-a573-3b8a6c33db70
step_execution_id Applicable for plans only -
task_execution_id - -
task_id - -
thread_id One of the JVM's thread UUID "40bd2dfa-47cd-4856-a96e-9784aa93a531"
workspace_id - -

The following context parameters are disabled by default, but can be enabled if needed.

  • artifact_version
  • artifact_name
  • cluster_id
  • cluster_name
  • compatibility_version (Talend Studio compatibility)
  • environment_id
  • environment_name
  • environment_version
  • plan_execution_id
  • plan_id
  • plan_name
  • plan_step_id
  • plan_step_name
  • run_type
  • task_name
  • task_version
  • trigger_timestamp
  • workspace_name