Skip to content

Commit

Permalink
update telemetry client metrics for new values
Browse files Browse the repository at this point in the history
  • Loading branch information
@chelseakomlo
chelseakomlo committed Sep 7, 2017
1 parent c3006c6 commit e5410d1
Showing 1 changed file with 190 additions and 1 deletion.
191 changes: 190 additions & 1 deletion website/source/docs/agent/telemetry.html.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,196 @@ configuration block.
Please see the [agent configuration](/docs/agent/configuration/telemetry.html)
page for more details.

## Host Metrics
## Host Metrics (post Nomad version 0.7)

Starting in version 0.7, Nomad will emit tagged metrics, in the below format:

<table class="table table-bordered table-striped">
<tr>
<th>Metric</th>
<th>Description</th>
<th>Unit</th>
<th>Type</th>
<th>Labels</th>
</tr>
<tr>
<td>`nomad.client.allocated.cpu`</td>
<td>Total amount of CPU shares the scheduler has allocated to tasks</td>
<td>MHz</td>
<td>Gauge</td>
<td>Host ID</td>
</tr>
<tr>
<td>`nomad.client.unallocated.cpu`</td>
<td>Total amount of CPU shares free for the scheduler to allocate to tasks</td>
<td>MHz</td>
<td>Gauge</td>
<td>Host ID</td>
</tr>
<tr>
<td>`nomad.client.allocated.memory`</td>
<td>Total amount of memory the scheduler has allocated to tasks</td>
<td>Megabytes</td>
<td>Gauge</td>
<td>Host ID</td>
</tr>
<tr>
<td>`nomad.client.unallocated.memory`</td>
<td>Total amount of memory free for the scheduler to allocate to tasks</td>
<td>Megabytes</td>
<td>Gauge</td>
<td>Host ID</td>
</tr>
<tr>
<td>`nomad.client.allocated.disk`</td>
<td>Total amount of disk space the scheduler has allocated to tasks</td>
<td>Megabytes</td>
<td>Gauge</td>
<td>Host ID</td>
</tr>
<tr>
<td>`nomad.client.unallocated.disk`</td>
<td>Total amount of disk space free for the scheduler to allocate to tasks</td>
<td>Megabytes</td>
<td>Gauge</td>
<td>Host ID</td>
</tr>
<tr>
<td>`nomad.client.allocated.iops`</td>
<td>Total amount of IOPS the scheduler has allocated to tasks</td>
<td>IOPS</td>
<td>Gauge</td>
<td>Host ID</td>
</tr>
<tr>
<td>`nomad.client.unallocated.iops`</td>
<td>Total amount of IOPS free for the scheduler to allocate to tasks</td>
<td>IOPS</td>
<td>Gauge</td>
<td>Host ID, Datacenter</td>
</tr>
<tr>
<td>`nomad.client.allocated.network`</td>
<td>Total amount of bandwidth the scheduler has allocated to tasks on the
given device</td>
<td>Megabits</td>
<td>Gauge</td>
<td>Device Name, Host ID, Datacenter</td>
</tr>
<tr>
<td>`nomad.client.unallocated.network`</td>
<td>Total amount of bandwidth free for the scheduler to allocate to tasks on
the given device</td>
<td>Megabits</td>
<td>Gauge</td>
<td>Device Name, Host ID, Datacenter</td>
</tr>
<tr>
<td>`nomad.client.host.memory.total`</td>
<td>Total amount of physical memory on the node</td>
<td>Bytes</td>
<td>Gauge</td>
<td>Host ID, Datacenter</td>
</tr>
<tr>
<td>`nomad.client.host.memory.available`</td>
<td>Total amount of memory available to processes which includes free and
cached memory</td>
<td>Bytes</td>
<td>Gauge</td>
<td>Host ID, Datacenter</td>
</tr>
<tr>
<td>`nomad.client.host.memory.used`</td>
<td>Amount of memory used by processes</td>
<td>Bytes</td>
<td>Gauge</td>
<td>Host ID, Datacenter</td>
</tr>
<tr>
<td>`nomad.client.host.memory.free`</td>
<td>Amount of memory which is free</td>
<td>Bytes</td>
<td>Gauge</td>
<td>Host ID, Datacenter</td>
</tr>
<tr>
<td>`nomad.client.uptime`</td>
<td>Uptime of the host running the Nomad client</td>
<td>Seconds</td>
<td>Gauge</td>
<td>Host ID, Datacenter</td>
</tr>
<tr>
<td>`nomad.client.host.cpu.total`</td>
<td>Total CPU utilization</td>
<td>Percentage</td>
<td>Gauge</td>
<td>CPU-Core, Host ID, Datacenter</td>
</tr>
<tr>
<td>`nomad.client.host.cpu.user`</td>
<td>CPU utilization in the user space</td>
<td>Percentage</td>
<td>Gauge</td>
<td>CPU-Core, Host ID, Datacenter</td>
</tr>
<tr>
<td>`nomad.client.host.cpu.system`</td>
<td>CPU utilization in the system space</td>
<td>Percentage</td>
<td>Gauge</td>
<td>CPU-Core, Host ID, Datacenter</td>
</tr>
<tr>
<td>`nomad.client.host.cpu.idle`</td>
<td>Idle time spent by the CPU</td>
<td>Percentage</td>
<td>Gauge</td>
<td>CPU-Core, Host ID, Datacenter</td>
</tr>
<tr>
<td>`nomad.client.host.disk.size`</td>
<td>Total size of the device</td>
<td>Bytes</td>
<td>Gauge</td>
<td>Device Name, Host ID, Datacenter</td>
</tr>
<tr>
<td>`nomad.client.host.disk.used`</td>
<td>Amount of space which has been used</td>
<td>Bytes</td>
<td>Gauge</td>
<td>Device Name, Host ID, Datacenter</td>
</tr>
<tr>
<td>`nomad.client.host.disk.available`</td>
<td>Amount of space which is available</td>
<td>Bytes</td>
<td>Gauge</td>
<td>Device Name, Host ID, Datacenter</td>
</tr>
<tr>
<td>`nomad.client.host.disk.used_percent`</td>
<td>Percentage of disk space used</td>
<td>Percentage</td>
<td>Gauge</td>
<td>Device Name, Host ID, Datacenter</td>
</tr>
<tr>
<td>`nomad.client.host.disk.inodes_percent`</td>
<td>Disk space consumed by the inodes</td>
<td>Percent</td>
<td>Gauge</td>
<td>Device Name, Host ID, Datacenter</td>
</tr>
</table>

## Host Metrics (deprecated post Nomad 0.7)

The below are metrics emitted by Nomad in versions prior to 0.7. These metrics
can be emitted in the below format post-0.7 (as well as the new format,
detailed above) but any new metrics will only be available in the new format.

<table class="table table-bordered table-striped">
<tr>
Expand Down

0 comments on commit e5410d1

Please sign in to comment.