Create and Configure Source - Ironstream_Hub - 1.3.1

Ironstream Hub Administration

Product type
Software
Portfolio
Integrate
Product family
Ironstream
Product
Ironstream > Ironstream Hub
Version
1.3.1
Language
English
ContentType
Administration
Product name
Ironstream Hub
Title
Ironstream Hub Administration
Topic type
Administration
First publish date
2022

The source configuration panel has four tabs:
Tab Description Type
General Contains important information required to configure the source. General setting
Log Allows you to configure log settings for the source. Advance setting
Monitoring Allows you to monitor the source based on certain monitors. Advance setting
Message Tag Provides a way to add insight to log events by adding a JSON key/ value pair. Advance setting
  1. Click anywhere in the ‘IBM I – Untitled Source’ box to configure the source. ‘Edit Source Configuration’ panel will open at the bottom.
  2. Complete these fields for General tab in the bottom panel (Edit Source Configuration) of the canvas:
    Field Description
    Source name Name of the source. Character limit is from 1 to 50.
    Description Short description about the source. This will be visible on the canvas. Character limit is 200.
    License Keys One or more hub license keys. These are 48-character strings made up of the numbers 0 through 9 and A through F. Separate multiple keys with a comma. At least one key must be within its expiry date or you will be unable to save the target.
    Address and Agent Information
    Hostname or IP address Valid DNS name or IP address
    Agent port number The port number used by Ironstream service to connect to the IBM i agents. Valid values are between 1024 and 65535. The default port number is 9000.
    Retry interval The interval (in seconds) at which the Hub will try to connect to the IBM i agent. Valid values are between 1 and 86400. The default Retry interval is 30.
    Agent Time Zone Location Allows a user to select the time zone to associate data from this IBM i system. The default value for backward compatibility is ‘No timezone' which means the timezone of the Hub will be used. The next drop down option is 'Use agent timezone' - this will ensure all data from this system has its correct timezone, but requires that the agent is updated to provide this data. Setting this option without updating the agent will result in the pipeline not being able to run. Further drop-down choices provide a comprehensive list of world timezones if a specific one is required.
    Host Command
    Local port number Port number used by the host command to connect to the Ironstream Hub. Valid values are between 1024 and 65535. The default port number is 9001.
    Secure Connection to Agent
    Enable TLS encryption Indicates if TLS encryption is to be implemented for the connection between Hub and the Ironstream Agent for IBM i. To specify the use of TLS communication, follow the steps in the chapter 'Using TLS Encryption for the Hub-to-IBM i Agent Connection' of the Ironstream Hub Installation Guide.
    Certificate authority file

    Specifies the location of the certificate authority file created for the TLS connection.

    For windows: Character limit is from 1 to 260.

    For Linux: Character limit is from 1 to 4096.

    Note:

    Source name, Hostname or IP address, Agent port number, Retry interval, Local port number and (if 'Enable TLS encryption' is ticked) Certificate authority file are required fields. If you leave one of the required fields blank, text on the bottom panel identifies this and the icon against the source box on the canvas remains orange. You must complete the required fields to turn the icon to a green ‘check’ against the source.

    Example of completed source:
  3. Complete these fields for Log tab in the bottom panel of the canvas:
    Field Description
    Log level Specifies the granularity of the pipeline specific log tracing. The valid levels are None, Error, Warning, Info, and Debug. The default is None.
    Maximum log size (MB) Maximum size of the log file (in megabytes). Valid values are between 10 and 1000000. The default is 30 MB.
  4. Complete these fields for Monitoring tab in the bottom panel of the canvas:
    Field Description
    Enable Monitor Activity
    Monitor QHST Indicates whether the Ironstream Agent for IBM i will collect the QHST system history log and send it to the Ironstream Hub. This field is unchecked by default.
    QHST message area buffer size
    The size of the buffer for QHST messages (1 message = ~ 1 KB).
    Note: This field is displayed only if the Monitor QHST box is checked.

    Default is 100 KB.

    Monitor Journal Indicates whether the Ironstream Agent for IBM i will monitor the system or user journals (using EVJRNPROC jobs) on the IBM i LPAR.
    Ignore journal records older than Allows a user to set a limit in hours beyond which older journal data will be ignored.
    Note: This field is visible only if the Monitor Journal box is checked.

    This field is unchecked by default.

    Enable Performance Collection
    Collection interval for metrics that tend to fluctuate more (e.g. CPU busy) Enables collection of performance data by the IBM i agent such as CPU usage, average numbers of users signed in and jobs.

    This field is unchecked by default.

    Collection interval for metrics that tend to fluctuate less (e.g. disk space) Enables collection of performance data by the IBM i agent such as disk occupancy, storage size, and number of memory pools.

    This field is unchecked by default.

  5. Complete these fields for Message Tag tab in the bottom panel of the canvas:
    Field Description
    Message tag key Key name of an optional JSON key/value pair that will be added to all records sent to the target.
    Message tag value Value of an optional JSON key/value pair that will be added to all records sent to the target.