Skip to content

Commit

Permalink
Address comments
Browse files Browse the repository at this point in the history
  • Loading branch information
sarah-witt committed Oct 21, 2024
1 parent 75396e8 commit 7a3d2bd
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 11 deletions.
11 changes: 2 additions & 9 deletions octopus_deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,7 @@

## Overview

This check monitors [Octopus Deploy][1] through the Datadog Agent.

Include a high level overview of what this integration does:
- What does your product do (in 1-2 sentences)?
- What value will customers get from this integration, and why is it valuable to them?
- What specific data will your integration monitor, and what's the value of that data?
This check monitors your [Octopus Deploy][1] deployments through the Datadog Agent. Track information such as average deployment time per Environment, and deployment failure rate for a Project.

## Setup

Expand All @@ -20,7 +15,7 @@ No additional installation is needed on your server.

### Configuration

1. Edit the `octopus_deploy.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your octopus_deploy performance data. See the [sample octopus_deploy.d/conf.yaml][4] for all available configuration options.
1. Edit the `octopus_deploy.d/conf.yaml` file in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your `octopus_deploy` performance data. See the [sample `octopus_deploy.d/conf.yaml`][4] for all available configuration options.

2. [Restart the Agent][5].

Expand All @@ -42,8 +37,6 @@ The Octopus Deploy integration does not include any events.

The Octopus Deploy integration does not include any service checks.

See [service_checks.json][8] for a list of service checks provided by this integration.

## Troubleshooting

Need help? Contact [Datadog support][9].
Expand Down
2 changes: 1 addition & 1 deletion octopus_deploy/assets/configuration/spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ files:
- name: project_groups
display_priority: 5
description: |
filter your integration by project groups and projects.
Filter your integration by project groups and projects.
value:
type: object
properties:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ instances:
X-Octopus-ApiKey: <OCTOPUS_API_KEY>

## @param project_groups - mapping - optional
## filter your integration by project groups and projects.
## Filter your integration by project groups and projects.
#
# project_groups: {}

Expand Down

0 comments on commit 7a3d2bd

Please sign in to comment.