chore: OpenTelemetry integration test validating resource attributes by richard-salac · Pull Request #4459 · zowe/api-layer

richard-salac · 2026-01-20T15:56:27Z

Description

The Service Registration test was enhanced to run APIML Modulith with OpenTelemetry and validates the produced telemetry data contains correct values for the resource attributes, so the OpenTelemetry configuration is propagated correctly.

The validation uses docker images with OpenTelemetry Collector and Golden Tester, check the README.md.

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>

pablocarle · 2026-01-22T13:02:23Z

otel/docker-compose.yml

+    "--otlp-http-endpoint", "0.0.0.0:4318",
+    "--otlp-endpoint", "0.0.0.0:4317",
+    "--ignore-timestamp",
+    "--ignore-start-timestamp",
+    "--timeout", "3m",
+    "--ignore-resource-attribute-value", "service.instance.id",
+    "--ignore-resource-attribute-value", "host.name",
+    "--ignore-resource-attribute-value", "host.arch",
+    "--ignore-resource-attribute-value", "process.pid",
+    "--ignore-resource-attribute-value", "process.command_line",
+    "--ignore-resource-attribute-value", "process.command_args",
+    "--ignore-resource-attribute-value", "process.executable.path",
+    "--ignore-resource-attribute-value", "process.runtime.description",
+    "--ignore-resource-attribute-value", "process.runtime.version",
+    "--ignore-resource-attribute-value", "process.runtime.name",
+    "--ignore-resource-attribute-value", "os.description",
+    "--ignore-resource-attribute-value", "os.type",
+    "--ignore-resource-attribute-value", "telemetry.sdk.version",
+    "--ignore-resource-attribute-value", "telemetry.distro.name",
+    "--ignore-resource-attribute-value", "telemetry.distro.version",
+    "--ignore-resource-attribute-value", "telemetry.sdk.language",
+    "--ignore-resource-attribute-value", "telemetry.sdk.name",
+    "--ignore-resource-attribute-value", "service.version",
+    "--ignore-resource-attribute-value", "service.name",
+    "--ignore-metric-attribute-value", "service.instance.id",
+    "--ignore-metric-attribute-value", "service.version",
+    "--ignore-metric-attribute-value", "service.name",
+    "--ignore-resource-metrics-order",
+    "--ignore-scope-metrics-order",
+    "--ignore-metrics-order",
+    "--ignore-metrics-data-points-order",
+    "--ignore-metric-values",
+    "--ignore-data-points-attributes-order",
+    "--ignore-scope-version",
+    "--expected", "/var/data/expected.yaml",


I think it needs an extra indent, the YAML appears with format issues in my IDE

pablocarle · 2026-01-22T13:04:42Z

integration-tests/src/test/resources/environment-configuration.yml

    ZWE_configs_apiml_security_authorization_provider: endpoint
    # set the value to "authentication" if you want to test the sticky session load balancing
    APIML_SERVICE_CUSTOMMETADATA_APIML_LB_TYPE: headerRequest
+    OTEL_SDK_DISABLED: false


Isn't this enabling it for all integration tests?

pablocarle · 2026-01-22T13:05:25Z

.github/workflows/service-registration.yml

+                        --retry-delay 2 \
+                        --retry 10
+                    echo ""
+                    echo "curl exit code: "$?


I think this exit code will be the one from the previous echo, not curl

pablocarle · 2026-01-22T13:05:40Z

.github/workflows/service-registration.yml

+                        --retry-delay 2 \
+                        --retry 10
+                    echo ""
+                    echo "curl exit code: "$?


same about exit code

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

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

sonarqubecloud · 2026-02-13T07:43:44Z

Quality Gate failed

Failed conditions
50.6% Coverage on New Code (required ≥ 80%)
20.4% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

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

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

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

…pi-layer into reboot/feat/otel-standard

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

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

… to create a route for itself Signed-off-by: Richard Salac <richard.salac@broadcom.com>

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

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

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

Pablo Carle added 14 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

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>

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

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

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

richard-salac force-pushed the reboot/otel-golden-test-compose branch from 05e1b89 to c1a6bca Compare January 20, 2026 15:57

pull-request-size bot added size/L and removed size/XL labels Jan 20, 2026

richard-salac force-pushed the reboot/otel-golden-test-compose branch from c1a6bca to ff1a65e Compare January 20, 2026 16:01

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

richard-salac force-pushed the reboot/otel-golden-test-compose branch from ff1a65e to 9a2daff Compare January 21, 2026 13:13

richard-salac marked this pull request as ready for review January 21, 2026 14:20

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

a5e5b46

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

pablocarle reviewed Jan 22, 2026

View reviewed changes

richard-salac and others added 2 commits February 11, 2026 20:22

fix resource provider order

34baf94

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

use zos profile

19c17d5

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

pablocarle force-pushed the reboot/otel-golden-test-compose branch from f2406e6 to 55d706d Compare February 12, 2026 12:16

Pablo Carle and others added 6 commits February 13, 2026 09:36

remove job id

829b142

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

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

d6f3d06

cleanup config

628ccef

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

handle missing zos symbols

de78efa

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

Merge branch 'reboot/feat/otel-standard' of https://github.com/zowe/a…

37401eb

…pi-layer into reboot/feat/otel-standard

fix test

ae3fb11

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

richard-salac force-pushed the reboot/otel-golden-test-compose branch from 3a177c4 to 042a0e0 Compare February 13, 2026 12:57

Pablo Carle and others added 15 commits February 13, 2026 15:15

add apiml prefix for service.name

02bda92

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

read os.version from jvm properties

839bee1

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

Fix modulith service registration IT and prevent gateway and modulith…

9266353

… to create a route for itself Signed-off-by: Richard Salac <richard.salac@broadcom.com>

Enable route creation for gateway

c8296e0

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

remove unnecessary shell variable initialization

43f221d

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

OpenTelemetry integration test validating resource attributes

26ad7d0

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

cr

71429f5

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

refactor otel gh action into scripts

41d4bf2

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

tune GH IT setup

94ab59a

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

fix mount on SElinux environments

c902f45

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

improve otel docker scripts

4379f93

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

revert improve otel docker scripts

2c79733

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

add os.version to ignored otel attributes

67adc5b

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

rename yaml to yml for consistency

6f5b985

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

update expected service name

90f2a96

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

richard-salac force-pushed the reboot/otel-golden-test-compose branch from b5872f6 to 90f2a96 Compare February 17, 2026 14:11

richard-salac added 3 commits February 17, 2026 17:27

exclude rate limiter tests from modulith ha

4077065

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

add batch processing of otel data for ha setup

08d1f47

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

reduce otel batch timeout

dd069b9

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

chore: OpenTelemetry integration test validating resource attributes#4459

chore: OpenTelemetry integration test validating resource attributes#4459
richard-salac wants to merge 77 commits intov3.x.xfrom
reboot/otel-golden-test-compose

richard-salac commented Jan 20, 2026 •

edited by pablocarle

Loading

Uh oh!

pablocarle Jan 22, 2026

Uh oh!

pablocarle Jan 22, 2026

Uh oh!

pablocarle Jan 22, 2026

Uh oh!

pablocarle Jan 22, 2026

Uh oh!

sonarqubecloud bot commented Feb 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

Conversation

richard-salac commented Jan 20, 2026 • edited by pablocarle Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

Checklist:

Uh oh!

pablocarle Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

pablocarle Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

pablocarle Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

pablocarle Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Feb 13, 2026

Quality Gate failed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

richard-salac commented Jan 20, 2026 •

edited by pablocarle

Loading