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

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

Signed-off-by: Richard Salac <richard.salac@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

pablocarle · 2026-01-22T13:06:33Z

.github/workflows/service-registration.yml

+                    docker stop collector -t 60
+
+                    echo "Collector container logs:"
+                    docker logs collector


Should it save it as a file to be picked up by the Store results otel/** filter?

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

sonarqubecloud · 2026-01-23T10:45:20Z

Quality Gate passed

Issues
0 New issues
1 Accepted issue

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

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

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

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

… into reboot/otel-golden-test-compose

richard-salac added 4 commits January 20, 2026 12:41

Fix modulith service registration IT and prevent gateway and modulith…

1f723d1

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

Enable route creation for gateway

b8a5dc7

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

fix sonar

0fb8de0

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

Merge branch 'v3.x.x' into reboot/fix_modulith_service_registration_it

db9aadf

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

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

pablocarle reviewed Jan 22, 2026

View reviewed changes

richard-salac force-pushed the reboot/otel-golden-test-compose branch 11 times, most recently from e6ab157 to e88917c Compare January 22, 2026 15:30

richard-salac force-pushed the reboot/otel-golden-test-compose branch 2 times, most recently from 22bbbd5 to ddd5ed4 Compare January 23, 2026 09:17

richard-salac added 2 commits January 23, 2026 10:39

remove unnecessary shell variable initialization

454c776

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

Merge branch 'v3.x.x' into reboot/fix_modulith_service_registration_it

48bf959

richard-salac force-pushed the reboot/otel-golden-test-compose branch 2 times, most recently from 392a024 to f8167a5 Compare January 23, 2026 09:48

achmelo and others added 2 commits January 23, 2026 11:28

OpenTelemetry integration test validating resource attributes

4f75023

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

cr

02faf4b

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

richard-salac force-pushed the reboot/otel-golden-test-compose branch from f8167a5 to 02faf4b Compare January 23, 2026 10:28

richard-salac added 5 commits February 3, 2026 15:08

refactor otel gh action into scripts

0023bbe

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

Merge branch 'v3.x.x' into reboot/otel-golden-test-compose

115e634

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

Merge branch 'v3.x.x' into reboot/otel-golden-test-compose

4176b4c

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

Merge remote-tracking branch 'origin/reboot/otel-golden-test-compose'…

eb8660c

… into reboot/otel-golden-test-compose

Merge branch 'v3.x.x' into reboot/otel-golden-test-compose

9b8998f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: OpenTelemetry integration test validating resource attributes#4459

chore: OpenTelemetry integration test validating resource attributes#4459
richard-salac wants to merge 13 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!

pablocarle Jan 22, 2026

Uh oh!

sonarqubecloud bot commented Jan 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

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!

pablocarle Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Jan 23, 2026

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

richard-salac commented Jan 20, 2026 •

edited by pablocarle

Loading