Appendix: Available Configuration Settings for the Agent
A list of all meaningful environment variables for the Chronicle agent can be found below:
Setting | Description | Default Value |
---|---|---|
CHRONICLE_SERVER_ADDRESS |
The URL (including both hostname and port) of the Chronicle server to forward logs and metrics to. | http://localhost:5252 |
CHRONICLE_SKIP_TLS_VERIFY |
Skip verification of TLS certificates for requests sent to the Chronicle server. This can be 0 or 1 . |
1 |
CHRONICLE_CONNECT_SERVER_URL |
The URL of the Posit Connect API server. | http://localhost:3939 |
CHRONICLE_CONNECT_SERVER_SKIP_TLS_VERIFY |
Skip verification of TLS certificates for requests to the Connect API. This can be 0 or 1 . |
1 |
CHRONICLE_CONNECT_METRICS_URL |
The URL of the Prometheus Metrics for the Posit Connect server. | <empty-string> |
CHRONICLE_WORKBENCH_METRICS_URL |
The URL of the Prometheus metrics for the Posit Workbench server. This should only be set if you are trying to collect metrics from a Workbench instance running on a separate server (not recommended), or if your Workbench configuration is not stored at the default location (/etc/rstudio/rserver.conf ). |
http://localhost:8989 |
CHRONICLE_WORKBENCH_CONFIG_LOCATION |
If XDG_CONFIG_DIRS and/or RSTUDIO_CONFIG_HOME is set for Workbench, you can provide the path for your rserver.conf file. For example, /var/config/settings/rserver.conf or /var/config/rstudio/rserver.conf |
/etc/rstudio/rserver.conf |
CHRONICLE_ENVIRONMENT |
Sets the value for the environment column for all logs and metrics collected by this agent. |
<empty-string> |
CHRONICLE_METRICS_SCRAPE_INTERVAL |
Sets how frequently metrics will be collected by this agent. The value must be no less than 10 seconds and no more than 10 minutes. This can be represented in seconds (s ), minutes (m ), or a combination: 30s (30 seconds), 7m (7 minutes), 1m30s (1 minute 30 seconds). |
1m0s |
CHRONICLE_METRICS_SKIP_TLS_VERIFY |
Skip verification of TLS certificates for requests sent to Posit Team product metrics endpoints. This can be 0 or 1 . |
1 |
CHRONICLE_LOGGING_LEVEL |
The minimum level for logging messages. It can be one of: DEBUG , INFO , WARN , or ERROR . This value is not case sensitive. |
INFO |
CHRONICLE_LOGGING_FORMAT |
The output format for service logs. It can be one of: TEXT or JSON . |
TEXT |
CHRONICLE_LOGGING_OUTPUT_PATH |
Optionally, specify a file path (e.g., /var/log/chronicle-agent.log ) to write Chronicle agent logs in addition to STDERR . The specified folder must exist. Logs are always written to STDERR , and if this value is unset, they will only be written there. |
<empty-string> |
CHRONICLE_METRICS_ENABLED |
Enable the Chronicle agent to expose Prometheus metrics about itself. This can be 0 or 1 . |
0 |
CHRONICLE_METRICS_PORT |
The port on which the agent should emit Prometheus metrics about itself. CHRONICLE_METRICS_ENABLED must be set to 1 for this to have effect. |
8888 |