Activitylog
The activitylog
service is responsible for storing events (activities) per resource.
Log services like the activitylog
, userlog
, clientlog
and sse
are responsible for composing notifications for a specific 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. - The
activitylog
service stores events per resource. These can be retrieved to show item activities
The activitylog
stores activities for each resource. It works in conjunction with the eventhistory
service to keep the data it needs to store to a minimum.
The activitylog
service has embedded translations sourced via transifex to provide a basic set of translated languages. These embedded translations are available for all deployment scenarios. In addition, the service supports custom translations, though it is currently not possible to just add custom translations to embedded ones. If custom translations are configured, the embedded ones are not used. To configure custom translations, the ACTIVITYLOG_TRANSLATION_PATH
environment variable needs to point to a base folder that will contain the translation files. This path must be available from all instances of the activitylog service, a shared storage is recommended. Translation files must be of type .po or .mo. For each language, the filename needs to be activitylog.po
(or activitylog.mo
) and stored in a folder structure defining the language code. In general the path/name pattern for a translation file needs to be:
{ACTIVITYLOG_TRANSLATION_PATH}/{language-code}/LC_MESSAGES/activitylog.po
The language code pattern is composed of language[_territory]
where language
is the base language and _territory
is optional and defines a country.
For example, for the language de
, one needs to place the corresponding translation files to {ACTIVITYLOG_TRANSLATION_PATH}/de_DE/LC_MESSAGES/activitylog.po
.
Important: For the time being, the embedded ownCloud Web frontend only supports the main language code but does not handle any territory. When strings are available in the language code language_territory
, the web frontend does not see it as it only requests language
. In consequence, any translations made must exist in the requested language
to avoid a fallback to the default.
- If a requested language code is not available, the service tries to fall back to the base language if available. For example, if the requested language-code
de_DE
is not available, the service tries to fall back to translations in thede
folder. - If the base language
de
is also not available, the service falls back to the system’s default English (en
), which is the source of the texts provided by the code.
The default language can be defined via the OCIS_DEFAULT_LANGUAGE
environment variable. See the settings
service for a detailed description.
|
|
Name | Type | Default Value | Description |
---|---|---|---|
OCIS_TRACING_ENABLED ACTIVITYLOG_TRACING_ENABLED |
bool | false | Activates tracing. |
OCIS_TRACING_TYPE ACTIVITYLOG_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 ACTIVITYLOG_TRACING_ENDPOINT |
string | The endpoint of the tracing agent. | |
OCIS_TRACING_COLLECTOR ACTIVITYLOG_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 ACTIVITYLOG_LOG_LEVEL |
string | The log level. Valid values are: ‘panic’, ‘fatal’, ’error’, ‘warn’, ‘info’, ‘debug’, ’trace’. | |
OCIS_LOG_PRETTY ACTIVITYLOG_LOG_PRETTY |
bool | false | Activates pretty log output. |
OCIS_LOG_COLOR ACTIVITYLOG_LOG_COLOR |
bool | false | Activates colorized log output. |
OCIS_LOG_FILE ACTIVITYLOG_LOG_FILE |
string | The path to the log file. Activates logging to this file if set. | |
ACTIVITYLOG_DEBUG_ADDR | string | 127.0.0.1:9197 | Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. |
ACTIVITYLOG_DEBUG_TOKEN | string | Token to secure the metrics endpoint. | |
ACTIVITYLOG_DEBUG_PPROF | bool | false | Enables pprof, which can be used for profiling. |
ACTIVITYLOG_DEBUG_ZPAGES | bool | false | Enables zpages, which can be used for collecting and viewing in-memory traces. |
OCIS_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 | 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 | bool | false | Whether to verify the server TLS certificates. |
OCIS_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 | 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 | 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 | 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_PERSISTENT_STORE ACTIVITYLOG_STORE |
string | nats-js-kv | The type of the store. Supported values are: ‘memory’, ‘ocmem’, ’etcd’, ‘redis’, ‘redis-sentinel’, ’nats-js’, ’noop’. See the text description for details. |
OCIS_PERSISTENT_STORE_NODES ACTIVITYLOG_STORE_NODES |
[]string | [127.0.0.1:9233] | A list of nodes to access the configured store. This has no effect when ‘memory’ or ‘ocmem’ stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. |
ACTIVITYLOG_STORE_DATABASE | string | activitylog | The database name the configured store should use. |
ACTIVITYLOG_STORE_TABLE | string | The database table the store should use. | |
OCIS_PERSISTENT_STORE_TTL ACTIVITYLOG_STORE_TTL |
Duration | 0s | Time to live for events in the store. See the Environment Variable Types description for more details. |
OCIS_PERSISTENT_STORE_SIZE ACTIVITYLOG_STORE_SIZE |
int | 0 | The maximum quantity of items in the store. Only applies when store type ‘ocmem’ is configured. Defaults to 512 which is derived from the ocmem package though not explicitly set as default. |
OCIS_PERSISTENT_STORE_AUTH_USERNAME ACTIVITYLOG_STORE_AUTH_USERNAME |
string | The username to authenticate with the store. Only applies when store type ’nats-js-kv’ is configured. | |
OCIS_PERSISTENT_STORE_AUTH_PASSWORD ACTIVITYLOG_STORE_AUTH_PASSWORD |
string | The password to authenticate with the store. Only applies when store type ’nats-js-kv’ is configured. | |
OCIS_REVA_GATEWAY | string | com.owncloud.api.gateway | CS3 gateway used to look up user metadata |
ACTIVITYLOG_HTTP_ADDR | string | 127.0.0.1:0 | The bind address of the HTTP service. |
ACTIVITYLOG_HTTP_ROOT | string | / | Subdirectory that serves as the root for this HTTP service. |
OCIS_CORS_ALLOW_ORIGINS ACTIVITYLOG_CORS_ALLOW_ORIGINS |
[]string | [*] | A list of allowed CORS origins. See following chapter for more details: Access-Control-Allow-Origin at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. See the Environment Variable Types description for more details. |
OCIS_CORS_ALLOW_METHODS ACTIVITYLOG_CORS_ALLOW_METHODS |
[]string | [GET] | A list of allowed CORS methods. See following chapter for more details: Access-Control-Request-Method at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details. |
OCIS_CORS_ALLOW_HEADERS ACTIVITYLOG_CORS_ALLOW_HEADERS |
[]string | [Authorization Origin Content-Type Accept X-Requested-With X-Request-Id Ocs-Apirequest] | A list of allowed CORS headers. See following chapter for more details: Access-Control-Request-Headers at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details. |
OCIS_CORS_ALLOW_CREDENTIALS ACTIVITYLOG_CORS_ALLOW_CREDENTIALS |
bool | true | Allow credentials for CORS.See following chapter for more details: Access-Control-Allow-Credentials at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials. |
OCIS_HTTP_TLS_ENABLED | bool | false | Activates TLS for the http based services using the server certifcate and key configured via OCIS_HTTP_TLS_CERTIFICATE and OCIS_HTTP_TLS_KEY. If OCIS_HTTP_TLS_CERTIFICATE is not set a temporary server certificate is generated - to be used with PROXY_INSECURE_BACKEND=true. |
OCIS_HTTP_TLS_CERTIFICATE | string | Path/File name of the TLS server certificate (in PEM format) for the http services. | |
OCIS_HTTP_TLS_KEY | string | Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the http services. | |
OCIS_JWT_SECRET ACTIVITYLOG_JWT_SECRET |
string | The secret to mint and validate jwt tokens. | |
OCIS_TRANSLATION_PATH ACTIVITYLOG_TRANSLATION_PATH |
string | (optional) Set this to a path with custom translations to overwrite the builtin translations. Note that file and folder naming rules apply, see the documentation for more details. | |
OCIS_DEFAULT_LANGUAGE | string | en | The default language used by services and the WebUI. If not defined, English will be used as default. See the documentation for more details. |
OCIS_SERVICE_ACCOUNT_ID ACTIVITYLOG_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 ACTIVITYOG_SERVICE_ACCOUNT_SECRET |
string | The service account secret. |