flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FLINK-7843) Improve and enhance documentation for system metrics
Date Thu, 26 Oct 2017 09:37:00 GMT

    [ https://issues.apache.org/jira/browse/FLINK-7843?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16220226#comment-16220226

ASF GitHub Bot commented on FLINK-7843:

Github user yew1eb commented on a diff in the pull request:

    --- Diff: docs/monitoring/metrics.md ---
    @@ -801,53 +849,67 @@ Thus, in order to infer the metric identifier:
     <table class="table table-bordered">
    -      <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>
           <th rowspan="9"><strong>Job (only available on JobManager)</strong></th>
    -      <td>The time it took to complete the last checkpoint.</td>
    +      <td>The time it took to complete the last checkpoint (in milliseconds).</td>
    +      <td>Gauge</td>
    -      <td>The total size of the last checkpoint.</td>
    +      <td>The total size of the last checkpoint (in bytes).</td>
    +      <td>Gauge</td>
           <td>The path where the last external checkpoint was stored.</td>
    +      <td>Gauge</td>
    -      <td>Timestamp when the last checkpoint was restored at the coordinator.</td>
    +      <td>Timestamp when the last checkpoint was restored at the coordinator (in
    --- End diff --
    but the "milliseconds" not cause confusion to user

> 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

View raw message