IBM i AS/400

Defines the IBM i system monitored by the sampler. This can be either an IP address or the actual system name.

Mandatory: Yes

IBM i username to use for monitoring.

Mandatory: Yes

Note

The Subsystem View requires user type SECOFR to return data for all subsystems.

Password of the IBM i user.

Mandatory: Yes

Defines the time-out for the views, in seconds.

Mandatory: Yes

Default: 30

The percentage of processor database capability that was used during the elapsed time.

The value -1 (Not reported by this system) indicates that the system does not report the amount of CPU used for processing.

The percentage of the total shared processor pool capacity used by all partitions using the pool during the elapsed time.

The value -1 (Partition does not share processors) indicates that the partition does not share processors.

The percentage of uncapped shared processing capacity for the partition that was used during the elapsed time.

The value -1 (Partition limited to configured capacity) indicates that the partition cannot use more than its configured processing capacity.

Indicates if the partition is sharing processors.

0 - does not share processors

1 - shares processors (capped - limited to using configured capacity)

2 - shares processors (uncapped - can use more than its configured capacity).

• -sampleCount is the number of times the disk queue was checked to determine whether or not the queue was empty
• -notBusyCount is the number of times the disk queue was empty during the same period that the sample count was taken

Note

On a partitioned system, the main storage size can change while the system is active.

• All jobs on job queues waiting to be processed.
• All jobs currently active (being processed).
• All jobs that have completed running but still have pending job logs or output on output queues to be produced.

Specifies the files to be displayed in the dataview.

Mandatory: Yes

Note

Headlines have a length limit; therefore, the displayed value can be truncated. You can retrieve the complete name from the headline, for example, by right-clicking and selecting Copy from <!>streamName > Value.

Number of messages that the sampler holds in the stream.

The sampler holds these messages until they are consumed by another sampler.

Maximum number of messages that the sampler can hold before it starts to drop earlier messages.

This value is set by the query Row limit option.

Total number of messages that the sampler has received in the stream.

A row in the query result counts as a message.

The SQL query that represents what data will be displayed in the dataview. By default, this runs only on the default database file member.

In some IBM i machines, database files may have one or more members. A member is similar to a subset of the file and each member contains records. To run a query on a non-default file member, follow these steps:

1. Create an alias that references the file and the member. This can be created within the terminal or via a database client. For example:

CREATE ALIAS QSYS.ALIAS1 FOR QSYS.FILENAME(MEMBERNAME).

2. Use the created alias in the query. For example:

SELECT * FROM QSYS.ALIAS1

Maximum number of rows to be displayed on the dataview. The rows are counted from the results of the query.

Default value: 200

This setting is disabled by default. If ticked, this enables the publishing of query results to a stream. Query result rows are streamed as JSON data containing column name-value pairs. A single row then counts as one stream message. On the first sample, all rows displayed in the dataview are streamed. On succeeding samples, only new and updated rows are streamed.

When enabled, the resulting stream has a fully qualified stream name in the following format: managedEntity-name.sampler-name(type).query-name

For example: ME.ibmi-jdbc.queryA

Caution

The stream option is not supported on Linux: Red Hat on IBM POWER8.

• Unsecure connection: 8471
• Secure connection: 9471

• If you specify a default database, for example, MYDB, containing the table TBL1 then the query SELECT * FROM TBL1 in the Sql option would suffice.
• If you have another database, MYDB2, containing the table TBL2, then you have to specify SELECT * FROM MYDB2.TBL2 in the Sql option. Notice that the fully qualified table name was specified, including the database it belongs to.

• stdAES— use this to input your plaintext password. If you select stdAES, you can define your password directly in the sampler and store it in standard AES encryption hash in the Gateway.
• var — use this to pass the password as a variable. The variable is defined in Managed entity > Advanced > Var. This is useful for situations where you have multiple samplers that use the same credentials.
• extPwd use this for passwords provided by an external provider. For more information, see Securing your Gateway with an external password provider in Secure Passwords.

Sets the maximum size that the pool is allowed to reach, including both idle and in-use connections. This option is set per IBM i JDBC sampler.

Default value: 5

Sets the maximum number of seconds that a query waits for a connection from the pool. A connection may time out when it cannot be established, for example, due to network issues.

Default value: 30

Sets the maximum number of seconds that a connection can be idle in the pool.

Default value: 600

• AUTOSTART
• BATCH
• INTERACTIVE
• SCPF_SYSTEM
• SPOOLED_READER
• SPOOLED_WRITER
• SUBSYSTEM_MONITOR
• SYSTEM

• ACTIVE
• JOBQ - job currently on a job queue
• OUTQ - completed running but still has output on an output queue

• DEQW - waiting for completion of a dequeue operation
• DSPW - waiting for input from a work station display
• MSGW - waiting for a message from a message queue
• SEMW - waiting for a semaphore (a synchronization function that is used to allow multiple jobs or threads to serialize their access to shared data)
• TIMA - waiting in a pool activity level for a time interval to end.
• TIMW - waiting for a time interval to end.

• BLANK
• HELD
• READY
• SCHEDULED
• RLS - job is ready to be selected

• 0: Job not ending.
• 1: Job ending in a normal manner.
• 2: Job ended while it was still on a job queue.
• 3: System ended abnormally.
• 4: Job ending normally after a controlled end was requested.
• 5: Job ending immediately.
• 6: Job ending abnormally.
• 7: Job ended due to the CPU limit being exceeded.
• 8: Job ended due to the storage limit being exceeded.
• 9: Job ended due to the message severity level being exceeded.
• 10: Job ended due to the disconnect time interval being exceeded.
• 11: Job ended due to the inactivity time interval being exceeded.
• 12: Job ended due to a device error.
• 13: Job ended due to a signal.
• 14: Job ended due to an unhandled error.

Time difference between the start datetime and the end datetime or the datetime of the current sample, if the job does not yet have an end datetime.

Unit: dddd:hh:mm:ss

Total amount of processing time the job used.

Unit: ms

Note

This field will not be displayed if enableCpuStatistics is set to false.

Percentage of the processing unit used by the job during the elapsed sampling time.

Unit: %

Note

This field will not be displayed if enableCpuStatistics is set to false.

Elapsed sampling time when a processing unit is used by the job.

Unit: ms

Note

This field will not be displayed if enableCpuStatistics is set to false.

Filters the dataview to include only the jobs with names matching the configuration.

Mandatory: No

By default, the plugin filters the dataview using a Java regex as indicated in the Javadoc for java.util.regex.Pattern.

If set to false, the Job name filter will expect a list of specific and generic AS/400 job names separated by the pipe symbol. A generic job name is indicated by a prefix, followed by an asterisk. The following are examples of valid job names:

• QSERVER
• QSERVER|QCTL
• QSERVER|QU*|QCTL|QT*
• Q*

Mandatory: No

Default: True

Note

• If the list of job names does not include valid specific or generic names, or if job names are not separated by the pipe symbol, then it will be treated as a regex instead.
• When using a list of job names, IBM i queries are more specific and relatively faster than when using a regex filter that queries all job names and applies the regex on the search results.

• ACTIVE
• JOBQ- job currently on a job queue
• OUTQ- completed running but still has output on an output queue

Filters the dataview based on the specified subsystem where the job runs.

Mandatory: No

Default: None

Note

This filter works by regex. If the subsystem filter has a value and enableCpuStatistics is false, then the subsystem filter will be ignored.

• AUTOSTART
• BATCH
• INTERACTIVE
• SCPF_SYSTEM
• SPOOLED_READER
• SPOOLED_WRITER
• SUBSYSTEM_MONITOR
• SYSTEM

Mandatory: No

Default: None

Note

This filter works by an exact match but is not case sensitive.

Filters the dataview based on jobs with jobEnteredSystemDate that falls within the specified last number of hours.

Mandatory: No

Default: 1

Maximum number of rows that the dataview displays.

Mandatory: No

Default: 20

Determines whether or not the CPU statistics will be retrieved by the plugin. Disabling CPU statistics will improve the performance of the plugin, but the following fields will not be displayed: totalCpuUsed,cpuPercentElapsed, cpuTimeElapsed.

Mandatory: No

Default: true

Name of the log file to read in the IBM i host.

This configuration supports wildcard expressions for filenames. Supported wildcard characters are * and ?. When you use wildcard characters for filenames, the stream rows are added to the Log Reader dataview as these are detected.

Note

Only one file will be associated with a wildcard pattern and stream at a time. The newest or most recently updated file matching the wildcard character will be monitored.

If ticked, the IBM i Log Reader reads from the beginning of a log file. Otherwise, the IBM i Log Reader reads from the last read position when the Netprobe or sampler is restarted.

This option is disabled by default.

Note

If both rewind and file position support are disabled, then the Log Reader reads from the end of the file.

Sets the maximum number of messages per stream that the IBM i Log Reader sampler holds in memory at a time. Messages clear the buffer when the stream is received by an FKM sampler.

You can toggle between entering a numerical value (data) or a variable (var).

Default value: 1000

Number of worker tasks that can be executed for reading files concurrently. This enables the IBM i Log Reader sampler to read multiple files at the same time during a sampling.

Files are queued and picked up for processing by an available worker. After being read, the files return to the queue for the next sample. You can tune the worker pool size so that the sampling of large or rapidly growing files would not block the sampling of other files.

You can toggle between entering a numerical value (data) or a variable (var).

Default value: 10

If ticked, then the IBM i Log Reader plugin keeps track of the current position of each monitored file. This makes it possible to resume from the last read position when the Netprobe is stopped or restarted.

If both rewind and file position support are disabled, then the Log Reader reads from the end of the file.

This option is ticked by default.

Number of days that a position file is allowed to be inactive before it is deleted.

Default value: 7

Note

This returns a value of 0 if the file member is suspended.

• If a file is entered, such as /QSYS.LIB/QS9DDS.FILE, then all its members will be displayed in the dataview.
• If a specific file member is entered, such as /QSYS.LIB/QUSRSYS.LIB/QAALERT.FILE/QAALERT.MBR, then that member will be displayed in the dataview.
• If a generic file member is entered, such as /QSYS.LIB/MOREFILE.LIB/PF2.FILE/PF*.MBR, then all matching file members will be displayed in the dataview.

• COMPLETION
• DIAGNOSTIC
• ESCAPE
• ESCAPE_NOT_HANDLED
• INFORMATIONAL
• INQUIRY
• MESSAGE_OPTION_UP_TO_10
• NOTIFY
• NOTIFY_NOT_HANLDED
• REPLY_FROM_SYSTEM_REPLY_LIST
• REPLY_MESSAGE_DEFAULT_USED
• REPLY_NOT_VALIDITY_CHECKED
• REPLY_SYSTEM_DEFAULT_USED
• REPLY_VALIDITY_CHECKED
• REQUEST
• REQUEST_WITH_PROMPTING
• SENDERS_COPY

Defines the message queue to monitor the sampler, such as QSYS.LIB/QSYSOPR.MSGQ.

Mandatory: Yes

Filters the messages based on the severity. The minimum and maximum values for severity are 0 and 99, respectively.

Mandatory: No

Default: 0

Filters the dataview based on the job name of the sender.

Mandatory: No

Default: None

Filters the dataview based on the job user of the sender.

Mandatory: No

Default: None

Maximum number of queued messages that will be fetched and displayed on the dataview.

Mandatory: No

Default: 20

Filters the dataview based on jobs with jobEnteredSystemDate that falls within the specified last number of hours.

Mandatory: No

Default: 1

Name of the message queue.

If Use full path for rowname is enabled, then this column displays the path of the message queue instead.

The qualified path name of the message queue.

If Use full path for rowname is enabled, then this column is not displayed in the dataview.

Name of the message queue.

If Use full path for rowname is enabled, then this column is displayed. Otherwise, it does not appear in the dataview.

• Specific library name
• *ALL - sets the filter to search in all libraries.
• *ALLUSR - sets the filter to search in all user libraries.
• *CURLIB - sets the filter to search in the current library.
• *LIBL - sets the filter to search in the library list.
• *USRLIBL - sets the filter to search in the user library list.

Mandatory: No

Default: *ALL

• Specific queue name.
• Generic queue name, such as QCQ*.
• *ALL - sets the filter to consider all queues.

Mandatory: No

Default: *ALL

Maximum number of rows that will appear on the dataview.

Mandatory: No

Default: 20

If enabled, the name column on the dataview displays the path, while a separate queueName column displays the queue name.

Mandatory: No

Default: false

• ACTIVE
• ENDING
• INACTIVE
• RESTRICTED
• STARTING

• Specific library name
• *ALL - sets the filter to search in all libraries.
• *ALLUSR - sets the filter to search in all user libraries.
• *CURLIB - sets the filter to search in the current library.
• *LIBL - sets the filter to search in the library list.
• *USRLIBL - sets the filter to search in the user library list.

Mandatory: No

Default: *ALL

• Specific subsystem name.
• Generic subsystem name, such as QC*.
• *ALL - sets the filter to consider all subsystems.

Mandatory: No

Default: *ALL

• ACTIVE
• ENDING
• INACTIVE
• RESTRICTED
• STARTING

Mandatory: No

Default: All the values listed above are ticked.

Maximum number of rows that will appear on the dataview.

Mandatory: No

Default: 20