---
title: Octopus Deploy
description: Monitor your Octopus Deploy Server.
breadcrumbs: Docs > Integrations > Octopus Deploy
---

# Octopus Deploy
Supported OS Integration version2.4.0
## Overview{% #overview %}

This check monitors your [Octopus Deploy](https://octopus.com/) deployments through the Datadog Agent. Track information such as average deployment time per environment and deployment failure rate for a project.

**Minimum Agent version:** 7.63.0

## Setup{% #setup %}

Complete the following steps to install and configure this check on a host-based Agent. For containerized environments, see the [Autodiscovery Integration Templates](https://docs.datadoghq.com/agent/kubernetes/integrations/) for guidance on applying these instructions.

### Installation{% #installation %}

The Octopus Deploy check is included in the [Datadog Agent](https://app.datadoghq.com/account/settings/agent/latest) package. No additional installation is needed.

### Configuration{% #configuration %}

1. Create an [API key](https://octopus.com/docs/octopus-rest-api/how-to-create-an-api-key) on your Octopus Server.

1. Edit the `octopus_deploy.d/conf.yaml` file (located in the `conf.d/` folder at the root of your Agent's configuration directory) to start collecting `octopus_deploy` performance data. See the [sample config](https://github.com/DataDog/integrations-core/blob/master/octopus_deploy/datadog_checks/octopus_deploy/data/conf.yaml.example) for all available options.

**Note**: Limit the number of projects you collect data for by configuring **one** of the `spaces`, `project_groups`, or `projects` sections. For example, the following snippet limits collection to at most 10 projects whose names start with 'test':

   ```
   projects:
       limit: 10
       include:
       - 'test.*'
   ```

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

#### Logs{% #logs %}

The Octopus Deploy integration collects two types of logs: deployment logs and server logs.

##### Collecting deployment logs{% #collecting-deployment-logs %}

Deployment logs are gathered from deployment tasks and are useful for debugging failed deployments. To collect deployment logs:

1. Enable log collection in your `datadog.yaml` file:

   ```yaml
   logs_enabled: true
   ```

1. Uncomment and edit the logs configuration block in your `octopus_deploy.d/conf.yaml` file. For example:

   ```yaml
   logs:
     - type: integration
       source: octopus_deploy
   ```

##### Collecting server logs{% #collecting-server-logs %}

Server logs are diagnostic information from the Octopus Server itself. They can only be collected when the Datadog Agent is running on the same machine as the Octopus Server. To collect server logs:

1. Enable log collection in your `datadog.yaml` file:

   ```yaml
   logs_enabled: true
   ```

1. Uncomment and edit the logs configuration block in your `octopus_deploy.d/conf.yaml` file. For example:

   ```yaml
   logs:
     - type: file
       path: /OctopusServer/Server/Logs/OctopusServer.txt
       source: octopus_deploy
   ```

### Validation{% #validation %}

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

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

### Metrics{% #metrics %}

|  |
|  |
| **octopus\_deploy.api.can\_connect**(gauge)                           | Whether or not the check can connect to the Octopus Deploy API |
| **octopus\_deploy.deployment.completed\_time**(gauge)                 | Duration of deployment*Shown as second*                        |
| **octopus\_deploy.deployment.count**(gauge)                           | Number of deployments monitored                                |
| **octopus\_deploy.deployment.executing**(gauge)                       | Whether or not the deployment is currently executing           |
| **octopus\_deploy.deployment.executing\_time**(gauge)                 | How long the deployment has been executing*Shown as second*    |
| **octopus\_deploy.deployment.queued**(gauge)                          | Whether or not the deployment is currently in the queue        |
| **octopus\_deploy.deployment.queued\_time**(gauge)                    | Time deployment was in queue*Shown as second*                  |
| **octopus\_deploy.deployment.waiting**(gauge)                         | Whether or not the deployment is in a waiting state            |
| **octopus\_deploy.environment.allow\_dynamic\_infrastructure**(gauge) | Whether or not the environment allows dynamic infrastructure   |
| **octopus\_deploy.environment.count**(gauge)                          | Number of environments discovered                              |
| **octopus\_deploy.environment.use\_guided\_failure**(gauge)           | Whether or not the environment is in guided failure mode       |
| **octopus\_deploy.machine.count**(gauge)                              | Number of machines discovered                                  |
| **octopus\_deploy.machine.is\_healthy**(gauge)                        | Whether or not the machine is healthy                          |
| **octopus\_deploy.project.count**(gauge)                              | Number of projects discovered                                  |
| **octopus\_deploy.project\_group.count**(gauge)                       | Number of project groups discovered                            |
| **octopus\_deploy.server\_node.count**(gauge)                         | Number of Octopus server nodes discovered                      |
| **octopus\_deploy.server\_node.in\_maintenance\_mode**(gauge)         | Whether or not the Octopus server node is in maintenance mode  |
| **octopus\_deploy.server\_node.max\_concurrent\_tasks**(gauge)        | The max concurrent tasks for the given Octopus server node     |
| **octopus\_deploy.space.count**(gauge)                                | Number of spaces discovered                                    |

### Events{% #events %}

The Octopus Deploy integration does not include events.

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

The Octopus Deploy integration does not include service checks.

## Troubleshooting{% #troubleshooting %}

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