---
title: Nextcloud
description: Track overall statistics from your Nextcloud instance
breadcrumbs: Docs > Integrations > Nextcloud
---

# Nextcloud
Supported OS 
## Overview{% #overview %}

This check monitors [Nextcloud](https://nextcloud.com).

## Setup{% #setup %}

The Nextcloud check is not included in the [Datadog Agent](https://app.datadoghq.com/account/settings/agent/latest) package, so you need to install it.

### Installation{% #installation %}

For Agent v7.21+ / v6.21+, follow the instructions below to install the Nextcloud check on your host. See [Use Community Integrations](https://docs.datadoghq.com/agent/guide/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:

   ```shell
   datadog-agent integration install -t datadog-nextcloud==<INTEGRATION_VERSION>
   ```

1. Configure your integration similar to core [integrations](https://docs.datadoghq.com/getting_started/integrations/).

### Configuration{% #configuration %}

1. Edit the `nextcloud.d/conf.yaml` file in the `conf.d/` folder at the root of your [Agent's configuration directory](https://docs.datadoghq.com/agent/guide/agent-configuration-files/#agent-configuration-directory) to start collecting your Nextcloud metrics. See the [sample nextcloud.d/conf.yaml](https://github.com/DataDog/integrations-extras/blob/master/nextcloud/datadog_checks/nextcloud/data/conf.yaml.example) for all available configuration options.

1. [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent)

### Validation{% #validation %}

Run the [Agent's status subcommand](https://docs.datadoghq.com/agent/guide/agent-commands/#service-status) and look for `nextcloud` under the Checks section.

## Data Collected{% #data-collected %}

### Metrics{% #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{% #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](https://github.com/nextcloud/serverinfo#api) by using the URL parameter `skipApps=false`. However, Nextcloud recommends to not check this endpoint too often.

### Events{% #events %}

Nextcloud does not include any events.

### Service Checks{% #service-checks %}

**nextcloud.can\_connect**

Returns `CRITICAL` if the Agent can't connect to the Nextcloud endpoint, OK otherwise

*Statuses: ok, critical*

## Troubleshooting{% #troubleshooting %}

Need help? Contact [Datadog support](https://docs.datadoghq.com/help/).