Network Performance Monitoring is now generally available! Network Monitoring is now available!

Nextcloud

Agent Check Agent Check

Supported OS: Linux Mac OS Windows

Overview

This check monitors Nextcloud.

Setup

Installation

If you are using Agent v6.8+ follow the instructions below to install the Nextcloud check on your host. See our dedicated Agent guide for installing community integrations to install checks with the Agent prior v6.8 or the Docker Agent:

  1. Install the developer toolkit.
  2. Clone the integrations-extras repository:

    git clone https://github.com/DataDog/integrations-extras.git.
    
  3. Update your ddev config with the integrations-extras/ path:

    ddev config set extras ./integrations-extras
    
  4. To build the nextcloud package, run:

    ddev -e release build nextcloud
    
  5. Download and launch the Datadog Agent.

  6. Run the following command to install the integrations wheel with the Agent:

    datadog-agent integration install -w <PATH_OF_NEXTCLOUD_ARTIFACT_>/<NEXTCLOUD_ARTIFACT_NAME>.whl
    
  7. Configure your integration like any other packaged integration.

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)

Service Checks

nextcloud.can_connect

The check returns:

  • OK if Nextcloud is reachable.
  • CRITICAL if Nextcloud is unreachable.

Events

Nextcloud does not include any events.

Troubleshooting

Need help? Contact Datadog support.


Mistake in the docs? Feel free to contribute!