clevermicro/amq-adapter-python
14
0
Fork 0
Code Issues 16 Pull Requests 4 Actions Packages Projects Releases Wiki Activity
Files
aa4492d443d5b41e059f1e651ee22ec9bcf0bb70
amq-adapter-python/api-doc/_build/html/_modules/amqp/service/tracing.html
T
Stanislav Hejny aa4492d443
Unit test coverage / pytest (push) Failing after 1m54s
Details
/ build-and-push (push) Successful in 1m50s
Details
Unit test coverage / pytest (pull_request) Failing after 1m27s
Details
Create API documentation
2025-08-14 09:29:57 +01:00

328 lines
29 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>amqp.service.tracing &mdash; AMQ Adapter Python 1.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=f2a433a1"></script>
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/js/theme.js"></script>
<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">
AMQ Adapter Python
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="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="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../modules/amqp.html">AMQP Package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../modules/amqp.config.html">Configuration Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../modules/amqp.adapter.html">Adapter Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../modules/amqp.service.html">Service Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../modules/amqp.router.html">Router Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../modules/amqp.model.html">Model Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../modules/amqp.rabbitmq.html">RabbitMQ 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="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">AMQ Adapter Python</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
<li class="breadcrumb-item active">amqp.service.tracing</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 amqp.service.tracing</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">OpenTelemetry configuration for tracing and metrics.</span>
<span class="sd">This module provides functionality to initialize and configure OpenTelemetry</span>
<span class="sd">for both tracing (Jaeger via OTLP) and metrics (Prometheus) in the AMQ adapter.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">logging</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">dataclasses</span><span class="w"> </span><span class="kn">import</span> <span class="n">dataclass</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Optional</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">opentelemetry</span><span class="w"> </span><span class="kn">import</span> <span class="n">metrics</span><span class="p">,</span> <span class="n">trace</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">opentelemetry.exporter.otlp.proto.grpc.trace_exporter</span><span class="w"> </span><span class="kn">import</span> <span class="n">OTLPSpanExporter</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">opentelemetry.exporter.prometheus</span><span class="w"> </span><span class="kn">import</span> <span class="n">PrometheusMetricReader</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">opentelemetry.sdk.metrics</span><span class="w"> </span><span class="kn">import</span> <span class="n">MeterProvider</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">opentelemetry.sdk.metrics.export</span><span class="w"> </span><span class="kn">import</span> <span class="n">PeriodicExportingMetricReader</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">opentelemetry.sdk.resources</span><span class="w"> </span><span class="kn">import</span> <span class="n">SERVICE_NAME</span><span class="p">,</span> <span class="n">SERVICE_VERSION</span><span class="p">,</span> <span class="n">Resource</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">opentelemetry.sdk.trace</span><span class="w"> </span><span class="kn">import</span> <span class="n">TracerProvider</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">opentelemetry.sdk.trace.export</span><span class="w"> </span><span class="kn">import</span> <span class="n">BatchSpanProcessor</span><span class="p">,</span> <span class="n">ConsoleSpanExporter</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">opentelemetry.trace</span><span class="w"> </span><span class="kn">import</span> <span class="n">Tracer</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">prometheus_client</span><span class="w"> </span><span class="kn">import</span> <span class="n">start_http_server</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>
<div class="viewcode-block" id="TracingConfig">
<a class="viewcode-back" href="../../../modules/amqp.service.html#amqp.service.tracing.TracingConfig">[docs]</a>
<span class="nd">@dataclass</span>
<span class="k">class</span><span class="w"> </span><span class="nc">TracingConfig</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Configuration for OpenTelemetry tracing.&quot;&quot;&quot;</span>
<span class="n">service_name</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">service_version</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">otlp_endpoint</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;http://localhost:4317&quot;</span> <span class="c1"># Default Jaeger OTLP endpoint</span>
<span class="n">insecure</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">debug</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">additional_attributes</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="MetricsConfig">
<a class="viewcode-back" href="../../../modules/amqp.service.html#amqp.service.tracing.MetricsConfig">[docs]</a>
<span class="nd">@dataclass</span>
<span class="k">class</span><span class="w"> </span><span class="nc">MetricsConfig</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Configuration for OpenTelemetry metrics.&quot;&quot;&quot;</span>
<span class="n">prometheus_port</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">9464</span>
<span class="n">prometheus_host</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;localhost&quot;</span>
<span class="n">export_interval_millis</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">30000</span>
<span class="n">additional_attributes</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="create_resource">
<a class="viewcode-back" href="../../../modules/amqp.service.html#amqp.service.tracing.create_resource">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">create_resource</span><span class="p">(</span><span class="n">config</span><span class="p">:</span> <span class="n">TracingConfig</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Resource</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create an OpenTelemetry resource with service information.&quot;&quot;&quot;</span>
<span class="n">attributes</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">SERVICE_NAME</span><span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">service_name</span><span class="p">,</span>
<span class="n">SERVICE_VERSION</span><span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">service_version</span><span class="p">,</span>
<span class="p">}</span>
<span class="k">if</span> <span class="n">config</span><span class="o">.</span><span class="n">additional_attributes</span><span class="p">:</span>
<span class="n">attributes</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">additional_attributes</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Resource</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">attributes</span><span class="p">)</span></div>
<div class="viewcode-block" id="setup_otlp_exporter">
<a class="viewcode-back" href="../../../modules/amqp.service.html#amqp.service.tracing.setup_otlp_exporter">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">setup_otlp_exporter</span><span class="p">(</span><span class="n">config</span><span class="p">:</span> <span class="n">TracingConfig</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">OTLPSpanExporter</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Configure and create an OTLP exporter for Jaeger.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">OTLPSpanExporter</span><span class="p">(</span><span class="n">endpoint</span><span class="o">=</span><span class="n">config</span><span class="o">.</span><span class="n">otlp_endpoint</span><span class="p">,</span> <span class="n">insecure</span><span class="o">=</span><span class="n">config</span><span class="o">.</span><span class="n">insecure</span><span class="p">)</span></div>
<div class="viewcode-block" id="setup_trace_provider">
<a class="viewcode-back" href="../../../modules/amqp.service.html#amqp.service.tracing.setup_trace_provider">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">setup_trace_provider</span><span class="p">(</span><span class="n">config</span><span class="p">:</span> <span class="n">TracingConfig</span><span class="p">,</span> <span class="n">resource</span><span class="p">:</span> <span class="n">Resource</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TracerProvider</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Set up the TracerProvider with OTLP exporter.&quot;&quot;&quot;</span>
<span class="n">provider</span> <span class="o">=</span> <span class="n">TracerProvider</span><span class="p">(</span><span class="n">resource</span><span class="o">=</span><span class="n">resource</span><span class="p">)</span>
<span class="c1"># Add OTLP exporter for Jaeger</span>
<span class="n">otlp_exporter</span> <span class="o">=</span> <span class="n">setup_otlp_exporter</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
<span class="n">provider</span><span class="o">.</span><span class="n">add_span_processor</span><span class="p">(</span><span class="n">BatchSpanProcessor</span><span class="p">(</span><span class="n">otlp_exporter</span><span class="p">))</span>
<span class="c1"># Add console exporter in debug mode</span>
<span class="k">if</span> <span class="n">config</span><span class="o">.</span><span class="n">debug</span><span class="p">:</span>
<span class="n">provider</span><span class="o">.</span><span class="n">add_span_processor</span><span class="p">(</span><span class="n">BatchSpanProcessor</span><span class="p">(</span><span class="n">ConsoleSpanExporter</span><span class="p">()))</span>
<span class="k">return</span> <span class="n">provider</span></div>
<div class="viewcode-block" id="setup_metrics_provider">
<a class="viewcode-back" href="../../../modules/amqp.service.html#amqp.service.tracing.setup_metrics_provider">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">setup_metrics_provider</span><span class="p">(</span><span class="n">config</span><span class="p">:</span> <span class="n">MetricsConfig</span><span class="p">,</span> <span class="n">resource</span><span class="p">:</span> <span class="n">Resource</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">MeterProvider</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Set up the MeterProvider with Prometheus export.&quot;&quot;&quot;</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># Start Prometheus HTTP server</span>
<span class="n">start_http_server</span><span class="p">(</span><span class="n">port</span><span class="o">=</span><span class="n">config</span><span class="o">.</span><span class="n">prometheus_port</span><span class="p">,</span> <span class="n">addr</span><span class="o">=</span><span class="n">config</span><span class="o">.</span><span class="n">prometheus_host</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="sa">f</span><span class="s2">&quot;Started Prometheus metrics server on </span><span class="si">{</span><span class="n">config</span><span class="o">.</span><span class="n">prometheus_host</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">config</span><span class="o">.</span><span class="n">prometheus_port</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="p">)</span>
<span class="c1"># Create Prometheus reader</span>
<span class="n">prometheus_reader</span> <span class="o">=</span> <span class="n">PrometheusMetricReader</span><span class="p">()</span>
<span class="c1"># Create periodic reader for custom metrics</span>
<span class="n">periodic_reader</span> <span class="o">=</span> <span class="n">PeriodicExportingMetricReader</span><span class="p">(</span>
<span class="n">prometheus_reader</span><span class="p">,</span> <span class="n">export_interval_millis</span><span class="o">=</span><span class="n">config</span><span class="o">.</span><span class="n">export_interval_millis</span>
<span class="p">)</span>
<span class="c1"># Create and configure meter provider</span>
<span class="k">return</span> <span class="n">MeterProvider</span><span class="p">(</span><span class="n">resource</span><span class="o">=</span><span class="n">resource</span><span class="p">,</span> <span class="n">metric_readers</span><span class="o">=</span><span class="p">[</span><span class="n">prometheus_reader</span><span class="p">,</span> <span class="n">periodic_reader</span><span class="p">])</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Failed to set up metrics provider: </span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="c1"># Return a no-op meter provider</span>
<span class="k">return</span> <span class="n">MeterProvider</span><span class="p">(</span><span class="n">resource</span><span class="o">=</span><span class="n">resource</span><span class="p">)</span></div>
<div class="viewcode-block" id="initialize_telemetry">
<a class="viewcode-back" href="../../../modules/amqp.service.html#amqp.service.tracing.initialize_telemetry">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">initialize_telemetry</span><span class="p">(</span>
<span class="n">tracing_config</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">TracingConfig</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">metrics_config</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">MetricsConfig</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tracer</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Initialize OpenTelemetry with tracing and metrics.</span>
<span class="sd"> Args:</span>
<span class="sd"> tracing_config: Configuration for tracing</span>
<span class="sd"> metrics_config: Configuration for metrics</span>
<span class="sd"> Returns:</span>
<span class="sd"> Tracer: Configured OpenTelemetry tracer</span>
<span class="sd"> Example:</span>
<span class="sd"> ```python</span>
<span class="sd"> config = TracingConfig(</span>
<span class="sd"> service_name=&quot;amq-adapter&quot;,</span>
<span class="sd"> service_version=&quot;1.0.0&quot;,</span>
<span class="sd"> otlp_endpoint=&quot;http://jaeger:4317&quot;,</span>
<span class="sd"> debug=True</span>
<span class="sd"> )</span>
<span class="sd"> metrics_config = MetricsConfig(</span>
<span class="sd"> prometheus_port=9464,</span>
<span class="sd"> prometheus_host=&quot;0.0.0.0&quot;</span>
<span class="sd"> )</span>
<span class="sd"> tracer = initialize_telemetry(config, metrics_config)</span>
<span class="sd"> ```</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># Use default configs if none provided</span>
<span class="k">if</span> <span class="n">tracing_config</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">tracing_config</span> <span class="o">=</span> <span class="n">TracingConfig</span><span class="p">(</span>
<span class="n">service_name</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;SERVICE_NAME&quot;</span><span class="p">,</span> <span class="s2">&quot;amq-adapter&quot;</span><span class="p">),</span>
<span class="n">service_version</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;SERVICE_VERSION&quot;</span><span class="p">,</span> <span class="s2">&quot;unknown&quot;</span><span class="p">),</span>
<span class="n">otlp_endpoint</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;OTEL_EXPORTER_OTLP_ENDPOINT&quot;</span><span class="p">,</span> <span class="s2">&quot;http://localhost:4317&quot;</span><span class="p">),</span>
<span class="n">insecure</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;OTEL_INSECURE_MODE&quot;</span><span class="p">,</span> <span class="s2">&quot;true&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s2">&quot;true&quot;</span><span class="p">,</span>
<span class="n">debug</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;OTEL_DEBUG&quot;</span><span class="p">,</span> <span class="s2">&quot;false&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s2">&quot;true&quot;</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">if</span> <span class="n">metrics_config</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">metrics_config</span> <span class="o">=</span> <span class="n">MetricsConfig</span><span class="p">(</span>
<span class="n">prometheus_port</span><span class="o">=</span><span class="nb">int</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;PROMETHEUS_PORT&quot;</span><span class="p">,</span> <span class="s2">&quot;9464&quot;</span><span class="p">)),</span>
<span class="n">prometheus_host</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;PROMETHEUS_HOST&quot;</span><span class="p">,</span> <span class="s2">&quot;localhost&quot;</span><span class="p">),</span>
<span class="n">export_interval_millis</span><span class="o">=</span><span class="nb">int</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;METRICS_EXPORT_INTERVAL&quot;</span><span class="p">,</span> <span class="s2">&quot;30000&quot;</span><span class="p">)),</span>
<span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># Create resource</span>
<span class="n">resource</span> <span class="o">=</span> <span class="n">create_resource</span><span class="p">(</span><span class="n">tracing_config</span><span class="p">)</span>
<span class="c1"># Set up tracing</span>
<span class="n">provider</span> <span class="o">=</span> <span class="n">setup_trace_provider</span><span class="p">(</span><span class="n">tracing_config</span><span class="p">,</span> <span class="n">resource</span><span class="p">)</span>
<span class="n">trace</span><span class="o">.</span><span class="n">set_tracer_provider</span><span class="p">(</span><span class="n">provider</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="sa">f</span><span class="s2">&quot;Initialized tracing for service </span><span class="si">{</span><span class="n">tracing_config</span><span class="o">.</span><span class="n">service_name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="c1"># Set up metrics</span>
<span class="n">metrics_provider</span> <span class="o">=</span> <span class="n">setup_metrics_provider</span><span class="p">(</span><span class="n">metrics_config</span><span class="p">,</span> <span class="n">resource</span><span class="p">)</span>
<span class="n">metrics</span><span class="o">.</span><span class="n">set_meter_provider</span><span class="p">(</span><span class="n">metrics_provider</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="s2">&quot;Initialized metrics export&quot;</span><span class="p">)</span>
<span class="c1"># Return configured tracer</span>
<span class="k">return</span> <span class="n">trace</span><span class="o">.</span><span class="n">get_tracer</span><span class="p">(</span>
<span class="n">tracing_config</span><span class="o">.</span><span class="n">service_name</span><span class="p">,</span>
<span class="n">tracing_config</span><span class="o">.</span><span class="n">service_version</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Failed to initialize telemetry: </span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="c1"># Return a no-op tracer in case of failure</span>
<span class="k">return</span> <span class="n">trace</span><span class="o">.</span><span class="n">get_tracer</span><span class="p">(</span><span class="s2">&quot;no-op&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="create_span">
<a class="viewcode-back" href="../../../modules/amqp.service.html#amqp.service.tracing.create_span">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">create_span</span><span class="p">(</span><span class="n">tracer</span><span class="p">:</span> <span class="n">Tracer</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">attributes</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Create a new span with the given name and attributes.</span>
<span class="sd"> Args:</span>
<span class="sd"> tracer: The OpenTelemetry tracer</span>
<span class="sd"> name: Name of the span</span>
<span class="sd"> attributes: Optional attributes to add to the span</span>
<span class="sd"> Returns:</span>
<span class="sd"> A context manager that creates and manages a span</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">tracer</span><span class="o">.</span><span class="n">start_as_current_span</span><span class="p">(</span>
<span class="n">name</span><span class="p">,</span>
<span class="n">attributes</span><span class="o">=</span><span class="n">attributes</span> <span class="ow">or</span> <span class="p">{},</span>
<span class="p">)</span></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024, CleverThis.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink