Source code for apache_beam.portability.api.metrics_pb2_urns

from ..utils import PropertiesFromEnumValue
from . import metrics_pb2
EMPTY_MONITORING_INFO_LABEL_PROPS = metrics_pb2.MonitoringInfoLabelProps()
EMPTY_MONITORING_INFO_SPEC = metrics_pb2.MonitoringInfoSpec()

[docs]class MonitoringInfo(object):
[docs] class MonitoringInfoLabels(object): TRANSFORM = PropertiesFromEnumValue(u'', u'', EMPTY_MONITORING_INFO_SPEC, metrics_pb2.MonitoringInfoLabelProps(name=u'PTRANSFORM')) PCOLLECTION = PropertiesFromEnumValue(u'', u'', EMPTY_MONITORING_INFO_SPEC, metrics_pb2.MonitoringInfoLabelProps(name=u'PCOLLECTION')) WINDOWING_STRATEGY = PropertiesFromEnumValue(u'', u'', EMPTY_MONITORING_INFO_SPEC, metrics_pb2.MonitoringInfoLabelProps(name=u'WINDOWING_STRATEGY')) CODER = PropertiesFromEnumValue(u'', u'', EMPTY_MONITORING_INFO_SPEC, metrics_pb2.MonitoringInfoLabelProps(name=u'CODER')) ENVIRONMENT = PropertiesFromEnumValue(u'', u'', EMPTY_MONITORING_INFO_SPEC, metrics_pb2.MonitoringInfoLabelProps(name=u'ENVIRONMENT')) NAMESPACE = PropertiesFromEnumValue(u'', u'', EMPTY_MONITORING_INFO_SPEC, metrics_pb2.MonitoringInfoLabelProps(name=u'NAMESPACE')) NAME = PropertiesFromEnumValue(u'', u'', EMPTY_MONITORING_INFO_SPEC, metrics_pb2.MonitoringInfoLabelProps(name=u'NAME'))
[docs]class MonitoringInfoSpecs(object):
[docs] class Enum(object): USER_SUM_INT64 = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:user:sum_int64:v1', type=u'beam:metrics:sum_int64:v1', required_labels=[u'PTRANSFORM', u'NAMESPACE', u'NAME'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'URN utilized to report user metric.')]), EMPTY_MONITORING_INFO_LABEL_PROPS) USER_SUM_DOUBLE = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:user:sum_double:v1', type=u'beam:metrics:sum_double:v1', required_labels=[u'PTRANSFORM', u'NAMESPACE', u'NAME'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'URN utilized to report user metric.')]), EMPTY_MONITORING_INFO_LABEL_PROPS) USER_DISTRIBUTION_INT64 = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:user:distribution_int64:v1', type=u'beam:metrics:distribution_int64:v1', required_labels=[u'PTRANSFORM', u'NAMESPACE', u'NAME'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'URN utilized to report user metric.')]), EMPTY_MONITORING_INFO_LABEL_PROPS) USER_DISTRIBUTION_DOUBLE = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:user:distribution_double:v1', type=u'beam:metrics:distribution_double:v1', required_labels=[u'PTRANSFORM', u'NAMESPACE', u'NAME'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'URN utilized to report user metric.')]), EMPTY_MONITORING_INFO_LABEL_PROPS) USER_LATEST_INT64 = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:user:latest_int64:v1', type=u'beam:metrics:latest_int64:v1', required_labels=[u'PTRANSFORM', u'NAMESPACE', u'NAME'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'URN utilized to report user metric.')]), EMPTY_MONITORING_INFO_LABEL_PROPS) USER_LATEST_DOUBLE = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:user:latest_double:v1', type=u'beam:metrics:latest_double:v1', required_labels=[u'PTRANSFORM', u'NAMESPACE', u'NAME'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'URN utilized to report user metric.')]), EMPTY_MONITORING_INFO_LABEL_PROPS) USER_TOP_N_INT64 = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:user:top_n_int64:v1', type=u'beam:metrics:top_n_int64:v1', required_labels=[u'PTRANSFORM', u'NAMESPACE', u'NAME'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'URN utilized to report user metric.')]), EMPTY_MONITORING_INFO_LABEL_PROPS) USER_TOP_N_DOUBLE = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:user:top_n_double:v1', type=u'beam:metrics:top_n_double:v1', required_labels=[u'PTRANSFORM', u'NAMESPACE', u'NAME'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'URN utilized to report user metric.')]), EMPTY_MONITORING_INFO_LABEL_PROPS) USER_BOTTOM_N_INT64 = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:user:bottom_n_int64:v1', type=u'beam:metrics:bottom_n_int64:v1', required_labels=[u'PTRANSFORM', u'NAMESPACE', u'NAME'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'URN utilized to report user metric.')]), EMPTY_MONITORING_INFO_LABEL_PROPS) USER_BOTTOM_N_DOUBLE = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:user:bottom_n_double:v1', type=u'beam:metrics:bottom_n_double:v1', required_labels=[u'PTRANSFORM', u'NAMESPACE', u'NAME'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'URN utilized to report user metric.')]), EMPTY_MONITORING_INFO_LABEL_PROPS) ELEMENT_COUNT = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:element_count:v1', type=u'beam:metrics:sum_int64:v1', required_labels=[u'PCOLLECTION'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'The total elements output to a Pcollection by a PTransform.')]), EMPTY_MONITORING_INFO_LABEL_PROPS) SAMPLED_BYTE_SIZE = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:sampled_byte_size:v1', type=u'beam:metrics:distribution_int64:v1', required_labels=[u'PCOLLECTION'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'The total byte size and count of a sampled set (or all) of elements in the pcollection. Sampling is used because calculating the byte count involves serializing the elements which is CPU intensive.')]), EMPTY_MONITORING_INFO_LABEL_PROPS) START_BUNDLE_MSECS = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:pardo_execution_time:start_bundle_msecs:v1', type=u'beam:metrics:sum_int64:v1', required_labels=[u'PTRANSFORM'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'The total estimated execution time of the start bundlefunction in a pardo')]), EMPTY_MONITORING_INFO_LABEL_PROPS) PROCESS_BUNDLE_MSECS = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:pardo_execution_time:process_bundle_msecs:v1', type=u'beam:metrics:sum_int64:v1', required_labels=[u'PTRANSFORM'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'The total estimated execution time of the process bundlefunction in a pardo')]), EMPTY_MONITORING_INFO_LABEL_PROPS) FINISH_BUNDLE_MSECS = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:pardo_execution_time:finish_bundle_msecs:v1', type=u'beam:metrics:sum_int64:v1', required_labels=[u'PTRANSFORM'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'The total estimated execution time of the finish bundle function in a pardo')]), EMPTY_MONITORING_INFO_LABEL_PROPS) TOTAL_MSECS = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:ptransform_execution_time:total_msecs:v1', type=u'beam:metrics:sum_int64:v1', required_labels=[u'PTRANSFORM'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'The total estimated execution time of the ptransform')]), EMPTY_MONITORING_INFO_LABEL_PROPS) WORK_REMAINING = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:ptransform_progress:remaining:v1', type=u'beam:metrics:progress:v1', required_labels=[u'PTRANSFORM'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'The remaining amount of work for each active element. Each active element represents an independent amount of work not shared with any other active element.')]), EMPTY_MONITORING_INFO_LABEL_PROPS) WORK_COMPLETED = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:ptransform_progress:completed:v1', type=u'beam:metrics:progress:v1', required_labels=[u'PTRANSFORM'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'The remaining amount of work for each active element. Each active element represents an independent amount of work not shared with any other active element.')]), EMPTY_MONITORING_INFO_LABEL_PROPS) DATA_CHANNEL_READ_INDEX = PropertiesFromEnumValue(u'', u'', metrics_pb2.MonitoringInfoSpec(urn=u'beam:metric:data_channel:read_index:v1', type=u'beam:metrics:sum_int64:v1', required_labels=[u'PTRANSFORM'], annotations=[metrics_pb2.Annotation(key=u'description', value=u'The read index of the data channel.')]), EMPTY_MONITORING_INFO_LABEL_PROPS)
[docs]class MonitoringInfoTypeUrns(object):
[docs] class Enum(object): SUM_INT64_TYPE = PropertiesFromEnumValue(u'beam:metrics:sum_int64:v1', u'', EMPTY_MONITORING_INFO_SPEC, EMPTY_MONITORING_INFO_LABEL_PROPS) SUM_DOUBLE_TYPE = PropertiesFromEnumValue(u'beam:metrics:sum_double:v1', u'', EMPTY_MONITORING_INFO_SPEC, EMPTY_MONITORING_INFO_LABEL_PROPS) DISTRIBUTION_INT64_TYPE = PropertiesFromEnumValue(u'beam:metrics:distribution_int64:v1', u'', EMPTY_MONITORING_INFO_SPEC, EMPTY_MONITORING_INFO_LABEL_PROPS) DISTRIBUTION_DOUBLE_TYPE = PropertiesFromEnumValue(u'beam:metrics:distribution_double:v1', u'', EMPTY_MONITORING_INFO_SPEC, EMPTY_MONITORING_INFO_LABEL_PROPS) LATEST_INT64_TYPE = PropertiesFromEnumValue(u'beam:metrics:latest_int64:v1', u'', EMPTY_MONITORING_INFO_SPEC, EMPTY_MONITORING_INFO_LABEL_PROPS) LATEST_DOUBLE_TYPE = PropertiesFromEnumValue(u'beam:metrics:latest_double:v1', u'', EMPTY_MONITORING_INFO_SPEC, EMPTY_MONITORING_INFO_LABEL_PROPS) TOP_N_INT64_TYPE = PropertiesFromEnumValue(u'beam:metrics:top_n_int64:v1', u'', EMPTY_MONITORING_INFO_SPEC, EMPTY_MONITORING_INFO_LABEL_PROPS) TOP_N_DOUBLE_TYPE = PropertiesFromEnumValue(u'beam:metrics:top_n_double:v1', u'', EMPTY_MONITORING_INFO_SPEC, EMPTY_MONITORING_INFO_LABEL_PROPS) BOTTOM_N_INT64_TYPE = PropertiesFromEnumValue(u'beam:metrics:bottom_n_int64:v1', u'', EMPTY_MONITORING_INFO_SPEC, EMPTY_MONITORING_INFO_LABEL_PROPS) BOTTOM_N_DOUBLE_TYPE = PropertiesFromEnumValue(u'beam:metrics:bottom_n_double:v1', u'', EMPTY_MONITORING_INFO_SPEC, EMPTY_MONITORING_INFO_LABEL_PROPS) PROGRESS_TYPE = PropertiesFromEnumValue(u'beam:metrics:progress:v1', u'', EMPTY_MONITORING_INFO_SPEC, EMPTY_MONITORING_INFO_LABEL_PROPS)