Sidecar Configuration Settings Reference

Graylog Sidecar uses a central configuration file to define how it connects to Graylog, manages collectors, and handles logging and runtime behavior. The Sidecar configuration file is located by default at /etc/graylog/sidecar/sidecar.yml. The settings described in this article help administrators customize Sidecar behavior to fit a wide range of deployment environments.

Communication and API Connections Properties

These properties govern how the Graylog Sidecar communicates with the Graylog server API. They ensure secure and authenticated connections and determine how the Sidecar interacts with the backend.

Parameter	Default Value	Description
`server_url`	None	Specifies the Graylog API endpoint URL. The value must end with `/api/` to ensure proper communication between the Sidecar and the Graylog Server.
`server_api_token`	None	Defines the authentication token generated in Graylog. This token is required for the Sidecar to authenticate securely with the Graylog Server.
`tls_skip_verify`	`false`	Indicates whether TLS certificate validation should be skipped. This option should only be used in development or laboratory environments using self-signed certificates.

Sidecar Identity Properties

These properties define the unique identity of each Sidecar instance. Identity settings are essential for registration, monitoring, and management within Graylog.

Parameter	Default Value	Description
`node_id`	`file:/etc/graylog/sidecar/node-id`	Specifies the unique identifier assigned to the Sidecar. This ID is essential for successful registration and ongoing lifecycle management in the Graylog environment.
`node_name`	`hostname`	Specifies the name that appears in the Graylog web interface. This value typically defaults to the local system hostname.

Status Polling and Heartbeat Properties

These properties control how frequently the Sidecar updates Graylog about its status and collector health. These parameters help monitor performance and ensure accurate system state reporting.

Parameter	Default Value	Description
`update_interval`	`10`	Defines the polling interval, in seconds, used by the Sidecar to request new configuration data or updates from Graylog. Adjusting this value helps balance responsiveness against system load.
`send_status`	`1`	Indicates whether the Sidecar should send health status and collector metrics to Graylog. This should remain enabled unless troubleshooting performance or load-related issues.

Log File Visibility and Diagnostics Properties

These properties determine which log files are visible in the Graylog interface and how the Sidecar manages its own log output. Proper configuration supports effective troubleshooting and system transparency.

Parameter	Default Value	Description
`list_log_files`	`[ ]`	Specifies which log file paths should be displayed in the Graylog interface. Administrators can add directories such as `/var/log` to enhance visibility during troubleshooting.
`log_path`	`/var/log/graylog-sidecar`	Defines the directory where the Sidecar stores its own log files. This location is frequently used during debugging and issue tracebacks.
`log_rotate_max_file_size`	`10MiB`	Specifies the maximum size a log file can reach before rotation occurs. Proper configuration prevents log files from consuming excessive disk space.
`log_rotate_keep_files`	None	Determines how many rotated log files are retained. Retaining an appropriate number helps preserve diagnostic history while managing disk space.

File Paths and Storage Properties

These properties specify where Sidecar stores operational data, including caches and rendered collector configurations. Adjust these paths when customizing file system layouts or storage devices.

Parameter	Default Value	Description
`cache_path`	`/var/cache/graylog-sidecar`	Identifies the directory where the Sidecar stores runtime cache data. This path can be relocated as needed for custom storage configurations.
`collector_configuration_directory`	`/var/lib/graylog-sidecar/generated`	Specifies the folder where the Sidecar writes fully rendered collector configurations before execution.

Execution and Collector Control Properties

These properties control which collectors the Sidecar is permitted to run and how it matches tags for selecting the correct configuration assignments. Proper configuration ensures that collectors operate securely and accurately.

Parameter	Default Value	Description
`collector_binaries_accesslist`	(default collector paths)	Specifies the list of collector binaries that the Sidecar is authorized to execute. Leaving this value empty disables execution control and permits all collectors.
Tags	None	Defines classification labels used to match the Sidecar with appropriate collector configurations. Tags such as linux, windows, or dns help organize and automate configuration assignment in complex deployments.