From 7a3d2bd85b9258ca1a59848dbbf5fbff92b0caf0 Mon Sep 17 00:00:00 2001 From: Sarah Witt Date: Mon, 21 Oct 2024 11:12:01 -0400 Subject: [PATCH] Address comments --- octopus_deploy/README.md | 11 ++--------- octopus_deploy/assets/configuration/spec.yaml | 2 +- .../octopus_deploy/data/conf.yaml.example | 2 +- 3 files changed, 4 insertions(+), 11 deletions(-) diff --git a/octopus_deploy/README.md b/octopus_deploy/README.md index 36c68fb632b90..bc417a843fe94 100644 --- a/octopus_deploy/README.md +++ b/octopus_deploy/README.md @@ -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 @@ -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]. @@ -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]. diff --git a/octopus_deploy/assets/configuration/spec.yaml b/octopus_deploy/assets/configuration/spec.yaml index 27c819dbd228d..51fff1090d038 100644 --- a/octopus_deploy/assets/configuration/spec.yaml +++ b/octopus_deploy/assets/configuration/spec.yaml @@ -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: diff --git a/octopus_deploy/datadog_checks/octopus_deploy/data/conf.yaml.example b/octopus_deploy/datadog_checks/octopus_deploy/data/conf.yaml.example index b75d832e4078e..25d32dd938c3c 100644 --- a/octopus_deploy/datadog_checks/octopus_deploy/data/conf.yaml.example +++ b/octopus_deploy/datadog_checks/octopus_deploy/data/conf.yaml.example @@ -65,7 +65,7 @@ instances: X-Octopus-ApiKey: ## @param project_groups - mapping - optional - ## filter your integration by project groups and projects. + ## Filter your integration by project groups and projects. # # project_groups: {}