Skip to main content

Environment Variables

Environment variables for the clientlog service

NameIntroduction VersionTypeDescriptionDefault Value
OC_TRACING_ENABLED
CLIENTLOG_TRACING_ENABLED
1.0.0boolActivates tracing.false
OC_TRACING_TYPE
CLIENTLOG_TRACING_TYPE
1.0.0stringThe type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now.
OC_TRACING_ENDPOINT
CLIENTLOG_TRACING_ENDPOINT
1.0.0stringThe endpoint of the tracing agent.
OC_TRACING_COLLECTOR
CLIENTLOG_TRACING_COLLECTOR
1.0.0stringThe HTTP endpoint for sending spans directly to a collector, i.e. \http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset.
OC_LOG_LEVEL
CLIENTLOG_USERLOG_LOG_LEVEL
1.0.0stringThe log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'.
OC_LOG_PRETTY
CLIENTLOG_USERLOG_LOG_PRETTY
1.0.0boolActivates pretty log output.false
OC_LOG_COLOR
CLIENTLOG_USERLOG_LOG_COLOR
1.0.0boolActivates colorized log output.false
OC_LOG_FILE
CLIENTLOG_USERLOG_LOG_FILE
1.0.0stringThe path to the log file. Activates logging to this file if set.
CLIENTLOG_DEBUG_ADDR1.0.0stringBind address of the debug server, where metrics, health, config and debug endpoints will be exposed.127.0.0.1:9260
CLIENTLOG_DEBUG_TOKEN1.0.0stringToken to secure the metrics endpoint.
CLIENTLOG_DEBUG_PPROF1.0.0boolEnables pprof, which can be used for profiling.false
CLIENTLOG_DEBUG_ZPAGES1.0.0boolEnables zpages, which can be used for collecting and viewing in-memory traces.false
OC_JWT_SECRET
CLIENTLOG_JWT_SECRET
1.0.0stringThe secret to mint and validate jwt tokens.
OC_REVA_GATEWAY1.0.0stringCS3 gateway used to look up user metadataeu.opencloud.api.gateway
OC_EVENTS_ENDPOINT
CLIENTLOG_EVENTS_ENDPOINT
1.0.0stringThe address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture.127.0.0.1:9233
OC_EVENTS_CLUSTER
CLIENTLOG_EVENTS_CLUSTER
1.0.0stringThe clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system.opencloud-cluster
OC_INSECURE
CLIENTLOG_EVENTS_TLS_INSECURE
1.0.0boolWhether to verify the server TLS certificates.false
OC_EVENTS_TLS_ROOT_CA_CERTIFICATE
CLIENTLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE
1.0.0stringThe root CA certificate used to validate the server's TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false.
OC_EVENTS_ENABLE_TLS
CLIENTLOG_EVENTS_ENABLE_TLS
1.0.0boolEnable TLS for the connection to the events broker. The events broker is the OpenCloud service which receives and delivers events between the services.false
OC_EVENTS_AUTH_USERNAME
CLIENTLOG_EVENTS_AUTH_USERNAME
1.0.0stringThe username to authenticate with the events broker. The events broker is the OpenCloud service which receives and delivers events between the services.
OC_EVENTS_AUTH_PASSWORD
CLIENTLOG_EVENTS_AUTH_PASSWORD
1.0.0stringThe password to authenticate with the events broker. The events broker is the OpenCloud service which receives and delivers events between the services.
OC_SERVICE_ACCOUNT_ID
CLIENTLOG_SERVICE_ACCOUNT_ID
1.0.0stringThe ID of the service account the service should use. See the 'auth-service' service description for more details.
OC_SERVICE_ACCOUNT_SECRET
CLIENTLOG_SERVICE_ACCOUNT_SECRET
1.0.0stringThe service account secret.