---
title: Capistrano
description: >-
  Capistrano is a Ruby DSL for running scripts on multiple servers, mainly for
  deploying web applications.
breadcrumbs: Docs > Integrations > Capistrano
---

# Capistrano

{% callout %}
# Important note for users on the following Datadog sites: us2.ddog-gov.com

{% alert level="info" %}
To find out if this integration is available in your organization, see your [Datadog Integrations](https://app.datadoghq.com/integrations) page or ask your organization administrator.

To initiate an exception request to enable this integration for your organization, email [support@ddog-gov.com](mailto:support@ddog-gov.com).
{% /alert %}

{% /callout %}

## Overview{% #overview %}

[Capistrano](http://capistranorb.com) is a remote server automation and deployment tool written in Ruby.

Install the Capistrano Datadog integration to:

- Capture and search for deploy events in your event stream
- Overlay deploy events with other metrics within dashboards to identify which deploys affect your application's performance

Once you enable this integration for a given `Capfile`, each Capistrano task that completes is submitted as an event to Datadog. Role information and logging output are submitted too.

## Setup{% #setup %}

### Installation{% #installation %}

Install the `dogapi` Ruby gem:

```shell
sudo gem install dogapi --version ">=1.10.0"
```

### Configuration{% #configuration %}

Add the following to the beginning of any `Capfile` whose tasks you want to send to Datadog:

```text
require "capistrano/datadog"
set :datadog_api_key, "${your_api_key}"
```

### Validation{% #validation %}

After you've configured your `Capfile` and have run at least one Capistrano task:

1. Navigate to your [events stream](https://app.datadoghq.com/event/stream).
1. Either enter `sources:capistrano` in the Search bar, or click 'Capistrano' in the FROM list of integrations on the left.
1. Either enter `priority:all` in the Search bar, or click 'All' in the PRIORITY list on the left. Capistrano tasks are submitted with Low priority by default, so they do not display using the default events stream view (Normal priority).

{% video
   url="https://docs.dd-static.net/images/integrations/capistrano/capistranoevents.mp4" /%}

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

### Metrics{% #metrics %}

The Capistrano integration does not include any metric.

### Events{% #events %}

The Capistrano integration does not include any events.

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

The Capistrano integration does not include any service checks.

## Troubleshooting{% #troubleshooting %}

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