feat: OpenTelemetry standard attributes #4456

richard-salac · 2026-02-02T16:12:28Z

yes, it's a matter of deciding if it should be part of the default namespace for instance. What do you think?

I think we should remove it form here.

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

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.

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

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"?

richard-salac · 2026-02-02T16:28:31Z

We are missing the service.instance.id fallback. Or are we ok with the generated uuid?

I thought we were ok with the generated one. If we go the fallback route, we need to define some boolean to let the user decide.

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

richard-salac · 2026-02-02T16:31:02Z

Does this bring additional value over having only the service.name if no namespace is provided?

This is simply my suggestion to have defaults that make sense. It's open to suggestions. I expect most users will set these two values.

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.

The default namespace should be more of a corner case rather than the norm. We should aim at users configuring a namespace always with meaning in the configuration if they enable OpenTelemetry.
I agree it doesn't have value as it is over the service name, but we need to have a default nonetheless.
How about adding the environmentName value as a prefix?

-Original file line number
+Diff line change
@@ Expand Up / @@ -8,6 +8,7 @@ dependencies { @@
         implementation libs.spring.boot.starter.actuator
         implementation libs.spring.boot.starter.web
         implementation libs.spring.cloud.starter.eureka.client
+        implementation libs.opentelemetry.spring.boot.starter
         compileOnly libs.netty.reactor.http
         implementation libs.eureka.core
@@ Expand Down @@

-Original file line number
+Diff line change
@@ -0,0 +1,29 @@
+    /*
+     * This program and the accompanying materials are made available under the terms of the
+     * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+     * https://www.eclipse.org/legal/epl-v20.html
+     *
+     * SPDX-License-Identifier: EPL-2.0
+     *
+     * Copyright Contributors to the Zowe Project.
+     */
+    package org.zowe.apiml.product.opentelemetry;
+    import io.opentelemetry.api.common.Attributes;
+    import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
+    import org.springframework.stereotype.Component;
+    import javax.annotation.Nonnull;
+    @ConditionalOnExpression("#{!T(org.zowe.apiml.product.zos.ZosSystemInformation).isRunningOnZos()}")
+    @Component
+    public class ApimlNonZosOpenTelemetryResourceProvider extends ApimlOpenTelemetryResourceProvider {
+        @Override
+        @Nonnull
+        public Attributes calculateAttributes() {
+            return Attributes.empty();
+        }
+    }

-Original file line number
+Diff line change
@@ -0,0 +1,32 @@
+    /*
+     * This program and the accompanying materials are made available under the terms of the
+     * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+     * https://www.eclipse.org/legal/epl-v20.html
+     *
+     * SPDX-License-Identifier: EPL-2.0
+     *
+     * Copyright Contributors to the Zowe Project.
+     */
+    package org.zowe.apiml.product.opentelemetry;
+    import io.opentelemetry.api.common.Attributes;
+    import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
+    import io.opentelemetry.sdk.autoconfigure.spi.ResourceProvider;
+    import io.opentelemetry.sdk.resources.Resource;
+    import javax.annotation.Nonnull;
+    public abstract class ApimlOpenTelemetryResourceProvider implements ResourceProvider {
+        public abstract @Nonnull Attributes calculateAttributes();
+        @Override
+        public Resource createResource(@Nonnull ConfigProperties config) {
+            var attributesBuilder = Attributes.builder();
+            attributesBuilder.putAll(calculateAttributes());
+            return Resource.create(attributesBuilder.build());
+        }
+    }

-Original file line number
+Diff line change
@@ -0,0 +1,147 @@
+    /*
+     * This program and the accompanying materials are made available under the terms of the
+     * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+     * https://www.eclipse.org/legal/epl-v20.html
+     *
+     * SPDX-License-Identifier: EPL-2.0
+     *
+     * Copyright Contributors to the Zowe Project.
+     */
+    package org.zowe.apiml.product.opentelemetry;
+    import io.opentelemetry.api.common.Attributes;
+    import jakarta.annotation.PostConstruct;
+    import lombok.RequiredArgsConstructor;
+    import lombok.extern.slf4j.Slf4j;
+    import org.apache.commons.lang3.StringUtils;
+    import org.springframework.beans.factory.annotation.Value;
+    import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+    import org.springframework.stereotype.Component;
+    import org.zowe.apiml.product.zos.ZosSystemInformation;
+    import javax.annotation.Nonnull;
+    import java.util.Map;
+    import java.util.Optional;
+    import static org.zowe.apiml.product.zos.ZosSystemInformation.ZOS_JOB_ID;
+    import static org.zowe.apiml.product.zos.ZosSystemInformation.ZOS_JOB_NAME;
+    import static org.zowe.apiml.product.zos.ZosSystemInformation.ZOS_SYSCLONE;
+    import static org.zowe.apiml.product.zos.ZosSystemInformation.ZOS_SYSNAME;
+    import static org.zowe.apiml.product.zos.ZosSystemInformation.ZOS_SYSPLEX;
+    import static org.zowe.apiml.product.zos.ZosSystemInformation.ZOS_USER_ID;
+    @Component
+    @RequiredArgsConstructor
+    @ConditionalOnMissingBean(ApimlNonZosOpenTelemetryResourceProvider.class)
+    @Slf4j
+    public class ApimlZosOpenTelemetryResourceProvider extends ApimlOpenTelemetryResourceProvider {
+        private final ZosSystemInformation zosSystemInformation;
+        @Value("${otel.resource.attributes.deployment.environment.name:#{null}}")
+        private String environmentName;
+        @Value("${otel.resource.attributes.service.namespace:#{null}}")
+        private String serviceNamespace;
+        @Value("${otel.resource.attributes.service.name:#{null}}")
+        private String serviceName;
+        @Value("${apiml.service.apimlId:#{null}}")
+        private String apimlId;
+        @Value("${apiml.service.port:10010}")
+        private int port;
+        @Value("${otel.resource.attributes.zos.sysplex.name:#{null}}")
+        private String sysplexName;
+        @Value("${otel.resource.attributes.mainframe.lpar.name:#{null}}")
+        private String lparName;
+        @Value("${otel.resource.attributes.zos.smf.id:#{null}}")
+        private String smfId;
+        @PostConstruct
+        void afterPropertiesSet() {
+            log.debug("Using ZOS OpenTelemetry resource provider");
+        }
+        @SuppressWarnings("null")
+        @Override
+        @Nonnull
+        public Attributes calculateAttributes() {
+            var attributesBuilder = Attributes.builder();
+            var zosAttributes = zosSystemInformation.get();
+            if (StringUtils.isBlank(serviceNamespace)) {
+                var generatedDefaultNamespace = generateServiceNamespace(zosAttributes);
+                attributesBuilder.put("service.namespace", generatedDefaultNamespace);
+                log.debug("service.namespace not provided in configuration, using generated default {}", generatedDefaultNamespace);
+            }
+            if (StringUtils.isBlank(serviceName)) {
+                var generatedServiceName = generateServiceName(zosAttributes);
+                attributesBuilder.put("service.name", generatedServiceName);
+                log.debug("service.name not provided in configuration, using generated default {}", generatedServiceName);
+            }
+            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");
+                }
+            }
+            Optional.ofNullable(zosAttributes.get(ZOS_JOB_ID))
+                .map(String::valueOf)
+                .filter(StringUtils::isNotBlank)
+                .ifPresent(zosJobId -> attributesBuilder.put(ZosAttributes.ZOS_JOBID, zosJobId));
+            Optional.ofNullable(zosAttributes.get(ZOS_JOB_NAME))
+                .map(String::valueOf)
+                .filter(StringUtils::isNotBlank)
+                .ifPresent(zosJobName -> attributesBuilder.put(ZosAttributes.ZOS_JOBNAME, zosJobName));
+            Optional.ofNullable(zosAttributes.get(ZOS_USER_ID))
+                .map(String::valueOf)
+                .filter(StringUtils::isNotBlank)
+                .ifPresent(zosUserId -> attributesBuilder.put(ZosAttributes.ZOS_USERID, zosUserId));
+            return attributesBuilder.build();
+        }
+        private String generateServiceName(Map<String,Object> zosAttributes) {
+            var systemName = StringUtils.isBlank(apimlId) ? zosAttributes.get(ZOS_SYSPLEX) : apimlId;
+            return systemName + ":" + port;
+        }
+        private String generateServiceNamespace(Map<String,Object> zosAttributes) {
+            return "apiml:" + generateServiceName(zosAttributes);
+        }
+    }

-Original file line number
+Diff line change
@@ -0,0 +1,22 @@
+    /*
+     * This program and the accompanying materials are made available under the terms of the
+     * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+     * https://www.eclipse.org/legal/epl-v20.html
+     *
+     * SPDX-License-Identifier: EPL-2.0
+     *
+     * Copyright Contributors to the Zowe Project.
+     */
+    package org.zowe.apiml.product.opentelemetry;
+    /**
+     * Set of attributes set by API ML
+     */
+    public class ZosAttributes {
+        public static final String ZOS_JOBNAME = "process.zos.jobname";
+        public static final String ZOS_USERID = "process.zos.userid";
+        public static final String ZOS_JOBID = "process.zos.jobid";
+    }

-Original file line number
+Diff line change
@@ -0,0 +1,44 @@
+    /*
+     * This program and the accompanying materials are made available under the terms of the
+     * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+     * https://www.eclipse.org/legal/epl-v20.html
+     *
+     * SPDX-License-Identifier: EPL-2.0
+     *
+     * Copyright Contributors to the Zowe Project.
+     */
+    package org.zowe.apiml.product.opentelemetry;
+    import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
+    import org.junit.jupiter.api.BeforeEach;
+    import org.junit.jupiter.api.Test;
+    import org.junit.jupiter.api.extension.ExtendWith;
+    import org.mockito.junit.jupiter.MockitoExtension;
+    import static org.junit.jupiter.api.Assertions.assertTrue;
+    import static org.mockito.Mockito.mock;
+    @ExtendWith(MockitoExtension.class)
+    class ApimlNonZosOpenTelemetryResourceProviderTest {
+        private ApimlNonZosOpenTelemetryResourceProvider resourceProvider;
+        @BeforeEach
+        void setUp() {
+            this.resourceProvider = new ApimlNonZosOpenTelemetryResourceProvider();
+        }
+        @Test
+        void testCalculateAttributes() {
+            var result = resourceProvider.calculateAttributes();
+            assertTrue(result.isEmpty());
+        }
+        @Test
+        void testCreateResource() {
+            var result = resourceProvider.createResource(mock(ConfigProperties.class));
+            assertTrue(result.getAttributes().isEmpty());
+        }
+    }

-Original file line number
+Diff line change
@@ -0,0 +1,72 @@
+    /*
+     * This program and the accompanying materials are made available under the terms of the
+     * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+     * https://www.eclipse.org/legal/epl-v20.html
+     *
+     * SPDX-License-Identifier: EPL-2.0
+     *
+     * Copyright Contributors to the Zowe Project.
+     */
+    package org.zowe.apiml.product.opentelemetry;
+    import org.junit.jupiter.api.BeforeEach;
+    import org.junit.jupiter.api.Nested;
+    import org.junit.jupiter.api.Test;
+    import org.junit.jupiter.api.extension.ExtendWith;
+    import org.mockito.Mock;
+    import org.mockito.junit.jupiter.MockitoExtension;
+    import org.springframework.test.util.ReflectionTestUtils;
+    import org.zowe.apiml.product.zos.ZosSystemInformation;
+    import java.util.Map;
+    import static io.opentelemetry.api.common.AttributeKey.stringKey;
+    import static org.junit.jupiter.api.Assertions.assertEquals;
+    import static org.junit.jupiter.api.Assertions.assertFalse;
+    import static org.junit.jupiter.api.Assertions.assertNull;
+    import static org.mockito.Mockito.when;
+    @ExtendWith(MockitoExtension.class)
+    class ApimlZosOpenTelemetryResourceProviderTest {
+        @Mock
+        private ZosSystemInformation zosSystemInformation;
+        private ApimlZosOpenTelemetryResourceProvider resourceProvider;
+        @BeforeEach
+        void setUp() {
+            resourceProvider = new ApimlZosOpenTelemetryResourceProvider(zosSystemInformation);
+            ReflectionTestUtils.setField(resourceProvider, "port", 10010);
+        }
+        @Nested
+        class GivenZosAttributes {
+            @Test
+            void testCalculateAttributes() {
+                when(zosSystemInformation.get()).thenReturn(Map.of(
+                    "zos.jobid", "JOB12345",
+                    "zos.jobname", "JOBN12",
+                    "zos.userid", "ZWEUSR",
+                    "zos.pid", 123456,
+                    "zos.sysname", "SYSA",
+                    "zos.sysclone", "16",
+                    "zos.sysplex", "PLEX1"
+                ));
+                var attributes = resourceProvider.calculateAttributes();
+                assertFalse(attributes.isEmpty());
+                assertNull(attributes.get(stringKey("mainframe.lpar.name")));
+                assertEquals("JOB12345", attributes.get(stringKey("process.zos.jobid")));
+                assertEquals("JOBN12", attributes.get(stringKey("process.zos.jobname")));
+                assertEquals("ZWEUSR", attributes.get(stringKey("process.zos.userid")));
+                assertEquals("apiml:PLEX1:10010", attributes.get(stringKey("service.namespace")));
+                assertEquals("PLEX1:10010", attributes.get(stringKey("service.name")));
+            }
+        }
+    }

feat: OpenTelemetry standard attributes #4456

Are you sure you want to change the base?

Uh oh!

feat: OpenTelemetry standard attributes #4456

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

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!

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!

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!