Activitylog

Introduction

The Infinite Scale activitylog service is responsible for storing events (activities) per resource. Resources can be Space Roots, Files and Folders.

Default Values

  • Activitylog listens on port 9195 by default.

The Log Service Ecosystem

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


Log services and their tasks

activitylog 1

This service stores events per resource. These can be retrieved to show item activities.

clientlog

This service composes machine-readable messages, so clients can act without the need to query the server.

eventhistory

This service stores events and allows other services to retrieve them via an event ID.

sse

This service is only responsible for sending these messages. It does not care about their form or language.

userlog 2

This service translates and adjusts messages to be human-readable.

Services may depend on each other:

  1. The activitylog service requires the eventhistory service.

  2. The userlog service is configured by default to use both the eventhistory and sse service. It can be configured to use both, the one, or the other.

Storing

The activitylog service can use a configured store via the global OCIS_PERSISTENT_STORE environment variable.

Note that for each global environment variable, a service-based one might be available additionally. For precedences see Environment Variable Notes. Check the configuration section below. Supported stores are:



Store Type Description

memory

Basic in-memory store and the default.

redis-sentinel

Stores data in a configured Redis Sentinel cluster.

nats-js-kv

Stores data using key-value-store feature of NATS JetStream.

noop

Stores nothing. Useful for testing. Not recommended in production environments.

ocmem

(deprecated) Advanced in-memory store allowing max size.

redis

(deprecated) Stores data in a configured Redis cluster.

etcd

(deprecated) Stores data in a configured etcd cluster.

nats-js

(deprecated) Stores data using the key-value-store feature of NATS JetStream.

Other store types may work but are currently not supported.

The activitylog service can only be scaled if not using the memory store and the stores are configured identically over all instances!
If you have used one of the deprecated stores of a former version, you should reconfigure to use one of the supported ones as the deprecated stores will be removed in a later version.
Store specific notes
  • When using redis-sentinel:
    The Redis master to use is configured via e.g. OCIS_PERSISTENT_STORE_NODES in the form of <sentinel-host>:<sentinel-port>/<redis-master> like 10.10.0.200:26379/mymaster.

  • When using nats-js-kv:

    • It is recommended to set OCIS_PERSISTENT_STORE_NODES to the same value as OCIS_EVENTS_ENDPOINT. That way the cache uses the same nats instance as the event bus.

    • Authentication can be added, if configured, via OCIS_CACHE_AUTH_USERNAME and OCIS_CACHE_AUTH_PASSWORD.

    • It is possible to set OCIS_CACHE_DISABLE_PERSISTENCE to instruct nats to not persist cache data on disc.

Event Bus Configuration

The Infinite Scale event bus can be configured by a set of environment variables.

  • If you are using a binary installation as described in Minimal Bare Metal Deployment or Bare Metal with systemd, the address of the event bus OCIS_EVENTS_ENDPOINT is predefined as localhost address without the need for further configuration, but changeable on demand.

  • In case of an orchestrated installation like with Docker or Kubernetes, the event bus must be an external service for scalability like a Redis Sentinel cluster or a key-value-store NATS JetStream. Both named stores are supported and also used in Caching and Persistence. The store used is not part of the Infinite Scale installation and must be separately provided and configured.

  • Note that from a configuration point of view, caching and persistence are independent of the event bus configuration.

Note that for each global environment variable, a service-based one might be available additionally. For precedences see Environment Variable Notes. Check the configuration section below.

Without the aim of completeness, see the list of environment variables to configure the event bus:

Envvar Description

OCIS_EVENTS_ENDPOINT

The address of the event system.

OCIS_EVENTS_CLUSTER

The clusterID of the event system. Mandatory when using NATS as event system.

OCIS_EVENTS_ENABLE_TLS

Enable TLS for the connection to the events broker.

OCIS_INSECURE

Whether to verify the server TLS certificates.

OCIS_EVENTS_AUTH_USERNAME

The username to authenticate with the events broker.

OCIS_EVENTS_AUTH_PASSWORD

The password to authenticate with the events broker.

Configuration

Environment Variables

The activitylog service is configured via the following environment variables. Read the Environment Variable Types documentation for important details.

  • master

Environment variables for the activitylog service
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:9197

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_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 exclicitly 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

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.

YAML Example

  • master

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

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9197
  token: ""
  pprof: false
  zpages: false
events:
  endpoint: 127.0.0.1:9233
  cluster: ocis-cluster
  tls_insecure: false
  tls_root_ca_certificate: ""
  enable_tls: false
  username: ""
  password: ""
store:
  store: nats-js-kv
  nodes:
  - 127.0.0.1:9233
  database: activitylog
  table: ""
  ttl: 0s
  size: 0
  username: ""
  password: ""
reva_gateway: com.owncloud.api.gateway
grpc_client_tls: null
service_account:
  service_account_id: ""
  service_account_secret: ""