feat: OpenTelemetry standard attributes by pablocarle · Pull Request #4456 · zowe/api-layer

pablocarle · 2026-01-16T12:56:05Z

Description

Implementation of required / additional / recommended properties for base signals from APIML OpenTelemetry implementation with defaults.

Linked to # (issue)
Part of the # (epic)

Type of change

feat: New feature (non-breaking change which adds functionality)

Checklist:

My code follows the style guidelines of this project
PR title conforms to commit message guideline ## Commit Message Structure Guideline
I have commented my code, particularly in hard-to-understand areas. In JS I did provide JSDoc
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
The java tests in the area I was working on leverage @nested annotations
Any dependent changes have been merged and published in downstream modules

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

…andard

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

…andard

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

…andard

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

…andard

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

…andard Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

Signed-off-by: Richard Salac <richard.salac@broadcom.com>

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

…andard Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

…andard

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

…andard

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

…andard

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

apiml/src/test/resources/application.yml

apiml/src/test/java/org/zowe/apiml/acceptance/OpenTelemetryMetricsTests.java

richard-salac · 2026-02-02T15:33:34Z

apiml/src/test/java/org/zowe/apiml/acceptance/OpenTelemetryMetricsTests.java

+                    assertEquals("zos", attributes.get(stringKey("os.type")));
+                    assertEquals("STC1111", attributes.get(stringKey("process.zos.jobid")));
+                    assertEquals("ZWE1AG", attributes.get(stringKey("process.zos.jobname")));
+                    assertEquals("gateway", attributes.get(stringKey("service.name")));
+                    assertEquals("apiml:apiml1:40985", attributes.get(stringKey("service.namespace")));
+                    assertNotNull(attributes.get(stringKey("service.version")));


The os.name is set before but not validated.

What do you mean? This validates the attributes we set, os.name is part of the default implementation. If we want to test those I'd add them to the default integration test, otherwise we'd be testing a feature of the core library

On line 60 the os.name is set in the static initializer (and then again in BeforeAll on line 68), and populated to resource attributes on line 123. But never asserted. Hence you assert os.type. I thought this is to test overrides - what happens if we set a property automatically discovered by the OpenTelemetry SDK

os.name is set simply to force the use of the Zos spring bean. In this case sure, I can set any otel. resource property and assert it. I'll add one or two to cover for it, but we are basically using Spring's default for those

You are absolutely right and I missed that it is set to trigger the z/os attributes provider.

apiml/src/test/java/org/zowe/apiml/acceptance/OpenTelemetryMetricsTests.java

apiml-common/src/main/java/org/zowe/apiml/product/opentelemetry/ZosAttributes.java

richard-salac · 2026-02-02T16:47:25Z

apiml-utility/src/main/java/org/zowe/apiml/product/zos/ZosSystemInformation.java

+    }
+
+    public Map<String, Object> get() {
+        return Map.of(


Can we somehow get the address space id?

Not with this interface, needs research

any progress? Does maybe launcher provides it? If not just leave a note it and close the conversation

not really, I don't see in the launcher code that refers to the address space ID. It's only using USS environment variables to control some address space related things.
We should create a work item to follow up on this if we deem it important.

apiml-package/src/main/resources/bin/start.sh

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

…andard

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

sonarqubecloud · 2026-02-04T09:27:23Z

Quality Gate failed

Failed conditions
47.5% Coverage on New Code (required ≥ 80%)
23.8% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

apiml/src/test/resources/application.yml

gateway-service/src/test/resources/application.yml

richard-salac · 2026-02-05T12:37:41Z

apiml-utility/src/main/java/org/zowe/apiml/product/zos/ZosSystemInformation.java

+    }
+
+    public Map<String, Object> get() {
+        return Map.of(


any progress? Does maybe launcher provides it? If not just leave a note it and close the conversation

richard-salac · 2026-02-05T12:43:01Z

...rc/main/java/org/zowe/apiml/product/opentelemetry/ApimlZosOpenTelemetryResourceProvider.java

+    private String generateServiceNamespace(Map<String,Object> zosAttributes) {
+        return "apiml:" + generateServiceName(zosAttributes);
+    }
+


I don't think it makes sense when it is only service name with a prefix. Then it has no additional value over the service name in therm of identifying the installation.

richard-salac · 2026-02-05T12:44:26Z

...rc/main/java/org/zowe/apiml/product/opentelemetry/ApimlZosOpenTelemetryResourceProvider.java

+        Optional.ofNullable(zosAttributes.get(ZOS_USER_ID)).map(String::valueOf)
+            .ifPresent(zosUserId -> attributesBuilder.put("process.zos.userid", zosUserId));
+
+        return attributesBuilder.build();


Ok, I got the impression that you prefer the lpar+port over the uuid.

richard-salac · 2026-02-05T12:45:00Z

...rc/main/java/org/zowe/apiml/product/opentelemetry/ApimlZosOpenTelemetryResourceProvider.java

+    private final ZosSystemInformation zosSystemInformation;
+
+    @Value("${otel.resource.attributes.deployment.environment.name:#{null}}")
+    private String environmentName;


I think we should remove it form here.

apiml-package/src/main/resources/bin/start.sh

richard-salac · 2026-02-05T12:55:13Z

...rc/main/java/org/zowe/apiml/product/opentelemetry/ApimlZosOpenTelemetryResourceProvider.java

+        Optional.ofNullable(zosAttributes.get(ZOS_JOB_ID))
+            .map(String::valueOf)
+            .filter(StringUtils::isNotBlank)
+            .ifPresent(zosJobId -> attributesBuilder.put(ZosAttributes.ZOS_JOBID, zosJobId));


The constant naming is confusing: ZOS_JOB_ID vs ZOS_JOBID
and similarly for some others

I can rename them, but they are different values anyway, one is zos.jobid from the system information and the other one is process.zos.jobid for the target OpenTelemetry attribute

It is confusing, as you say they mean something totally different and yet named so similarly. Maybe "OTEL_ZOS_JOBNAME" or "OtelZosAttributes.ZOS_JOBNAME"?

...rc/main/java/org/zowe/apiml/product/opentelemetry/ApimlZosOpenTelemetryResourceProvider.java

richard-salac · 2026-02-05T13:06:59Z

...rc/main/java/org/zowe/apiml/product/opentelemetry/ApimlZosOpenTelemetryResourceProvider.java

+        if (StringUtils.isBlank(sysplexName)) {
+            var sysplexName = zosAttributes.get(ZOS_SYSPLEX);
+            if (sysplexName != null && StringUtils.isNotBlank(sysplexName.toString())) {
+                log.debug("zos.sysplex.name not provided in configuration, using system-obtained {}", sysplexName);
+            } else {
+                log.debug("zos.sysplex.name not provided in configuration. Could not determine name from system");
+            }
+        }
+
+        if (StringUtils.isBlank(lparName)) {
+            var lparName = zosAttributes.get(ZOS_SYSNAME);
+            if (lparName != null && StringUtils.isNotBlank(lparName.toString())) {
+                log.debug("mainframe.lpar.name not provided in configuration, using system-obtained {}", lparName);
+            } else {
+                log.debug("mainframe.lpar.name not provided in configuration. Could not determine name from system");
+            }
+        }
+
+        if (StringUtils.isBlank(smfId)) {
+            var smfId = zosAttributes.get(ZOS_SYSCLONE);
+            if (smfId != null && StringUtils.isNotBlank(smfId.toString())) {
+                log.debug("zos.smf.id not provided in configuration, using system-obtained {}", smfId);
+            } else {
+                log.debug("zos.smf.id not provided in configuration. Could not determine ID from system");
+            }
+        }


They are checked for value but never set to the attributes.

I added these only to show in the logs if such overrides are happening, if there's no value in the logs we can remove it. We don't need to explicitly set them because they are otel.* properties which are automatically picked up by OpenTelemetry implementation.

Regardless it is configured or discovered, they are not set in resource attributes and are not present in the exported data.

Pablo Carle added 7 commits January 14, 2026 13:20

deprecate onboarding-enabler zutil, move to apiml-utility

bcee5f4

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

Merge remote-tracking branch 'origin/v3.x.x' into reboot/feat/otel-st…

0e0b568

…andard

Merge remote-tracking branch 'origin' into reboot/feat/otel-standard

5243473

initial commit

4fbb002

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

Merge remote-tracking branch 'origin/v3.x.x' into reboot/feat/otel-st…

1acb61c

…andard

wip add calculated attributes

2d03079

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

Merge remote-tracking branch 'origin/v3.x.x' into reboot/feat/otel-st…

976bb8b

…andard

github-project-automation bot added this to API Mediation Layer Backlog Management Jan 16, 2026

github-project-automation bot moved this to New in API Mediation Layer Backlog Management Jan 16, 2026

pull-request-size bot added the size/XL label Jan 16, 2026

Pablo Carle added 8 commits January 16, 2026 16:57

wip testing

46fb08b

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

Merge remote-tracking branch 'origin/v3.x.x' into reboot/feat/otel-st…

7d12592

…andard

compile issue

1fa20d2

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

add defaults

06206ef

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

otel test wip

d9d2541

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

test works

d0e1967

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

test data is empty

9fa1332

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

attempts to have acceptance tests working

245a277

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

EvaJavornicka moved this from New to In Progress in API Mediation Layer Backlog Management Jan 21, 2026

Merge remote-tracking branch 'origin/v3.x.x' into reboot/feat/otel-st…

a5e5b46

…andard Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

This comment was marked as off-topic.

Sign in to view

pablocarle and others added 9 commits January 22, 2026 14:19

Merge branch 'v3.x.x' into reboot/feat/otel-standard

a65086e

InMemoryMetricReader for tests

014845a

Signed-off-by: Richard Salac <richard.salac@broadcom.com>

rename test, update structure

c42575e

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

add unit tests

07054ca

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

wip

f6dfe77

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

Merge remote-tracking branch 'origin/v3.x.x' into reboot/feat/otel-st…

92f6300

…andard Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

Merge remote-tracking branch 'origin/v3.x.x' into reboot/feat/otel-st…

c342fc4

…andard

fix for acceptance test

94c9370

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

Merge remote-tracking branch 'origin/v3.x.x' into reboot/feat/otel-st…

753c7c1

…andard

pablocarle and others added 6 commits January 27, 2026 15:06

Merge branch 'v3.x.x' into reboot/feat/otel-standard

f4c4416

unit test

1015c38

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

Merge branch 'v3.x.x' into reboot/feat/otel-standard

1e2b2fc

complete functional test

a8be34c

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

remove standard attribute from test

86094cb

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

Merge branch 'v3.x.x' into reboot/feat/otel-standard

8dd9c79

pablocarle requested a review from richard-salac January 28, 2026 08:55

attempt to fix otel settings start.sh

49520e1

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

pablocarle marked this pull request as ready for review January 28, 2026 09:39

Pablo Carle and others added 6 commits January 29, 2026 15:31

Merge remote-tracking branch 'origin/v3.x.x' into reboot/feat/otel-st…

68680c3

…andard

add unit test

a667103

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

fix merge issue

ba4e739

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

Merge branch 'v3.x.x' into reboot/feat/otel-standard

f80fba5

Merge branch 'v3.x.x' into reboot/feat/otel-standard

c7c98ba

Merge branch 'v3.x.x' into reboot/feat/otel-standard

ed9c5c3

richard-salac reviewed Feb 2, 2026

View reviewed changes

Pablo Carle added 4 commits February 3, 2026 09:36

pr review 1

ca9d625

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

use attributes, add exporter settings

05b870d

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

fix for blank otel properties in start.sh

80874a4

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

add zos attributes

5c70cf5

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

pull-request-size bot added size/XXL and removed size/XL labels Feb 3, 2026

Pablo Carle added 2 commits February 4, 2026 10:08

Merge remote-tracking branch 'origin/v3.x.x' into reboot/feat/otel-st…

0a4a818

…andard

add comment

1991a26

Signed-off-by: Pablo Carle <pablo.carle@broadcom.com>

richard-salac reviewed Feb 5, 2026

View reviewed changes

Conversation

pablocarle commented Jan 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

Checklist:

Uh oh!

This comment was marked as off-topic.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Feb 4, 2026

Quality Gate failed

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

pablocarle commented Jan 16, 2026 •

edited

Loading