Skip to main content

Send global broadcast messages to Megaphone on changes

Project description

kinto-megaphone

travis Coverage

Send global broadcast messages to Megaphone on changes.

Installation

Install the Python package:

pip install kinto-megaphone

Add it to kinto.includes:

kinto.includes = kinto_megaphone

Then, you’ll want to add a listener.

The kinto-megaphone listener is called KintoChangesListener and it watches the monitor/changes collection from kinto-changes. You provide a list of resources, and when those resources are updated in monitor/changes, we notify megaphone with the new collection timestamp.

If talking to megaphone fails, it will abort the request (including rolling back the changes made in the request).

kinto-megaphone only offers this one kind of listener right now, but that could change later.

Add it using configuration like:

kinto.event_listeners = mp
kinto.event_listeners.mp.use = kinto_megaphone.listeners
kinto.event_listeners.mp.api_key = foobar
kinto.event_listeners.mp.url = http://megaphone.example.com/
kinto.event_listeners.mp.broadcaster_id = remote-settings
kinto.event_listeners.mp.match_kinto_changes = /buckets/main /buckets/blocklists/collections/addons /buckets/blocklists/collections/gfx

Note that the match_kinto_changes configuration only lets you describe resources that are tracked by kinto-changes – you won’t be able to put e.g. groups or accounts in there.

Changelog

This document describes changes between each past release.

0.3.0 (2018-11-12)

  • Add configuration to restrict what kinto-changes records cause notifications (#13).

0.2.3 (2018-11-07)

  • Remove a broken log message (#10).

0.2.2 (2018-11-07)

  • I failed to correctly release 0.2.1. Try again.

0.2.1 (2018-11-07)

  • Add a few log messages to help try to troubleshoot.

0.2.0 (2018-09-25)

  • Update to match kinto 10.1.1 – see Kinto/kinto#1770 (#2).

  • Add a heartbeat feature.

0.1.0 (2018-09-12)

  • Initial implementation

Contributors

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

kinto-megaphone-0.3.0.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

kinto_megaphone-0.3.0-py2.py3-none-any.whl (6.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file kinto-megaphone-0.3.0.tar.gz.

File metadata

  • Download URL: kinto-megaphone-0.3.0.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for kinto-megaphone-0.3.0.tar.gz
Algorithm Hash digest
SHA256 1702367d97b199e56f6e5acbd017db64e68c07487486fb8fdf8255140792f4b4
MD5 b3337ae1ebb780be9df9bb001c294e7d
BLAKE2b-256 fac557d6d2b6dfc9d38f0cc1acf74dbc12e3d25895c6046b1fc8e0bf19783d7a

See more details on using hashes here.

Provenance

File details

Details for the file kinto_megaphone-0.3.0-py2.py3-none-any.whl.

File metadata

  • Download URL: kinto_megaphone-0.3.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for kinto_megaphone-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5c74ee8174373f627629dbda946a06a5f407a64110d8c1aaac36f6da74aa090b
MD5 197f343803a84f2bca505950dfcf171c
BLAKE2b-256 1b65085dd7fcd19b223d6b435c052e038d13225a2d40ccf66a67a51d0d094d20

See more details on using hashes here.

Provenance

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