Log File log source parameters for IBM WebSphere
If QRadar does not automatically detect the log source, add a IBM® WebSphere® log source on the QRadar Console by using the Log File protocol.
When using the Log File protocol, there are specific parameters that you must use.
Parameter | Value |
---|---|
Log Source name | Type a name of your log source. |
Log Source description | Type a description for your log source. |
Log Source type | IBM WebSphere Application Server |
Protocol Configuration | Log File |
Log Source Identifier |
Type an IP address, host name, or name to identify your IBM WebSphere Application Server as an event source in QRadar. IP addresses or host names are recommended as they allow QRadar to identify a log file to a unique event source. For example, if your network contains multiple IBM WebSphere Application Serves that provides logs to a file repository, specify the IP address or host name of the device that created the event log. This allows events to be identified at the device level in your network, instead of identifying the file repository. |
Service Type |
From the list, select the protocol that you want to use when retrieving log files from a remove server. The default is SFTP.
The underlying protocol that is used to retrieve log files for the SCP and SFTP service type requires that the server specified in the Remote IP or Hostname field has the SFTP subsystem enabled. |
Remote IP or Hostname |
Type the IP address or host name of your IBM WebSphere Application Server storing your event log files. |
Remote Port |
Type the TCP port on the remote host that is running the selected Service Type. The valid range is 1 - 65535. The options include FTP ports:
If the host for your event files is using a non-standard port number for FTP, SFTP, or SCP, you must adjust the port value. |
Remote User |
Type the user name necessary to log in to the host that contains your event files. The user name can be up to 255 characters in length. |
Remote Password |
Type the password necessary to log in to the host. |
Confirm Password |
Confirm the password necessary to log in to the host. |
SSH Key File |
If you select SCP or SFTP as the Service Type, this parameter allows for the definition of an SSH private key file. The Remote Password field is ignored when you provide an SSH Key File. |
Remote Directory |
Type the directory location on the remote host to the cell and file path you specified in Configuring IBM WebSphere. This is the directory that you created containing your IBM WebSphere Application Server event files. For FTP only. If your log files are located in the remote user's home directory, you can leave the remote directory blank. This is to support operating systems where a change in the working directory (CWD) command is restricted. |
Recursive |
Select this check box if you want the file pattern to search sub folders. By default, the check box is clear. The Recursive option is ignored if you configure SCP as the Service Type. |
FTP File Pattern |
If you select SFTP or FTP as the Service Type, this option allows for the configuration of the regular expression (regex) to filter the list of files that are specified in the Remote Directory. All matching files are included in the processing. The FTP file pattern that you specify must match the name that you assigned to your JVM logs in Customizing the Logging Option. For example, to collect system logs, type the following code:
Use of this parameter requires knowledge of regular expressions (regex). For more information, see the following website: http://download.oracle.com/javase/tutorial/essential/regex/ |
FTP Transfer Mode |
This option appears only if you select FTP as the Service Type. The FTP Transfer Mode parameter allows for the definition of the file transfer mode when log files are retrieved over FTP. From the list, select the transfer mode that you want to apply to this log source:
You must select None for the Processor parameter and LINEBYLINE the Event Generator parameter when you use ASCII as the FTP Transfer Mode. |
SCP Remote File |
If you select SCP as the Service Type you must type the file name of the remote file. |
Start Time |
Type the time of day you want the processing to begin. This parameter functions with the Recurrence value to establish when and how often the Remote Directory is scanned for files. Type the start time, based on a 24-hour clock, in the following format: HH: MM. |
Recurrence |
Type the frequency, beginning at the Start Time, that you want the remote directory to be scanned. Type this value in hours (H), minutes (M), or days (D). For example, type 2H if you want the directory to be scanned every 2 hours. The default is 1H. When you schedule a log file protocol, select a recurrence time for the log file protocol shorter than the scheduled write interval of the WebSphere Application Server log files. This ensures that WebSphere events are collected by the log file protocol before the new log file overwrites the old event log. |
Run On Save |
Select this check box if you want the log file protocol to run immediately after you click Save. After the Run On Save completes, the log file protocol follows your configured start time and recurrence schedule. Selecting Run On Save clears the list of previously processed files for the Ignore Previously Processed File parameter. |
EPS Throttle |
The maximum number of events per second that QRadar ingests. If your data source exceeds the EPS throttle, data collection is delayed. Data is still collected and then it is ingested when the data source stops exceeding the EPS throttle. The valid range is 100 to 5000. |
Processor |
If the files on the remote host are stored in a zip, gzip, tar, or tar+gzip archive format, select the processor that allows the archives to be expanded and the contents to be processed. |
Ignore Previously Processed File(s) |
Select this check box to track files that are processed. Files that are previously processed are not processed a second time. This check box applies only to FTP and SFTP Service Types. |
Change Local Directory? |
Select this check box to define the local directory on your QRadar that you want to use for storing downloaded files during processing. We recommend that you leave the check box clear. When the check box is selected, the Local Directory field is displayed, which gives the option of configuring the local directory to use for storing files. |
Event Generator |
From the Event Generator list, select WebSphere Application Server. The Event Generator applies more processing, which is specific to retrieved event files for IBM WebSphere Application Server events. |
For a complete list of Log File protocol parameters and their values, see Log File protocol configuration options.