Attribute names versus field names

OMEGAMON® attribute names are either not ideal or not usable as field names in some analytics platforms and data formats. OMEGAMON Data Provider converts OMEGAMON attribute names into safe field names.

In this context, the term field name corresponds to platform- or format-specific terms such as key, property name, and metric name.

Example OMEGAMON attribute name: MVS Busy%.

Format of OMEGAMON attribute names Example rules for field names
Several words separated by spaces. No spaces allowed.
Can contain various non-alphanumeric characters, such as a percent sign (%). Only a limited subset of non-alphanumeric characters allowed.
Can begin with a digit. Must begin with a letter.
Mixed-case. Case-sensitive. Referring to a field name with a single character in the incorrect case can result in an error such as Field not found.

OMEGAMON Data Provider field names

OMEGAMON Data Provider field names have the following format:

  • Snake case, containing only lowercase letters (a - z), digits (0 - 9), and underscores (_).
  • Begin with a letter.
  • End with a letter or a number; no trailing underscores.

Converting attribute names to field names

OMEGAMON Data Provider field names are the OMEGAMON attribute names after applying the following conversion steps:

  1. Lowercase all letters.
  2. Replace space, hyphen (-), backslash (\) with underscore (_).
  3. Replace slash (/) with underscore (_).

    Exception: replace I/O with io, not i_o.

  4. Replace percent sign (%) with the string pct.

    Insert a leading or trailing underscore before or after pct, to separate it from adjacent text, unless that underscore already exists.

  5. If the first character is a digit (1, 2, 3, …), replace it with the corresponding English word (one, two, three, …).
  6. Convert double underscores (__) to a single underscore (_).
Note:
  • For a comprehensive mapping of field names to attribute names, see the attribute dictionary included with OMEGAMON Data Connect.
  • Each OMEGAMON product documents the attributes that it collects. For example, for attributes collected by IBM Z® OMEGAMON AI for z/OS®, 6.1, see the corresponding Attributes documentation.
  • The OMEGAMON enhanced 3270 user interface (e3270UI) menu option Tools > ODI (Object Definitions) lists attribute tables and their attributes.

Examples

OMEGAMON attribute name OMEGAMON Data Provider field name
Buffer Size buffer_size
SCM Service Time scm_service_time
Amount CSA In Use amount_csa_in_use
Total 4K Reqs Completed/Sec total_4k_reqs_completed_sec
Active I/O Threshold active_io_threshold
MVS Busy% mvs_busy_pct
Physical % zIIP physical_pct_ziip
Dependent Enclave IFA % On CP dependent_enclave_ifa_pct_on_cp
CPU % \ MVS Normalized cpu_pct_mvs_normalized
1 Megabyte Writes Demoted one_megabyte_writes_demoted
3rd Device Wait Percentage third_device_wait_percentage
  • In JSON output from OMEGAMON Data Provider, the attribute name Buffer Size is represented as the key buffer_size.
  • In a Prometheus endpoint published by OMEGAMON Data Provider, the attribute name MVS Busy% is represented as the metric km5thrsuml_mvs_busy_pct, where km5thrsuml is the table name.