Updating the Data Receiver properties

After you copy the Z Common Data Provider Data Receiver files to the target system, you must update the cdpdr.properties sample file in the Data Receiver working directory (CDPDR_HOME directory).

About this task

In the cdpdr.properties sample file, you can customize the following Data Receiver properties:
port
The port on which the Data Receiver listens for data from the Data Streamer. This port must be the same as the port that is defined for the subscriber in the policy file. For more information, see Subscriber configuration.
cycle
The number of output files that can simultaneously exist in the Data Receiver output directory (CDPDR_PATH directory). The maximum value is 299, and the minimum value is 3.

The cycle property is related to how the Data Receiver manages disk space. For more information about how the Data Receiver manages disk space, see Data Receiver process for managing disk space.

ssl
A y or n specification of whether to use the Transport Layer Security (TLS) protocol for Data Receiver communication with the Data Streamer. If a lowercase value y is used for this property, the Data Receiver enables TLS, and if a lowercase value n is used for this property, the Data Receiver disables TLS.
enable_trace_ssl
A y or n specification of whether to enable Secure Sockets Layer (SSL) communication between the Data Receiver and dynamic logging. If a lowercase value y is used for this property, the Data Receiver enables SSL for dynamic logging (default option). Else, a lowercase value n disables SSL for dynamic logging.
verify_client
A y or n specification of whether to use the mutual TLS (two-way) authentication protocol for Data Receiver communication with the Data Streamer. If a lowercase value y is used for both ssl and verify_client, the Data Receiver enables mutual TLS; otherwise, the Data Receiver disables TLS.
trace
A y or n specification of whether to activate tracing for the Data Receiver. If a lowercase value y is used for this property, the Data Receiver enables tracing, and if a lowercase value n is used for this property, the Data Receiver disables tracing. Typically, you activate tracing only at the request of IBM® Support.
csv_header
A y or n specification of whether to write header information of CSV data streams into the output data files. If a lowercase value y is used for this property, the Data Receiver enables the 'CSV Header Included' function; otherwise, a lowercase value n disables the CSV Header Included function.
Note: Header information will be written into the output data files and then received by Splunk only when you set the csv_header parameter in the cdpdr.properties file to y and also set the CSV Header Included parameter in the policy to Yes.
isNewPollingMechanism
A y or n specification of whether to use an updated polling mechanism to receive data. If a lowercase value y is used for this property, the Data Receiver uses an exponential polling mechanism; otherwise, a lowercase value n uses a constant polling mechanism.
JAVA_HOME
The Java™ environment on which you run the Data Receiver. You can specify the local Java environment, otherwise, the DataReceiver.sh and the DataReceiver.bat scripts run the Data Receiver on the default local Java environment.
CDPDR_HOME
The path of the working directory of Data Receiver. There cannot be spaces in the path name.

After the Data Receiver is started, the log directory logs is created in the CDPDR_HOME directory by default.

If CDPDR_HOME is not specified, the default path is the directory where the script DataReceiver.sh or DataReceiver.bat is located. The working directory (CDPDR_HOME) and the output directory (CDPDR_PATH) for the Data Receiver must be different.
CDPDR_PATH
The path of output directory for Data Receiver. There cannot be spaces in the path name. If CDPDR_PATH is not specified, the ouptuts directory is generated as the default directory in the current CDPDR_HOME directory. The working directory (CDPDR_HOME) and the output directory (CDPDR_PATH) for the Data Receiver must be different.
fileSizeThreshold
The threshold value for the file size. It is used to determine the maximum size limit for the .cdp files. This value is optional, and you can specify the value in kilobytes (KB), megabytes (MB), or gigabytes (GB). This property sets a threshold beyond which .cdp files are considered oversized. The default value is 100 GB.

Procedure

To update the Data Receiver properties, complete the following steps:

  1. In the cdpdr.properties file in the CDPDR_HOME directory, update the property values with your configuration preferences.
  2. If you choose to use the TLS protocol for Data Receiver communication with the Data Streamer (ssl=y in the cdpdr.properties file), also complete the appropriate configuration steps in Configuring TLS on the Data Receiver.
  3. If you want to run multiple Data Receivers in your environment, you can modify the property values in the cdpdr.properties file. You must ensure that each Data Receiver has a unique port value.