Skip to end of metadata
Go to start of metadata
 Click to expand table of contents...

Content




Created  

Update 


Overview

z/IRIS z/OS Connect support provides users with the following features:

  • z/IRIS z/OS Connect Metrics Streaming:
    Real-time visualization and monitoring of z/OS Connect metrics created by z/IRIS using SMF type 123 record data
  • z/IRIS z/OS Connect Trace Streaming:
    Real-time distributed observability of z/OS Connect REST API request processing in z/IRIS partner and open-source APM products.

IBM z/OS SMF record streaming

All SMF records supported by z/IRIS are processed in real-time. Users control which SMF records z/IRIS streams and processes using the z/IRIS z/OS Client ziris.comm.config file. For more information about configuring SMF integration, see the  z/IRIS - Latest Administration and User Guide.

z/OS Connect Metrics Streaming 

z/IRIS supports SMF 123 version 1 and version 2 records for Metrics streaming. 

  • z/OS Connect version 1 metrics provides  zosconnect_basic metrics. These metrics provide z/OS Connect request entry and exit timestamps, elapsed time and basic request method and user data.
  • z/OS Connect version 2 metrics provides zosconnect_advanced metrics. These metrics provide zosconnect_basic metrics and additional data about the System-Of-Record (SOR) entry and exit timestamps, elapsed times, more request data and HTTP response codes.

For more information about these metrics see: z/IRIS - z/OS Connect Metrics Streaming.

z/OS Connect Trace Streaming 

z/IRIS creates OTLP compliant traces from SMF 123 version 2 records. The HTTP headers that facilitate context (a.k.a. correlation) are captured in the SMF 123 version 2 records. The IronTap server transforms the SMF records into APM traces. Using the OTLP specification, IronTap creates z/OS Connect traces within the context of the calling application requests/services. Additional attributes are added so that all z/OS Connect traces can be grouped, filtered using APM software analysis functionality.

DevOps teams can view the following performance data for each REST API request from their applications processed by z/OS Connect server:

  • request entry and exit times reported by the z/OS Connect server, and the calculated elapsed time(span time).
  • request entry and exit times reported by the system-Of-Record (SOR). SORs can be CICS or IMS systems, Db2 or batch programs.
  • SOR identifiers useful for support escalation to mainframe SMEs.
  • request and response payload, HTTP response and z/OS authorization identifiers.


z/IRIS can use OTLP compliance to provide z/OS Connect traces to any compliant partner and open-source APM products and can achieve higher vendor-neutrality for our customers.

Example of z/IRIS z/OS Connect traces available in Jaeger using OpenTelemetry instrumentation

click to enlarge image


For more information about OpenTelemetry trace attributes provided by z/IRIS see z/IRIS - Trace attributes with OpenTelemetry.


Configuring z/OS Connect for z/IRIS metrics streaming

Metrics streaming for z/OS Connect supports SMF type 123 version 1 or version 2 records.

  1. Back up the server.xml for the z/OS Connect server that you want to integrate with z/IRIS.
  2. Open the server.xml for editing.
  3. Add a zosconnect_auditInterceptor element with version 1 or version 2 SMF type 123 records.

    Example zosconnect_auditInterceptor server.xml element
    <zosconnect_auditInterceptor id="zirisMetrics" sequence="1"
                 apiProviderSmfVersion="2"/>

    Please note:

    Pay careful attention to the sequence if there are any previously configured auditInterceptors. For more information about server.xml and zosconnect_auditInterceptor configuration elements, refer to the IBM z/OS Connect product documentation in the IBM Knowledge Center.

  4. Add the new zosconnect_auditInterceptor id to the interceptorRef attribute of the zosconnect_zosConnectInterceptors or create a new zosconnect_zosConnectInterceptors if one was not previously configured.

    Example zosconnect_zosConnectInterceptors server.xml element
    <zosconnect_zosConnectInterceptors id="myServerInterceptorList"
          interceptorRef="zirisMetrics, otherInstanaInterceptor"/>
  5. If the updateTrigger="mbean" config element was configured in the server.xml file, a refresh can be dynamically performed to activate the new configuration using the MVS z/OS Connect MODIFY command. 

    Example z/OS Connect refresh command
    /F ZOSCONN1,zcon,refresh
  6. Check the logs for confirmation that the auditInterceptor configuration has been accepted and activated.

    Example z/OS Connect messages.log auditInterceptor confirmation
    [2/11/21 9:31:29:906 GMT] 000004de om.ibm.zosconnect.audit.smf.internal.AuditSMFInterceptorImpl I BAQR0801I: When active, the audit interceptor zirisMetrics is set to record SMF 123 subtype 1 version 2 records for API provider and version 1 records for API requester.
    [2/11/21 9:31:33:584 GMT] 000004de com.ibm.zosconnect.internal.ServiceManagerImpl               A BAQR7096I: z/OS Connect EE interceptor list myServerInterceptorList is active at the global level with interceptors: zirisMetrics,otherInstanaInterceptor.

Configuring z/OS Connect  for OpenTelemetry Trace Streaming

z/IRIS z/OS Connect Trace Streaming support SMF type 123 version 2 records only.

  1. Back up the server.xml for the z/OS Connect server that you want to integrate with z/IRIS.
  2. Open the server.xml for editing.
  3. Add a zosconnect_auditInterceptor element with version 2 SMF recording, and specify the OpenTelemetry HTTP W3C tracing header in the apiProviderRequestHeaders attribute.

    Example OpenTelemetry zosconnect_auditInterceptor
    <zosconnect_auditInterceptor id="openTelemetryInterceptor"
         sequence="3" apiProviderSmfVersion="2"
         apiProviderRequestHeaders="tracestate, traceparent" />

    Please note:

    Pay careful attention to the sequence if there are any previously configured auditInterceptors. For more information about server.xml and zosconnect_auditInterceptor configuration elements, refer to the IBM z/OS Connect product documentation in the IBM Knowledge Center.


  4. Add the new zosconnect_auditInterceptor id to the interceptorRef attribute of the zosconnect_zosConnectInterceptors or create a new zosconnect_zosConnectInterceptors if one was not previously configured.

    Example zosconnect_zosConnectInterceptors server.xml element
    <zosconnect_zosConnectInterceptors id="myServerInterceptorList"
          interceptorRef="zirisMetrics, openTelemetryInterceptor"/>
  5. If the updateTrigger="mbean" config element was configured in the server.xml file, a refresh can be dynamically performed to activate the new configuration using the MVS z/OS Connect MODIFY command. 

    Example z/OS Connect refresh command
    /F ZOSCONN1,zcon,refresh
  6. Check the z/OS Connect server messages.log for confirmation that the auditInterceptor changes have been detected and activated.

    Example z/OS Connect messages.log auditInterceptor confirmation
    [2/11/21 9:31:29:906 GMT] 000004de om.ibm.zosconnect.audit.smf.internal.AuditSMFInterceptorImpl I BAQR0801I: When active, the audit interceptor zirisMetrics is set to record SMF 123 subtype 1 version 2 records for API provider and version 1 records for API requester.
    [2/11/21 9:31:30:603 GMT] 000004de om.ibm.zosconnect.audit.smf.internal.AuditSMFInterceptorImpl I BAQR0801I: When active, the audit interceptor openTelemetryInterceptor is set to record SMF 123 subtype 1 version 2 records for API provider and version 1 records for API requester.
    [2/11/21 9:31:30:668 GMT] 000004de om.ibm.zosconnect.audit.smf.internal.AuditSMFInterceptorImpl I BAQR0803I: Request headers to be recorded by the audit interceptor openTelemetryInterceptor are [tracestate, traceparent].
    [2/11/21 9:31:32:883 GMT] 000004de om.ibm.zosconnect.audit.smf.internal.AuditSMFInterceptorImpl I BAQR0801I: When active, the audit interceptor hrAuditInterceptor is set to record SMF 123 subtype 1 version 2 records for API provider and version 1 records for API requester.
    [2/11/21 9:31:33:584 GMT] 000004de com.ibm.zosconnect.internal.ServiceManagerImpl               A BAQR7096I: z/OS Connect EE interceptor list myServerInterceptorList is active at the global level with interceptors: zirisMetrics,openTelemetryInterceptor.