[
https://issues.apache.org/jira/browse/BEAM-4374?focusedWorklogId=410440&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-410440
]
ASF GitHub Bot logged work on BEAM-4374:
----------------------------------------
Author: ASF GitHub Bot
Created on: 26/Mar/20 17:42
Start Date: 26/Mar/20 17:42
Worklog Time Spent: 10m
Work Description: lukecwik commented on pull request #11184: [BEAM-4374]
Update protos related to MonitoringInfo.
URL: https://github.com/apache/beam/pull/11184#discussion_r398767189
##########
File path: model/pipeline/src/main/proto/metrics.proto
##########
@@ -229,121 +330,152 @@ message MonitoringInfo {
NAMESPACE = 5 [(label_props) = { name: "NAMESPACE" }];
NAME = 6 [(label_props) = { name: "NAME" }];
}
- // A set of key+value labels which define the scope of the metric.
+
+ // A set of key and value labels which define the scope of the metric. For
+ // well known URNs, the set of required labels is provided by the associated
+ // MonitoringInfoSpec.
+ //
// Either a well defined entity id for matching the enum names in
// the MonitoringInfoLabels enum or any arbitrary label
// set by a custom metric or user metric.
+ //
// A monitoring system is expected to be able to aggregate the metrics
// together for all updates having the same URN and labels. Some systems such
// as Stackdriver will be able to aggregate the metrics using a subset of the
// provided labels
- map<string, string> labels = 5;
-
- // The walltime of the most recent update.
- // Useful for aggregation for latest types such as LatestInt64.
- google.protobuf.Timestamp timestamp = 6;
+ map<string, string> labels = 4;
}
+// A set of well known URNs that specify the encoding and aggregation method.
message MonitoringInfoTypeUrns {
enum Enum {
+ // Represents an integer counter where values are summed across bundles.
+ //
+ // Encoding: <value>
+ // - value: beam:coder:varint:v1
SUM_INT64_TYPE = 0 [(org.apache.beam.model.pipeline.v1.beam_urn) =
- "beam:metrics:sum_int_64"];
-
- DISTRIBUTION_INT64_TYPE = 1 [(org.apache.beam.model.pipeline.v1.beam_urn) =
- "beam:metrics:distribution_int_64"];
-
- LATEST_INT64_TYPE = 2 [(org.apache.beam.model.pipeline.v1.beam_urn) =
- "beam:metrics:latest_int_64"];
-
- // iterable<double> is encoded with a beam:coder:double:v1 coder for each
- // element.
- LATEST_DOUBLES_TYPE = 3 [(org.apache.beam.model.pipeline.v1.beam_urn) =
- "beam:metrics:latest_doubles"];
- }
-}
-
-message Metric {
- // (Required) The data for this metric.
- oneof data {
- CounterData counter_data = 1;
- DistributionData distribution_data = 2;
- ExtremaData extrema_data = 3;
- }
-}
-
-// Data associated with a Counter or Gauge metric.
-// This is designed to be compatible with metric collection
-// systems such as DropWizard.
-message CounterData {
- oneof value {
- int64 int64_value = 1;
- double double_value = 2;
- string string_value = 3;
- }
-}
-
-// Extrema messages are used for calculating
-// Top-N/Bottom-N metrics.
-message ExtremaData {
- oneof extrema {
- IntExtremaData int_extrema_data = 1;
- DoubleExtremaData double_extrema_data = 2;
- }
-}
-
-message IntExtremaData {
- repeated int64 int_values = 1;
-}
-
-message DoubleExtremaData {
- repeated double double_values = 2;
-}
-
-// Data associated with a distribution metric.
-// This is based off of the current DistributionData metric.
-// This is not a stackdriver or dropwizard compatible
-// style of distribution metric.
-message DistributionData {
- oneof distribution {
- IntDistributionData int_distribution_data = 1;
- DoubleDistributionData double_distribution_data = 2;
+ "beam:metrics:sum_int64:v1"];
+
+ // Represents a double counter where values are summed across bundles.
+ //
+ // Encoding: <value>
+ // value: beam:coder:double:v1
+ SUM_DOUBLE_TYPE = 1 [(org.apache.beam.model.pipeline.v1.beam_urn) =
+ "beam:metrics:sum_double:v1"];
+
+ // Represents a distribution of an integer value where:
+ // - count: represents the number of values seen across all bundles
+ // - sum: represents the total of the value across all bundles
+ // - min: represents the smallest value seen across all bundles
+ // - max: represents the largest value seen across all bundles
+ //
+ // Encoding: <count><sum><min><max>
+ // - count: beam:coder:varint:v1
+ // - sum: beam:coder:varint:v1
+ // - min: beam:coder:varint:v1
+ // - max: beam:coder:varint:v1
+ DISTRIBUTION_INT64_TYPE = 2 [(org.apache.beam.model.pipeline.v1.beam_urn) =
+ "beam:metrics:distribution_int64:v1"];
+
+ // Represents a distribution of a double value where:
+ // - count: represents the number of values seen across all bundles
+ // - sum: represents the total of the value across all bundles
+ // - min: represents the smallest value seen across all bundles
+ // - max: represents the largest value seen across all bundles
+ //
+ // Encoding: <count><sum><min><max>
+ // - count: beam:coder:varint:v1
+ // - sum: beam:coder:double:v1
+ // - min: beam:coder:double:v1
+ // - max: beam:coder:double:v1
+ DISTRIBUTION_DOUBLE_TYPE = 3 [(org.apache.beam.model.pipeline.v1.beam_urn)
=
+ "beam:metrics:distribution_double:v1"];
+
+ // Represents the latest seen integer value. The timestamp is used to
+ // provide an "ordering" over multiple values to determine which is the
+ // latest.
+ //
+ // Encoding: <timestamp><value>
+ // - timestamp: beam:coder:varint:v1 (milliseconds since epoch)
+ // - value: beam:coder:varint:v1
+ LATEST_INT64_TYPE = 4 [(org.apache.beam.model.pipeline.v1.beam_urn) =
Review comment:
Would need to do this in other places such as the timer coder, windowed
value coder if we wanted to keep the URN naming to be consistent so I'll leave
as is and added this to the protocol changes tracking sheet.
----------------------------------------------------------------
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:
us...@infra.apache.org
Issue Time Tracking
-------------------
Worklog Id: (was: 410440)
Time Spent: 27.5h (was: 27h 20m)
> Update existing metrics in the FN API to use new Metric Schema
> --------------------------------------------------------------
>
> Key: BEAM-4374
> URL: https://issues.apache.org/jira/browse/BEAM-4374
> Project: Beam
> Issue Type: New Feature
> Components: beam-model
> Reporter: Alex Amato
> Priority: Major
> Time Spent: 27.5h
> Remaining Estimate: 0h
>
> Update existing metrics to use the new proto and cataloging schema defined in:
> [_https://s.apache.org/beam-fn-api-metrics_]
> * Check in new protos
> * Define catalog file for metrics
> * Port existing metrics to use this new format, based on catalog
> names+metadata
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
