z/OS software

This document defines z/OS software entity and documents how to populate other entities, such as host in the context of mainframes.

Status: Development

type: zos.software

Description: A software resource running on a z/OS system.

AttributeTypeDescriptionExamplesRequirement LevelStability
zos.smf.idstringThe 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.SYS1RequiredDevelopment
zos.sysplex.namestringThe name of the SYSPLEX to which the z/OS system belongs too.SYSPLEX1RequiredDevelopment
mainframe.lpar.namestringName of the logical partition that hosts a systems with a mainframe operating system.LPAR01RecommendedDevelopment

Host

The following table describes how to populate attributes on the host entity on mainframes.

AttributeTypeDescriptionExamplesRequirement LevelStability
host.archstringThe CPU architecture the host system is running on.s390xRecommendedDevelopment
host.namestringName of the host. On z/OS, SHOULD be the full qualified hostname used to register the z/OS system in DNS.SYS1.DOMAIN.COMRecommendedDevelopment
host.idstringUnique host ID. On z/OS, SHOULD be the concatenation of sysplex name and SMFID, separated by a dashSYSPLEX1-SYS1Opt-InDevelopment

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.

ValueDescriptionStability
amd64AMD64Development
arm32ARM32Development
arm64ARM64Development
ia64ItaniumDevelopment
ppc3232-bit PowerPCDevelopment
ppc6464-bit PowerPCDevelopment
s390xIBM z/ArchitectureDevelopment
x8632-bit x86Development

Operating System

The following table describes how to populate the operating system attributes on mainframes.

AttributeTypeDescriptionExamplesRequirement LevelStability
os.typestringThe operating system type.zosRequiredDevelopment
os.versionstringThe version string of the operating system. On z/OS, SHOULD be the release returned by the command d iplinfo.3.1.0RecommendedDevelopment
os.descriptionstringHuman readable OS version information, e.g., as reported by command d iplinfo.IBM z/OS 3.1Opt-InDevelopment
os.namestringHuman readable operating system name.z/OSOpt-InDevelopment

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.

ValueDescriptionStability
aixAIX (Advanced Interactive eXecutive)Development
darwinApple DarwinDevelopment
dragonflybsdDragonFly BSDDevelopment
freebsdFreeBSDDevelopment
hpuxHP-UX (Hewlett Packard Unix)Development
linuxLinuxDevelopment
netbsdNetBSDDevelopment
openbsdOpenBSDDevelopment
solarisSunOS, Oracle SolarisDevelopment
windowsMicrosoft WindowsDevelopment
z_osDeprecated. Use zos instead.Development
zosIBM z/OSDevelopment

Process

The following table describes how to populate attributes on the process entity on mainframes.

AttributeTypeDescriptionExamplesRequirement LevelStability
process.commandstringThe 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.CICSSTRTRequiredDevelopment
process.pidintProcess identifier (PID). [1]008ARequiredDevelopment
process.ownerstringThe username of the user that owns the process. [2]CICSUSROpt-InDevelopment
process.runtime.descriptionstringAn 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.6Opt-InDevelopment
process.runtime.namestringThe name of the runtime of this process.CICS Transaction Server z/OS Version 5.6Opt-InDevelopment
process.runtime.versionstringThe version of the runtime of this process, as returned by the runtime without modification.5.6Opt-InDevelopment

[1] process.pid: On z/OS, SHOULD be set to the Address Space Identifier.

[2] process.owner: On z/OS, SHOULD be set to the user under which the z/OS system software is executed.