[
https://issues.apache.org/jira/browse/BEAM-1974?focusedWorklogId=296263&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-296263
]
ASF GitHub Bot logged work on BEAM-1974:
----------------------------------------
Author: ASF GitHub Bot
Created on: 16/Aug/19 12:47
Start Date: 16/Aug/19 12:47
Worklog Time Spent: 10m
Work Description: RyanSkraba commented on pull request #9328: [BEAM-1974]
Add Metrics user-oriented documentation
URL: https://github.com/apache/beam/pull/9328#discussion_r314702621
##########
File path: website/src/documentation/programming-guide.md
##########
@@ -2907,3 +2907,137 @@ elements, or after a minute.
```py
{% github_sample
/apache/beam/blob/master/sdks/python/apache_beam/examples/snippets/snippets_test.py
tag:model_other_composite_triggers
%}```
+
+## 9. Metrics {#metrics}
+The Beam model provides a way to use different types of metrics in a user
pipeline. There could be
Review comment:
```suggestion
In the Beam model, metrics provide some insight into the current state of a
user pipeline, potentially while the pipeline is running. There could be
```
(Just a suggestion -- the first sentence should describe why metrics are
interesting. The examples are a good illustration!)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 296263)
Time Spent: 0.5h (was: 20m)
> Metrics documentation
> ---------------------
>
> Key: BEAM-1974
> URL: https://issues.apache.org/jira/browse/BEAM-1974
> Project: Beam
> Issue Type: Improvement
> Components: website
> Reporter: Aviem Zur
> Assignee: Alexey Romanenko
> Priority: Major
> Time Spent: 0.5h
> Remaining Estimate: 0h
>
> Document metrics API and uses (make sure to remark that it is still
> experimental).
--
This message was sent by Atlassian JIRA
(v7.6.14#76016)