https://github.com/jop-software/redmine_sentry_client

This redmine extensions integrates a sentry client to report internal errors to sentry
https://github.com/jop-software/redmine_sentry_client

hacktoberfest redmine redmine-plugin ruby ruby-on-rails sentry sentry-client

Last synced: 10 months ago
JSON representation

This redmine extensions integrates a sentry client to report internal errors to sentry

• Host: GitHub
• URL: https://github.com/jop-software/redmine_sentry_client
• Owner: jop-software
• License: mit
• Created: 2021-06-08T17:03:37.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-08-24T20:16:57.000Z (over 3 years ago)
• Last Synced: 2025-01-11T16:17:33.044Z (12 months ago)
• Topics: hacktoberfest, redmine, redmine-plugin, ruby, ruby-on-rails, sentry, sentry-client
• Language: Ruby
• Homepage: https://www.redmine.org/plugins/redmine_sentry_client
• Size: 63.5 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


    
Redmine Sentry Client

    
Report internal redmine errors to sentry



[![GitHub license](https://img.shields.io/github/license/jop-software/redmine_sentry_client?style=for-the-badge)](https://github.com/jop-software/redmine-sentry-client/blob/main/LICENSE)

![Redmine Version](https://img.shields.io/badge/Redmine-5.0-red?style=for-the-badge "redmine version")

## Introduction

This redmine plugin allows you to specify a sentry dsn, to report errors.  

The plugin is tested with redmine version **5.0**

## Redmine Versions

| Plugin Version | Redmine Version |

|---|---|

| 1.x | 4.x |

| 2.x | 5.x |

## Installation

You can follow the default way to install redmine plugins.

1. Download the plugin sources. Either from the [Plugins Directory](https://www.redmine.org/plugins/redmine_sentry_client) or the [Git Repository](https://github.com/jop-software/redmine_sentry_client)

1. unpack the downloaded archive into your `/plugins` directory.

2. Install dependencies with `bundle install`.

3. Restart redmine.

## Configuration

Please provide you'r sentry dsn in the plugin configuration.  

Keep in mind to restart redmine after adding the DSN, because the sentry client only gets registerd if this configuration is provided

You also can configure some parts with environment variables:

| Environment variable | Description | Default |

| --- | --- | --- |

| SENTRY_ACTIVE | Toogle weather the sentry integration should be active or not. | true |

## Test

In the configuration of the plugin is a button to trigger a test error.  

Alternatively you can visit the `/sentry` route to trigger the same behaviour

## License

See [LICENSE](./LICENSE) file for more information

© 2021-2022 jop-software Inh. Johannes Przymusinski