Merge pull request #4440 from hashicorp/f-docs-telemetry-parent-labels

Improve telemetry docs
This commit is contained in:
Preetha 2018-06-21 17:13:52 -05:00 committed by GitHub
commit ff85f20b05
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 0 deletions

View File

@ -236,6 +236,32 @@ configuration block.
Please see the [agent configuration](/docs/agent/configuration/telemetry.html)
page for more details.
As of Nomad 0.9, Nomad will emit additional labels for [parameterized](/docs/job-specification/parameterized.html) and
[periodic](/docs/job-specification/parameterized.html) jobs. Nomad
emits the parent job id as a new label `parent_id`. Also, the labels `dispatch_id`
and `periodic_id` are emitted, containing the ID of the specific invocation of the
parameterized or periodic job respectively. For example, a dispatch job with the id
`myjob/dispatch-1312323423423`, will have the following labels.
<table class="table table-bordered table-striped">
<tr>
<th>Label</th>
<th>Value</th>
</tr>
<tr>
<td>job</td>
<td>`myjob/dispatch-1312323423423`</td>
</tr>
<tr>
<td>parent_id</td>
<td>myjob</td>
</tr>
<tr>
<td>dispatch_id</td>
<td>1312323423423</td>
</tr>
</table>
## Host Metrics (post Nomad version 0.7)
Starting in version 0.7, Nomad will emit tagged metrics, in the below format:
@ -463,6 +489,9 @@ Starting in version 0.7, Nomad will emit tagged metrics, in the below format:
</tr>
</table>
Nomad 0.9 adds an additional "node_class" label from the client's
`NodeClass` attribute. This label is set to the string "none" if empty.
## Host Metrics (deprecated post Nomad 0.7)
The below are metrics emitted by Nomad in versions prior to 0.7. These metrics