Clientlog Service

Abstract

The clientlog service is responsible for composing machine readable notifications for clients. Clients are apps and web interfaces.

The Log Service Ecosystem
Clientlog Events
Example Yaml Config

The Log Service Ecosystem

Log services like the userlog, clientlog and sse are responsible for composing notifications for a certain audience.

The userlog service translates and adjusts messages to be human readable.
The clientlog service composes machine readable messages, so clients can act without the need to query the server.
The sse service is only responsible for sending these messages. It does not care about their form or language.

Clientlog Events

The messages the clientlog service sends are intended for the use by clients, not by users. The client might for example be informed that a file has finished post-processing. With that, the client can make the file available to the user without additional server queries.

Example Yaml Config

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33


# Autogenerated
# Filename: clientlog-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9260
  token: ""
  pprof: false
  zpages: false
grpc_client_tls: null
token_manager:
  jwt_secret: ""
reva_gateway: com.owncloud.api.gateway
events:
  endpoint: 127.0.0.1:9233
  cluster: ocis-cluster
  tls_insecure: false
  tls_root_ca_certificate: ""
  enable_tls: false
  username: ""
  password: ""
service_account:
  service_account_id: ""
  service_account_secret: ""

Environment Variables

Name	Type	Default Value	Description
OCIS_TRACING_ENABLED CLIENTLOG_TRACING_ENABLED	bool	false	Activates tracing.
OCIS_TRACING_TYPE CLIENTLOG_TRACING_TYPE	string		The type of tracing. Defaults to ‘’, which is the same as ‘jaeger’. Allowed tracing types are ‘jaeger’ and ’’ as of now.
OCIS_TRACING_ENDPOINT CLIENTLOG_TRACING_ENDPOINT	string		The endpoint of the tracing agent.
OCIS_TRACING_COLLECTOR CLIENTLOG_TRACING_COLLECTOR	string		The 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.
OCIS_LOG_LEVEL CLIENTLOG_USERLOG_LOG_LEVEL	string		The log level. Valid values are: ‘panic’, ‘fatal’, ’error’, ‘warn’, ‘info’, ‘debug’, ’trace’.
OCIS_LOG_PRETTY CLIENTLOG_USERLOG_LOG_PRETTY	bool	false	Activates pretty log output.
OCIS_LOG_COLOR CLIENTLOG_USERLOG_LOG_COLOR	bool	false	Activates colorized log output.
OCIS_LOG_FILE CLIENTLOG_USERLOG_LOG_FILE	string		The path to the log file. Activates logging to this file if set.
CLIENTLOG_DEBUG_ADDR	string	127.0.0.1:9260	Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
CLIENTLOG_DEBUG_TOKEN	string		Token to secure the metrics endpoint.
CLIENTLOG_DEBUG_PPROF	bool	false	Enables pprof, which can be used for profiling.
CLIENTLOG_DEBUG_ZPAGES	bool	false	Enables zpages, which can be used for collecting and viewing in-memory traces.
OCIS_JWT_SECRET CLIENTLOG_JWT_SECRET	string		The secret to mint and validate jwt tokens.
OCIS_REVA_GATEWAY CLIENTLOG_REVA_GATEWAY	string	com.owncloud.api.gateway	CS3 gateway used to look up user metadata
OCIS_EVENTS_ENDPOINT CLIENTLOG_EVENTS_ENDPOINT	string	127.0.0.1:9233	The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture.
OCIS_EVENTS_CLUSTER CLIENTLOG_EVENTS_CLUSTER	string	ocis-cluster	The 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.
OCIS_INSECURE CLIENTLOG_EVENTS_TLS_INSECURE	bool	false	Whether to verify the server TLS certificates.
OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE CLIENTLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE	string		The root CA certificate used to validate the server’s TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false.
OCIS_EVENTS_ENABLE_TLS CLIENTLOG_EVENTS_ENABLE_TLS	bool	false	Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services.
OCIS_EVENTS_AUTH_USERNAME CLIENTLOG_EVENTS_AUTH_USERNAME	string		The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services.
OCIS_EVENTS_AUTH_PASSWORD CLIENTLOG_EVENTS_AUTH_PASSWORD	string		The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services.
OCIS_SERVICE_ACCOUNT_ID CLIENTLOG_SERVICE_ACCOUNT_ID	string		The ID of the service account the service should use. See the ‘auth-service’ service description for more details.
OCIS_SERVICE_ACCOUNT_SECRET CLIENTLOG_SERVICE_ACCOUNT_SECRET	string		The service account secret.