Environment Variables
This is a placeholder for a future summary of all environment variables used by the environment, including those only used for debugging purposes. For now I'm just using it as a place to dump the following information:
Platform / Agent Runtime
| Variable | Used by | Runtime use |
|---|---|---|
| SIP_CONFIG_SERVER | ISAMAgent, JSONAgent, SQLAgent (read) | Fallback ConfigServer URL when it was not supplied on the command line or in appsettings. |
| SIP_CONFIG_PROFILE | ConfigServer, ISAMAgent, JSONAgent, SQLAgent, LaunchPad (read); LaunchPad child ConfigServer (set) | Profile name fallback and active profile selection. |
| SIP_CONFIG_SERVER_PORT | ConfigServer, LaunchPad (read) | ConfigServer HTTPS port override or discovery value. |
| SIP_CONFIG_PATH | ConfigServer (read); LaunchPad child ConfigServer (set) | Overrides the base directory used by ConfigServer for its local files. |
| SIP_ISAM_AGENT_PORT | ISAMAgent, LaunchPad (read) | ISAM Agent management HTTPS port override or discovery value. |
| SIP_JSON_AGENT_PORT | JSONAgent, LaunchPad (read) | JSONAgent management HTTPS port override or discovery value. |
| SIP_SQL_AGENT_PORT | SQLAgent, LaunchPad (read) | SQLAgent management HTTPS port override or discovery value. |
| SIP_CONFIG | ReplicationLibrary I/O hooks, LaunchPad, bundled DBR/.NET utilities (read/set) | Active profile/config directory; also the SIP_CONFIG: logical used to locate config files. |
| SIP_ENVIRONMENT | ReplicationLibrary I/O hooks (read); LaunchPad (set) | Active environment/profile name used by the I/O hook layer. |
| SIP_HOOKS_CONSOLE_DEBUG | ReplicationLibrary I/O hooks (read) | Enables console debug output from the hook code. |
| SIP_HOOKS_DEBUG_LOG | ReplicationLibrary I/O hooks (read) | Enables extra hook debug logging. |
| SIP_HOOKS_ENABLED | ReplicationLibrary I/O hooks (read); random-data/test utilities (set) | Turns replication I/O hooks on or off. |
| SIP_HOOKS_LOGLEVEL | ReplicationLibrary I/O hooks (read) | Numeric logging verbosity for hook processing. |
| SIP_KAFKA_MAX_FAIL | ReplicationLibrary I/O hooks (read) | Maximum Kafka exceptions tolerated before hooks disable themselves. |
| SIP_ZMQ_BROKERS | ReplicationLibrary I/O hooks on VMS (read) | ZMQ broker list for the VMS replication path. |
| SIP_LOG | ReplicationLibrary runtime (logical name in file specs) | Base location for hook exception logs and replicator PID files. |
LaunchPad / Developer Tooling Only
| Variable | Used by | Runtime use |
|---|---|---|
| SIP_CONFIG_DIR | LaunchPad (set) | Passed to child DBR/helper tools; no direct read was found elsewhere in the shared runtime code. |
| SIP_EXE | LaunchPad (set) | Seeds the Synergy executable logical for child DBR/helper tools. |
| SSL_CERT_FILE | LaunchPad snapshot-agent child process (set to nul) | Disables explicit cert-file lookup for that child process. |
| SSL_CERT_DIR | LaunchPad snapshot-agent child process (set to nul) | Disables cert-directory lookup for that child process. |
| REQUESTS_CA_BUNDLE | LaunchPad snapshot-agent child process (set to nul) | Disables Python Requests CA-bundle lookup for that child process. |
| CURL_CA_BUNDLE | LaunchPad snapshot-agent child process (set to nul) | Disables cURL CA-bundle lookup for that child process. |
| RUST_LOG | LaunchPad snapshot-agent child process (set) | Sets the Rust snapshot-agent log level to INFO. |
| SIP_DAT | Random-data/load-test tools and DBR utilities (logical name in file specs) | Base location for sample/demo ISAM data files. |
Dynamic / Config-Defined Names
These are also runtime environment-variable mechanisms, but the names are not hard-coded in the repo:
| Dynamic source | Used by | Runtime use |
|---|---|---|
| MasterConfig.SQLAgent.EnvironmentVariables[*].Name | ProfileHelper, SQLReplayService | Sets arbitrary environment/logical names defined in SQLAgent configuration. |
| MasterConfig.FileMappings.Logicals[*].Key | ISAMAgent, SQLAgent, LocalFileStatus | Sets and resolves arbitrary Synergy logical names used by configured file mappings. |
| OriginSystemTools.EnvironmentVariables[*].Name | LaunchPad | Sets arbitrary environment/logical names before launching origin-system tools. |
| toolSettings.EnvironmentVariables[*].Name | FakeDataGenerator | Sets arbitrary tool-specific environment/logical names from tool settings. |
| Any %NAME% token embedded in configured paths | HelpersCS.PathMapper | Expands arbitrary OS environment variables inside configured paths. |
| Any %NAME% token embedded in a Windows service ImagePath | LaunchPad | Expanded while parsing service command lines to discover profile and port settings. |
Message Broker Debug Logging
On Windows and Linux, the Message Broker application's logging level can be set via the environment variable IOX2_LOG_LEVEL. Valid values are trace, debug, info, warning, error, and fatal. If not set, the logging level defaults to error.