Customizing the Log Forwarder started task to collect z/OS log data

To enable the Log Forwarder to stream z/OS® log data to the Data Streamer, you must create and update the started task for the Log Forwarder.

To create and update the started task, complete the following steps:

1. In your copy of the procedure HBOPROC, in the STDPARM DD statement, customize the following parameter values for your environment:

   /usr/lpp/IBM/zcdp/v5r1m0/LF/samples/startup.sh

   Replace this value with the path where the startup.sh script is located.

   The following path is the default installation path for the startup.sh script:

   /usr/lpp/IBM/zcdp/v5r1m0/LF/samples/startup.sh

   Change the value if a different installation path was used during the SMP/E installation.

   -e

   Specifies the full file path of the Log Forwarder configuration file.

   -e /etc/cdpConfig/myPolicy.config.properties

   -p

   The port on which the Data Streamer listens for data from the Log Forwarder.

   Tip: For more information about the Data Streamer port, see Configuring the Data Streamer.

   You can also set the following parameters under the STDPARM DD statement:

   -h

   Specifies the IP address of the Data Streamer that the Log Forwarder will connect to. Specify this parameter only if the Data Streamer is configured to bind to a specific IP address. Because the Data Streamer and Log Forwarder must be running on the same LPAR, the IP address must be a valid IP address on the LPAR where the Log Forwarder runs. This parameter is optional. If not specified, the Log Forwarder connects to the Data Streamer on the IP address of 127.0.0.1.

   -l/-L

   Specifies the collection level of the Log Forwarder.

   • If this parameter is specified, the Log Forwarder will only collect LPAR level data streams.
   • If this parameter is specified with one or more collection groups, the Log Forwarder will collect LPAR level data streams and SYSPLEX data streams that belong to the collection groups. You can specify the collection group in this format:

      -L Group1,Group2…

   • If the parameter is not specified, the Log Forwarder will collect both LPAR level and SYSPLEX level data streams.

   Tip: You can define the level of a data stream through the Scope in the Configuration Tool. If the scope is SYSPLEX, the data stream is a SYSPLEX level data stream. If the scope is LPAR or MVS_IMAGE, the data stream is LPAR level. You can define the collection group of a SYSPLEX level data stream through the Collection Group in the Configuration Tool.

   Note:

   • If you use the -L Group to collect data, ensure that all the started task of Log Forwarder is started with -L or -L Group so that duplicated data is not collected.
   • If you use one Log Forwarder to collect sysplex-level data stream for some time, then use another Log Forwarder to continue to collect the same data stream for some time, and then you want to use the first Log Forwarder to continue to collect the data stream, you must start the first Log Forwarder in cold mode to clear the outdated resume point for the data stream so that no duplicated data is collected.

2. Update the following environment variables in the STDENV DD statement:

   JAVA_HOME

   The Java™ installation directory.

   CDP_HOME

   The Log Forwarder working directory, which contains files that are created and used during the operation of the Log Forwarder. For example, it includes files that contain information about the state of the Log Forwarder and its progress in collecting data.

   TZ

   The time zone offset for the Log Forwarder and all data streams from the Log Forwarder.

   You can also set the following environment variables in the STDENV DD statement based on your needs:

   DEFAULT_HEAP

   Specifies the heap value that is used by the Log Forwarder Java application by default. DEFAULT_HEAP=4g means that the default heap size is 4 GB. If you want to change the default heap size, uncomment the parameter DEFAULT_HEAP and set a new size.

   Important:

   • If you are running out of memory, you can increase the heap size.
   • For best performance, set the same value for both DEFAULT_HEAP and MAXIMUM_HEAP.

   MAXIMUM_HEAP

   The maximum heap value that is available to the Log Forwarder Java application. MAXIMUM_HEAP=4g means that the maximum heap size is 4 GB. If you want to change the maximum heap size, uncomment the parameter MAXIMUM_HEAP and set a new size. This value must be no less than the value of DEFAULT_HEAP.

   Important:

   • If you are running out of memory, you can increase the heap size.
   • For best performance, set the same value for both DEFAULT_HEAP and MAXIMUM_HEAP.

   RESOLVER_CONFIG

   The TCP/IP resolver configuration file that the Log Forwarder must use.

   The Log Forwarder is a z/OS UNIX System Services program. It uses TCP/IP functions that require access to the TCP/IP resolver configuration file.

   For more information, see Base resolver configuration files.

   IBM_WAS_LIBPATH

   The IBM WebSphere Application Server for z/OS installation root directory for Web Server Plug-ins. This directory $IBM_WAS_LIBPATH/plugins contains the com.ibm.hpel.logging.jar file that is used to retrieve log data from High Performance Extensible Logging (HPEL).

   CDP_PTKT_USER

   The user ID to authenticate with RMF DDS.

   _BPXK_SETIBMOPT_TRANSPORT

   The TCP/IP stack to which the Log Forwarder must have affinity. If no value is specified, the Log Forwarder has affinity to the default TCP/IP stack.

   Important: If the LPAR has multiple TCP/IP stacks, you must specify which stack you want the Log Forwarder to use and specify the same TCP/IP stack for the Data Streamer (as instructed in Customizing the Data Streamer started task). Otherwise, the Log Forwarder might be unable to connect to the Data Streamer.