admin.md

Admin documentation

Configuration

All this app needs to operate is a valid Sentry DSN and a public DSN. You can set it via the command line

php occ config:system:set sentry.dsn --value=https://xxxxx:yyyyy@sentry.io/1234567
php occ config:system:set sentry.public-dsn --value=https://xxxxx@sentry.io/1234567

or add the entry directly to config/config.php

  "sentry.dsn" => "https://xxxxx:yyyyy@sentry.io/1234567",
  "sentry.public-dsn" => "https://xxxxx@sentry.io/1234567",

If you omit the sentry.public-dsn config, client-side (browser) errors won't be reported.

Sampling rate

This app can monitor Nextcloud's performance. The sampling rate is derived from the log level (more verbose -> more sampling) but can be overwritten:

  "sentry.sampling-rate" => 0.1,

Read more at https://docs.sentry.io/platforms/php/guides/symfony/performance/.

CSP error reporting

Sentry can capture CSP violation reports. Just set the sentry.csp-report-url in addition to your other configuration parameters:

  "sentry.dsn" => "https://xxxxx:yyyyy@sentry.io/1234567",
  "sentry.public-dsn" => "https://xxxxx@sentry.io/1234567",
  "sentry.csp-report-url" => "https://sentry.io/api/1234567/security/?sentry_key=adf205d197bd7201da1d564379e694a2",

Preventing Abuse

It is recommended to whitelist known hosts (your Nextcloud host) to prevent malicious reports.

Minimum log level

The setting sentry.minimum.log.level can be used to filter out exceptions with lower log level before they are sent to the Sentry instance. By default warning and upwards will be captured.

To change this you can specify the minimum log level of the Sentry instance by following command

php occ config:system:set sentry.minimum.log.level --value=0 --type=integer

or add the entry directly to config/config.php

  "sentry.minimum.log.level" => 0

The value needs to be a number between 0 and 4, where 0 is debug, 1 is info, 2 is warning, 3 is error and 4 is fatal.