Integrating IBM OMEGAMON with Instana

Learn about integrating IBM OMEGAMON with Instana.

Summary

You can integrate IBM OMEGAMON with Instana by configuring IBM Z OMEGAMON Data Provider and by using the Instana OMEGAMON sensor to communicate. The Instana host agent (OMEGAMON sensor) sends the payloads to the Instana server where the payloads are processed, creating entities in the Instana server, and saving the metrics for display in the Instana UI.

Figure 1. Architecture diagram
Architecture diagram of IBM OMEGAMON integration with Instana

Additionally, you can use multiple ODP Data connectors to send OMEGAMON data to the Instana backend from multiple hosts. The following diagram shows two systems, each gathering ODP data and sending it to its respective ODP data connector. Each ODP data connector then communicates with its own OMEGAMON sensor, and both OMEGAMON sensors send the data to the same Instana backend for display in the Instana UI.

Figure 2. Architecture diagram 2
Diagram illustrating the integration process between IBM OMEGAMON and Instana

Prerequisites

Check the following requirements:

  • Ensure that you have the host agent installed for Instana. For more information, see Installing the host agent on Linux.

  • Enable OMEGAMON Support by following the steps in Enabling OMEGAMON support.

  • For the sensor to gather metrics from OMEGAMON, the IBM Z OMEGAMON Data Provider needs to be configured to push data to the IBM OMEGAMON sensor. For information about configuring IBM Z OMEGAMON Data Provider, see the IBM OMEGAMON Documentation.

  • Specify the url in the OMEGAMON Data Connect configuration file as follows: url: http://hostname:42699/com.instana.plugin.ibmomegamon

  • Specify a filter to ensure that OMEGAMON Data Connect pushes data to the IBM OMEGAMON sensor only for the included product tables. For more information about specifying the filter, see Configuring OMEGAMON data connect.

Configuring OMEGAMON data connect

In the connect.yaml file, you specify the endpoint to which OMEGAMON Data Connect must send data. The following example shows a typical format of an HTTP output for Instana. The filter.include parameter contains the path and name of the file that has the filters for the product tables. For example, instana.yaml.

connect:
  output:
    http:
      enabled: true
      endpoints:
        instana:
          enabled: true
          url:  http://hostname:42699/com.instana.plugin.ibmomegamon
          batching:
            enabled: true
            batch-size: 1000
            linger: 5000
          filter:
            enabled: true
            include: /u/odp/instana.yaml
 

The following instana.yaml file contains the filters for product tables.

enabled: true
products:
  km5:
    tables:
      m5stgfdth:
        enabled: true
      m5stgcdth:
        enabled: true
      syscpuutil:
        enabled: true
  kgw:
    tables:
      ctgrov:
        enabled: true
      ctgwts:
        enabled: true
      ctgcsd:
        enabled: true
      ctgcms:
        enabled: true
  kc5:
    tables:
      cicsrov:
        enabled: true
      cicstca:
        enabled: true
      wss:
        enabled: true
      cicscsd:
        enabled: true
  kd5:
    tables:
      dp_sy_exc:
        enabled: true
      db2lkconf:
        enabled: true
      dp_ci_excs:
        enabled: true
      dp_im_conn:
        enabled: true
      real2252:
        enabled: true
      real225:
        enabled: true
      real230:
        enabled: true
      statlokc:
        enabled: true
      statlogs:
        enabled: true
      statqxst:
        enabled: true
      realqbst:
        enabled: true
      statedmp:
        enabled: true
      dp_srm_sub:
        enabled: true
      dp_srm_sux:
        enabled: true
      opersys:
        enabled: true
  ki5:
    tables:
      kip_lrti02:
        enabled: true
      depregns:
        enabled: true
      vsamsubp:
        enabled: true
      balg:
        enabled: true
      kipimshlt:
        enabled: true
      ictcbcpu:
        enabled: true
      bufpools:
        enabled: true
      poolutil:
        enabled: true
      adrspacs:
        enabled: true
      subpools:
        enabled: true
      dlideprg:
        enabled: true
  kjj:
    tables:
      wlpsesm:
        enabled: true
      health:
        enabled: true
      zcsumm:
        enabled: true
      zosmem:
        enabled: true
      addrmem:
        enabled: true
      gcsumm:
        enabled: true
      envdet:
        enabled: true
      wlpwbam:
        enabled: true
      natmem:
        enabled: true
      wlpthplm:
        enabled: true
      wlpcnpls:
        enabled: true
      wlpsrvin:
        enabled: true
      environ:
        enabled: true
      zcoutbsum:
        enabled: true
  kmq:
    tables:
      qmq_hdl_st:
        enabled: true
      qmq_qu_st:
        enabled: true
      qmchan_st:
        enabled: true
      qmcurstat:
        enabled: true
      qmtpcst:
        enabled: true
      qmq_lh:
        enabled: true
      qmch_data:
        enabled: true
      qmlsstatus:
        enabled: true
      qmqueue:
        enabled: true
      qmq_data:
        enabled: true
 

For more information about how to edit the connect.yaml file, see Configuring OMEGAMON Data Connect.

Enabling OMEGAMON support

Metric ingestion by using the OMEGAMON sensor in the host agent is disabled by default. To enable this support, complete the following step:

  1. Enable the OMEGAMON sensor in your Instana host agent to receive IBM OMEGAMON data. Instana collects data from monitored systems by using a single agent on each host. The agent runs on your hosts to collect and aggregate data from various sensors before it sends the data to the Instana backend. For more information, see the Instana Host Agent documentation.

Configuration

To enable the OMEGAMON sensor, locate the ibmomegamon section of the agent configuration file, and uncomment the lines for the sensor <agent_install_dir>/etc/instana/configuration.yaml:

com.instana.plugin.ibmomegamon:
  enabled: true
 

Adjusting storage requirements

To adjust storage requirements, modify the following file: /opt/instana/agent/bin/setenv.

Then, modify the following lines with the updated values as shown in the following example:

DEFAULT_AGENT_MAX_MEM='2048m'
DEFAULT_HEAP_MAX_MEM='320m'
 
Note:
You can modify the actual settings to adjust memory size, but they might vary depending on the data volume that is being handled. The default memory is 512 m for the host agent.

Metrics collection

Metrics related to z/OS, Db2 for z/OS, CICS, JVM, MQ for z/OS, and IMS are collected from IBM OMEGAMON and visualized in Instana.

Supported dashboards for OMEGAMON observability

The following tables show each dashboard that OMEGAMON Observability supports and the required product code is listed:

z/OS dashboard

Table 1. Metrics table
Product code Table name Description
km5 m5stgfdth Real storage utilization history
km5 m5stgcdth Common storage utilization history
km5 syscpuutil System CPU utilization
ki5 kipimshlt IMS health

CICS gateway dashboard

Table 2. Metrics table
Product code Table name Description
kgw ctgrov CICS region overview
kgw ctgwts Worker threads
kgw ctgcms Connection manager threads
kgw ctgcsd CICS TS region details

JVM dashboard

Table 3. Metrics table
Product code Table name Description
kjj wlpsesm JVM Liberty sessions
kjj health Health
kjj zcsumm JVM zOS Connect summary
kjj zosmem JVM virtual memory
kjj addrmem JVM address space
kjj gcsumm JVM garbage collection
kjj envdet JVM environment details
kjj wlpwbam JVM Liberty Web Applications
kjj natmem JVM native memory
kjj wlpthplm JVM Liberty thread pool
kjj wlpcnpls JVM Liberty connection pool
kjj wlpsrvin JVM Liberty server info
kjj environ JVM environment data
kjj zcoutbsum JVM zOS Connect API requester summary

CICSplex dashboard

Table 4. Metrics table
Product code Table name Description
kc5 cicsrov CICSplex region overview
kc5 cicstca CICSplex task class analysis
kc5 wss CICSplex service class analysis
kc5 cicscsd CICSplex dynamic storage details

z/OS Db2 dashboard

Product code Table name Description
kd5 db2lkconf Db2 lock contention
kd5 dp_ci_excs Db2 CICS exceptions
kd5 dp_im_conn Db2 IMS connections
kd5 dp_sy_exc Db2 system states
kd5 real225 Db2 memory DBM1 DIST
kd5 real2252 Db2 memory
kd5 real230 Db2 group buffer pool
kd5 statlokc Db2 lock count
kd5 statlogs Db2 log stats
kd5 statqxst Db2 stat SQL count
kd5 realqbst Db2 buffer pool statistics
kd5 statedmp Db2 EDM statistics
kd5 dp_srm_sub Db2 SRM subsystem
kd5 dp_srm_sux Db2 SRM subsystem statistics
kd5 opersys Z/os system statistics

IMS dashboard

Product code Table name Description
ki5 kip_lrti02 RTA group summary
ki5 depregns Dependent regions
ki5 vsamsubp VSAM sub pools
ki5 balg Balancing groups
ki5 ictcbcpu TCBCPU utilization
ki5 bufpools Buffer pool statistics
ki5 poolutil Pool utilization
ki5 adrspacs Address spaces
ki5 subpools Sub pool statistics
ki5 dlideprg Dependent region Statistics
ki5 kipimshlt IMS health

z/OS MQ manager

Product code Table name Description
kmq qmq_hdl_st Queue handle status
kmq qmq_qu_st Queue status
kmq qmchan_st Channel status
kmq qmcurstat Current queue manager status
kmq qmtpcst Topic status
kmq qmq_lh Queue long term history
kmq qmch_data Channel data
kmq qmlsstatus Listener status
kmq qmqueue Queue definitions
kmq qmq_data Queue data

z/OS

See the configuration and performance metrics that are related to z/OS as follows.

Configuration data

  • Workload Management Mode
  • Sysplex Name
  • SMF ID
  • Managed System
  • Product Code
  • Physical CPU Count

Performance metrics

See the performance metrics that are related to System CPU utilization, Real storage utilization history and Common storage utilization history as follows.

System CPU utilization

This table provides information about CPU usage for the system.

Table 5. Metrics table
Metric Description Granularity
Average CPU percent Current or latest sample of the system CPU, as seen by the LPAR
Undispatched Tasks The number of tasks or address spaces that are not dispatched by the SRM due to constraints
MVS Overhead The CPU utilization percentage that is not attributable to any user or address space
Average IFA percent Average IFA percent
Average IFA on CP percent Average IFA on CP percent
4 Hour MSUs The four-hour rolling average value of the millions of service units (MSUs) per hour
Average zIIP percent The average percentage of IBM Z Integrated Information Processor (zIIP) time
Average zIIP on CP percent The average percentage of regular processor time the system consumed for zIIP
Percent LPAR MSU capacity The percentage of the entitled or defined capacity millions of service units (MSUs) of this LPAR
Average Unused Group MSUs The number of millions of service units (MSUs) that were unused
Note:
Granularity depends on OMEGAMON and IBM OMEGAMON host agent sensor configuration.
Real storage utilization history

The historical real storage utilization attribute group provides information about the real storage that is allocated to an address space in terms of various types of frame counts and slot counts, in addition to the management status of a particular address space.

Table 6. Metrics table
Metric Description Granularity
Total Frames The total number of frames occupied by the address space
Active Frames The number of active frames occupied by the address space
Idle Frames The number of idle frames occupied by the address space
Auxiliary Storage Slots The number of auxiliary storage slots occupied by this address space
Memory Objects Allocated The number of memory objects allocated by this address space
1 Meg Frames In Real The number of 1-Megabyte frames backed in real storage
Active Frames Working Set The number of active frames contained in the working set
Active Frames Fixed The number of fixed frames actively used by the address space
Active Frames DIV The number of active Data-in-Virtual frames actively used by the address space
Page-In Rate Page-In rate (Page-ins per second)
Shared Page-In Rate Shared page-in rate from auxiliary storage (Page-ins per second)
Shared Pages Total Views The total shared page views
Shared Pages Total Valid The total valid shared pages
Shared Pages Validation Rate The shared page validation rate of the address space
Note:
Granularity depends on OMEGAMON and IBM OMEGAMON host agent sensor configuration.
Common storage utilization history

The historical Common Storage attribute group displays historical information about four important areas of common storage: common service area (CSA), extended CSA, system queue area (SQA), and extended SQA.

Metric Description Granularity
Percentage CSA In Use The average percentage of Common Service Area (CSA) storage used by the job
Percentage ECSA In Use The average percentage of Extended Common Service Area (ECSA) storage used by the job
Percentage SQA In Use The average percentage of System Queue Area (SQA) storage used by the job
Percentage ESQA In Use The average percentage of Extended System Queue Area (ESQA) storage used by the job
Amount CSA In Use The amount of total Common Service Area (CSA) used by this address space
Amount ECSA In Use The amount of total Extended Common Service Area (ECSA) used by this address space
Amount SQA In Use The amount of total System Queue Area (SQA) used by this address space
Amount ESQA In Use The amount of total Extended System Queue Area (ESQA) used by this address space
Note:
Granularity depends on OMEGAMON and IBM OMEGAMON host agent sensor configuration.

Db2 for z/OS

See the configuration and performance metrics that are related to Db2 for z/OS as follows.

Configuration data

  • MVS System
  • Origin Node
  • Db2 Subsystem
  • Product Code

Performance metrics

See the performance metrics that are related to Db2 system states, Db2 CICS exceptions, and Db2 IMS connections as follows.

Db2 system states

This table provides information about Db2 system states attributes.

Metric Description Granularity
Lock Conflict Count The total number of owners and waiters that are in lock conflict
Current Thread Count The current number of active threads
Transactions Per Second The number of successful requests for commit phase 1 in a two-phase commit environment such as CICS or IMS
Pages read from BPs The number of Getpage requests including conditional and unconditional requests
Pages Read From DASD The number of synchronous read I/O operations performed by DB2 for applications and utilities
Extended CSA size The size of the common storage area (CSA) above the 16 MB line
Real storage in use The amount of real storage in use for 31-bit and 64-bit private pools
Deadlocks The number of times deadlocks were detected
Timeouts The number of times a unit of work was suspended for a time exceeding the timeout value
Average thread footprint The current average memory usage of active user threads (allied threads and DBATs)
Maximum number of threads The maximum number of possible threads, depending on storage size and average memory usage of active threads
DSC hit ratio The ratio of successful search requests for prepared statements from the global dynamic SQL cache in the EDM pool
Note:
Granularity depends on OMEGAMON and IBM OMEGAMON host agent sensor configuration.
Db2 CICS exceptions

This table provides information about Db2 CICS Exceptions attributes from connected CICS subsystems.

Metric Description Granularity
Total Thread Utilization The utilization of threads based on the current total threads in use divided by the maximum allowed threads
Pool Thread Utilization The utilization of pool threads based on the current pool thread in use count that is divided by the maximum allowed pool threads
Total Threads Maximum The maximum number of threads that can be used concurrently for this CICS connection
Total Threads In Use The count of active threads for this CICS connection
Pool Threads In Use The count of pool threads that are currently active
Pool Thread Waits The count of pool threads that are waiting because the maximum has been reached
Pool Thread Maximum The maximum number of pool threads that is allowed
Note:
Granularity depends on OMEGAMON and IBM OMEGAMON host agent sensor configuration.
Db2 IMS connections

This table provides information about Db2 IMS Connections attributes from connected IMS subsystems.

Metric Description Granularity
Active Threads The count of threads currently active for this IMS region
Defined Dependent regions The count of defined dependent regions for this IMS connection
Connected Dependent regions The count of dependent regions currently connected to this Db2 system
Unconnected Regions The number of regions not connected
Note:
Granularity depends on OMEGAMON and IBM OMEGAMON host agent sensor configuration.
Db2 buffer pool statistics

This table provides information about Db2 Buffer Pool Statistics.

Metric Description Granularity
BP hit ratio The buffer pool hit ratio -
Get page The number of get page requests -
Sync read IO The number of synchronous read operations -
Datasets opened The number of datasets currently open -
Note:
Granularity depends on OMEGAMON and IBM OMEGAMON host agent sensor configuration.
Db2 group buffer pool

This table provides information about Db2 Group Buffer Pool performance.

Metric Description Granularity
Hit ratio The group buffer pool hit ratio -
Note:
Granularity depends on OMEGAMON and IBM OMEGAMON host agent sensor configuration.
Db2 lock contentions

This table provides information about Db2 Lock Contentions.

Metric Description Granularity
Lock Elapsed Time Lock Elapsed Time
Note:
Granularity depends on OMEGAMON and IBM OMEGAMON host agent sensor configuration.
Db2 lock count

Db2 lock count statistics provide information about lock requests and escalations in the database system.

The following table describes the metrics available for Db2 lock count statistics.

Table 7. Metrics table
Metric Description
Lock requests The total number of lock requests
Shared lock escalations The number of lock escalations to shared locks
Exclusive lock escalations The number of lock escalations to exclusive locks
Note:
Granularity depends on OMEGAMON and IBM OMEGAMON host agent sensor configuration.
Db2 log statistics

Db2 log statistics provide information about log write operations and buffer availability in the database system.

The following table describes the metrics available for Db2 log statistics.

Table 8. Metrics table
Metric Description
Log writes The number of log write operations
Wait unavailable log buffer The number of waits for unavailable log buffer
Note:
Granularity depends on OMEGAMON and IBM OMEGAMON host agent sensor configuration.
Db2 stat SQL count

Db2 SQL statement count statistics provide information about SQL statement execution and RID processing operations in the database system.

The following table describes the metrics available for Db2 SQL statement counts.

Metric Description
Total DML count Total count of Data Manipulation Language statements
Total DCL count Total count of Data Control Language statements
Total DDL count Total count of Data Definition Language statements
RID processing Successful The number of successful RID processing operations
RID not used no storage The number of times RID was not used due to no storage
RID not used max limit The number of times RID was not used due to max limit
RID overflow to workfile The number of times RID overflowed to workfile
Note:
Granularity depends on OMEGAMON and IBM OMEGAMON host agent sensor configuration.
Db2 EDM statistics

Db2 EDM (Environmental Descriptor Manager) pool statistics provide information about database descriptor, cursor table, and package table requests.

The following table describes the metrics available for Db2 EDM pool statistics.

Metric Description
DBD requests The number of Database Descriptor requests
CT requests The number of Cursor Table requests
PT requests The number of Package Table requests
Note:
Granularity depends on OMEGAMON and IBM OMEGAMON host agent sensor configuration.
Db2 SRM subsystem

Db2 System Resource Manager subsystem metrics provide information about active threads and database access threads.

The following table describes the metrics available for Db2 System Resource Manager subsystem.

Metric Description
Current threads (Local) The current number of active threads
Current DBAT The current number of Database Access Threads
Note:
Granularity depends on OMEGAMON and IBM OMEGAMON host agent sensor configuration.
Db2 SRM subsystem statistics

Db2 System Resource Manager subsystem statistics provide information about commit operations in the database system.

The following table describes the metrics available for Db2 System Resource Manager subsystem statistics.

Metric Description
Commit count The number of commit requests
Commit count total The total number of commit requests
Note:
Granularity depends on OMEGAMON and IBM OMEGAMON host agent sensor configuration.
z/OS system statistics

z/OS system statistics provide information about CPU utilization across the logical partition and Db2 components.

The following table describes the metrics available for z/OS system CPU utilization statistics.

Metric Description
CPU utilization LPAR The CPU utilization percentage on the logical partition
CPU utilization Db2 The CPU utilization percentage for Db2
CPU utilization Db2 MSTR The CPU utilization percentage for Db2 master address space
CPU utilization Db2 DBM1 The CPU utilization percentage for Db2 database services address space
Note:
Granularity depends on OMEGAMON and IBM OMEGAMON host agent sensor configuration.

CICS

See the configuration and performance metrics that are related to CICS as follows.

Configuration data

  • Origin node
  • System ID
  • CICS region name
  • CICS version
  • CICSPlex name

Performance metrics

See the performance metrics that are related to CICSplex region overview as follows.

CICSplex region overview

The CICSplex Region Overview attributes report on the internal resources of CICS regions. These resources include storage, files, queues, and enqueues.

Metric Description Granularity
Transaction rate The average number of transactions executed in one minute of elapsed time
Maximum tasks percent The total number of tasks within a CICS region, expressed as a percentage of the MXT limit
CPU utilization The percentage of accumulated CPU time for the CICS region
I/O rate The rate at which I/O operations are being performed in a specified CICS region per second of elapsed time
Page rate The number of page-in operations in the CICS region per CPU second
Storage violations The number of storage violations that have occurred within the last hour
Enqueue waits The number of CICS enqueues exclusively controlling a resource that tasks are also waiting for
AIDs The number of automatic initiate descriptors (AIDs) found on the AID chain within a given CICS region
ICEs The number of interval control elements (ICEs) found on the ICE chain within a given CICS region
Worst region performance index Indicator as to which CICS region's response time might be starting to degrade
Queued remote requests The CICS region's total number of queued allocation requests for MRO, ISC, and IP sessions
Highest percent class MaxT The highest percentage of transactions regarding the class limit for any one transaction class
Total queued transactions The total number of transactions queued for Maximum task or transaction class limits
Note:
Granularity depends on OMEGAMON and IBM OMEGAMON host agent sensor configuration.

JVM metrics

See the following JVM metrics that are collected by the IBM OMEGAMON host agent sensor.

Table 9. Metrics table
Metric Description
Collector IDs Collector ID is the identifier of a JVM collector instance
Memory pool allocated bytes The number of bytes allocated (not including children)
Application title name Name of the job or started task hosting this JVM
JVM free memory The sum of free memory across 64-bit virtual memory (MB) remaining above the 2 GB bar in the address space, 31-bit virtual memory remaining above the 16 MB line in the address space and 24-bit virtual memory remaining below the 16 MB line in the address space.
JVM used memory The sum of used memory across 64-bit virtual memory (MB) remaining above the 2 GB bar in the address space, 31-bit virtual memory remaining above the 16 MB line in the address space and 24-bit virtual memory remaining below the 16 MB line in the address space.
JVM total memory allocated The total memory across 64-bit virtual memory (MB) remaining above the 2 GB bar in the address space, 31-bit virtual memory remaining above the 16 MB line in the address space and 24-bit virtual memory remaining below the 16 MB line in the address space.
JVM total blocked threads Current number of blocked threads in the JVM.
JVM total thread count The total number of active threads in the JVM.
Garbage collection time Total time performing garbage collection.
Garbage collection invocations Nursery garbage collection count.
Maximum heap size reached Maximum heap size (bytes) reached during interval.
Minimum heap size reached Minimum heap size (bytes) during interval.
Maximum heap used Maximum used heap reached during interval.
Minimum heap used Minimum used heap (bytes) during interval.

MQ for z/OS metrics

See the following IBM MQ metrics that are collected by the IBM OMEGAMON host agent sensor.

Table 10. Metrics table
Metric Description
Queue manager name The name of the Queue Manager.
Queue manager start date Queue Manager start date and time.
Queue manager status The current execution status of the queue manager. One of Starting, Running, Quiescing, Stopping, Standby, Stopped
Queue manager connections The current number of connections to the queue manager.
Queue names Queues that have had queue depth at some point in the past or currently. (Active queues)
Queue puts enabled Whether the current queue is enabled for puts (that is, whether applications can call WebSphere MQ API routines MQPUT or MQPUT1 for this queue).
Queue gets enabled Whether the current queue is enabled for gets (that is, whether applications can call the WebSphere MQ API routine MQGET for this queue).
Current queue depth The number of messages that are currently on the queue.
Maximum queue depth Highest recorded current depth value from the collection of sampling intervals that comprise the entire historical period.
Messages Placed into Queue The number of messages that are put to the queue during the sampling interval.
Messages read from queue The number of messages that are read (and removed) from the queue during the sampling interval.
Queue monitoring level The current level of monitoring data collection for the queue.
Current queue output handles The number of handles that are currently open for output.
Current queue input handles The number of handles that are currently open for input (either shared or exclusive). This does not include opens for browsing.
Channel names The name of the channel.
Connection names Name of the connection. This is the connection name that is obtained using the MQSC DIS CHS command (see WebSphere MQ documentation for more information about this command).
Channel status Status of the channel. One of Binding, Starting, Running, Stopping, Retrying, Stopped, Requesting, Paused, Initializing, Switching.
Channel sub-status Current action that is being performed by the channel.
Channel in doubt The number of monitored channel connections that are currently in doubt for this queue manager. A sender channel is in doubt when a logical unit of work (LUW) is sent and the channel is waiting for an acknowledgment that the LUW was successfully received (in other words, when a syncpoint is requested but not yet performed).
Channel start date and time The date and time at which the channel is started.
Channel last message date and time Date and time at which the last message is sent or an MQI call is handled.
Channel buffers sent Number of buffers that are sent.
Channel buffers received Number of buffers that are received.
Channel bytes received Number of bytes that are received.
Channel sharing conversations Blank for all channel types other than server-connection channels. For each instance of a server-connection channel, it gives the number of conversations that are currently running over that channel instance.
Channel message count The number of messages that are sent or received on this channel during the current interval or aggregation period.
Channel message sequence number The number of the last message sent for the logical unit of work (LUW) that the in-doubt channel is currently processing. This attribute is not available for CICS channels.
Channel sequence number last The number of the last-committed message in the last-committed logical unit of work (LUW).

IMS

See the following IMS metrics and configuration data that are collected by IBM OMEGAMON host agent sensor.

Dependent regions

The Dependent Regions table is used to view status information for dependent regions.

Configuration data
Configuration data Description
MVS system The MVS System Management Facility (SMF) identifier (mvs_system)
IMS ID The IMS subsystem identifier (ims_id)
Region name The job name of the subject IMS address space (region_name)
Transaction name The transaction ID that is currently running in the subject region (transaction_name)
IMSPlex name The name of the IMSplex that this dependent region belongs to (imsplex_name)
User ID The user identification currently active in the region (user_id)
Originating system identifier Fully identifies the originating IMS subsystem (originating_system_identifier)
PSB name The PSB name that is currently running in the subject region (psb_name)
Metrics
Metric Description
logical_terminal The LTERM name for message type regions.
type The IMS dependent region type. Valid values include BMP, DBCTL, FastPath, HSSP-BMP, Java, Message, and Java Batch.
locks_held_count The number of IRLM or PI locks held by subject IMS region.
region_status The current status of the region.
region_occupancy_percentage The dependent region occupancy percentage.
external_subsystem_calls The external subsystem status, provided when the application is processing an external subsystem request as indicated by the region status value of Exec-DB2, Exec-MQ, or Exec-ESS.
call_pcb_sensitive_segments PCB number of sensitive segments from the current or most recently run call.
external_subsystem_calls For IMS V10 and later versions, the current count of all external subsystem (ESAF) calls for the running transaction (UOR); before IMS V10, N/A is displayed.
call_pcb_status PCB status code from the current or most recently run call.

VSAM sub pools

Configuration data
Configuration data Description
Pool name The pool identifier name assigned to this subpool (pool_name)
MVS system The MVS System Management Facility (SMF) identifier (mvs_system)
IMS ID The IMS subsystem identifier (ims_id)
Originating system identifier Fully identifies the originating IMS subsystem (originating_system_identifier)
Metrics
Metric Description
using_hiperspace Whether the subpool is using hiperspace.
subpool_hit_ratio The percentage of total record requests that were satisfied from the subpool.
buffer_size The subpool buffer size, in bytes.
blocks_pagefixed Whether the blocks for this subpool are page fixed.
subpool_number The subpool identification number.
pool_type The pool type for this subpool. Valid value is Data or Index.
buffers_pagefixed Whether the buffers for this subpool are page fixed.

Pool utilization

Configuration data
Configuration data Description
Originating system identifier Fully identifies the originating IMS subsystem (originating_system_identifier)
IMS ID The IMS subsystem identifier (ims_id)
Pool name The pool identifier name assigned to this subpool (pool_name)
Pool group The group of the subject IMS storage pool. Valid values include Communications, Database, and Program (pool_group)
Metrics
Metric Description
free_blocks The current count of free blocks for the subject IMS pool.
largest_free_block The largest free blocks for the subject IMS pool in bytes.
pool_size The size of the subject IMS storage pool in bytes.
free_space The current free space for the subject IMS pool in bytes.

Sub pool statistics

Configuration data
Configuration data Description
Originating system identifier Fully identifies the originating IMS subsystem (originating_system_identifier)
MVS system The MVS System Management Facility (SMF) identifier (mvs_system)
IMS ID The IMS subsystem identifier (ims_id)
Metrics
Metric Description
subpool_hit_ratio The percentage of total locate calls that were satisfied from the subpool.
prefix_pagefixed Whether the prefix is page fixed. Valid values include Yes, No, All, Mixed, and None.
subpool_number Identifies the subpool.
total_storage The total amount of storage allocated for subpool.

Address spaces

Configuration data
Configuration data Description
Originating system identifier Fully identifies the originating IMS subsystem (originating_system_identifier)
IMSPlex name The name of the IMSplex that this dependent region belongs to (imsplex_name)
MVS system The MVS System Management Facility (SMF) identifier (mvs_system)
IMS ID The IMS subsystem identifier (ims_id)
Job name The job name of the subject IMS address space (job_name)
Metrics
Metric Description
type Type of IMS address space, including BMP, Control, FastPath, HSSP-BMP, IRLM, Track, TMS, Message, DBRC, DL/I_SAS, Java, and Java_Batch.
cpu_time Total amount of CPU time consumed by this address space.
cpu_percentage Percentage of CPU time consumed by this address space.
working_set_size Current working set size for address space, expressed in number of frames.
common_page_in_rate Page-in rate of common area storage in pages per second for address space.
swapped_out Whether this address space is currently swapped out.
excp_rate EXCP rate for this address space in EXCPs per second.

IMS health

Configuration data
Configuration data Description
SQGroup name The name of the Shared Queues group for this IMS system if defined (sqgroup_name)
IMSPlex name The name of the IMSplex that this dependent region belongs to (imsplex_name)
MVS system The MVS System Management Facility (SMF) identifier (mvs_system)
IMS ID The IMS subsystem identifier (ims_id)
Sysplex name The originating sysplex for this request (sysplex_name)
Metrics
Metric Description
region_count The number of dependent regions running under this IMS.
total_transaction_rate The total full function and Fast Path transaction rate.
lock_waiters The number of regions waiting on global or local locks.
shared_transaction_queue The number of transactions on the shared queue. This includes messages on the transaction and fast path program queues.
total_io_rate The total I/O rate for IMS control type regions and all dependent regions.
longest_lock The elapsed time, in microseconds, that the region has been waiting on a database lock.
total_cpu_percent The total CPU percentage for IMS control type regions and all dependent regions.
affinity_count The number of transactions on the shared queue that have affinity to this IMS system.
total_enq_rate The total message enqueue rate for full function and Fast Path.
highest_r0_time The highest R0 response time in microseconds for collected transactions.
total_transaction_queue The total number of transactions in the input queue for all full function and Fast Path.
total_paging_rate The total paging rate for IMS control type regions and all dependent regions.

Monitoring issues

Failed to connect to the Instana host agent

If you see an error that looks like AYC0079E Error sending data to HTTP endpoint endpoint-instana-sensor-pp1: Failed to connect to cdc-pp1.fyre.ibm.com/9.46.91.99:42699 in the OMEGAMON Data Provider logs, configure the host agent to listen on the available network interfaces. For more information, see General Reference - Network.

Verifying record data is being received

To verify that record data for tables is being sent from the Omegamon Data Provider (ODP) and received in the Omegamon sensor, you can check the Instana host agent logs.

  1. Open the agent log file located at <agent_install_dir>/data/log/agent.log.
  2. Search for log entries containing ACTIVITY - Number of unique tables for which valid records were received.

This log entry shows the total count of unique tables for which valid records were received. The subsequent lines list the individual tables with their record counts. The records must be from valid tables that are defined in the filter file (for example, instana.yaml).

Example log entries:

ACTIVITY - Number of unique tables for which valid records were received: 37
ACTIVITY -     dp_srm_sux: 300, kipimshlt: 20, ctgrov: 1, statedmp: 360, opersys: 20
ACTIVITY -     dp_sy_exc: 20, statqxst: 3960, environ: 25, real2252: 20, qmlsstatus: 30
ACTIVITY -     statlogs: 580, natmem: 1050, adrspacs: 180, envdet: 10440, realqbst: 110
ACTIVITY -     real230: 70, qmtpcst: 75, cicsrov: 40, cicstca: 640, ctgwts: 1
ACTIVITY -     health: 25, vsamsubp: 100, dp_srm_sub: 20, subpools: 60, qmq_lh: 152
ACTIVITY -     syscpuutil: 10, ctgcms: 1, qmq_qu_st: 75, gcsumm: 25, qmchan_st: 10
ACTIVITY -     zcsumm: 10, poolutil: 470, wlpsrvin: 15, zosmem: 25, qmcurstat: 15
ACTIVITY -     statlokc: 2940, real225: 40

If you see these log entries with table names and record counts, the Omegamon sensor is successfully receiving data from the Omegamon Data Provider.