Skip to main content

Fake Sentry service for debugging and integration tests

Project description

Kent is a service for debugging and integration testing Sentry.

Code:

https://github.com/willkg/kent/

Issues:

https://github.com/willkg/kent/issues

License:

MPL v2

Goals

Goals of Kent:

  1. make it possible to debug before_send and before_breadcrumb sanitization code when using sentry-sdk

  2. make it possible to debug other sentry event submission payload issues

  3. make it possible to write integration tests against a fake sentry instance

Quick start

Installing and running on your local machine

  1. Install Kent.

    You can install Kent from PyPI with pipx or pip or whatever:

    pipx install kent

    You can install a REVISH (“main”, branch name, commit, whatever) from GitHub:

    pipx install https://github.com/willkg/kent/archive/refs/heads/<REVISH>.zip

    You can install from a checked out version of this repository:

    pipx install .
  2. Run Kent:

    kent-server run [-h HOST] [-p PORT]

Running in a Docker container

I’m using something like this:

FROM python:3.11.5-slim-bookworm

WORKDIR /app/

ENV PYTHONUNBUFFERED=1 \
    PYTHONDONTWRITEBYTECODE=1

RUN groupadd -r kent && useradd --no-log-init -r -g kent kent

# NOTE(willkg): This installs Kent from main tip. If you're using Kent for
# realzies, you probably don't want to do this because Kent could change and
# break all your stuff. Pick a specific commit or tag.
RUN pip install -U 'pip>=8' && \
    pip install --no-cache-dir 'kent==<VERSION>'

USER kent

ENTRYPOINT ["/usr/local/bin/kent-server"]
CMD ["run"]

Make sure to replace <VERSION> with the version of Kent you want to use. See https://pypi-hypernode.com/project/kent for releases.

Then:

$ docker build -t kent:latest .
$ docker run --init --rm --publish 8000:8000 kent:latest run --host 0.0.0.0 --port 8000

Things to know about Kent

Kent is the fakest of fake Sentry servers. You can set up a Sentry DSN to point to Kent and have your application send events to it.

Kent is for testing sentry-sdk things. Kent is not for testing Relay.

Kent is a refined fake Sentry service and doesn’t like fast food.

Kent will keep track of the last 100 payloads it received in memory. Nothing is persisted to disk.

You can access the list of events and event data with your web browser by going to Kent’s index page.

You can also access it with the API. This is most useful for integration tests that want to assert things about events.

GET /api/eventlist/

List of all events in memory with a unique event id.

GET /api/event/EVENT_ID

Retrieve the payload for a specific event by id.

POST /api/flush/

Flushes the event manager of all events.

You can use multiple project ids. Kent will keep the events separate.

If you run kent-server run with the defaults, your DSN is:

http://public@localhost:5000/1    for project id 1
http://public@localhost:5000/2    for project id 2
etc.

Kent definitely works with:

  • Python sentry-sdk client

  • Python raven client (deprecated)

I don’t know about anything else. If you use Kent with another Sentry client, add an issue with details or a pull request to update the README.

Development

Install

  1. mkvirtualenv kent

  2. pip install -e '.[dev]'

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kent-2.1.0.tar.gz (36.1 kB view details)

Uploaded Source

Built Distribution

kent-2.1.0-py3-none-any.whl (29.5 kB view details)

Uploaded Python 3

File details

Details for the file kent-2.1.0.tar.gz.

File metadata

  • Download URL: kent-2.1.0.tar.gz
  • Upload date:
  • Size: 36.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.13.0

File hashes

Hashes for kent-2.1.0.tar.gz
Algorithm Hash digest
SHA256 8b873ed98b8740aa6c21c5bbd83ad64d362bd3614b48bdb13d33d99bd00f4a82
MD5 4d92fb515e707fd96dc90ec915d10982
BLAKE2b-256 b25d157b019d3411bf87df2bd3da22be6771e0d0d2c7bd5c05c84b97bf12d6b0

See more details on using hashes here.

File details

Details for the file kent-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: kent-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 29.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.13.0

File hashes

Hashes for kent-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2e661d06e3cf4fb1e807f292bb1e401690d3696159da69d401fce3dd1cbc5ef3
MD5 11b981cc101087037a780ceb46c0bed1
BLAKE2b-256 935c60bbb01a3d0c1c0a03a8d002703f6ec5788b1bd687fc52c66676c784906c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page