Sidecar configuration settings

Access configuration settings for sidecars in the configuration files.

Some sidecars are activated by default.

The following table presents names of configuration files, stanzas, default values of settings, and other details related to the supervisor and sidecars.

Sidecar name Process name Configuration file stanza Default setting Product compatibility Notes
Supervisor compsup [teleport_supervisor] in server.conf

disabled = false

Activated.

Available on the Splunk platform.
SCIM identity [feature:identity_sidecar_scim] in web-features.conf

enabled = false

Deactivated.

Available on the Splunk platform.
SCIM [<saml-authSettings-key>] in authentication.conf

scimEnabled = false

Deactivated.
Storage postgres [postgres] in server.conf

Activated on Splunk Enterprise:

disabled = false

Deactivated on Splunk Cloud Platform:

disabled = true

Available for single search heads. By default, the value of the Storage port is set to <5432>. You can change it by specifying the <DB_port> environment variable.
Data Orchestration (DO) cmp-orchestrator Not configured in a .conf file Activated. Available on Splunk Enterprise.
Edge Processor Control Plane edge-processor-config [data_management] in server.conf

edge_processor_enabled = false

Deactivated.

Available on Splunk Enterprise for single search heads. Deactivated if Edge Processor is deactivated.
OpAmp opamp-svc [data_management] in server.conf

edge_processor_enabled = false,

otel_collector_management_enabled = false

Deactivated.

Available on Splunk Enterprise with a single search head and single deployment server.

To activate the sidecar, set one of these settings to true.

Activated if Edge Processor or OTel Collector Management is used.

Agent Management agent-manager agent_management.conf Activated. Available on Splunk Enterprise.
IPC Broker ipc_broker [ipc_broker] in server.conf Activated. Available on the Splunk platform.

Requires configuring the port on which IPC Broker waits for incoming requests.

port = <integer>

To assign a specific IPC address, for example, a port, to a sidecar, see Allocating a port by IPC Broker.

Spotlight spotlight-collector [teleport_supervisor] in server.conf

Activated on Splunk Enterprise:

enable_splunk_spotlight = true

Deactivated on Splunk Cloud Platform:

enable_splunk_spotlight = false

Available on the Splunk platform. Although Spotlight is deactivated by default on Splunk Cloud Platform, the spotlight-collector process displays on the list of running processes.
Note: For the sidecars available for single search heads, such as Storage, Edge Processor Control Plane, and OpAmp, ensure the enable_clustered_mode setting is set to false in the [postgres] stanza of server.conf.

Allocating a port by IPC Broker

IPC Broker allocates the port for itself using a value in the [port] setting. If you want IPC Broker to always allocate a specific port to a sidecar, configure the following setting in the [ipc_broker] stanza in the server.conf file:

<splunkd_helper_process_name>:<service_name>:address = <value>

where:

  • splunkd_helper_process_name is the process name of the sidecar. For process names of sidecars, see the Process name column in the Sidecar configuration settings table.

  • service_name is the name of a service exposed by a sidecar. Each sidecar can have any number of services. Each service has to have a unique name. IPC broker allocates a specific port to each service.

  • value is the IPC address, in this case a TCP/IP network port, that the sidecar service uses to serve incoming requests. The valid port range is from 1024 to 65535.

If this setting is not configured, then IPC Broker assigns a random available port to the sidecar.

In this example:

  • IPC Broker is allocated the port 8194 using the port setting.

  • Storage is allocated the port 5432 using the <splunkd_helper_process_name>:<service_name>:address setting.

//server.conf

[ipc_broker] 
port = 8194


postgres:postgres:address = 5432

Check the range of sidecar ports

To check the range of ports that can be allocated to sidecars, use the sysctl utility on Linux. It is a command-line tool that you use to modify kernel parameters at runtime.
Enter the following query: 
sysctl net.ipv4.ip_local_port_range
This is an example result of the query. It indicates that sidecars are allocated pseudo-randomly to ports within the range of 32768 to 60999. 
net.ipv4.ip_local_port_range = 32768 60999

Deactivate a sidecar

If necessary, you can deactivate a sidecar by editing its settings directly in the configuration files.

Note: Never change, copy, or move the configuration files that are in the default directory.

To change settings for a particular configuration file, follow these steps:

  1. Create a new version of the file in a non-default directory.
  2. Add the settings that you want to change. To learn how to edit the configuration files, see Edit the configuration file settings directly.