Configuring DWA Emitters
Last updated
Last updated
DWA Emitter for OpenSSH SFTP Server -- Prefix emitter.osshsftp[<label>].*
All pattern properties included in the configuration conform to Java Message Format syntax as defined in:
logFilePath
Name of the primary log file to monitor, complete with absolute path.
logFileFilterRegEx
Regular expression identifying all archived log files to monitor, located in the same directory configured for logFilePath primary log. Secondary log files are those logs that have been renamed by the system as part of some dynamic log rotation policy.
filterSftpdPattern
Pattern used to filter only SFTP lines related to current OpenSSH SFTP daemon. The provided default value is: {0,date,MMM d HH:mm:ss} {1} sftp-server[{2,number,integer}]: {3} Where: {0,date,MMM d HH:mm:ss} = timestamp according to the specified locale {1} = hostname {2} = session {3} = remainder of the line
sessionOpenedPattern
Pattern used to match user session opening. The provided default value is: session opened for local user {0} from [{1}] Where: {0} = user name {1} = client IP
sessionClosedPattern
Pattern used to match user session closing. The provided default value is: session closed for local user {0} from [{1}] Where: {0} = user name {1} = client IP
openPattern
Pattern used to match file opening. The provided default value is: open "{0}" flags {1} mode {2} Where: {0} = file name {1} = file opening flag {2} = file opening mode bitmask
closePattern
Pattern used to match file closing. The provided default value is: close "{0}" bytes read {1,number,integer} written {2,number,integer} Where: {0} = file name {1} = total read bytes {2} = total written bytes
sendStatusPattern
Pattern used to match send errors. The provided default value is: sent status {0} Where: {0} = error message
forcedClosePattern
Pattern used to match session errors/session abort. The provided default value is: forced close "{0}" bytes read {1,number,integer} written {2,number,integer} Where: {0} = file name {1} = total read bytes {2} = total written bytes
This emitter supports monitoring of IBM Sterling Connect:Direct 6.0.0 on distributed platforms (non-z/OS).
Actual detection of Connect:Direct (C:D) file transfer events is performed by accessing C:D Server statistics at runtime using C:D Java API.
C:D Java API jar must be provisioned by the customer on the machine where DWAgent is installed, this jar (usually named CDJAI.jar) is part of IBM Sterling Connect:Direct product installation and it is not distributed with DWAgent.
To include C:D Java API jar into DWAgent CLASSPATH you must create this environment variable DWAGENT_EXT_CP and set its value to the jar file name including its absolute path, then you must export it / make it in the environment where DWAgent is started.
IBM Sterling Connect:Direct versions different from 6.0.0 may be supported as well, depending on C:D Java API compatibility guarantees provided by IBM Sterling across versions.
Given that C:D Java API supports remote connections, DWAgent can also be installed on a machine different from the one where the monitored C:D Server is running.
DWA Emitter for C:D for distributed platforms -- Prefix emitter.cdmini[<label>].*
nodeName port userId password
Hostname (nodeName), port and credentials to be used when connecting to a C:D instance to retrieve statistical records.
connectTimeoutSeconds
Connection timeout to be assumed when connecting to a C:D instance to retrieve statistical records.
startStatisticsFromDate
Optional start date and time in YYYYMMDD-HHMMSS format starting from which old statistical records will be processed by DWAgent the first time it is started. When this parameter is blank, the assumed default timestamp is the date and time DWAgent is started up for the first time.
additionalRecordIDs=IFED,RJED,RTED
Used to emit event also for non-file transfer operations in this list: if statement (IFED), Run Job (RJED) and Run Task (RTED) operations.