OpenCensus - A stats collection and distributed tracing frameworkWarning
OpenCensus and OpenTracing have merged to form OpenTelemetry, which serves as the next major version of OpenCensus and OpenTracing.
OpenTelemetry has now reached feature parity with OpenCensus, with tracing and metrics SDKs available in .NET, Golang, Java, NodeJS, and Python. All OpenCensus Github repositories will be archived. We encourage users to migrate to OpenTelemetry.
To help you gradually migrate your instrumentation to OpenTelemetry, bridges are available in Java, Go, Python (tracing only), and JS. Read the full blog post to learn more.
OpenCensus for Python. OpenCensus provides a framework to measure a server's resource usage and collect performance stats. This repository contains Python related utilities and supporting software needed by OpenCensus.
Installation & basic usageInstall the opencensus package using pip or pipenv:
pip install opencensus pipenv install opencensus
Initialize a tracer for your application:
from opencensus.trace.tracer import Tracer from opencensus.trace.samplers import AlwaysOnSampler tracer = Tracer(sampler=AlwaysOnSampler())
Initialize a view_manager and a stats_recorder for your application:
from opencensus.stats import stats as stats_module stats = stats_module.stats view_manager = stats.view_manager stats_recorder = stats.stats_recorder
You can collect traces using the Tracer
context manager:
from opencensus.trace.tracer import Tracer from opencensus.trace.samplers import AlwaysOnSampler # Initialize a tracer, by default using the `PrintExporter` tracer = Tracer(sampler=AlwaysOnSampler()) # Example for creating nested spans with tracer.span(name='span1'): do_something_to_trace() with tracer.span(name='span1_child1'): do_something_to_trace() with tracer.span(name='span1_child2'): do_something_to_trace() with tracer.span(name='span2'): do_something_to_trace()
OpenCensus will collect everything within the with
statement as a single span.
Alternatively, you can explicitly start and end a span:
from opencensus.trace.tracer import Tracer from opencensus.trace.samplers import AlwaysOnSampler # Initialize a tracer, by default using the `PrintExporter` tracer = Tracer(sampler=AlwaysOnSampler()) tracer.start_span(name='span1') do_something_to_trace() tracer.end_span()
There are several things you can customize in OpenCensus:
PrintExporter
, FileExporter
and LoggingExporter
, the other exporters are provided as extensions.ProbabilitySampler
, which samples (i.e. enables tracing for) a percentage of all requests. Sampling is deterministic according to the trace ID. To force sampling for all requests, or to prevent any request from being sampled, see AlwaysOnSampler
and AlwaysOffSampler
.SpanContext
and its headers. The default propagator is TraceContextPropagator
, other propagators include BinaryFormatPropagator
, GoogleCloudFormatPropagator
and TextFormatPropagator
.You can customize while initializing a tracer.
import requests from opencensus.trace import config_integration from opencensus.trace import file_exporter from opencensus.trace import tracer as tracer_module from opencensus.trace.propagation import google_cloud_format from opencensus.trace.samplers import ProbabilitySampler config_integration.trace_integrations(['httplib']) tracer = tracer_module.Tracer( exporter=file_exporter.FileExporter(file_name='traces'), propagator=google_cloud_format.GoogleCloudFormatPropagator(), sampler=ProbabilitySampler(rate=0.5), ) with tracer.span(name='parent'): with tracer.span(name='child'): response = requests.get('http://localhost:5000')
You can use a configuration file for Flask/Django/Pyramid. For more information, please read the individual integration documentation.
'OPENCENSUS': { 'TRACE': { 'EXCLUDELIST_HOSTNAMES': ['localhost', '127.0.0.1'], 'EXCLUDELIST_PATHS': ['_ah/health'], 'SAMPLER': 'opencensus.trace.samplers.ProbabilitySampler(rate=1)', 'EXPORTER': '''opencensus.ext.ocagent.trace_exporter.TraceExporter( service_name='foobar', )''', 'PROPAGATOR': 'opencensus.trace.propagation.google_cloud_format.GoogleCloudFormatPropagator()', } }
OpenCensus supports integration with popular web frameworks, client libraries and built-in libraries.
This library follows Semantic Versioning.
GA: Libraries defined at a GA quality level are stable, and will not introduce backwards-incompatible changes in any minor or patch releases. We will address issues and requests with the highest priority. If we were to make a backwards-incompatible changes on an API, we will first mark the existing API as deprecated and keep it for 18 months before removing it.
Beta: Libraries defined at a Beta quality level are expected to be mostly stable and we're working towards their release candidate. We will address issues and requests with a higher priority. There may be backwards incompatible changes in a minor version release, though not in a patch release. If an element is part of an API that is only meant to be used by exporters or other opencensus libraries, then there is no deprecation period. Otherwise, we will deprecate it for 18 months before removing it, if possible.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4