You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: octopus_deploy/README.md
+24-25Lines changed: 24 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -2,67 +2,66 @@
2
2
3
3
## Overview
4
4
5
-
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.
5
+
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.
6
6
7
7
## Setup
8
8
9
-
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.
9
+
Complete the following steps to install and configure this check on a host-based Agent. For containerized environments, see the [Autodiscovery Integration Templates][3] for guidance on applying these instructions.
10
10
11
11
### Installation
12
12
13
-
The Octopus Deploy check is included in the [Datadog Agent][2] package.
14
-
No additional installation is needed on your server.
13
+
The Octopus Deploy check is included in the [Datadog Agent][2] package. No additional installation is needed.
15
14
16
15
### Configuration
17
16
18
17
1. Create an [API key][10] on your Octopus Server.
19
18
20
-
2. 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.
19
+
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][4] for all available options.
21
20
22
-
Ensure you limit the amount of projects you collect data for by using either the `spaces`, `project_groups`, or `projects`configuration options. For example, this configuration collects data about at most 10 projects, and only those projects whose names start with 'test':
21
+
**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':
23
22
24
-
```
25
-
projects:
26
-
limit: 10
27
-
include:
28
-
- 'test.*'
29
-
```
23
+
```
24
+
projects:
25
+
limit: 10
26
+
include:
27
+
- 'test.*'
28
+
```
30
29
31
30
3.[Restart the Agent][5].
32
31
33
32
#### Logs
34
33
35
-
The Octopus deploy integration collects two types of logs: deployment logs and server logs.
34
+
The Octopus Deploy integration collects two types of logs: deployment logs and server logs.
36
35
37
-
##### Collecting Deployment Logs
36
+
##### Collecting deployment logs
38
37
39
-
Deployment logs are gathered from deployment tasks, useful for debugging failed deployments. To collect deployment logs, complete the following steps:
38
+
Deployment logs are gathered from deployment tasks and are useful for debugging failed deployments. To collect deployment logs:
40
39
41
-
1.Collecting logs is disabled by default in the Datadog Agent. Enable it in your `datadog.yaml` file:
40
+
1. Enable log collection in your `datadog.yaml` file:
42
41
43
42
```yaml
44
43
logs_enabled: true
45
44
```
46
45
47
-
2. Uncomment and edit the logs configuration block in your `octopus_deploy.d/conf.yaml` file. Here's an example:
46
+
2. Uncomment and edit the logs configuration block in your `octopus_deploy.d/conf.yaml` file. For example:
48
47
49
48
```yaml
50
49
logs:
51
50
- type: integration
52
51
source: octopus_deploy
53
52
```
54
53
55
-
##### Collecting Server Logs
54
+
##### Collecting server logs
56
55
57
-
Server logs are diagnostic information from the Octopus Server itself. They can only be collected when the Datadog Agent is running on same machine as the Octopus Server. To collect server logs, complete the following steps:
56
+
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:
58
57
59
-
1. Collecting logs is disabled by default in the Datadog Agent. Enable it in your `datadog.yaml` file:
58
+
1. Enable log collection in your `datadog.yaml` file:
60
59
61
60
```yaml
62
61
logs_enabled: true
63
62
```
64
63
65
-
2. Uncomment and edit the logs configuration block in your `octopus_deploy.d/conf.yaml` file. Here's an example:
64
+
2. Uncomment and edit the logs configuration block in your `octopus_deploy.d/conf.yaml` file. For example:
66
65
67
66
```yaml
68
67
logs:
@@ -75,19 +74,19 @@ Server logs are diagnostic information from the Octopus Server itself. They can
75
74
76
75
[Run the Agent's status subcommand][6] and look for `octopus_deploy` under the Checks section.
77
76
78
-
## Data Collected
77
+
## Data collected
79
78
80
79
### Metrics
81
80
82
81
See [metadata.csv][7] for a list of metrics provided by this integration.
83
82
84
83
### Events
85
84
86
-
The Octopus Deploy integration does not include any events.
85
+
The Octopus Deploy integration does not include events.
87
86
88
-
### Service Checks
87
+
### Service checks
89
88
90
-
The Octopus Deploy integration does not include any service checks.
89
+
The Octopus Deploy integration does not include service checks.
0 commit comments