It's much easier to manage a bunch of services when they all have the same shape: the way they're developed, the way they interact with the infrastructure they run on, and the way they interact with each other. Baseplate is reddit's specification for the common shape of our services. This library, Baseplate.py, is the Python implementation of that specification.
Baseplate.py glues together tooling for interacting with the reddit backend ecosystem and spackles over things that are missing. It integrates with Apache Thrift, Pyramid, and client libraries for many systems to transparently make your applications observable.
Baseplate applications transparently get:
- Timing and request rate metrics using statsd
- Distributed tracing with Zipkin
- Error reporting and aggregation with Sentry
And can take advantage of:
- Integration with commonly used clients like: Thrift, SQLAlchemy, cassandra-driver, pymemcache, redis-py, and Kombu
- Secrets securely pulled from Vault
And many other things!
This repo comes with pre-commit hooks that let you (on a voluntary basis) enable pre-commit and/or pre-push hooks.
Configuration can be found at the root of the directory in
.pre-commit-config.yaml. On its own, the configuration file doesn't do
anything. You either need to run the hooks manually
or install them so that they run
automatically on every commit or push.
Currently, we run the
make fmt target on commit and
make lint /
actions on push.
Specific hooks can be temporarily disabled.
You can install hooks only for a specific step (i.e. pre-push).
Testing in Snoodev
You can upgrade any service to use in development Baseplate code in Snoodev by editing the requirements file for the service you would like to use for testing. Update the the Baseplate requirement to pull from Github instead, like this:
diff --git a/requirements.txt b/requirements.txt index aef8ad8..d32a078 100644 --- a/requirements.txt +++ b/requirements.txt -baseplate==2.5.7 +git+https://github.com/reddit/baseplate.py@<ref>#egg=baseplate
In this case the ref can be either a commit hash or a branch name. After making this update you can check if the service works in Snoodev.
Warning Never deploy this change to production. Production should always use a Baseplate semantic version that has been tagged, and released.