Properties
Lists and describes some of the properties in the .properties file.
For a complete, up-to-date list of configurable properties for the adapter, see the example file located at STREAMING_HOME/adapters/logfile_input/example.properties.
The example.properties file contains commented-out examples of the column lists for the common log format and the combined log format (see the "Parse.Class" section of the file). To use the Extended Common log format, add column names and datatypes to the Parse.Format.Common.Columns property. Since the log file reader is extensible and modifiable, you can define your own formats, and modify the existing formats to match your configurations. For example, if your Apache server has changed the format it writes for common log format or combined log format, you can modify the properties file to match. You can either modify existing entries or create new entries. For example, you can create a new format named "MyUncommonFormat" and define the columns for that format.
| Property Name | Description |
|---|---|
| Input.Filename |
Type: string Specifies the path to the first file in the directory to read. If using Windows, backslashes in the path must be escaped. For example, to specify C:\exampleDir\file.log, enter C:\\exampleDir\\file.log. Regular expression file names cannot contain backslashes. In the case of AdvancingLogFileInputBean, if the filename you give doesn't exist in the directory, it will instead read all of the files that were modified after Input.After. If Input.After is not set, then the default value will be the current system time when the adapter is started. If the filename does exist, then the Input.After property has no effect |
| Input.Class |
Type: string Specifies whether to use advancing or rotating mode: com.sybase.esp.adapter.logFileInput.AdvancingLogFileInputBean for advancing or com.sybase.esp.adapter.logFileInput.RotatingLogFileInputBean |
| Input.After |
Type: time (in milliseconds since the epoch) Used for AdvancingLogFileInputBean only. If a filename is given that isn't in the specified directory, the adapter will instead read all the files in that directory that were modified after Input.After. If this property is not set, then the default value will be the current system time in milliseconds when the adapter is started. |
| Input.WaitForGrowth |
Type: string If set to false, the adapter reads until it reaches the end of the file and then exits. If set to true, the adapter continues reading from the log file indefinitely at intervals of 100 milliseconds (the default interval). A value in the format milliseconds, or milliseconds, nanoseconds tells the server to continue reading from the log file indefinitely at the specified interval; for example, 10 tells the adapter to read every 10 milliseconds and 0,500000 tells the adapter to check every 500000 nanoseconds, or 2000 times per second. The actual interval between reads is approximately the interval you specify; the exact interval depends upon your system's hardware and operating system and load. |
| Parse.Class |
Type: string Specifies the JavaBean used to parse columns in the log file. |
| Parse.FormatName |
Type: string Specifies the name of the format of the data in the log file. This may be the name of one of the predefined formats, such as common or combined, or it may be the name of a custom format. |
| Parse.{FormatName}.Columns (where {FormatName} is replaced with the name provided by Parse.FormatName) |
Type: string Contains the names and datatypes of the column names in the log file. You may need to customize this property. |
| Parse.{FormatName}.DateColumn (where {FormatName} is replaced with the name provided by Parse.FormatName) |
Type: string Contains the name of the date column in the log file. This value must match the actual name of your date column. |
| Parse.{FormatName}.TimeColumn (where {FormatName} is replaced with the name provided by Parse.FormatName) |
Type: string (Optional) Contains the name of the time column in the log file. This column is needed only if the date column does not include the time. |
| Output.Uri |
Type: string URI of the input stream or window to send the rows to. |
| Output.Columns |
Type: string The string should contain a list of column names separated by spaces. This allows you to match the output to the schema of the input stream or window that you are writing to. |
| Output.Stream |
Type: string The name of the input stream or window that you are writing to. |
| Admin.Input |
Type: string If Admin.Input is set to stdin, then the log file adapter reads stdin looking for administrative commands. The only administrative command it currently supports is exit, which can be requested by any of the input lines: exit, quit, x, or q. The primary intent of this is as a debugging aid. The default is for no administrative request bean. |
| Output.AuthType |
Type: string (Optional) Specifies authentication type. Valid values are: UserPassword, Kerberos, or ServerRSA. Default value is UserPassword. |
| Output.username |
Type: string (Required) For UserPassword, this specifies the username for the server. For ServerRSA authentication method, this specifies the keystore alias. |
| Output.password |
Type: string (Dependent required) Required by UserPassword authentication method. Specifies password for the Server. |
| Output.passwordEncrypted |
Type: string (Dependent required) Specifies whether password in Output.password property is encrypted. Valid values are true or false. Default value is false. |
| Output.RSAKeyStore |
Type: string (Dependent required) Specifies location of keystore file. Required by ServerRSA authentication method or UserPassword (if password is encrypted). |
| Output.RSAKeyStoreAlias |
Type: string (Dependent required) Specifies the keystore alias. Required by UserPassword authentication method if password is encrypted. |
| Output.RSAKeyStorePassword |
Type: string (Dependent required) Specifies password for the RSA keystore. Required by ServerRSA authentication method or UserPassword (if password is encrypted). |
| Output.KerberosKDC |
Type: string (Dependent required) Specifies host name for the Kerberos key distribution center. Required by Kerberos authentication method. |
| Output.KerberosRealm |
Type: string (Dependent required) Specifies the Kerberos realm setting. Required by Kerberos authentication method. |
| Output.KerberosService |
Type: string (Dependent required) Specifies the Kerberos principal name that identifies an Event Stream Processor cluster. Required by Kerberos authentication method. |
| Output.KerberosTicketCache |
Type: string (Dependent required) Specifies the location of the Kerberos ticket cache file. Required by Kerberos authentication method. |
| Parse.BigDatetime.Format |
Type: string Specifies format of bigdatetime column. Uses java.text.SimpleDateFormat, which does not support microseconds. To display microseconds, ensure the string UUUUUU is present. If month comes after microseconds, and the number of characters in the month are variable, the data is parsed incorrectly. For example, if the full month name is used, September has more characters than July, and July has more than May. |