Nextcloud

Supported OS Linux Mac OS Windows

Integration version2.0.0

Overview

This check monitors Nextcloud.

Setup

The Nextcloud check is not included in the Datadog Agent package, so you need to install it.

Installation

For Agent v7.21+ / v6.21+, follow the instructions below to install the Nextcloud check on your host. See Use Community Integrations to install with the Docker Agent or earlier versions of the Agent.

  1. Run the following command to install the Agent integration:

    datadog-agent integration install -t datadog-nextcloud==<INTEGRATION_VERSION>
    
  2. Configure your integration similar to core integrations.

Configuration

  1. Edit the nextcloud.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Nextcloud metrics. See the sample nextcloud.d/conf.yaml for all available configuration options.

  2. Restart the Agent

Validation

Run the Agent’s status subcommand and look for nextcloud under the Checks section.

Data Collected

Metrics

nextcloud.system.freespace
(gauge)
The amount of free space available.
Shown as byte
nextcloud.system.apps.num_installed
(gauge)
The number of apps installed.
nextcloud.system.apps.num_updates_available
(gauge)
nextcloud.storage.num_users
(gauge)
nextcloud.storage.num_files
(gauge)
nextcloud.storage.num_storages
(gauge)
nextcloud.storage.num_storages_local
(gauge)
nextcloud.storage.num_storages_home
(gauge)
nextcloud.storage.num_storages_other
(gauge)
nextcloud.shares.num_shares
(gauge)
nextcloud.shares.num_shares_user
(gauge)
nextcloud.shares.num_shares_groups
(gauge)
nextcloud.shares.num_shares_link_no_password
(gauge)
nextcloud.shares.num_fed_shares_sent
(gauge)
nextcloud.shares.num_fed_shares_received
(gauge)
nextcloud.server.php.memory_limit
(gauge)

Shown as byte
nextcloud.server.php.max_execution_time
(gauge)

Shown as second
nextcloud.server.php.upload_max_filesize
(gauge)

Shown as byte
nextcloud.server.database.size
(gauge)

Shown as byte
nextcloud.activeUsers.last5minutes
(gauge)
nextcloud.activeUsers.last1hour
(gauge)
nextcloud.activeUsers.last24hours
(gauge)

Optional metrics

The nextcloud.system.apps.* metrics are optional and enabled with the apps_stats configuration key. Beginning with Nextcloud 28, the monitoring endpoint no longer provides information about available app updates, as gathering the data always involves at least one external request to apps.nextcloud.com.

It is still possible to ask the monitoring endpoint to show new app updates by using the URL parameter skipApps=false. However, Nextcloud recommends to not check this endpoint too often.

Events

Nextcloud does not include any events.

Service Checks

nextcloud.can_connect
Returns CRITICAL if the Agent can’t connect to the Nextcloud endpoint, OK otherwise
Statuses: ok, critical

Troubleshooting

Need help? Contact Datadog support.

PREVIEWING: bryce/soar-blog