Launch Parameters

Description#

In this section, you find the list of all params which can be used to customize Drill apps.

Introduction - How to pass Drill params#

Type	Additional Info	Example
java args	the supplied command-line arguments as an array of String objects	`-agentpath:mingwX64-0.8.0-15/ drill_agent.dll=drillInstallationDir=mingwX64-0.8.0-15/, adminAddress=localhost:8090, agentId=Petclinic, buildVersion=0.1.0, logLevel=DEBUG -jar spring-petclinic.BUILD-SNAPSHOT.jar`
System variables		DRILL_PLUGINS_REMOTE_ENABLED
Java System variable		-D[drill.example]
config file	for java-agent	see example below
by maven/gradle plugin	for autotest agents	see example below

Java Agent#

List of parameters#

Parameter	Description	Required	Default value	Example/Format(Default=String)
agentpath	The file where stores the agent	yes		a relative or absolute path, for example: mingwX64-0.7.0/drill_agent.dll
agentId	Name of agent	yes		Petclinic
adminAddress	Drill Admin API URL	yes		localhost:8090
drillInstallationDir	The folder where stores agent files(a relative or absolute path)	yes		mingwX64-0.7.0/
buildVersion	buildVersion of a target application if it is not set manually then it will calculate by system env JAVA_APP_JAR , for example, "/deployments/tmp/src/gs-spring-boot-docker-0.1.0.jar" → "gs-spring-boot-docker-0.1.0" otherwise it will set "unspecified"	no		0.1.0
instanceId		no	generated by uuid4()
groupId	This parameter groups your agents in one section. It is helpful if your app is based on a microservices arch.	no	""	petclinic-micro
logLevel	Logging agent work	no	ERROR	TRACE\|DEBUG\|INFO\|ERROR
logFile	the location where the logs will be stored	no	null	a relative or absolute path, for example: "E:\projects\project\spring-petclinic run with agent\drill-log.log"
isTlsApp	Add the ability of an agent to gain incoming headers from an Https request. Process TLS only for tomcat architecture	no	false	Boolean
isAsyncApp	TODO	no	false	Boolean
isWebApp	TODO	no	false	Boolean
webAppNames	the list of TODO. use : as delimiter.	no	""	web1:web2:etc
classScanDelay	start scanning after waiting of duration in milliseconds	no	0	5000 / int
configPath	The file where stores the config file	no		mingwX64-0.8.0-15/configFile.properties

System Variables#

Please, don't forget to reopen Command prompt window to apply changes. For more details see this information.

Parameter	Description	Required	Example / Format
DRILL_HTTP_HOOK_ENABLED drill.http.hook.enabled		no	It can be true/false. By default = true.
DRILL_AGENT_CONFIG_PATH	The file stores the config file	no	a relative or absolute path, for example: configFile.properties

Example of How to Pass Parameters by config file#

You can list params by properties file:

# This config file for Drill agent. docs: https://drill4j.github.io/docs/configuration/launch-parameters
#The folder where stores agent files(a relative or absolute path)
drillInstallationDir=mingwX64-0.8.0-15/
#Drill Admin API URL
adminAddress=localhost:8090
#adminAddress=host.docker.internal:8090
#Name of agent
agentId=Petclinic
#This parameter groups your agents in one section. It is helpful if your app is based on a microservices arch.
groupId=petclinic-micro
#buildVersion of a target application
#if it is not set manually then it will calculate by system env JAVA_APP_JAR , for example, "/deployments/tmp/src/gs-spring-boot-docker-0.1.0.jar" → "gs-spring-boot-docker-0.1.0"
#otherwise it will set "unspecified"
buildVersion=0.1.0
#Logging agent work. Options: TRACE|DEBUG|INFO|ERROR
logLevel=INFO
#a relative or absolute path for logging
#logFile=/drill-agent.log
#start scanning after waiting of duration in milliseconds, for example, 5 sec:
#classScanDelay=5000
#isTlsApp=true
#isAsyncApp=true
#isWebApp=true
#use ':' as delimiter
#webAppNames=web1:web2:etc

For Windows:
Point to the config file in java args (Command prompt example):

java -agentpath:mingwX64-0.8.0-15/drill_agent.dll=configPath=mingwX64-0.8.0-15/configFile.properties -jar spring-petclinic-0.1.0.BUILD-SNAPSHOT.jar

Or use the system variable DRILL_AGENT_CONFIG_PATH=mingwX64-0.8.0-15/configFile.properties

java -agentpath:mingwX64-0.8.0-15/drill_agent.dll -jar spring-petclinic-0.1.0.BUILD-SNAPSHOT.jar

For Docker:
If you are using docker images example, change "JAVA_TOOL_OPTIONS" parameter to:

- JAVA_TOOL_OPTIONS="-agentpath:/data/libdrill_agent.so=configPath=/data/configFile.properties"

Or use "DRILL_AGENT_CONFIG_PATH" parameter:

- JAVA_TOOL_OPTIONS="-agentpath:/data/libdrill_agent.so"
- DRILL_AGENT_CONFIG_PATH=/data/configFile.properties

Drill Admin#

Parameter	Default value	Description	Required	Example / Format
{PLUGIN_NAME}_PLUGIN_VERSION	""	if it is an empty value then it will take the latest version	no	key=TEST2CODE_PLUGIN_VERSION value=0.7.0
DRILL_AGENTS_SOCKET_TIMEOUT	120	a timeout of agent answers in seconds	no	3000
DRILL_DEFAULT_PACKAGES	""	when you register an agent you can set the default packages	no	org/springframework/samples/petclinic
DRILL_PLUGIN_CACHE	true	a cache for messages from plugins	no	true/false
DRILL_PLUGIN_CACHE_TYPE	mapdb	# jvm - on-heap cache mapdb - off-heap cache	no	jvm/mapdb
DRILL_JWT_LIFETIME	60d	lifetime of JWT token	no
PORT	8090	port of admin	no
DRILL_DEVMODE	false		no
DRILL_PLUGINS_REMOTE_ENABLED	true	the flag that disables plugin loading from artifactory	no	It can be true/false.
DRILL_JWT_LIFETIME	60d	lifetime of token	no

Autotest Agent#

Parameter	Required	Default value	Example	Description
version	yes	""	0.16.2	https://github.com/Drill4J/autotest-agent/releases — take version from here
adminHost	yes	""	localhost
adminPort	no	8080
agentId		""		like in Java agent
groupId		""		like in Java agent
logFile	no	null	file("debug.log")	create a log file
logLevel	no	ERROR		Logging agent work
sessionId	no	null		if empty it will generate by uuid4
runtimePath	no
agentPath	no

additionalParams:

Parameter	Default value	Input Example	Description
isRealTimeEnable	true		realtime feature
browserProxyAddress	null	localhost:7777
isManuallyControlled	false		if it is true - start & stop session need to be do manually
sessionForEachTest	false		if it is true - start & stop session will be for each test it affects performance!
isGlobal	false		Global session
rawFrameworkPlugins	""	Separate by ";" example: cucumber-v4; cucumber-v5; junit	strategy for autotest agent if it is empty value it will set all strategies automatically

Example with gradle plugin#

plugins {
    id 'com.epam.drill.agent.runner.autotest' version '0.2.3'
}

drill {
    def testFramework = System.getProperty("testFramework") ?: ""
    version = System.getProperty("autotestAgentVersion") ?: "0.16.12"
    agentId = System.getProperty("agentId") ?: null
    groupId = System.getProperty("groupId") ?: null
    adminHost = System.getProperty("adminHost") ?: "localhost"
    adminPort = System.getProperty("adminPort") ?: 8090
    logLevel = com.epam.drill.agent.runner.LogLevels.TRACE
    additionalParams =
            [
             "rawFrameworkPlugins": "$testFramework"
            ]
    logFile = file("build/drill-autotest.log")
}

Test2Code Plugin#

Part of admin#

It is runtime configs

Parameter	Default value	Description	Required	Example / Format
drill.plugins.test2code.features.realtime	true	the flag for disabling of the realtime feature when it uses StartSession in Active Scope	no	true/false
drill.plugins.test2code.features.realtime.cache	depends on drill.plugins.test2code.features.realtime		no	true/false
drill.plugins.test2code.send.packages	true	the flag for disabling of package sending Topics: .../scopes/{scopeId}/coverage/packages/{path}	no	true/false

Part of agent#

Parameter	Default value	Description	Required	Example / Format
drill.probes.perf.mode	false	when it true, we use less memory but can lose coverage	no	true/false