Google Git
Sign in
apache / beam-site / aa4899384bfb3460196adf6331c744cb480b96df / . / pydoc / 2.38.0 / _modules / apache_beam / internal / metrics / metric.html
blob: 9b692685221909dc8c3b5daff9815296f02ff2dc [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>apache_beam.internal.metrics.metric &mdash; Apache Beam 2.38.0 documentation</title>
<script type="text/javascript" src="../../../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../../_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="../../../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../../index.html" class="icon icon-home"> Apache Beam
</a>
<div class="version">
2.38.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.coders.html">apache_beam.coders package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.dataframe.html">apache_beam.dataframe package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.io.html">apache_beam.io package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.metrics.html">apache_beam.metrics package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.ml.html">apache_beam.ml package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.options.html">apache_beam.options package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.portability.html">apache_beam.portability package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.runners.html">apache_beam.runners package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.transforms.html">apache_beam.transforms package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.typehints.html">apache_beam.typehints package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.utils.html">apache_beam.utils package</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.error.html">apache_beam.error module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../index.html">Apache Beam</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../index.html">Docs</a> &raquo;</li>
<li><a href="../../../index.html">Module code</a> &raquo;</li>
<li>apache_beam.internal.metrics.metric</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for apache_beam.internal.metrics.metric</h1><div class="highlight"><pre>
<span></span><span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
<span class="c1"># contributor license agreements. See the NOTICE file distributed with</span>
<span class="c1"># this work for additional information regarding copyright ownership.</span>
<span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
<span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
<span class="c1"># the License. You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>
<span class="c1">#</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Metrics API classes for internal use only.</span>
<span class="sd">Users should use apache_beam.metrics.metric package instead.</span>
<span class="sd">For internal use only. No backwards compatibility guarantees.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="c1"># pytype: skip-file</span>
<span class="c1"># mypy: disallow-untyped-defs</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">threading</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Type</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Union</span>
<span class="kn">from</span> <span class="nn">apache_beam.internal.metrics.cells</span> <span class="kn">import</span> <span class="n">HistogramCellFactory</span>
<span class="kn">from</span> <span class="nn">apache_beam.metrics</span> <span class="kn">import</span> <span class="n">monitoring_infos</span>
<span class="kn">from</span> <span class="nn">apache_beam.metrics.execution</span> <span class="kn">import</span> <span class="n">MetricUpdater</span>
<span class="kn">from</span> <span class="nn">apache_beam.metrics.metric</span> <span class="kn">import</span> <span class="n">Metrics</span> <span class="k">as</span> <span class="n">UserMetrics</span>
<span class="kn">from</span> <span class="nn">apache_beam.metrics.metricbase</span> <span class="kn">import</span> <span class="n">Histogram</span>
<span class="kn">from</span> <span class="nn">apache_beam.metrics.metricbase</span> <span class="kn">import</span> <span class="n">MetricName</span>
<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">apache_beam.metrics.cells</span> <span class="kn">import</span> <span class="n">MetricCell</span>
<span class="kn">from</span> <span class="nn">apache_beam.metrics.cells</span> <span class="kn">import</span> <span class="n">MetricCellFactory</span>
<span class="kn">from</span> <span class="nn">apache_beam.utils.histogram</span> <span class="kn">import</span> <span class="n">BucketType</span>
<span class="c1"># Protect against environments where bigquery library is not available.</span>
<span class="c1"># pylint: disable=wrong-import-order, wrong-import-position</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">apitools.base.py.exceptions</span> <span class="kn">import</span> <span class="n">HttpError</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;Metrics&#39;</span><span class="p">]</span>
<span class="n">_LOGGER</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">Metrics</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">counter</span><span class="p">(</span><span class="n">urn</span><span class="p">,</span> <span class="n">labels</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">process_wide</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="c1"># type: (str, Optional[Dict[str, str]], bool) -&gt; UserMetrics.DelegatingCounter</span>
<span class="sd">&quot;&quot;&quot;Obtains or creates a Counter metric.</span>
<span class="sd"> Args:</span>
<span class="sd"> namespace: A class or string that gives the namespace to a metric</span>
<span class="sd"> name: A string that gives a unique name to a metric</span>
<span class="sd"> urn: URN to populate on a MonitoringInfo, when sending to RunnerHarness.</span>
<span class="sd"> labels: Labels to populate on a MonitoringInfo</span>
<span class="sd"> process_wide: Whether or not the metric is specific to the current bundle</span>
<span class="sd"> or should be calculated for the entire process.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A Counter object.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">UserMetrics</span><span class="o">.</span><span class="n">DelegatingCounter</span><span class="p">(</span>
<span class="n">MetricName</span><span class="p">(</span><span class="n">namespace</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">urn</span><span class="o">=</span><span class="n">urn</span><span class="p">,</span> <span class="n">labels</span><span class="o">=</span><span class="n">labels</span><span class="p">),</span>
<span class="n">process_wide</span><span class="o">=</span><span class="n">process_wide</span><span class="p">)</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">histogram</span><span class="p">(</span><span class="n">namespace</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">bucket_type</span><span class="p">,</span> <span class="n">logger</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="c1"># type: (Union[Type, str], str, BucketType, Optional[MetricLogger]) -&gt; Metrics.DelegatingHistogram</span>
<span class="sd">&quot;&quot;&quot;Obtains or creates a Histogram metric.</span>
<span class="sd"> Args:</span>
<span class="sd"> namespace: A class or string that gives the namespace to a metric</span>
<span class="sd"> name: A string that gives a unique name to a metric</span>
<span class="sd"> bucket_type: A type of bucket used in a histogram. A subclass of</span>
<span class="sd"> apache_beam.utils.histogram.BucketType</span>
<span class="sd"> logger: MetricLogger for logging locally aggregated metric</span>
<span class="sd"> Returns:</span>
<span class="sd"> A Histogram object.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">namespace</span> <span class="o">=</span> <span class="n">UserMetrics</span><span class="o">.</span><span class="n">get_namespace</span><span class="p">(</span><span class="n">namespace</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">DelegatingHistogram</span><span class="p">(</span>
<span class="n">MetricName</span><span class="p">(</span><span class="n">namespace</span><span class="p">,</span> <span class="n">name</span><span class="p">),</span> <span class="n">bucket_type</span><span class="p">,</span> <span class="n">logger</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">DelegatingHistogram</span><span class="p">(</span><span class="n">Histogram</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Metrics Histogram that Delegates functionality to MetricsEnvironment.&quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">metric_name</span><span class="p">,</span> <span class="n">bucket_type</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
<span class="c1"># type: (MetricName, BucketType, Optional[MetricLogger]) -&gt; None</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">metric_name</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metric_name</span> <span class="o">=</span> <span class="n">metric_name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cell_type</span> <span class="o">=</span> <span class="n">HistogramCellFactory</span><span class="p">(</span><span class="n">bucket_type</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span> <span class="o">=</span> <span class="n">logger</span>
<span class="bp">self</span><span class="o">.</span><span class="n">updater</span> <span class="o">=</span> <span class="n">MetricUpdater</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cell_type</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">metric_name</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="c1"># type: (object) -&gt; None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">updater</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cell_type</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">metric_name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">MetricLogger</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Simple object to locally aggregate and log metrics.</span>
<span class="sd"> This class is experimental. No backwards-compatibility guarantees.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_metric</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># type: Dict[MetricName, MetricCell]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_lock</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Lock</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_last_logging_millis</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">*</span> <span class="mi">1000</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">minimum_logging_frequency_msec</span> <span class="o">=</span> <span class="mi">180000</span>
<span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cell_type</span><span class="p">,</span> <span class="n">metric_name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="c1"># type: (Union[Type[MetricCell], MetricCellFactory], MetricName, object) -&gt; None</span>
<span class="n">cell</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_metric_cell</span><span class="p">(</span><span class="n">cell_type</span><span class="p">,</span> <span class="n">metric_name</span><span class="p">)</span>
<span class="n">cell</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_get_metric_cell</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cell_type</span><span class="p">,</span> <span class="n">metric_name</span><span class="p">):</span>
<span class="c1"># type: (Union[Type[MetricCell], MetricCellFactory], MetricName) -&gt; MetricCell</span>
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
<span class="k">if</span> <span class="n">metric_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_metric</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_metric</span><span class="p">[</span><span class="n">metric_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">cell_type</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_metric</span><span class="p">[</span><span class="n">metric_name</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">log_metrics</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">reset_after_logging</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="c1"># type: (bool) -&gt; None</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="o">.</span><span class="n">acquire</span><span class="p">(</span><span class="kc">False</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">current_millis</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">*</span> <span class="mi">1000</span><span class="p">)</span>
<span class="k">if</span> <span class="p">((</span><span class="n">current_millis</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_logging_millis</span><span class="p">)</span> <span class="o">&gt;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">minimum_logging_frequency_msec</span><span class="p">):</span>
<span class="n">logging_metric_info</span> <span class="o">=</span> <span class="p">[</span>
<span class="s1">&#39;[Locally aggregated metrics since </span><span class="si">%s</span><span class="s1">]&#39;</span> <span class="o">%</span>
<span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_last_logging_millis</span> <span class="o">/</span> <span class="mf">1000.0</span><span class="p">)</span>
<span class="p">]</span>
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">cell</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_metric</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">logging_metric_info</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">%s</span><span class="s1">: </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">cell</span><span class="o">.</span><span class="n">get_cumulative</span><span class="p">()))</span>
<span class="n">_LOGGER</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">logging_metric_info</span><span class="p">))</span>
<span class="k">if</span> <span class="n">reset_after_logging</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_metric</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_last_logging_millis</span> <span class="o">=</span> <span class="n">current_millis</span>
<span class="k">finally</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="o">.</span><span class="n">release</span><span class="p">()</span>
<span class="k">class</span> <span class="nc">ServiceCallMetric</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Metric class which records Service API call metrics.</span>
<span class="sd"> This class will capture a request count metric for the specified</span>
<span class="sd"> request_count_urn and base_labels.</span>
<span class="sd"> When call() is invoked the status must be provided, which will</span>
<span class="sd"> be converted to a canonical GCP status code, if possible.</span>
<span class="sd"> TODO(ajamato): Add Request latency metric.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request_count_urn</span><span class="p">,</span> <span class="n">base_labels</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="c1"># type: (str, Optional[Dict[str, str]]) -&gt; None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">base_labels</span> <span class="o">=</span> <span class="n">base_labels</span> <span class="k">if</span> <span class="n">base_labels</span> <span class="k">else</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">request_count_urn</span> <span class="o">=</span> <span class="n">request_count_urn</span>
<span class="k">def</span> <span class="nf">call</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">status</span><span class="p">):</span>
<span class="c1"># type: (Union[int, str, HttpError]) -&gt; None</span>
<span class="sd">&quot;&quot;&quot;Record the status of the call into appropriate metrics.&quot;&quot;&quot;</span>
<span class="n">canonical_status</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">convert_to_canonical_status_string</span><span class="p">(</span><span class="n">status</span><span class="p">)</span>
<span class="n">additional_labels</span> <span class="o">=</span> <span class="p">{</span><span class="n">monitoring_infos</span><span class="o">.</span><span class="n">STATUS_LABEL</span><span class="p">:</span> <span class="n">canonical_status</span><span class="p">}</span>
<span class="n">labels</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
<span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">base_labels</span><span class="o">.</span><span class="n">items</span><span class="p">())</span> <span class="o">+</span> <span class="nb">list</span><span class="p">(</span><span class="n">additional_labels</span><span class="o">.</span><span class="n">items</span><span class="p">()))</span>
<span class="n">request_counter</span> <span class="o">=</span> <span class="n">Metrics</span><span class="o">.</span><span class="n">counter</span><span class="p">(</span>
<span class="n">urn</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">request_count_urn</span><span class="p">,</span> <span class="n">labels</span><span class="o">=</span><span class="n">labels</span><span class="p">,</span> <span class="n">process_wide</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">request_counter</span><span class="o">.</span><span class="n">inc</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">convert_to_canonical_status_string</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">status</span><span class="p">):</span>
<span class="c1"># type: (Union[int, str, HttpError]) -&gt; str</span>
<span class="sd">&quot;&quot;&quot;Converts a status to a canonical GCP status cdoe string.&quot;&quot;&quot;</span>
<span class="n">http_status_code</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">status</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span>
<span class="n">http_status_code</span> <span class="o">=</span> <span class="n">status</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">status</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">return</span> <span class="n">status</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">status</span><span class="p">,</span> <span class="n">HttpError</span><span class="p">):</span>
<span class="n">http_status_code</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">status</span><span class="o">.</span><span class="n">status_code</span><span class="p">)</span>
<span class="n">http_to_canonical_gcp_status</span> <span class="o">=</span> <span class="p">{</span>
<span class="mi">200</span><span class="p">:</span> <span class="s1">&#39;ok&#39;</span><span class="p">,</span>
<span class="mi">400</span><span class="p">:</span> <span class="s1">&#39;out_of_range&#39;</span><span class="p">,</span>
<span class="mi">401</span><span class="p">:</span> <span class="s1">&#39;unauthenticated&#39;</span><span class="p">,</span>
<span class="mi">403</span><span class="p">:</span> <span class="s1">&#39;permission_denied&#39;</span><span class="p">,</span>
<span class="mi">404</span><span class="p">:</span> <span class="s1">&#39;not_found&#39;</span><span class="p">,</span>
<span class="mi">409</span><span class="p">:</span> <span class="s1">&#39;already_exists&#39;</span><span class="p">,</span>
<span class="mi">429</span><span class="p">:</span> <span class="s1">&#39;resource_exhausted&#39;</span><span class="p">,</span>
<span class="mi">499</span><span class="p">:</span> <span class="s1">&#39;cancelled&#39;</span><span class="p">,</span>
<span class="mi">500</span><span class="p">:</span> <span class="s1">&#39;internal&#39;</span><span class="p">,</span>
<span class="mi">501</span><span class="p">:</span> <span class="s1">&#39;not_implemented&#39;</span><span class="p">,</span>
<span class="mi">503</span><span class="p">:</span> <span class="s1">&#39;unavailable&#39;</span><span class="p">,</span>
<span class="mi">504</span><span class="p">:</span> <span class="s1">&#39;deadline_exceeded&#39;</span>
<span class="p">}</span>
<span class="k">if</span> <span class="p">(</span><span class="n">http_status_code</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span>
<span class="n">http_status_code</span> <span class="ow">in</span> <span class="n">http_to_canonical_gcp_status</span><span class="p">):</span>
<span class="k">return</span> <span class="n">http_to_canonical_gcp_status</span><span class="p">[</span><span class="n">http_status_code</span><span class="p">]</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">http_status_code</span><span class="p">)</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">bigtable_error_code_to_grpc_status_string</span><span class="p">(</span><span class="n">grpc_status_code</span><span class="p">):</span>
<span class="c1"># type: (Optional[int]) -&gt; str</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Converts the bigtable error code to a canonical GCP status code string.</span>
<span class="sd"> This Bigtable client library is not using the canonical http status code</span>
<span class="sd"> values (i.e. https://cloud.google.com/apis/design/errors)&quot;</span>
<span class="sd"> Instead they are numbered using an enum with these values corresponding</span>
<span class="sd"> to each status code: https://cloud.google.com/bigtable/docs/status-codes</span>
<span class="sd"> Args:</span>
<span class="sd"> grpc_status_code: An int that corresponds to an enum of status codes</span>
<span class="sd"> Returns:</span>
<span class="sd"> A GCP status code string</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">grpc_to_canonical_gcp_status</span> <span class="o">=</span> <span class="p">{</span>
<span class="mi">0</span><span class="p">:</span> <span class="s1">&#39;ok&#39;</span><span class="p">,</span>
<span class="mi">1</span><span class="p">:</span> <span class="s1">&#39;cancelled&#39;</span><span class="p">,</span>
<span class="mi">2</span><span class="p">:</span> <span class="s1">&#39;unknown&#39;</span><span class="p">,</span>
<span class="mi">3</span><span class="p">:</span> <span class="s1">&#39;invalid_argument&#39;</span><span class="p">,</span>
<span class="mi">4</span><span class="p">:</span> <span class="s1">&#39;deadline_exceeded&#39;</span><span class="p">,</span>
<span class="mi">5</span><span class="p">:</span> <span class="s1">&#39;not_found&#39;</span><span class="p">,</span>
<span class="mi">6</span><span class="p">:</span> <span class="s1">&#39;already_exists&#39;</span><span class="p">,</span>
<span class="mi">7</span><span class="p">:</span> <span class="s1">&#39;permission_denied&#39;</span><span class="p">,</span>
<span class="mi">8</span><span class="p">:</span> <span class="s1">&#39;resource_exhausted&#39;</span><span class="p">,</span>
<span class="mi">9</span><span class="p">:</span> <span class="s1">&#39;failed_precondition&#39;</span><span class="p">,</span>
<span class="mi">10</span><span class="p">:</span> <span class="s1">&#39;aborted&#39;</span><span class="p">,</span>
<span class="mi">11</span><span class="p">:</span> <span class="s1">&#39;out_of_range&#39;</span><span class="p">,</span>
<span class="mi">12</span><span class="p">:</span> <span class="s1">&#39;unimplemented&#39;</span><span class="p">,</span>
<span class="mi">13</span><span class="p">:</span> <span class="s1">&#39;internal&#39;</span><span class="p">,</span>
<span class="mi">14</span><span class="p">:</span> <span class="s1">&#39;unavailable&#39;</span>
<span class="p">}</span>
<span class="k">if</span> <span class="n">grpc_status_code</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># Bigtable indicates this can be retried but itself has exhausted retry</span>
<span class="c1"># timeout or there is no retry policy set for bigtable.</span>
<span class="k">return</span> <span class="n">grpc_to_canonical_gcp_status</span><span class="p">[</span><span class="mi">4</span><span class="p">]</span>
<span class="k">return</span> <span class="n">grpc_to_canonical_gcp_status</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
<span class="n">grpc_status_code</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">grpc_status_code</span><span class="p">))</span>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>