[
https://issues.apache.org/jira/browse/FLINK-7843?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16220275#comment-16220275
]
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_r147100695
--- Diff: docs/monitoring/metrics.md ---
@@ -856,66 +918,80 @@ 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: 30%">Metrics</th>
- <th class="text-left" style="width: 50%">Description</th>
+ <th class="text-left" style="width: 18%">Scope</th>
+ <th class="text-left" style="width: 26%">Metrics</th>
+ <th class="text-left" style="width: 48%">Description</th>
+ <th class="text-left" style="width: 8%">Type</th>
</tr>
</thead>
<tbody>
<tr>
<th rowspan="7"><strong>Task</strong></th>
<td>currentLowWatermark</td>
- <td>The lowest watermark this task has received.</td>
+ <td>The lowest watermark this task has received (in
milliseconds).</td>
+ <td>Gauge</td>
</tr>
<tr>
<td>numBytesInLocal</td>
<td>The total number of bytes this task has read from a local
source.</td>
+ <td>Counter</td>
--- End diff --
Yes.
But, eg.
**numBytesInRemote** The total number of bytes this task has read from a
remote source.
**numBytesInRemotePerSecond** The number of bytes this task reads from a
remote source per second.
Users can easily know that these metrics units through this description,
will not be confused.
So, I think we do not need to add additional unit descriptions to these
metrics (except latency metric).
> 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)
