Tuning the agent configuration¶
According to the Lightrun actions you specify, the agent dynamically inserts logs and snapshots in the production code. The agent's behavior when performing these tasks is governed by a set of user-configurable properties.
You can specify the agent properties within the code or by using a config file.
Specifying agent properties within the code¶
You set agent configuration properties by entering keyword arguments in the
lightrun.enable() call function. For example:
server_url keyword is required only if Lightrun is used on-prem.
Specifying agent properties using a config file¶
lightrun.enable, you can either pass the
company_key parameter (as above), or use the
agent_config parameter as shown in this example.
agent_config keyword must reference the full path to a user-created
You can see here an example
agent.config file. The default parameter values can be modified for your own applications.
The above methods for passing keywords can be combined. However, configuration parameters passed as keyword arguments override the parameter values in
agent.config (if provided).
The following table lists the configuration parameters that can be set in both the
agent.config file and the
lightrun.enable() call function.
|Flag name||Description||Default value|
| ||Company name||-|
| ||The URL of the Lightrun backend server (default: https://app.lightrun.com/). server_url should only be changed when using Lightrun on-prem.||-|
| ||Combined URL of of the company and the Lightrun backend server. This single parameter can be used instead of the combination of ||-|
| ||The company's secret API key||-|
| ||The default expiration time for Lightrun actions||-|
| ||Whether or not to disable all performance safety measures - USE WITH CAUTION||-|
| ||Path to a JSON file containing the agent's registration metadata (such as tags, and display name)||-|
| ||Array of tags for the agent, can be used when there is no metadata file||-|
| ||The format for the logs to be printed by inserted logpoints to the console. For example - ||-|
| ||The pattern for writing logpoints to a file. If this parameter is left empty, logs from inserted actions are not written to a file||-|
| ||The format for logs from inserted log points to be printed to the file specified in the ||-|
| ||Files from this directory will have a higher priority in the case of name conflicts.||sys.path|
| ||Block the application until the first time breakpoints are fetched from the server. This option is intended for short-running applications like serverless functions, and it ensures that the Lightrun agent has time to communicate with the Lightrun server before the short-running application disconnects. |
Note - using lightrun_wait_for_init in a cloud environment will likely incur additional costs from the cloud provider due to a longer application runtime.
| ||Timeout in seconds for wait if ||-|
| ||Maximum allowed additional CPU load when inserting actions during condition evaluation (value between 0.1 and 1.0)||1.0|
| ||Maximum allowed additional CPU load when logging (value between 0.1 and 1.0)||1.0|
Except for the parameter
company_key, all other configuration options have default values.