Open Telemetry Feature by balhar-jakub · Pull Request #5044 · zowe/docs-site

balhar-jakub · 2026-05-27T09:20:08Z

Describe your pull request here:
Open Telemetry Feature

List the file(s) included in this PR:

After creating the PR, follow the instructions in the comments.

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

github-actions · 2026-05-27T09:20:22Z

😺 Thank you for creating this PR! To publish your content to Zowe Docs, follow these required steps.

Add the label review: doc.
Identify your content topic with a label. (Examples: area: apiml, area: cli, area: install and config, etc.)
Specify the major Zowe release(s) for your content. (Examples: release: V1, release: V2, release: V3)
- If adding content that needs to be removed from V3 documentation, add the V3 N/A tag.
Select the master branch if your PR updates content that is on the live site. Select docs-staging if your PR updates content for a future release.
Notify the Doc Squad about this PR. If you don't know whom should review your content, message the #zowe-doc Slack channel. If you know which Doc Squad writer should approve your content, add that person as a reviewer.

Need help? Contact the Doc Squad in the #zowe-doc Slack channel.

github-actions · 2026-05-27T09:20:22Z

😺 Thank you for creating this PR! To publish your content to Zowe Docs, follow these required steps.

Add the label review: doc.
Identify your content topic with a label. (Examples: area: apiml, area: cli, area: install and config, etc.)
Specify the major Zowe release(s) for your content. (Examples: release: V1, release: V2, release: V3)
- If adding content that needs to be removed from V3 documentation, add the V3 N/A tag.
Select the master branch if your PR updates content that is on the live site. Select docs-staging if your PR updates content for a future release.
Notify the Doc Squad about this PR. If you don't know whom should review your content, message the #zowe-doc Slack channel. If you know which Doc Squad writer should approve your content, add that person as a reviewer.

Need help? Contact the Doc Squad in the #zowe-doc Slack channel.

github-actions · 2026-05-27T09:20:24Z

📁 The PR description is missing the file name(s) for the updated content. List all the files included in this PR so this information displays in our Zowe Docs GitHub Slack channel.

If you have addressed this issue already, refresh this page in your browser to remove this comment.

github-actions · 2026-05-27T09:20:24Z

📁 The PR description is missing the file name(s) for the updated content. List all the files included in this PR so this information displays in our Zowe Docs GitHub Slack channel.

If you have addressed this issue already, refresh this page in your browser to remove this comment.

github-actions · 2026-05-27T09:20:25Z

📁 The PR description is missing the file name(s) for the updated content. List all the files included in this PR so this information displays in our Zowe Docs GitHub Slack channel.

If you have addressed this issue already, refresh this page in your browser to remove this comment.

github-actions · 2026-05-27T09:27:25Z

🚀 Deployed on https://6a1805338da371128e9ae569--zowe-docs-master.netlify.app

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

balhar-jakub · 2026-05-28T08:33:13Z

Do not merge this one, please.

…lly-routed-req-invalid-auth Add log signal for successfully routed requests with invalid authorization

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

…ples fix target app ref to service Id

Martin-Zeithaml · 2026-06-01T07:07:00Z

+
+* For a quick-start to configure API ML to collect observability data through OpenTelemetry, see [Quick-start Configuration of API ML Observability](../quick-start-configuration-of-apiml-observability.md).
+
+* For general information about configuration for  OpenTelemetry integration, automization of z/OS resource attribution, and architectural components for API ML observability, see [Configuring API ML Observability](../configuring-apiml-observability.md).


automization - is this expected to be atomization or automatization?

Same word used in other places too.

Martin-Zeithaml · 2026-06-01T07:09:31Z

+API ML exports OTLP-compliant telemetry signals where each payload is enriched with namespaced resource attributes. These attributes are transmitted as a flat-map structure, and adhere to OpenTelemetry Semantic Conventions—using dot-notation prefixes to establish logical hierarchies. These hierarchies facilitate analysis, filtering, and aggregation within an observability backend.
+
+:::note
+For a full list of OTel z/OS attributes for z/OS integration, see the _OpenTelemetry Semanic Conventions_ for [z/OS software](https://opentelemetry.io/docs/specs/semconv/resource/zos/).


Semanic -> Semantic?

Martin-Zeithaml · 2026-06-01T07:13:03Z

+The API ML service itself produces a range of telemetry data referred to as _signals_. A signal, defined as a discrete stream of telemetry data, is represented by any one of three types: metrics, traces, and logs.
+
+<details>
+<summary>Click here for futher details about API ML <b>Signals</b> used in OpenTelemetry.</summary>


futher -> further

Martin-Zeithaml · 2026-06-01T07:13:26Z

+* **The Provider (API ML)**  
+Captures internal events and exports them using the OTLP protocol. Details about the provider are found in the Zowe Docs documentation.
+* **The Collector**  
+A standalone service (OTel Collector) that receives, processes, and exports data. Details about the OTel Colector are found in the [OpenTelemetry documentation](https://opentelemetry.io/).


Colector or Collector?

Martin-Zeithaml · 2026-06-01T07:14:22Z

@@ -0,0 +1,36 @@
+# Understanding API ML Telemetry Signals
+
+API Mediation Layer utilizes the three core OpenTelemetry signals to provide a complete picture of your mainframe gateway’s health and performance. By combining these signals, administrators can identify high-level symptoms, and also pinpoint root causes within a specific service or address space. The follow points describe how diffent signal types apply to API ML observability:


diffent -> different?

janan07 added 30 commits January 20, 2026 11:24

create skeleton of OTel

fa3bfce

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

add titles

8b871cb

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

add initial draft of intro

11e7bbd

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

grammar fix

57ed363

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

Add content for Resource Attributes and Enabling Observability

bd31f03

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

add content to enable observability

01ca53b

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

add considerations for config service attributes

c3ac1fb

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

add req service attribute list

6af333e

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

add links to outline and reorder using section per Richard's feedback

fea7e6e

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

add details

3915103

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

initial draft of process and properties for acquiring z/OS Attributes

88763be

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

remove unneeded file

7b62f21

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

cange overview title and restructure outline

f3536e2

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

reorder attribute categories

2623606

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

add details about signals

c4c3cd2

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

add deployment attributes info

66aa80d

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

add comment

bff2796

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

Update enabling-observability-in-zowe.yaml.md

89c6c2d

refactor intro and move examples to Using OTel

98fdae4

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

add Otel install files to sidebars.js

80f1629

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

add using OTel metrics and sub-topics to sidebar

76ef864

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

fix syntax

1cc90f5

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

fix syntax

2b4459c

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

address comments

f67b276

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

add inline note to dev

d71bd68

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

refactor descriptions

38d7ae4

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

add info note for explanation

e7cc615

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

add OTel link

770f30f

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

improve note

d90a030

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

fix syntax

1ffd218

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

janan07 and others added 5 commits May 19, 2026 10:24

add interpretive statements

4a3ea88

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

address comments

581427c

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

draft with auth-status:ERROR

a5b0344

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

syntax fix

bafc156

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

removing redundant example with invalid authentication

db2202c

balhar-jakub added area: apiml This issue is related to Zowe API Mediation Layer release: V3 Zowe V3 content review: sme Needs review by an SME labels May 27, 2026

github-actions Bot temporarily deployed to pull request May 27, 2026 09:27 Inactive

janan07 and others added 2 commits May 28, 2026 10:29

refactored final statement

6eaa623

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

Merge branch 'master' into janan07/otel-feature-branch

8ddd9bf

balhar-jakub marked this pull request as draft May 28, 2026 08:33

github-actions Bot temporarily deployed to pull request May 28, 2026 08:40 Inactive

Merge pull request #5030 from zowe/janan07/2-log-signal-for-successfu…

9083867

…lly-routed-req-invalid-auth Add log signal for successfully routed requests with invalid authorization

github-actions Bot temporarily deployed to pull request May 28, 2026 08:48 Inactive

janan07 added 2 commits May 28, 2026 10:52

fix target app ref to service Id

12ce530

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

Merge pull request #5045 from zowe/janan07/fix-ref-in-log-signal-exam…

b4bb979

…ples fix target app ref to service Id

github-actions Bot temporarily deployed to pull request May 28, 2026 09:06 Inactive

Martin-Zeithaml reviewed Jun 1, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Open Telemetry Feature#5044

Open Telemetry Feature#5044
balhar-jakub wants to merge 199 commits into
masterfrom
janan07/otel-feature-branch

balhar-jakub commented May 27, 2026

Uh oh!

github-actions Bot commented May 27, 2026

Uh oh!

github-actions Bot commented May 27, 2026

Uh oh!

github-actions Bot commented May 27, 2026

Uh oh!

github-actions Bot commented May 27, 2026

Uh oh!

github-actions Bot commented May 27, 2026

Uh oh!

github-actions Bot commented May 27, 2026 •

edited

Loading

Uh oh!

balhar-jakub commented May 28, 2026

Uh oh!

Martin-Zeithaml Jun 1, 2026 •

edited

Loading

Uh oh!

Martin-Zeithaml Jun 1, 2026

Uh oh!

Martin-Zeithaml Jun 1, 2026

Uh oh!

Martin-Zeithaml Jun 1, 2026

Uh oh!

Martin-Zeithaml Jun 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants


		* For a quick-start to configure API ML to collect observability data through OpenTelemetry, see [Quick-start Configuration of API ML Observability](../quick-start-configuration-of-apiml-observability.md).

		* For general information about configuration for OpenTelemetry integration, automization of z/OS resource attribution, and architectural components for API ML observability, see [Configuring API ML Observability](../configuring-apiml-observability.md). No newline at end of file

		@@ -0,0 +1,36 @@
		# Understanding API ML Telemetry Signals

		API Mediation Layer utilizes the three core OpenTelemetry signals to provide a complete picture of your mainframe gateway’s health and performance. By combining these signals, administrators can identify high-level symptoms, and also pinpoint root causes within a specific service or address space. The follow points describe how diffent signal types apply to API ML observability:

Conversation

balhar-jakub commented May 27, 2026

Uh oh!

github-actions Bot commented May 27, 2026

Uh oh!

github-actions Bot commented May 27, 2026

Uh oh!

github-actions Bot commented May 27, 2026

Uh oh!

github-actions Bot commented May 27, 2026

Uh oh!

github-actions Bot commented May 27, 2026

Uh oh!

github-actions Bot commented May 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

balhar-jakub commented May 28, 2026

Uh oh!

Martin-Zeithaml Jun 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Martin-Zeithaml Jun 1, 2026

Choose a reason for hiding this comment

Uh oh!

Martin-Zeithaml Jun 1, 2026

Choose a reason for hiding this comment

Uh oh!

Martin-Zeithaml Jun 1, 2026

Choose a reason for hiding this comment

Uh oh!

Martin-Zeithaml Jun 1, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

github-actions Bot commented May 27, 2026 •

edited

Loading

Martin-Zeithaml Jun 1, 2026 •

edited

Loading