Make octopus deploy integration public #20392

sarah-witt · 2025-05-27T19:12:10Z

What does this PR do?

Makes the octopus deploy integration public and update some of the docs

Motivation

Review checklist (to be filled by reviewers)

Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
Add the qa/skip-qa label if the PR doesn't need to be tested during QA.
If you need to backport this PR to another branch, you can add the backport/<branch-name> label to the PR and it will automatically open a backport PR once this one is merged

hestonhoffman · 2025-05-27T20:47:55Z

Hi! Adding a docs card for this one so we can review the assets before they're published.

octopus_deploy/manifest.json

Review from AAraKKe is dismissed. Related teams and files:

agent-integrations
- octopus_deploy/datadog_checks/octopus_deploy/data/conf.yaml.example
- octopus_deploy/metadata.csv

domalessi · 2025-05-28T20:40:40Z

octopus_deploy/metadata.csv

@@ -2,7 +2,7 @@ metric_name,metric_type,interval,unit_name,per_unit_name,description,orientation
 octopus_deploy.api.can_connect,gauge,,,,Whether or not the check can connect to the Octopus Deploy API.,-1,octopus_deploy,octopus_deploy api,,
 octopus_deploy.deployment.completed_time,gauge,,second,,Duration of deployment.,-1,octopus_deploy,octopus_deploy deploy dur,,
 octopus_deploy.deployment.count,gauge,,,,Number of deployments monitored.,-1,octopus_deploy,octopus_deploy deploy count,,
-octopus_deploy.deployment.executing,gauge,,second,,Whether or not the deployment is currently executing.,-1,octopus_deploy,octopus_deploy deploy executing,,
+octopus_deploy.deployment.executing,gauge,,,,Whether or not the deployment is currently executing.,-1,octopus_deploy,octopus_deploy deploy executing,,


There are a handful of lines in here where the unit_type is second but the description implies it's actually a boolean ("Whether or not..."). Can we do a pass here to confirm we're using the correct type on these lines?

domalessi · 2025-05-28T20:42:28Z

octopus_deploy/metadata.csv

@@ -2,7 +2,7 @@ metric_name,metric_type,interval,unit_name,per_unit_name,description,orientation
 octopus_deploy.api.can_connect,gauge,,,,Whether or not the check can connect to the Octopus Deploy API.,-1,octopus_deploy,octopus_deploy api,,
 octopus_deploy.deployment.completed_time,gauge,,second,,Duration of deployment.,-1,octopus_deploy,octopus_deploy deploy dur,,
 octopus_deploy.deployment.count,gauge,,,,Number of deployments monitored.,-1,octopus_deploy,octopus_deploy deploy count,,
-octopus_deploy.deployment.executing,gauge,,second,,Whether or not the deployment is currently executing.,-1,octopus_deploy,octopus_deploy deploy executing,,
+octopus_deploy.deployment.executing,gauge,,,,Whether or not the deployment is currently executing.,-1,octopus_deploy,octopus_deploy deploy executing,,
 octopus_deploy.deployment.executing_time,gauge,,second,,How long the deployment has been executing.,-1,octopus_deploy,octopus_deploy deploy dur,,


octopus_deploy deploy dur shortname is also used on line 3. Is that intentional?

Same deal for lines 7 and 8 - same shortname

codecov · 2025-05-28T20:43:32Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.17%. Comparing base (0245920) to head (a39469c).
Report is 21 commits behind head on master.

Additional details and impacted files

Flag	Coverage Δ
activemq	`?`
cassandra	`?`
confluent_platform	`?`
hive	`?`
hivemq	`?`
hudi	`?`
ignite	`?`
jboss_wildfly	`?`
kafka	`?`
octopus_deploy	`99.25% <ø> (ø)`
presto	`?`
solr	`?`
tomcat	`?`
weblogic	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

domalessi · 2025-05-28T20:52:22Z

octopus_deploy/metadata.csv

+octopus_deploy.api.can_connect,gauge,,,,Whether or not the check can connect to the Octopus Deploy API,-1,octopus_deploy,octopus_deploy api,,
+octopus_deploy.deployment.completed_time,gauge,,second,,Duration of deployment,-1,octopus_deploy,octopus_deploy deploy dur,,
+octopus_deploy.deployment.count,gauge,,,,Number of deployments monitored,-1,octopus_deploy,octopus_deploy deploy count,,
+octopus_deploy.deployment.executing,gauge,,,,Whether or not the deployment is currently executing,-1,octopus_deploy,octopus_deploy deploy executing,,


There are a handful of lines in here where the unit_type is second but the description implies it's actually a boolean ("Whether or not..."). Can we do a pass here to confirm we're using the correct type on these lines?

Updated, thanks for finding that!

domalessi · 2025-05-28T20:53:41Z

octopus_deploy/metadata.csv

+octopus_deploy.deployment.queued,gauge,,second,,Whether or not the deployment is currently in the queue,-1,octopus_deploy,octopus_deploy deploy queue,,
+octopus_deploy.deployment.queued_time,gauge,,second,,Time deployment was in queue,-1,octopus_deploy,octopus_deploy deploy queue,,


These two have the same shortname. Is that intentional? Same with lines 3 and 6 - those also share a shortname

Good catch, updated!

octopus_deploy/assets/configuration/spec.yaml

domalessi

Left some suggested changes! Sorry if you got pinged a million times with my git nonsense (accidentally pushed a bunch of files on here so then had to revert). Anyway... take a look through everything and let me know what you think!

sarah-witt · 2025-05-29T19:09:53Z

Looks good to me @domalessi, I'm going to get my team to review it!

domalessi · 2025-05-29T19:17:45Z

@sarah-witt Awesome! I'll go ahead and approve from the Documentation team so you're not blocked on me :)

make integration public

fe26d91

datadog-agent-integrations-bot bot added documentation integration/octopus_deploy labels May 27, 2025

sarah-witt marked this pull request as ready for review May 27, 2025 19:38

sarah-witt requested review from a team as code owners May 27, 2025 19:38

datadog-agent-integrations-bot bot added team/agent-integrations team/documentation labels May 27, 2025

hestonhoffman added the editorial review Waiting on a more in-depth review from a docs team editor label May 27, 2025

AAraKKe reviewed May 28, 2025

View reviewed changes

octopus_deploy/manifest.json Show resolved Hide resolved

AAraKKe previously approved these changes May 28, 2025

View reviewed changes

domalessi added 2 commits May 28, 2025 16:35

copy edits for conf yaml example

a48ed53

remove second unit name

f73d03a

domalessi reviewed May 28, 2025

View reviewed changes

tweaks to metadata csv

3355f75

domalessi reviewed May 28, 2025

View reviewed changes

Update docs

95c1d20

sarah-witt added the changelog/no-changelog label May 28, 2025

sarah-witt requested a review from domalessi May 29, 2025 15:41

domalessi requested review from a team as code owners May 29, 2025 17:44

datadog-agent-integrations-bot bot added team/logs-integrations-reviewers team/logs-backend team/saas-integrations team/container-integrations team/agent-delivery new name for agent-build-and-delivery team/ndm-core team/ndm-integrations labels May 29, 2025

domalessi force-pushed the sarah/make-octopus-intg-public branch 2 times, most recently from 76f078e to 95c1d20 Compare May 29, 2025 17:49

domalessi added 4 commits May 29, 2025 13:59

README copy edit

92c47f0

spec yaml tweaks

333b6e7

minor conf yaml example edits

128a133

dashboard overview.json copy tweaks

f21d558

domalessi reviewed May 29, 2025

View reviewed changes

octopus_deploy/assets/configuration/spec.yaml Outdated Show resolved Hide resolved

Update octopus_deploy/assets/configuration/spec.yaml

b202fc9

domalessi reviewed May 29, 2025

View reviewed changes

update instance

a39469c

Kyle-Neale approved these changes May 29, 2025

View reviewed changes

domalessi approved these changes May 29, 2025

View reviewed changes

steveny91 approved these changes May 29, 2025

View reviewed changes

NouhaManai96 removed request for a team and NouhaManai96 May 30, 2025 09:17

sarah-witt added this pull request to the merge queue May 30, 2025

Merged via the queue into master with commit df33680 May 30, 2025
44 checks passed

sarah-witt deleted the sarah/make-octopus-intg-public branch May 30, 2025 13:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Make octopus deploy integration public #20392

Make octopus deploy integration public #20392

Uh oh!

sarah-witt commented May 27, 2025 •

edited

Loading

Uh oh!

hestonhoffman commented May 27, 2025

Uh oh!

Uh oh!

domalessi May 28, 2025

Uh oh!

domalessi May 28, 2025

Uh oh!

codecov bot commented May 28, 2025 •

edited

Loading

Uh oh!

domalessi May 28, 2025 •

edited

Loading

Uh oh!

sarah-witt May 28, 2025

Uh oh!

domalessi May 28, 2025

Uh oh!

sarah-witt May 28, 2025

Uh oh!

Uh oh!

domalessi left a comment

Uh oh!

sarah-witt commented May 29, 2025

Uh oh!

domalessi commented May 29, 2025

Uh oh!

Uh oh!

Uh oh!

		octopus_deploy.deployment.queued,gauge,,second,,Whether or not the deployment is currently in the queue,-1,octopus_deploy,octopus_deploy deploy queue,,
		octopus_deploy.deployment.queued_time,gauge,,second,,Time deployment was in queue,-1,octopus_deploy,octopus_deploy deploy queue,,

Make octopus deploy integration public #20392

Make octopus deploy integration public #20392

Uh oh!

Conversation

sarah-witt commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Motivation

Review checklist (to be filled by reviewers)

Uh oh!

hestonhoffman commented May 27, 2025

Uh oh!

Uh oh!

domalessi May 28, 2025

Choose a reason for hiding this comment

Uh oh!

domalessi May 28, 2025

Choose a reason for hiding this comment

Uh oh!

codecov bot commented May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

domalessi May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sarah-witt May 28, 2025

Choose a reason for hiding this comment

Uh oh!

domalessi May 28, 2025

Choose a reason for hiding this comment

Uh oh!

sarah-witt May 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

domalessi left a comment

Choose a reason for hiding this comment

Uh oh!

sarah-witt commented May 29, 2025

Uh oh!

domalessi commented May 29, 2025

Uh oh!

Uh oh!

Uh oh!

sarah-witt commented May 27, 2025 •

edited

Loading

codecov bot commented May 28, 2025 •

edited

Loading

domalessi May 28, 2025 •

edited

Loading