rszper commented on code in PR #32464:
URL: https://github.com/apache/beam/pull/32464#discussion_r1761588579
##########
website/www/site/content/en/documentation/programming-guide.md:
##########
@@ -6159,6 +6191,17 @@ matching a given filter. It takes in a predicate with a
`SingleResult` paramete
be used for custom filters.
{{< /paragraph >}}
+{{< paragraph class="language-py">}}
+`PipelineResult` has a method `metrics()` which returns a `MetricResults`
object that allows
Review Comment:
```suggestion
`PipelineResult` has a `metrics` method that returns a `MetricResults`
object. The `MetricResults` object lets you
```
##########
website/www/site/content/en/documentation/programming-guide.md:
##########
@@ -6159,6 +6191,17 @@ matching a given filter. It takes in a predicate with a
`SingleResult` paramete
be used for custom filters.
{{< /paragraph >}}
+{{< paragraph class="language-py">}}
+`PipelineResult` has a method `metrics()` which returns a `MetricResults`
object that allows
+accessing metrics. The main method available in a `MetricResults` object,
`query()`, allows
Review Comment:
```suggestion
access metrics. The main method available in the `MetricResults` object,
`query`, lets you
```
##########
website/www/site/content/en/documentation/programming-guide.md:
##########
@@ -6159,6 +6191,17 @@ matching a given filter. It takes in a predicate with a
`SingleResult` paramete
be used for custom filters.
{{< /paragraph >}}
+{{< paragraph class="language-py">}}
+`PipelineResult` has a method `metrics()` which returns a `MetricResults`
object that allows
+accessing metrics. The main method available in a `MetricResults` object,
`query()`, allows
+for querying all metrics matching a given filter. It takes in a
`MetricsFilter` object that can
Review Comment:
```suggestion
query all metrics that match a given filter. The `query` method takes in a
`MetricsFilter` object that you can
```
##########
website/www/site/content/en/documentation/programming-guide.md:
##########
@@ -6159,6 +6191,17 @@ matching a given filter. It takes in a predicate with a
`SingleResult` paramete
be used for custom filters.
{{< /paragraph >}}
+{{< paragraph class="language-py">}}
+`PipelineResult` has a method `metrics()` which returns a `MetricResults`
object that allows
+accessing metrics. The main method available in a `MetricResults` object,
`query()`, allows
+for querying all metrics matching a given filter. It takes in a
`MetricsFilter` object that can
+be constructed to filter by several different criteria. Querying a
`MetricResults` object returns
+a dictionary of lists of `MetricResult` objects, with the dictionary
organizing them by type
+(e.g., Counter, Distribution, and Gauge). The `MetricResult` object contains a
`result()` function
Review Comment:
```suggestion
for example, `Counter`, `Distribution`, and `Gauge`. The `MetricResult`
object contains a `result` function
```
##########
website/www/site/content/en/documentation/programming-guide.md:
##########
@@ -6159,6 +6191,17 @@ matching a given filter. It takes in a predicate with a
`SingleResult` paramete
be used for custom filters.
{{< /paragraph >}}
+{{< paragraph class="language-py">}}
+`PipelineResult` has a method `metrics()` which returns a `MetricResults`
object that allows
+accessing metrics. The main method available in a `MetricResults` object,
`query()`, allows
+for querying all metrics matching a given filter. It takes in a
`MetricsFilter` object that can
+be constructed to filter by several different criteria. Querying a
`MetricResults` object returns
+a dictionary of lists of `MetricResult` objects, with the dictionary
organizing them by type
+(e.g., Counter, Distribution, and Gauge). The `MetricResult` object contains a
`result()` function
+that gets the value of the metric, and contains a `key` property that contains
information on
Review Comment:
```suggestion
that gets the value of the metric and contains a `key` property. The `key`
property contains information about
```
##########
website/www/site/content/en/documentation/programming-guide.md:
##########
@@ -6159,6 +6191,17 @@ matching a given filter. It takes in a predicate with a
`SingleResult` paramete
be used for custom filters.
{{< /paragraph >}}
+{{< paragraph class="language-py">}}
+`PipelineResult` has a method `metrics()` which returns a `MetricResults`
object that allows
+accessing metrics. The main method available in a `MetricResults` object,
`query()`, allows
+for querying all metrics matching a given filter. It takes in a
`MetricsFilter` object that can
+be constructed to filter by several different criteria. Querying a
`MetricResults` object returns
Review Comment:
```suggestion
use to filter by several different criteria. Querying a `MetricResults`
object returns
```
##########
website/www/site/content/en/documentation/programming-guide.md:
##########
@@ -6159,6 +6191,17 @@ matching a given filter. It takes in a predicate with a
`SingleResult` paramete
be used for custom filters.
{{< /paragraph >}}
+{{< paragraph class="language-py">}}
+`PipelineResult` has a method `metrics()` which returns a `MetricResults`
object that allows
+accessing metrics. The main method available in a `MetricResults` object,
`query()`, allows
+for querying all metrics matching a given filter. It takes in a
`MetricsFilter` object that can
+be constructed to filter by several different criteria. Querying a
`MetricResults` object returns
+a dictionary of lists of `MetricResult` objects, with the dictionary
organizing them by type
Review Comment:
```suggestion
a dictionary of lists of `MetricResult` objects, with the dictionary
organizing them by type,
```
##########
website/www/site/content/en/documentation/programming-guide.md:
##########
@@ -6159,6 +6191,17 @@ matching a given filter. It takes in a predicate with a
`SingleResult` paramete
be used for custom filters.
{{< /paragraph >}}
+{{< paragraph class="language-py">}}
+`PipelineResult` has a method `metrics()` which returns a `MetricResults`
object that allows
+accessing metrics. The main method available in a `MetricResults` object,
`query()`, allows
+for querying all metrics matching a given filter. It takes in a
`MetricsFilter` object that can
+be constructed to filter by several different criteria. Querying a
`MetricResults` object returns
+a dictionary of lists of `MetricResult` objects, with the dictionary
organizing them by type
+(e.g., Counter, Distribution, and Gauge). The `MetricResult` object contains a
`result()` function
+that gets the value of the metric, and contains a `key` property that contains
information on
+the namespace and name of the metric.
Review Comment:
```suggestion
the namespace and the name of the metric.
```
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
