Skip to content
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.

Sign up for GitHub

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

Improve telemetry docs #4440

Merged
merged 2 commits into from
Jun 21, 2018
Merged

Improve telemetry docs #4440

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58b5e42
add docs for new labels
Jun 21, 2018
8f9647c
Docs about node_class label
Jun 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions website/source/docs/agent/telemetry.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down