Initial definition of a Transaction Processing System (TPS) by rrschulze · Pull Request #1898 · open-telemetry/semantic-conventions

rrschulze · 2025-02-11T09:54:46Z

Changes

The PR is based on the input from the Mainframe SIG meetings and is intended to have the discussion to complete the definition of a generic Transaction Processing System. Basing on the generic TPS, we aim to finalize the span definitions for CICS and IMS.

The PR adds the following new components to the semantic conventions:
tps: Introduces new (generic) Transaction Processing System (TPS), an initial set of attributes and defines TPS spans extending the HTTP and RPC servers spans, and uses them for initial definition of server spans for the TPS CICS and IMS available on the mainframe.
ibm: Introduces ibm as name space to represent specific attributes of systems like ibm.cics and ibm.ims (aiming to align with guidance for system names described in #1708

Note: if the PR is touching an area that is not listed in the existing areas, or the area does not have sufficient domain experts coverage, the PR might be tagged as experts needed and move slowly until experts are identified.

Merge requirement checklist

CONTRIBUTING.md guidelines followed.
Change log entry added, according to the guidelines in When to add a changelog entry.
- If your PR does not need a change log, start the PR title with [chore]
schema-next.yaml updated with changes to existing conventions.

github-actions · 2025-02-27T03:21:48Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

github-actions · 2025-03-06T03:22:16Z

Closed as inactive. Feel free to reopen if this PR is still being worked on.

mtwo

We created / reviewed this within the mainframe SIG prior to submitting it here. Approving!

gshriver

Looks good to me, and matches the discussions in SIG group to this point.

.github/CODEOWNERS

joaopgrassi · 2025-03-26T09:02:12Z

docs/attributes-registry/ibm.md

+<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
+<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
+
+# Ibm


You probably want IBM here right? You can add the acronym in this file and then it should be all uppercase: https://github.com/open-telemetry/semantic-conventions/blob/main/templates/registry/markdown/weaver.yaml. Also for the other acronyms.

github-actions · 2025-04-11T03:25:07Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

github-actions · 2025-05-04T03:33:03Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

github-actions · 2025-05-12T03:32:37Z

Closed as inactive. Feel free to reopen if this PR is still being worked on.

.github/CODEOWNERS

lmolkova · 2025-05-19T19:03:17Z

model/tps/registry.yaml

+    brief: >
+      This group defines generic attributes for Transaction Processing Systems (TPS).
+    attributes:
+      - id: tps.system


should it be tps.name? TPS already has system in it.

Looking at the current spec of db and messaging, it feels inconsistent to skip 'system'. How about going with tps.system.name?

model/tps/registry.yaml

lmolkova · 2025-05-19T19:06:21Z

model/tps/registry.yaml

+      - id: tps.region.id
+        type: string
+        stability: experimental
+        brief: "Runtime environment within the Transaction Processing System"


this does not seem to match attribute name

Updated comment.

model/tps/registry.yaml

lmolkova · 2025-05-19T19:09:51Z

model/tps/registry.yaml

+        type: string
+        stability: experimental
+        brief: Determines the type of commit mode processing that IMS performs.
+        examples: ['0', '1']


should it be an enum?

lmolkova · 2025-05-19T19:10:16Z

model/tps/spans.yaml

+        requirement_level: required
+      - ref: tps.transaction.id
+        requirement_level: required
+      - ref: tps.region.id


should it be a resource attribute instead?

@lmolkova you're right about that. This needs to be identifying attribute of a tps.region entity (on z/OS). Let me take this back to the mainframe SIG.

Moving tps.region.id into a tps entity for the transaction processing system.

model/tps/spans.yaml

github-actions · 2025-06-04T03:34:43Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

…inition of the TPS server span

… in.

Co-authored-by: Liudmila Molkova <neskazu@gmail.com>

…e/semantic-conventions into rrschulze/issue1687_tps Update with suggestions on PR

github-actions · 2026-02-17T04:02:46Z

This PR has been labeled as stale due to lack of activity. It will be automatically closed if there is no further activity over the next 7 days.

rrschulze · 2026-03-09T10:52:38Z

Will discuss PR in today's Semantic Conventions SIG call.

lmolkova · 2026-03-09T15:17:13Z

model/tps/spans.yaml

+    stability: development
+    brief: 'This document defines semantic conventions for a server spans of Transaction Processing Systems'
+    note: |
+      **Span name** SHOULD be `{tps.system.name} {tps.transaction.id}`.


ptal at the span guidance - https://github.com/open-telemetry/semantic-conventions/blob/main/docs/how-to-write-conventions/README.md#naming-pattern - this is best practice, low-cardinality of a span name is arequirement

lmolkova · 2026-03-09T15:17:41Z

model/tps/spans.yaml

+      - ref: tps.program.name
+      - ref: tps.unit_of_work.id
+      - ref: tps.connection.name
+      - ref: tps.facility.type


please add error.type

lmolkova · 2026-03-09T15:18:25Z

docs/tps/spans.md

+
+**Status:** ![Development](https://img.shields.io/badge/-development-blue)
+
+This document defines semantic conventions for a server spans of Transaction Processing Systems


maybe polish this to describe what this span represents

lmolkova · 2026-03-09T15:24:15Z

docs/tps/README.md

SIG discussion:

IBM and Oracle are two systems that would implement this

Oracle is not involved at the moment

If it's unlikely to get a second system to support this (or review and bless), it's better to do ibm or mainframe-specific convention

@lmolkova we had a discussion in the Mainframe SIG. Having an ibm namespace is probably not a good idea.

there are multiple operating systems and servers sold by IBM that could create some confusion

There are multiple vendors that provide middleware and operating systems that run on the IBM servers

There is a lot of synergy between the mainframe capabilities, for example virtualization, database, transaction processing, messaging, with other server architectures
As a result, the conclusion of the sig is that the high level qualifier should be closer to the z server technology than to ibm itself.

lmolkova · 2026-03-09T15:28:34Z

model/tps/entities.yaml

+  - id: entity.tps
+    type: entity
+    stability: development
+    name: tps


nit, this would be more precise an future-proof

Suggested change

name: tps

name: tps.region

github-actions · 2026-03-28T04:03:04Z

This PR has been labeled as stale due to lack of activity. It will be automatically closed if there is no further activity over the next 7 days.

rrschulze requested review from a team as code owners February 11, 2025 09:54

rrschulze mentioned this pull request Feb 11, 2025

Initial semantic conventions for mainframes #1741

Merged

3 tasks

github-actions bot added the Stale label Feb 27, 2025

github-actions bot closed this Mar 6, 2025

lmolkova reopened this Mar 17, 2025

lmolkova removed the Stale label Mar 17, 2025

lmolkova moved this from Untriaged to Awaiting SIG approval in Semantic Conventions Triage Mar 17, 2025

mtwo approved these changes Mar 18, 2025

View reviewed changes

youngaaronm approved these changes Mar 19, 2025

View reviewed changes

gshriver approved these changes Mar 25, 2025

View reviewed changes

joaopgrassi reviewed Mar 26, 2025

View reviewed changes

.github/CODEOWNERS Show resolved Hide resolved

joaopgrassi reviewed Mar 26, 2025

View reviewed changes

lmolkova moved this from Awaiting SIG approval to Needs More Approval in Semantic Conventions Triage Mar 29, 2025

github-actions bot added the Stale label Apr 11, 2025

rrschulze requested a review from a team as a code owner April 18, 2025 04:21

rrschulze removed the Stale label Apr 18, 2025

github-actions bot added the Stale label May 4, 2025

github-actions bot closed this May 12, 2025

joaopgrassi reopened this May 12, 2025

joaopgrassi removed the Stale label May 12, 2025

rrschulze added a commit to rrschulze/semantic-conventions that referenced this pull request May 12, 2025

Removed tps.md as it belongs open-telemetry#1898

0bba38d

lmolkova reviewed May 19, 2025

View reviewed changes

github-actions bot added the Stale label Jun 4, 2025

Merge branch 'open-telemetry:main' into rrschulze/issue1687_tps

1a076ad

lmolkova removed the Stale label Jan 26, 2026

lmolkova moved this from Needs More Approval to Awaiting codeowners approval in Semantic Conventions Triage Jan 26, 2026

lmolkova reopened this Jan 26, 2026

rrschulze and others added 12 commits January 27, 2026 17:42

Merge branch 'open-telemetry:main' into rrschulze/issue1687_tps

b1105a6

Fixed yaml structure

549de7f

Clean up of dead yaml

83cf2ce

Remove TPS HTTP server spans from definition to allow for concise def…

aa0834d

…inition of the TPS server span

Clean up lint issues

0f3ef26

Added guidance for span names

a7b0f92

Updated the way how the guidance description for span names is pulled…

5d629bd

… in.

Removed trailing spaces

ef92dfe

Apply suggestions from code review

bed128c

Co-authored-by: Liudmila Molkova <neskazu@gmail.com>

Added TPS to weaver.yaml

4f9616d

Merge branch 'rrschulze/issue1687_tps' of https://github.com/rrschulz…

98c0e74

…e/semantic-conventions into rrschulze/issue1687_tps Update with suggestions on PR

Added proper headers to Hugo generated files

58338af

github-actions bot added the Stale label Feb 17, 2026

github-actions bot closed this Feb 25, 2026

lmolkova reopened this Mar 2, 2026

github-actions bot removed the Stale label Mar 3, 2026

lmolkova moved this from Awaiting codeowners approval to Needs More Approval in Semantic Conventions Triage Mar 9, 2026

lmolkova reviewed Mar 9, 2026

View reviewed changes

github-actions bot added the Stale label Mar 28, 2026


		Status: ![Development](https://img.shields.io/badge/-development-blue)

		This document defines semantic conventions for a server spans of Transaction Processing Systems

Conversation

rrschulze commented Feb 11, 2025

Changes

Merge requirement checklist

Uh oh!

github-actions bot commented Feb 27, 2025

Uh oh!

github-actions bot commented Mar 6, 2025

Uh oh!

mtwo left a comment

Choose a reason for hiding this comment

Uh oh!

gshriver left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 11, 2025

Uh oh!

github-actions bot commented May 4, 2025

Uh oh!

github-actions bot commented May 12, 2025

Uh oh!

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!

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!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Feb 17, 2026

Uh oh!

rrschulze commented Mar 9, 2026

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!

github-actions bot commented Mar 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants