Metadata-Version: 2.1
Name: barium-meal
Version: 0.0.9
Summary: Convenience wrapper for OpenTelemetry
Home-page: https://github.com/peckhamdata/barium-meal
Author: Peckham Data Centre
Author-email: chris@peckhamdata.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: pytest
Requires-Dist: opentelemetry-exporter-jaeger
Requires-Dist: opentelemetry-api
Requires-Dist: opentelemetry.instrumentation.requests
Requires-Dist: opentelemetry.instrumentation.boto

# barium-meal

Python Wrapper for [OpenTelemetry](https://opentelemetry.io/) written to scratch the itch
of needing to use the same / similar code across several [Google Cloud Functions](https://cloud.google.com/functions)
and wanting to abstract away from tracing / logging so I can mix and match the two.

Some of these cloud functions are invoked via HTTP, others from [Pub/Sub](https://cloud.google.com/pubsub) messages.

For Pub/Sub I have jury-rigged persisting
[the state of a Span to propagate between processes](https://opentelemetry-python.readthedocs.io/en/stable/api/trace.html#opentelemetry.trace.SpanContext).
To ensure that a trace that goes from function to function via pub/sub remains contiguous.

I'm *sure* there is a better way of doing this but this is good enough for my purposes and by putting my solution
out in the wild I'm hoping to get feedback to help improve it.

For http I have used the [W3C Trace Context Level1 Recommendation]( https://www.w3.org/TR/trace-context/) 
from 6 February 2020. I rolled my own here as I didn't find an existing Python implementation. Again if I have
missed something and someone would like to put me right that would be great!

# Installation

```
pip install barium-meal
```

# Usage

The tests are the best guide to usage. In the interests of keeping things DRY please take a look there.

# Running the tests

In a new virtual environment:

```
python setup.py develop
pytest
```

