1b88e90e30
* Introduce patches with external kafka * Fix pre-commit hooks * Patch relay config file * Documentation for patches stuff * Provide more helpful information for Docker Compose Override file * Fix grep command * ref: rename to 'optional-modifications' * chore(pre-commit): exclude .patch extension * chore(pre-commit): escape backslash * chore(pre-commit): put exclude field on hooks * chore(pre-commit): put exclude field on top level Based on https://pre-commit.com/#top_level-exclude * chore(pre-commit): move to even more top level
Optional Modifications
Other than the default self-hosted Sentry installation, sometimes users can leverage their existing infrastructure to help them with limited resources. "Patches", or you might call this like a "plugin system", is a collection of patch files (see man patch(1)) that can be used with to modify the existing configuration to achieve the desired goal.
Warning
Beware that this is very experimental and might not work as expected.
Use it at your own risk!
How to use patches
The patches are designed mostly to help modify the existing
configuration files. You will need to run the install.sh script
afterwards.
They should be run from the root directory. For example, the
external-kafka patches should be run as:
patch < optional-modifications/patches/external-kafka/.env.patch
patch < optional-modifications/patches/external-kafka/config.example.yml.patch
patch < optional-modifications/patches/external-kafka/sentry.conf.example.py.patch
patch < optional-modifications/patches/external-kafka/docker-compose.yml.patch
Some patches might require additional steps to be taken, like providing credentials or additional TLS certificates.
Official support
Sentry employees are not obliged to provide dedicated support for patches, but they can help by providing information to move us forward. We encourage the community to contribute for any bug fixes or improvements.
See the support policy for self-hosted Sentry for more information.