File ParametersFile Parameters
This topic describes the File Collection configuration parameters.
Workflow
This workflow illustrates the basic tasks needed to start collecting events through Log Collection.
What do you want to do?
| Role | I Want to... | Documentation |
|---|---|---|
|
Administrator |
Perform basic Log Collection implementation |
|
|
Administrator |
Set up a lockbox to maintain lockbox settings. |
|
|
Administrator |
Start Log Collection services. |
|
|
Administrator |
*Configure Log Collection protocols and event sources |
|
|
Administrator |
Verify that Log Collection is working. |
*You can perform this task here.
Related Topics
File Collection Event Source Parameters
The following table provides descriptions of the File Collection source parameters.
The following table describes the Basic configuration parameter for File collection.
Note: Required parameters are marked with an asterisk. All other parameters are optional.
| Name | Description |
|---|---|
| File Directory* |
Collection directory (for example, Eur_London100) into which the File event source places its files. Valid value is a character string that is conforms to the following regular expression: [_a-zA-Z][_a-zA-Z0-9]* This means that the file directory must start with a letter followed by numbers, letters, and underscores. Do not modify this parameter after you start collecting event data. After you create the collection, the Log Collector creates the work, save, and error sub-directories under the collection directory. |
| Address* | IP address of the event source. Valid value is an IPv4 address, IPv6 address, or a hostname including a fully-qualified domain name. |
| File Spec | Regular expression. For example, ^.*$ = process everything. |
| File Encoding |
Character encoding used by the syslog senders to this port. Defaults to UTF-8. Note: It is safe to leave this as UTF-8, since UTF-8 handles ASCII characters as well, and most senders have their encoding set to UTF-8. NetWitness has tested the following values:
|
|
Cancel |
Closes the dialog without making adding an event source type. |
|
OK |
Adds the parameters for the event source. |
The following table describes the Advanced configuration parameter for File collection.
| Name | Description |
|---|---|
| Ignore Encoding Conversion Errors |
Select the check box to ignore encoding conversion errors and ignore invalid data. The check box is selected by default. Caution: This may cause parsing and transformation errors. |
| File Disk Quota |
Determines when to stop saving files regardless of the Save On Error and Save On Success parameter settings. For example, a value of 10 indicates that when there is less than 10% available disk left, the Log Collector stops saving files to reserve enough space for your estimated normal collection processing. Caution: Available disk refers to a partition where the base collection directory is mounted. If the Log Decoder server has a 10TB disk size and 2TB is allocated to base collection directory, then setting this value to 10 causes log collection to stop when less than 0.2TB (10% of 2TB) of space is left. It does not mean 10% of 10TB. Valid value is a number in the 0 to 100 range. 10 is the default. |
| Sequential Processing |
Sequential processing flag:
|
| Save On Error | Save on error flag. Check the checkbox to retain the eventsource collection file when the Log Collector it encounters an error. The check box is selected by default. |
| Save On Success | Save eventsource collection file after processing flag. Check the checkbox to save the eventsource collection file after processing it. The check box is not selected by default. |
| Eventsource SSH Key |
SSH public key used to upload files for this event source. Please refer to the Generate Key Pair on Event Source and Import Public Key to Log Collector section in the Install and Update the SFTP Agent Guide for instructions on generating keys. Note: If File collection is stopped, NetWitness does not update the authorized_keys file with the SSH public key that you add or modify in this parameter. You must restart File collection to update the public key. |
| Manage Error Files |
By default, the Log Collector uses the File Disk Quota parameter to ensure that the disk does not fill up with error files. If you set this parameter to true, you can specify one of these:
A reduction percent is also specified, which tells the system how much to reduce when the maximum is reached. Select the check box to manage error files. The check box is not selected by default. |
| Error Files Size |
Only valid if the Manage Error Files and Save On Error parameters are set to true. Valid value is a number in 0 to 281474976710655 range. You specify these values in either Kilobytes, Megabytes, or Gigabytes. 100 Megabytes is the default. If you change this parameter, the change does not take effect until you restart collection or restart the Log Collector service. |
| Error Files Count |
Only valid if the Manage Error Files and Save On Error parameters are set to true. Maximum number of error files allowed in the error directory. Valid value is a number in 0 to 65536 range. 65536 is the default. If you change this parameter, the change does not take effect until you restart collection or restart the Log Collector service. |
| Error Files Reduction % |
Percent amount by size or count of the error files that the Log Collector service removes when the maximum size or count has been reached. The service removes the oldest files first. Valid value is a number in the 0 to 100 range. 10 is the default. |
| Manage Saved Files |
Select the check box to manage saved files. The check box is not selected by default.
A reduction percent is also specified, which tells the system how much to reduce when the maximum is reached. |
| Saved Files Size |
Only valid if the Manage Saved Files and Save On Success parameters are set to true. If you change this parameter, the change does not take effect until you restart collection or restart the Log Collector service. |
| Saved Files Count |
Only valid if the Manage Saved Files and Save On Success parameters are set to true. Maximum number of saved files in the save directory. Valid value is a number in 0 to 65536 range. 65536 is the default. If you change this parameter, the change does not take effect until you restart collection or restart the Log Collector service. |
| Saved File Reduction % |
Percent amount by size or count of the saved files that the Log Collector service removes when the maximum size or count has been reached. The service removes the oldest files first. Valid value is a number in the 0 to 100 range. 10 is the default. |
| Debug |
Caution: Only enable debugging (set this parameter to On or Verbose) if you have a problem with an event source and you need to investigate this problem. Enabling debugging will adversely affect the performance of the Log Collector. Enables or disables debug logging for the event source.
This parameter is designed to debug and monitor isolated event source collection issues. The debug logging is verbose, so limit the number of event sources to minimize performance impact. If you change this value, the change takes effect immediately (no restart required). |
