Skip to content

Yelp/pyramid_zipkin

Repository files navigation

Coverage Status PyPi version Supported Python versions

pyramid_zipkin

This project provides Zipkin instrumentation for the Pyramid framework by using py_zipkin under the hood.

Full documentation here.

Features include:

  • Blacklisting specific route/paths from getting traced.

  • zipkin_tracing_percent to control the percentage of requests getting sampled (starting at, and downstream from, this service).

  • Creates http.uri, http.uri.qs, and status_code binary annotations automatically for each trace.

Install

    pip install pyramid_zipkin

Usage

In your service's webapp, you need to include:

    config.include('pyramid_zipkin')

Deployment

To bump and deploy a new version after changes have been merged into master, follow these steps:

  • $ git checkout master && git pull
  • update CHANGELOG.rst to document the changes
  • update __version__ in pyramid_zipkin/version.py
  • $ git add CHANGELOG.rst pyramid_zipkin/version.py && git commit -m 'version <VERSION>'
  • $ git tag v<VERSION>
  • $ git push origin master --tags

License

Copyright (c) 2023, Yelp, Inc. All rights reserved. Apache v2