[
https://issues.apache.org/jira/browse/FLINK-7843?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16220219#comment-16220219
]
ASF GitHub Bot commented on FLINK-7843:
---------------------------------------
Github user yew1eb commented on a diff in the pull request:
https://github.com/apache/flink/pull/4869#discussion_r147090107
--- Diff: docs/monitoring/metrics.md ---
@@ -543,62 +546,75 @@ Thus, in order to infer the metric identifier:
<table class="table table-bordered">
<thead>
<tr>
- <th class="text-left" style="width: 20%">Scope</th>
- <th class="text-left" style="width: 25%">Infix</th>
- <th class="text-left" style="width: 23%">Metrics</th>
- <th class="text-left" style="width: 32%">Description</th>
+ <th class="text-left" style="width: 18%">Scope</th>
+ <th class="text-left" style="width: 22%">Infix</th>
+ <th class="text-left" style="width: 20%">Metrics</th>
+ <th class="text-left" style="width: 32%">Description</th>
+ <th class="text-left" style="width: 8%">Type</th>
</tr>
</thead>
<tbody>
<tr>
<th rowspan="12"><strong>Job-/TaskManager</strong></th>
<td rowspan="12">Status.JVM.Memory</td>
<td>Heap.Used</td>
- <td>The amount of heap memory currently used.</td>
+ <td>The amount of heap memory currently used (in bytes).</td>
+ <td>Gauge</td>
</tr>
<tr>
<td>Heap.Committed</td>
- <td>The amount of heap memory guaranteed to be available to the
JVM.</td>
+ <td>The amount of heap memory guaranteed to be available to the JVM
(in bytes).</td>
+ <td>Gauge</td>
</tr>
<tr>
<td>Heap.Max</td>
- <td>The maximum amount of heap memory that can be used for memory
management.</td>
+ <td>The maximum amount of heap memory that can be used for memory
management (in bytes).</td>
+ <td>Gauge</td>
</tr>
<tr>
<td>NonHeap.Used</td>
- <td>The amount of non-heap memory currently used.</td>
+ <td>The amount of non-heap memory currently used (in bytes).</td>
+ <td>Gauge</td>
</tr>
<tr>
<td>NonHeap.Committed</td>
- <td>The amount of non-heap memory guaranteed to be available to the
JVM.</td>
+ <td>The amount of non-heap memory guaranteed to be available to the
JVM (in bytes).</td>
+ <td>Gauge</td>
</tr>
<tr>
<td>NonHeap.Max</td>
- <td>The maximum amount of non-heap memory that can be used for
memory management.</td>
+ <td>The maximum amount of non-heap memory that can be used for
memory management (in bytes).</td>
+ <td>Gauge</td>
</tr>
<tr>
<td>Direct.Count</td>
- <td>The number of buffers in the direct buffer pool.</td>
+ <td>The number of buffers in the direct buffer pool (in bytes).</td>
--- End diff --
will change
> Improve and enhance documentation for system metrics
> ----------------------------------------------------
>
> Key: FLINK-7843
> URL: https://issues.apache.org/jira/browse/FLINK-7843
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3.2
> Reporter: Hai Zhou UTC+8
> Assignee: Hai Zhou UTC+8
> Priority: Critical
> Fix For: 1.4.0
>
>
> I think we should do the following improvements about system metrics section
> in the documentation:
> # Add a column that the *Type* of metric. eg. Counters, Gauges, Histograms
> and Meters
> # Modify the *Description* of the metric，Add unit description. eg. in bytes,
> in megabytes, in nanoseconds, in milliseconds
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
