Skip to content

README.md

Latest commit

 

History

History
107 lines (67 loc) · 3.52 KB

README.md

File metadata and controls

107 lines (67 loc) · 3.52 KB
Raw

Agent Check: Octopus Deploy

Overview

This check monitors your Octopus Deploy 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

Complete the following steps to install and configure this check on a host-based Agent. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.

Installation

The Octopus Deploy check is included in the Datadog Agent package. No additional installation is needed.

Configuration

  1. Create an API key on your Octopus Server.

  2. 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 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.*'

  3. Restart the Agent.

Logs

The Octopus Deploy integration collects two types of logs: deployment logs and server 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:

    logs_enabled: true

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

    logs:
  - type: integration
    source: octopus_deploy
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:

    logs_enabled: true

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

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

Validation

Run the Agent's status subcommand and look for octopus_deploy under the Checks section.

Data collected

Metrics

See metadata.csv for a list of metrics provided by this integration.

Events

The Octopus Deploy integration does not include events.

Service checks

The Octopus Deploy integration does not include service checks.

Troubleshooting

Need help? Contact Datadog support.