-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[PLINT-469] Add Octopus Deploy integration #18488
base: master
Are you sure you want to change the base?
Changes from 44 commits
26c34b0
8237b43
87f6280
152e2bd
fcf2fdc
f77c3d7
fc9e61c
23a6260
f720cc9
c802b28
29c0191
a77d728
bbb52af
c180bef
3c2c9fa
a7bf9b9
1ba6632
bfc6d01
7cd3ef3
f716ef6
4f007c3
03393b3
d22f5fa
299f5ee
37e6752
c957319
90990f9
c659018
21e8ff8
83ab4ae
416fb69
14e851a
67c6303
1e58c47
3b74fdd
27b2c5e
0209824
e1abac8
49e6135
d84cad9
18b63b7
a88f90a
17cd086
6a88501
75396e8
7a3d2bd
179597c
e3d4d48
b66b970
197843e
ea78cf3
e0312a0
02785fd
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# CHANGELOG - Octopus Deploy | ||
|
||
<!-- towncrier release notes start --> | ||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,60 @@ | ||||||
# Agent Check: Octopus Deploy | ||||||
|
||||||
## 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? | ||||||
|
||||||
## Setup | ||||||
|
||||||
Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the [Autodiscovery Integration Templates][3] for guidance on applying these instructions. | ||||||
|
||||||
### Installation | ||||||
|
||||||
The Octopus Deploy check is included in the [Datadog Agent][2] package. | ||||||
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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
2. [Restart the Agent][5]. | ||||||
|
||||||
### Validation | ||||||
|
||||||
[Run the Agent's status subcommand][6] and look for `octopus_deploy` under the Checks section. | ||||||
|
||||||
## Data Collected | ||||||
|
||||||
### Metrics | ||||||
|
||||||
See [metadata.csv][7] for a list of metrics provided by this integration. | ||||||
|
||||||
### Events | ||||||
|
||||||
The Octopus Deploy integration does not include any events. | ||||||
|
||||||
### Service Checks | ||||||
|
||||||
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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These appear to be at odds with each other. Which is correct? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Removed one! |
||||||
|
||||||
## Troubleshooting | ||||||
|
||||||
Need help? Contact [Datadog support][9]. | ||||||
|
||||||
|
||||||
[1]: https://octopus.com/ | ||||||
[2]: https://app.datadoghq.com/account/settings/agent/latest | ||||||
[3]: https://docs.datadoghq.com/agent/kubernetes/integrations/ | ||||||
[4]: https://github.com/DataDog/integrations-core/blob/master/octopus_deploy/datadog_checks/octopus_deploy/data/conf.yaml.example | ||||||
[5]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent | ||||||
[6]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information | ||||||
[7]: https://github.com/DataDog/integrations-core/blob/master/octopus_deploy/metadata.csv | ||||||
[8]: https://github.com/DataDog/integrations-core/blob/master/octopus_deploy/assets/service_checks.json | ||||||
[9]: https://docs.datadoghq.com/help/ |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,52 @@ | ||||||
name: Octopus Deploy | ||||||
files: | ||||||
- name: octopus_deploy.yaml | ||||||
options: | ||||||
- template: init_config | ||||||
options: | ||||||
- template: init_config/default | ||||||
- template: init_config/http | ||||||
- template: instances | ||||||
options: | ||||||
- name: octopus_endpoint | ||||||
description: | | ||||||
Octopus API endpoint. | ||||||
See https://octopus.com/docs/octopus-rest-api/getting-started#authentication for more details. | ||||||
value: | ||||||
example: http://localhost:80/api | ||||||
type: string | ||||||
required: true | ||||||
- name: space | ||||||
description: | | ||||||
Space to monitor | ||||||
value: | ||||||
example: Default | ||||||
type: string | ||||||
enabled: true | ||||||
required: true | ||||||
- name: project_groups | ||||||
description: | | ||||||
filter your integration by project groups and projects. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
value: | ||||||
type: object | ||||||
properties: | ||||||
- name: limit | ||||||
description: | | ||||||
Maximum number of project groups to be processed. | ||||||
type: integer | ||||||
- name: include | ||||||
type: array | ||||||
items: | ||||||
anyOf: | ||||||
- type: string | ||||||
- type: object | ||||||
- name: exclude | ||||||
type: array | ||||||
items: | ||||||
type: string | ||||||
- name: interval | ||||||
type: integer | ||||||
example: {} | ||||||
- template: instances/default | ||||||
- template: instances/http | ||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
[] |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Initial Release |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# (C) Datadog, Inc. 2024-present | ||
# All rights reserved | ||
# Licensed under a 3-clause BSD style license (see LICENSE) | ||
__path__ = __import__('pkgutil').extend_path(__path__, __name__) # type: ignore |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# (C) Datadog, Inc. 2024-present | ||
# All rights reserved | ||
# Licensed under a 3-clause BSD style license (see LICENSE) | ||
__version__ = '0.0.1' |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# (C) Datadog, Inc. 2024-present | ||
# All rights reserved | ||
# Licensed under a 3-clause BSD style license (see LICENSE) | ||
from .__about__ import __version__ | ||
from .check import OctopusDeployCheck | ||
|
||
__all__ = ['__version__', 'OctopusDeployCheck'] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs to be replaced with actual content
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated, thanks!