Skip to content

Commit 5733053

Browse files
committed
refine README copy
1 parent 76f078e commit 5733053

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

octopus_deploy/README.md

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,67 +2,66 @@
22

33
## Overview
44

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.
66

77
## Setup
88

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.
1010

1111
### Installation
1212

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.
1514

1615
### Configuration
1716

1817
1. Create an [API key][10] on your Octopus Server.
1918

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.
2120

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':
2322

24-
```
25-
projects:
26-
limit: 10
27-
include:
28-
- 'test.*'
29-
```
23+
```
24+
projects:
25+
limit: 10
26+
include:
27+
- 'test.*'
28+
```
3029

3130
3. [Restart the Agent][5].
3231

3332
#### Logs
3433

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.
3635

37-
##### Collecting Deployment Logs
36+
##### Collecting deployment logs
3837

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:
4039

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:
4241

4342
```yaml
4443
logs_enabled: true
4544
```
4645
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:
4847

4948
```yaml
5049
logs:
5150
- type: integration
5251
source: octopus_deploy
5352
```
5453

55-
##### Collecting Server Logs
54+
##### Collecting server logs
5655

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:
5857

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:
6059

6160
```yaml
6261
logs_enabled: true
6362
```
6463

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:
6665

6766
```yaml
6867
logs:
@@ -75,19 +74,19 @@ Server logs are diagnostic information from the Octopus Server itself. They can
7574

7675
[Run the Agent's status subcommand][6] and look for `octopus_deploy` under the Checks section.
7776

78-
## Data Collected
77+
## Data collected
7978

8079
### Metrics
8180

8281
See [metadata.csv][7] for a list of metrics provided by this integration.
8382

8483
### Events
8584

86-
The Octopus Deploy integration does not include any events.
85+
The Octopus Deploy integration does not include events.
8786

88-
### Service Checks
87+
### Service checks
8988

90-
The Octopus Deploy integration does not include any service checks.
89+
The Octopus Deploy integration does not include service checks.
9190

9291
## Troubleshooting
9392

0 commit comments

Comments
 (0)