apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns module
- class apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo[source]
Bases:
object
- class MonitoringInfoLabels[source]
Bases:
object
- TRANSFORM = ('', '', , name: "PTRANSFORM" )
- PCOLLECTION = ('', '', , name: "PCOLLECTION" )
- WINDOWING_STRATEGY = ('', '', , name: "WINDOWING_STRATEGY" )
- CODER = ('', '', , name: "CODER" )
- ENVIRONMENT = ('', '', , name: "ENVIRONMENT" )
- NAMESPACE = ('', '', , name: "NAMESPACE" )
- NAME = ('', '', , name: "NAME" )
- SERVICE = ('', '', , name: "SERVICE" )
- METHOD = ('', '', , name: "METHOD" )
- RESOURCE = ('', '', , name: "RESOURCE" )
- STATUS = ('', '', , name: "STATUS" )
- BIGQUERY_PROJECT_ID = ('', '', , name: "BIGQUERY_PROJECT_ID" )
- BIGQUERY_DATASET = ('', '', , name: "BIGQUERY_DATASET" )
- BIGQUERY_TABLE = ('', '', , name: "BIGQUERY_TABLE" )
- BIGQUERY_VIEW = ('', '', , name: "BIGQUERY_VIEW" )
- BIGQUERY_QUERY_NAME = ('', '', , name: "BIGQUERY_QUERY_NAME" )
- GCS_BUCKET = ('', '', , name: "GCS_BUCKET" )
- GCS_PROJECT_ID = ('', '', , name: "GCS_PROJECT_ID" )
- DATASTORE_PROJECT = ('', '', , name: "DATASTORE_PROJECT" )
- DATASTORE_NAMESPACE = ('', '', , name: "DATASTORE_NAMESPACE" )
- BIGTABLE_PROJECT_ID = ('', '', , name: "BIGTABLE_PROJECT_ID" )
- INSTANCE_ID = ('', '', , name: "INSTANCE_ID" )
- TABLE_ID = ('', '', , name: "TABLE_ID" )
- SPANNER_PROJECT_ID = ('', '', , name: "SPANNER_PROJECT_ID" )
- SPANNER_DATABASE_ID = ('', '', , name: "SPANNER_DATABASE_ID" )
- SPANNER_TABLE_ID = ('', '', , name: "SPANNER_TABLE_ID" )
- SPANNER_INSTANCE_ID = ('', '', , name: "SPANNER_INSTANCE_ID" )
- SPANNER_QUERY_NAME = ('', '', , name: "SPANNER_QUERY_NAME" )
- class apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs[source]
Bases:
object
- class Enum[source]
Bases:
object
- USER_SUM_INT64 = ('', '', urn: "beam:metric:user:sum_int64:v1" type: "beam:metrics:sum_int64:v1" required_labels: "PTRANSFORM" required_labels: "NAMESPACE" required_labels: "NAME" annotations { key: "description" value: "URN utilized to report user metric." } , )
- USER_SUM_DOUBLE = ('', '', urn: "beam:metric:user:sum_double:v1" type: "beam:metrics:sum_double:v1" required_labels: "PTRANSFORM" required_labels: "NAMESPACE" required_labels: "NAME" annotations { key: "description" value: "URN utilized to report user metric." } , )
- USER_DISTRIBUTION_INT64 = ('', '', urn: "beam:metric:user:distribution_int64:v1" type: "beam:metrics:distribution_int64:v1" required_labels: "PTRANSFORM" required_labels: "NAMESPACE" required_labels: "NAME" annotations { key: "description" value: "URN utilized to report user metric." } , )
- USER_DISTRIBUTION_DOUBLE = ('', '', urn: "beam:metric:user:distribution_double:v1" type: "beam:metrics:distribution_double:v1" required_labels: "PTRANSFORM" required_labels: "NAMESPACE" required_labels: "NAME" annotations { key: "description" value: "URN utilized to report user metric." } , )
- USER_LATEST_INT64 = ('', '', urn: "beam:metric:user:latest_int64:v1" type: "beam:metrics:latest_int64:v1" required_labels: "PTRANSFORM" required_labels: "NAMESPACE" required_labels: "NAME" annotations { key: "description" value: "URN utilized to report user metric." } , )
- USER_LATEST_DOUBLE = ('', '', urn: "beam:metric:user:latest_double:v1" type: "beam:metrics:latest_double:v1" required_labels: "PTRANSFORM" required_labels: "NAMESPACE" required_labels: "NAME" annotations { key: "description" value: "URN utilized to report user metric." } , )
- USER_TOP_N_INT64 = ('', '', urn: "beam:metric:user:top_n_int64:v1" type: "beam:metrics:top_n_int64:v1" required_labels: "PTRANSFORM" required_labels: "NAMESPACE" required_labels: "NAME" annotations { key: "description" value: "URN utilized to report user metric." } , )
- USER_TOP_N_DOUBLE = ('', '', urn: "beam:metric:user:top_n_double:v1" type: "beam:metrics:top_n_double:v1" required_labels: "PTRANSFORM" required_labels: "NAMESPACE" required_labels: "NAME" annotations { key: "description" value: "URN utilized to report user metric." } , )
- USER_BOTTOM_N_INT64 = ('', '', urn: "beam:metric:user:bottom_n_int64:v1" type: "beam:metrics:bottom_n_int64:v1" required_labels: "PTRANSFORM" required_labels: "NAMESPACE" required_labels: "NAME" annotations { key: "description" value: "URN utilized to report user metric." } , )
- USER_BOTTOM_N_DOUBLE = ('', '', urn: "beam:metric:user:bottom_n_double:v1" type: "beam:metrics:bottom_n_double:v1" required_labels: "PTRANSFORM" required_labels: "NAMESPACE" required_labels: "NAME" annotations { key: "description" value: "URN utilized to report user metric." } , )
- USER_SET_STRING = ('', '', urn: "beam:metric:user:set_string:v1" type: "beam:metrics:set_string:v1" required_labels: "PTRANSFORM" required_labels: "NAMESPACE" required_labels: "NAME" annotations { key: "description" value: "URN utilized to report user metric." } , )
- ELEMENT_COUNT = ('', '', urn: "beam:metric:element_count:v1" type: "beam:metrics:sum_int64:v1" required_labels: "PCOLLECTION" annotations { key: "description" value: "The total elements output to a Pcollection by a PTransform." } , )
- SAMPLED_BYTE_SIZE = ('', '', urn: "beam:metric:sampled_byte_size:v1" type: "beam:metrics:distribution_int64:v1" required_labels: "PCOLLECTION" annotations { key: "description" value: "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." } , )
- START_BUNDLE_MSECS = ('', '', urn: "beam:metric:pardo_execution_time:start_bundle_msecs:v1" type: "beam:metrics:sum_int64:v1" required_labels: "PTRANSFORM" annotations { key: "description" value: "The total estimated execution time of the start bundlefunction in a pardo" } , )
- PROCESS_BUNDLE_MSECS = ('', '', urn: "beam:metric:pardo_execution_time:process_bundle_msecs:v1" type: "beam:metrics:sum_int64:v1" required_labels: "PTRANSFORM" annotations { key: "description" value: "The total estimated execution time of the process bundlefunction in a pardo" } , )
- FINISH_BUNDLE_MSECS = ('', '', urn: "beam:metric:pardo_execution_time:finish_bundle_msecs:v1" type: "beam:metrics:sum_int64:v1" required_labels: "PTRANSFORM" annotations { key: "description" value: "The total estimated execution time of the finish bundle function in a pardo" } , )
- TOTAL_MSECS = ('', '', urn: "beam:metric:ptransform_execution_time:total_msecs:v1" type: "beam:metrics:sum_int64:v1" required_labels: "PTRANSFORM" annotations { key: "description" value: "The total estimated execution time of the ptransform" } , )
- WORK_REMAINING = ('', '', urn: "beam:metric:ptransform_progress:remaining:v1" type: "beam:metrics:progress:v1" required_labels: "PTRANSFORM" annotations { key: "description" value: "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." } , )
- WORK_COMPLETED = ('', '', urn: "beam:metric:ptransform_progress:completed:v1" type: "beam:metrics:progress:v1" required_labels: "PTRANSFORM" annotations { key: "description" value: "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." } , )
- DATA_CHANNEL_READ_INDEX = ('', '', urn: "beam:metric:data_channel:read_index:v1" type: "beam:metrics:sum_int64:v1" required_labels: "PTRANSFORM" annotations { key: "description" value: "The read index of the data channel." } , )
- API_REQUEST_COUNT = ('', '', urn: "beam:metric:io:api_request_count:v1" type: "beam:metrics:sum_int64:v1" required_labels: "SERVICE" required_labels: "METHOD" required_labels: "RESOURCE" required_labels: "PTRANSFORM" required_labels: "STATUS" annotations { key: "description" value: "Request counts with status made to IO service APIs to batch read or write elements." } annotations { key: "process_metric" value: "true" } , )
- API_REQUEST_LATENCIES = ('', '', urn: "beam:metric:io:api_request_latencies:v1" type: "beam:metrics:histogram_int64:v1" required_labels: "SERVICE" required_labels: "METHOD" required_labels: "RESOURCE" required_labels: "PTRANSFORM" annotations { key: "description" value: "Histogram counts for request latencies made to IO service APIs to batch read or write elements." } annotations { key: "units" value: "Milliseconds" } annotations { key: "process_metric" value: "true" } , )
- class apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns[source]
Bases:
object
- class Enum[source]
Bases:
object
- SUM_INT64_TYPE = ('beam:metrics:sum_int64:v1', '', , )
- SUM_DOUBLE_TYPE = ('beam:metrics:sum_double:v1', '', , )
- DISTRIBUTION_INT64_TYPE = ('beam:metrics:distribution_int64:v1', '', , )
- DISTRIBUTION_DOUBLE_TYPE = ('beam:metrics:distribution_double:v1', '', , )
- LATEST_INT64_TYPE = ('beam:metrics:latest_int64:v1', '', , )
- LATEST_DOUBLE_TYPE = ('beam:metrics:latest_double:v1', '', , )
- TOP_N_INT64_TYPE = ('beam:metrics:top_n_int64:v1', '', , )
- TOP_N_DOUBLE_TYPE = ('beam:metrics:top_n_double:v1', '', , )
- BOTTOM_N_INT64_TYPE = ('beam:metrics:bottom_n_int64:v1', '', , )
- BOTTOM_N_DOUBLE_TYPE = ('beam:metrics:bottom_n_double:v1', '', , )
- PROGRESS_TYPE = ('beam:metrics:progress:v1', '', , )
- SET_STRING_TYPE = ('beam:metrics:set_string:v1', '', , )