Skip to content

Commit 95c1d20

Browse files
committed
Update docs
1 parent 3355f75 commit 95c1d20

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

octopus_deploy/assets/configuration/spec.yaml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,21 @@ files:
2020
- name: spaces
2121
display_priority: 5
2222
description: |
23-
Optional configuration to indicate the spaces that we want to be processed. If not configured,
23+
Optional configuration to indicate the spaces to process. If not configured,
2424
all spaces and their corresponding project groups and projects are be processed.
2525
2626
The 'include' key indicates the regular expressions of the spaces for reporting metrics
2727
and the configuration to be applied to each of them. Each group can have a 'project-groups'-like configuration,
2828
that enables or disables metric collection for the project groups matching that condition. For further details
2929
see the next section, 'project-groups'. If no configuration associated with the key is indicated with the regular
30-
expression, they are be processed with the default configuration.
30+
expression, they are processed with the default configuration.
3131
3232
The spaces are processed in the order indicated in the 'include'.
3333
If a space is matched on an 'include' key, it is only processed there and not in a later 'include'
3434
that it might match on.
3535
3636
The 'exclude' key indicates the regular expressions of those spaces for not reporting metrics.
37-
The excludes have priority over the includes, that is, if a space matches an exclude, it is not
37+
The excludes have priority over the includes; that is, if a space matches an exclude, it is not
3838
processed even if it matches an include. The 'include' key must be used if using the 'exclude' key.
3939
4040
The 'limit' key allows limiting the number of spaces processed to avoid a combinatorial explosion of tags
@@ -81,28 +81,28 @@ files:
8181
- name: project_groups
8282
display_priority: 5
8383
description: |
84-
Optional configuration to indicate the project groups that we want to be processed. If not configured,
84+
Optional configuration to indicate the project groups to process. If not configured,
8585
all project groups are processed.
8686
8787
The 'include' key indicates the regular expressions of the project groups for reporting metrics
8888
and the configuration to be applied to each of them. Each group can have a 'projects'-like
8989
configuration, that enables or disables metric collection for the projects matching that condition. For
9090
further details see previous section 'projects'. If no configuration associated with the key is indicated with
91-
the regular expression, they are be processed with the default configuration.
91+
the regular expression, they are processed with the default configuration.
9292
9393
The project groups are processed in the order indicated in the 'include'.
9494
If a project group is matched on an 'include' key, it is only processed there and not in a later 'include'
9595
that it might match on.
9696
9797
The 'exclude' key indicates the regular expressions of those project groups for not reporting metrics.
98-
The excludes has priority over the includes, that is, if a project group matches an exclude, it is not
98+
The excludes have priority over the includes; that is, if a project group matches an exclude, it is not
9999
processed even if it matches an include. The 'include' key must be used if using the 'exclude' key.
100100
101101
The 'limit' key allows limiting the number of project groups processed to avoid a combinatorial explosion of
102102
tags associated with a metric.
103103
104104
The 'interval' key indicates the validity time of the last list of project groups obtained through the
105-
endpoint. If 'interval' is not indicated, the list of project groups are obtained each time the check is
105+
endpoint. If 'interval' is not indicated, the list of project groups is obtained each time the check is
106106
executed and is not cached.
107107
108108
In the following example, all project groups are processed except those whose name begins with 'tmp_'
@@ -139,17 +139,17 @@ files:
139139
- name: projects
140140
display_priority: 5
141141
description: |
142-
Optional configuration to indicate the projects that we want to be processed. If not configured,
142+
Optional configuration to indicate the projects to process. If not configured,
143143
all projects are processed.
144144
145145
The 'include' key indicates the regular expressions of the projects for reporting metrics.
146146
147147
The projects are processed in the order indicated in the 'include'.
148-
If a projects is matched on an 'include' key, it is only processed there and not in a later 'include'
148+
If a project is matched on an 'include' key, it is only processed there and not in a later 'include'
149149
that it might match on.
150150
151151
The 'exclude' key indicates the regular expressions of those projects for not reporting metrics.
152-
The excludes has priority over the includes, that is, if a projects matches an exclude, it is not
152+
The excludes have priority over the includes; that is, if a project matches an exclude, it is not
153153
processed even if it matches an include. The 'include' key must be used if using the 'exclude' key.
154154
155155
The 'limit' key allows limiting the number of projects processed to avoid a combinatorial explosion of tags
@@ -187,7 +187,7 @@ files:
187187
- name: environments
188188
display_priority: 6
189189
description: |
190-
Optional configuration to indicate the environments that we want to be processed. If not configured,
190+
Optional configuration to indicate the environments to process. If not configured,
191191
all environments are processed.
192192
193193
The 'include' key indicates the regular expressions of the environments for reporting metrics.
@@ -197,7 +197,7 @@ files:
197197
that it might match on.
198198
199199
The 'exclude' key indicates the regular expressions of those environments for not reporting metrics.
200-
The excludes has priority over the includes, that is, if an environment matches an exclude, it is not
200+
The excludes have priority over the includes; that is, if an environment matches an exclude, it is not
201201
processed even if it matches an include. The 'include' key must be used if using the 'exclude' key.
202202
203203
The 'limit' key allows limiting the number of environments processed to avoid a combinatorial explosion of

octopus_deploy/datadog_checks/octopus_deploy/data/conf.yaml.example

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ instances:
9090

9191
## @param spaces - mapping - optional
9292
## Optional configuration to indicate the spaces to process. If not configured,
93-
## all spaces and their corresponding project groups and projects are processed.
93+
## all spaces and their corresponding project groups and projects are be processed.
9494
##
9595
## The 'include' key indicates the regular expressions of the spaces for reporting metrics
9696
## and the configuration to be applied to each of them. Each group can have a 'project-groups'-like configuration,
@@ -286,7 +286,7 @@ instances:
286286
## @param metric_patterns - mapping - optional
287287
## A mapping of metrics to include or exclude, with each entry being a regular expression.
288288
##
289-
## Metrics defined in `exclude` take precedence in case of overlap.
289+
## Metrics defined in `exclude` will take precedence in case of overlap.
290290
#
291291
# metric_patterns:
292292
# include:

octopus_deploy/metadata.csv

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
metric_name,metric_type,interval,unit_name,per_unit_name,description,orientation,integration,short_name,curated_metric,sample_tags
22
octopus_deploy.api.can_connect,gauge,,,,Whether or not the check can connect to the Octopus Deploy API,-1,octopus_deploy,octopus_deploy api,,
3-
octopus_deploy.deployment.completed_time,gauge,,second,,Duration of deployment,-1,octopus_deploy,octopus_deploy deploy dur,,
3+
octopus_deploy.deployment.completed_time,gauge,,second,,Duration of deployment,-1,octopus_deploy,octopus_deploy deploy completed,,
44
octopus_deploy.deployment.count,gauge,,,,Number of deployments monitored,-1,octopus_deploy,octopus_deploy deploy count,,
55
octopus_deploy.deployment.executing,gauge,,,,Whether or not the deployment is currently executing,-1,octopus_deploy,octopus_deploy deploy executing,,
6-
octopus_deploy.deployment.executing_time,gauge,,second,,How long the deployment has been executing,-1,octopus_deploy,octopus_deploy deploy dur,,
7-
octopus_deploy.deployment.queued,gauge,,second,,Whether or not the deployment is currently in the queue,-1,octopus_deploy,octopus_deploy deploy queue,,
8-
octopus_deploy.deployment.queued_time,gauge,,second,,Time deployment was in queue,-1,octopus_deploy,octopus_deploy deploy queue,,
9-
octopus_deploy.deployment.waiting,gauge,,second,,Whether or not the deployment is in a waiting state,-1,octopus_deploy,octopus_deploy deploy waiting,,
6+
octopus_deploy.deployment.executing_time,gauge,,second,,How long the deployment has been executing,-1,octopus_deploy,octopus_deploy deploy execute,,
7+
octopus_deploy.deployment.queued,gauge,,,,Whether or not the deployment is currently in the queue,-1,octopus_deploy,octopus_deploy deploy queue,,
8+
octopus_deploy.deployment.queued_time,gauge,,second,,Time deployment was in queue,-1,octopus_deploy,octopus_deploy deploy queue time,,
9+
octopus_deploy.deployment.waiting,gauge,,,,Whether or not the deployment is in a waiting state,-1,octopus_deploy,octopus_deploy deploy waiting,,
1010
octopus_deploy.environment.allow_dynamic_infrastructure,gauge,,,,Whether or not the environment allows dynamic infrastructure,-1,octopus_deploy,octopus_deploy env infra,,
1111
octopus_deploy.environment.count,gauge,,,,Number of environments discovered,-1,octopus_deploy,octopus_deploy env count,,
1212
octopus_deploy.environment.use_guided_failure,gauge,,,,Whether or not the environment is in guided failure mode,-1,octopus_deploy,octopus_deploy env guided failure,,

0 commit comments

Comments
 (0)