Kafka recording options

Customize the recording settings for Kafka protocol scripts.

To access, click Record > Recording Options.

Recording Options > Log Options

Define the log level for your script.

UI element Description
Log Level

Define log level for script generation. Default value: Brief.

  • None. No log is generated.
  • Brief. Generates a standard recording log.
  • Extended. Generates a detailed log for methods, arguments, and return values.

Back to top

Kafka > Code Generation

Configure the code generation related to the producer and optional consumer in a recorded Kafka script.

UI Element
Description
Producer Configurations

Choose where the producer configuration code is saved.

  • Save in script folder as a new file. Creates a new .properties file in the script folder and saves the producer configuration in the new file.

    File name. Enter a name for the .properties file created for the producer configuration. If you do not enter a file name, a new .properties file is not created, and the producer configuration is instead inserted into the script.

  • Insert in script. (Default) Inserts the producer configuration into the script.
Consumer Settings

Enable the optional consumer and configure its behavior.

  • Create consumer. Initiates an optional consumer instance at the end of the recorded script, which polls for all records sent by the producer during replay.
  • Commit records. When this option is selected, the consumer initiated at the end of the script commits the records sent by the producer during replay. When the records are committed, they are not consumed again by any subsequent consumers that poll for records.

Back to top

Kafka > Configuration Files

Create, edit, import, and export configuration files of the file type .properties.

When you record a Kafka script, you select a configuration file for the consumer instance that VuGen creates for the recording. The configuration file contains properties that define the behavior of the consumer. Each property consists of a key-value pair.

Certain properties are mandatory and must be included in order to record a script. For details on the mandatory properties and other properties available for consumer configuration, see Kafka consumer and producer properties.

Configuration files created or imported in VuGen are saved in the folder: <installdir>\bin\dat\kafka.

UI Element
Description
Add button

In the left pane: Creates a new configuration file.

In the right pane: Adds a new line to enter a property in the selected configuration file.
Delete button

In the left pane: Deletes the selected configuration file.

In the right pane: Deletes the selected property from the configuration file.
Import button Imports a .properties file into VuGen to use as a configuration file.
Export button
Exports the selected configuration file.
Save button Saves your changes to the selected configuration file.
Discard changes button Discards any unsaved changes to the selected configuration file.
Reload button

Reloads the selected file from the disk.

Tip: If you have made changes to a configuration file outside of VuGen (for example, using a text editor), click Reload to see the changes reflected in VuGen.
Clear file button

Clears the selected configuration file and leaves only the mandatory consumer property keys. You must enter a value for each key.

Note: This overwrites any existing properties in the configuration file.

Back to top

Java Environment Settings > Java VM

Indicate additional parameters to use when recording Java applications.

UI Element
Description
Additional VM Parameters

List the Java command line parameters here. These parameters may be any Java VM argument. The common arguments are the debug flag (-verbose) or memory settings (-ms, -mx). In additional, you may also pass properties to Java applications in the form of a -D flag.

For more information about the Java VM flags, see the JVM documentation.
Use the specified Additional VM Parameters during replay
Instructs VuGen to use the same Additional VM Parameters in replay.

Back to top

Java Environment Settings > Classpath

Specify the location of additional classes that were not included in the system's classpath environment variable. You may need these classes to run Java applications and ensure proper recording.

UI Element
Description
Upload file button
Uploads a single .jar or .class file and adds it to the list of classpath entries.
Upload directory button
Uploads a directory and adds it to the list of classpath entries.
Remove files button
Removes the selected files from the list of entries.
<Classpath entries list>
A list of classpath entries. Click and drag to reorder the entries in the list.

Back to top

See also: