Tuning the agent configuration¶

According to the Lightrun actions you specify, the agent dynamically inserts logs and snapshots in the target environment. The agent's behavior when performing these tasks is governed by a set of user-configurable properties.

Agent properties¶

You can specify the agent properties within your code, by using environment variables, or using an agent.config file.

Specifying agent properties within the code¶

You can specify your agent configuration parameters by entering the parameters in the Lightrun.Start command.

For example,

LightrunAgent.Start(new AgentOptions {
    Secret = "<LIGHTRUN_SECRET>",
    PropertyName1 = "value" ,
    PropertyName2 = "value",
});

Specifying agent properties using environment variables¶

An alternative method for configuring agent properties is to enter them as environment variables. This can be done by adding a LIGHTRUN_ prefix to the configuration parameter. For example, to set the Lightrun secret key and server url in a .env file, we would use something similar to the following:

//.env file

LIGHTRUN_SECRET=<lightrun_secret_key>
LIGHTRUN_SERVERURL=<lightrun_server_url>

Specifying agent properties using an agent.config file¶

You can also specify the agent properties using an agent.config file. Add the path to the agent.config file in your Lightrun.Start command using the AgentConfigFile parameter as shown in the example below.

LightrunAgent.Start(new AgentOptions {
   AgentConfigFile: '<PATH-TO-CONFIG>'
});

Order of precedence¶

When an application is run with a Lightrun agent, properties are defined in the following order of precedence:

1. Start method parameter
2. Environment variables
3. agent.config file

Configuration parameters¶

The following table lists the configuration parameters that can be set in the agent.config file, environment variables, or the Lightrun.Start command.