Configuring GWS Platform Service Settings
Environment Variables
| Name | Mandatory | Default Value | Description |
|---|---|---|---|
| GWS_COMMON_AUTH_SECRET | Yes | Specifies the secret that should be used for authentication purpose for inter-service communication. For more details, please refer to "serverSettings.auth.secret" in GWS API Service configuration options. | |
| GWS_COMMON_LOCATION | No | / | Specifies the region or datacenter name that service should serve for. For more details, please refer to "serverSetting.nodePath" in GWS API Service configuration options. |
| GWS_DATABASE_UPDATE_POLLING_TIMEOUT | No | 1000 | Specifies in milliseconds how often service should check for changes in ConfigDB. |
| GWS_ENV_CONFIG_FILE | No | ./environment.yaml | Specifies a location of environment.yaml file that should be used for service initialization. |
| {GWS_EXPORTER_OTLP_TRACES_ENDPOINT | No | http://localhost:4317 | Specifies OpenTelemetry address in URL format that should be used for exporting traces. |
| GWS_LOGGING_ENABLE_COMPRESSION | No | true | Specifies if compression for stored log files should be applied. |
| GWS_LOGGING_INTERVAL | No | 3600 | Specifies in seconds how often log file rotation should be performed. |
| GWS_LOGGING_MAX_FILE_COUNT | No | Specifies the max number of log files that should be kept. By default, service doesn't remove any log file. | |
| GWS_LOGGING_MAX_FILE_SIZE | No | Specifies the max log file size when log rotation should be performed in addition to configured interval (GWS_LOGGING_INTERVAL). By default, log rotation is done by timer only. | |
| GWS_LOGGING_MAX_HISTORY | No | Specifies in seconds how long the service's log files should be kept. By default, they are kept forever. | |
| GWS_LOGGING_PATH | No | /var/log/gws-service-platform | If specified, enables writing logs into a file instead of STDOUT/STDERR (in such case, logs are accessible through JournalD). Specifies the path where logs should be stored. |
| GWS_LOGGING_FILE | No | gws-service-platform.log | Specifies the log file name. |
| GWS_LOG_LEVEL | No | INFO | Specifies service logging level. Allowed values: [ERROR, WARN, INFO, DEBUG, TRACE] |
| GWS_SERVER_HOST | No | 0.0.0.0 | Specifies the host name or IP address of network interface that should be used by service to open API listening port. Default value "0.0.0.0" that means open listing port on all network interfaces. |
| GWS_SERVER_PORT | No | 8092 | Specifies the port number that should be used as API listening port. |
Comments or questions about this documentation? Contact us for support!
