forked from open-telemetry/semantic-conventions
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add initial Mainframe Semantic Conventions
Fixes open-telemetry#1687
- Loading branch information
Showing
16 changed files
with
1,091 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <!--- Hugo front matter used to generate the website version of this page: | ||
| ---> | ||
|
|
||
| <!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/attribute_namespace.md.j2 --> | ||
|
|
||
| # Mainframe | ||
|
|
||
| ## Mainframe LPAR attributes | ||
|
|
||
| This document defines attributes of a Mainframe Logical Partition (LPAR). | ||
|
|
||
| | Attribute | Type | Description | Examples | Stability | | ||
| |---|---|---|---|---| | ||
| | <a id="mainframe-lpar-name" href="#mainframe-lpar-name">`mainframe.lpar.name`</a> | string | Name of the logical partition that hosts a systems with a mainframe operating system. | `LPAR01` |  | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| <!--- Hugo front matter used to generate the website version of this page: | ||
| ---> | ||
|
|
||
| <!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/attribute_namespace.md.j2 --> | ||
|
|
||
| # Tps | ||
|
|
||
| - [Transaction Processing System Attributes](#transaction-processing-system-attributes) | ||
| - [IBM Information Management System (IMS) Attributes](#ibm-information-management-system-ims-attributes) | ||
|
|
||
| ## Transaction Processing System Attributes | ||
|
|
||
| This group defines generic attributes for Transaction Processing Systems (TPS). | ||
|
|
||
| | Attribute | Type | Description | Examples | Stability | | ||
| |---|---|---|---|---| | ||
| | <a id="tps-program-name" href="#tps-program-name">`tps.program.name`</a> | string | Program name executed by the task | `PROG123` |  | | ||
| | <a id="tps-region-id" href="#tps-region-id">`tps.region.id`</a> | string | Runtime environment within the Transaction Processing System | `PRD1` |  | | ||
| | <a id="tps-system" href="#tps-system">`tps.system`</a> | string | Type of Transaction Processing System | `jta`; `tuxedo`; `cics`; `ims`; `ztpf` |  | | ||
| | <a id="tps-task-id" href="#tps-task-id">`tps.task.id`</a> | string | Identifier of the task created to run the transaction | `1554` |  | | ||
| | <a id="tps-transaction-id" href="#tps-transaction-id">`tps.transaction.id`</a> | string | Identifier of the transaction initiated by a user or system request | `TRX1` |  | | ||
| | <a id="tps-transaction-owner" href="#tps-transaction-owner">`tps.transaction.owner`</a> | string | Identifier of the user owning the transaction | `USER` |  | | ||
| | <a id="tps-unit-of-work-id" href="#tps-unit-of-work-id">`tps.unit_of_work.id`</a> | string | Unit of work executed by the program | `DF308CBF385A3C05` |  | | ||
|
|
||
| ## IBM Information Management System (IMS) Attributes | ||
|
|
||
| This group defines attributes for IBM Information Management System (IMS) for z/OS | ||
|
|
||
| | Attribute | Type | Description | Examples | Stability | | ||
| |---|---|---|---|---| | ||
| | <a id="tps-ims-commit-mode" href="#tps-ims-commit-mode">`tps.ims.commit_mode`</a> | string | Determines the type of commit mode processing that IMS performs. | `0`; `1` |  | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <!--- Hugo front matter used to generate the website version of this page: | ||
| ---> | ||
|
|
||
| <!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/attribute_namespace.md.j2 --> | ||
|
|
||
| # Zos | ||
|
|
||
| ## z/OS attributes | ||
|
|
||
| This document defines attributes of a z/OS resource. | ||
|
|
||
| | Attribute | Type | Description | Examples | Stability | | ||
| |---|---|---|---|---| | ||
| | <a id="zos-smf-id" href="#zos-smf-id">`zos.smf.id`</a> | string | The System Management Facility (SMF) Identifier uniquely identified a z/OS system within a SYSPLEX or mainframe environment and is used for system and performance analysis. | `SYS1` |  | | ||
| | <a id="zos-sysplex" href="#zos-sysplex">`zos.sysplex`</a> | string | The name of the SYSPLEX to which the z/OS system belongs too. | `SYSPLEX1` |  | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| <!-- semconv resource.zos.software --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-capture --> | ||
| <!-- markdownlint-disable --> | ||
|
|
||
|
|
||
| **Status:**  | ||
|
|
||
| **type:** `zos.software` | ||
|
|
||
| **Description:** A software resource running on a z/OS system. | ||
|
|
||
| | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | | ||
| |---|---|---|---|---|---| | ||
| | [`os.type`](/docs/attributes-registry/os.md) | string | The operating system type. | `z_os` | `Required` |  | | ||
| | [`process.command`](/docs/attributes-registry/process.md) | string | The command used to launch the process (i.e. the command name). On z/OS, SHOULD be set to the name of the job used to start the z/OS system software. | `CICSSTRT` | `Required` |  | | ||
| | [`process.pid`](/docs/attributes-registry/process.md) | int | Process identifier (PID). [1] | `008A` | `Required` |  | | ||
| | [`service.instance.id`](/docs/attributes-registry/service.md) | string | The string ID of the service instance. [2] | `CICSPROD` | `Required` |  | | ||
| | [`service.name`](/docs/attributes-registry/service.md) | string | Logical name of the service. [3] | `CICS TS`; `Datacom`; `ADABAS` | `Required` |  | | ||
| | [`service.namespace`](/docs/attributes-registry/service.md) | string | A namespace for `service.name`. [4] | `CICSPLX2` | `Required` |  | | ||
| | [`service.version`](/docs/attributes-registry/service.md) | string | The version string of the service API or implementation. The format is not defined by these conventions. [5] | `5.6` | `Required` |  | | ||
| | [`zos.smf.id`](/docs/attributes-registry/zos.md) | string | The System Management Facility (SMF) Identifier uniquely identified a z/OS system within a SYSPLEX or mainframe environment and is used for system and performance analysis. | `SYS1` | `Required` |  | | ||
| | [`zos.sysplex`](/docs/attributes-registry/zos.md) | string | The name of the SYSPLEX to which the z/OS system belongs too. | `SYSPLEX1` | `Required` |  | | ||
| | [`host.arch`](/docs/attributes-registry/host.md) | string | The CPU architecture the host system is running on. | `s390x` | `Recommended` |  | | ||
| | [`host.name`](/docs/attributes-registry/host.md) | string | Name of the host. On z/OS, SHOULD be the full qualified hostname used to register the z/OS system in DNS. | `SYS1.DOMAIN.COM` | `Recommended` |  | | ||
| | [`mainframe.lpar.name`](/docs/attributes-registry/mainframe.md) | string | Name of the logical partition that hosts a systems with a mainframe operating system. | `LPAR01` | `Recommended` |  | | ||
| | [`os.version`](/docs/attributes-registry/os.md) | string | The version string of the operating system. On z/OS, SHOULD be the release returned by the command `d iplinfo`. | `3.1.0` | `Recommended` |  | | ||
| | [`telemetry.sdk.language`](/docs/attributes-registry/telemetry.md) | string | The language of the telemetry SDK. | `cpp`; `dotnet`; `erlang` | `Recommended` |  | | ||
| | [`telemetry.sdk.name`](/docs/attributes-registry/telemetry.md) | string | The name of the telemetry SDK as defined above. [6] | `opentelemetry` | `Recommended` |  | | ||
| | [`telemetry.sdk.version`](/docs/attributes-registry/telemetry.md) | string | The version string of the telemetry SDK. | `1.2.3` | `Recommended` |  | | ||
| | [`host.id`](/docs/attributes-registry/host.md) | string | Unique host ID. On z/OS, SHOULD be the concatenation of sysplex name and SMFID, separated by a dash | `SYSPLEX1-SYS1` | `Opt-In` |  | | ||
| | [`os.description`](/docs/attributes-registry/os.md) | string | Human readable OS version information, e.g., as reported by command `d iplinfo`. | `IBM z/OS 3.1` | `Opt-In` |  | | ||
| | [`os.name`](/docs/attributes-registry/os.md) | string | Human readable operating system name. | `z/OS` | `Opt-In` |  | | ||
| | [`process.owner`](/docs/attributes-registry/process.md) | string | The username of the user that owns the process. [7] | `CICSUSR` | `Opt-In` |  | | ||
| | [`process.runtime.description`](/docs/attributes-registry/process.md) | string | An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment. | `IBM Customer Information Control System (CICS) Transaction Server for z/OS Version 5.6` | `Opt-In` |  | | ||
| | [`process.runtime.name`](/docs/attributes-registry/process.md) | string | The name of the runtime of this process. | `CICS Transaction Server z/OS Version 5.6` | `Opt-In` |  | | ||
| | [`process.runtime.version`](/docs/attributes-registry/process.md) | string | The version of the runtime of this process, as returned by the runtime without modification. | `5.6` | `Opt-In` |  | | ||
|
|
||
| **[1] `process.pid`:** On z/OS, SHOULD be set to the Address Space Identifier. | ||
|
|
||
| **[2] `service.instance.id`:** For z/OS system software, SHOULD be set to the identifier representing the current instance of the the z/OS system software, e.g., the CICS region APPLID or IMS region IMSID. | ||
|
|
||
| **[3] `service.name`:** For z/OS system software, SHOULD be set to an appreviated name of the z/OS system software. | ||
|
|
||
| **[4] `service.namespace`:** For z/OS system software, SHOULD be set to the identifier representing of a grouping of the z/OS system software instances, e.g., the name of the CICSPLEX. | ||
|
|
||
| **[5] `service.version`:** For z/OS system software, SHOULD be set to the version of the z/OS system software. | ||
|
|
||
| **[6] `telemetry.sdk.name`:** The OpenTelemetry SDK MUST set the `telemetry.sdk.name` attribute to `opentelemetry`. | ||
| If another SDK, like a fork or a vendor-provided implementation, is used, this SDK MUST set the | ||
| `telemetry.sdk.name` attribute to the fully-qualified class or module name of this SDK's main entry point | ||
| or another suitable identifier depending on the language. | ||
| The identifier `opentelemetry` is reserved and MUST NOT be used in this case. | ||
| All custom identifiers SHOULD be stable across different versions of an implementation. | ||
|
|
||
| **[7] `process.owner`:** On z/OS, SHOULD be set to the user under which the z/OS system software is executed. | ||
|
|
||
| --- | ||
|
|
||
| `host.arch` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | ||
|
|
||
| | Value | Description | Stability | | ||
| |---|---|---| | ||
| | `amd64` | AMD64 |  | | ||
| | `arm32` | ARM32 |  | | ||
| | `arm64` | ARM64 |  | | ||
| | `ia64` | Itanium |  | | ||
| | `ppc32` | 32-bit PowerPC |  | | ||
| | `ppc64` | 64-bit PowerPC |  | | ||
| | `s390x` | IBM z/Architecture |  | | ||
| | `x86` | 32-bit x86 |  | | ||
|
|
||
| --- | ||
|
|
||
| `os.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | ||
|
|
||
| | Value | Description | Stability | | ||
| |---|---|---| | ||
| | `aix` | AIX (Advanced Interactive eXecutive) |  | | ||
| | `darwin` | Apple Darwin |  | | ||
| | `dragonflybsd` | DragonFly BSD |  | | ||
| | `freebsd` | FreeBSD |  | | ||
| | `hpux` | HP-UX (Hewlett Packard Unix) |  | | ||
| | `linux` | Linux |  | | ||
| | `netbsd` | NetBSD |  | | ||
| | `openbsd` | OpenBSD |  | | ||
| | `solaris` | SunOS, Oracle Solaris |  | | ||
| | `windows` | Microsoft Windows |  | | ||
| | `z_os` | IBM z/OS |  | | ||
|
|
||
| --- | ||
|
|
||
| `telemetry.sdk.language` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | ||
|
|
||
| | Value | Description | Stability | | ||
| |---|---|---| | ||
| | `cpp` | cpp |  | | ||
| | `dotnet` | dotnet |  | | ||
| | `erlang` | erlang |  | | ||
| | `go` | go |  | | ||
| | `java` | java |  | | ||
| | `nodejs` | nodejs |  | | ||
| | `php` | php |  | | ||
| | `python` | python |  | | ||
| | `ruby` | ruby |  | | ||
| | `rust` | rust |  | | ||
| | `swift` | swift |  | | ||
| | `webjs` | webjs |  | | ||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # Semantic Conventions for Transaction Processing Systems | ||
|
|
||
| This document defines semantic conventions for Transaction Processing Systems. | ||
|
|
||
| Semantic conventions for Transaction Processing Systems (TPS) are defined for spans. | ||
|
|
||
| * [TPS Spans](spans.md): Semantic Conventions for Transactions Processing *spans*. | ||
|
|
||
| Technology specific semantic conventions are defined for the following Transaction Processing Systems: | ||
|
|
||
| * [CICS](cics-spans.md): Semantic Conventions for IBM CICS Transaction Server for z/OS | ||
| * [IMS](ims-spans.md): Semantic Conventions for IBM Information Management System (IMS) for z/OS |
Oops, something went wrong.