csoellinger/silverstripe-rollbar

SilverStripe log handler for rollbar. https://rollbar.com

v2.1.0 2022-03-03 10:24 UTC

Requires

• php: >=7.3 <8.2
• rollbar/rollbar: ^2.1
• silverstripe/framework: ~4.10

Requires (Dev)

• ergebnis/composer-normalize: ^2.23
• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ^1.4
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-strict-rules: ^1.1
• phpunit/phpunit: ^9.5
• silverstripe/sqlite3: ^2
• squizlabs/php_codesniffer: ^3.6

BSD-3-Clause

• CSoellinger

• logging
• framework
• php
• plugin
• module
• cms
• JS
• monolog
• addon
• silverstripe
• rollbar
• monolog-handler
• silverstripe-module
• Rollbar-PHP
• Rollbar-JS
• silverstripe-vendormodule
• vendormodule

README

This is a very configurable module for the Rollbar Logging Service. Implementing the Rollbar PHP library including the rollbar js helper for client side logging in your SilverStripe application. Easy to use by injecting the log handler, setting the api key and optionally inserting a template helper called {RollbarJS} for the client code.

Requirements

• SilverStripe ^4.10 for latest version
• SilverStripe <4.10 with version 1.x.x
• Rollbar API key

Installation

BE AWARE TO TAKE THE VERSION WITH YOUR REQUIREMENTS

SilverStripe v4.10

composer require csoellinger/silverstripe-rollbar "^2"

SilverStripe v4.0 - v4.9

composer require csoellinger/silverstripe-rollbar "^1"

Configuration

To set the API key and the log handler as logger interface you have to set this config:

CSoellinger\SilverStripeRollbar\Configuration\RollbarConfiguration:
  access_token: Your Access Token
CSoellinger\SilverStripeRollbar\Configuration\RollbarJsConfiguration:
  accessToken: Your Client Access Token
SilverStripe\Core\Injector\Injector:
  RollbarLogHandler:
    class: CSoellinger\SilverStripeRollbar\Log\RollbarLogHandler
  Psr\Log\LoggerInterface:
    calls:
      RollbarLogHandler: [pushHandler, ["%$RollbarLogHandler"]]

Documentation

• Documentation readme

License

See License

We have included a 3-clause BSD license you can use as a default. We advocate for the BSD license as it is one of the most permissive and open licenses.

Maintainers

• CSoellinger [e-mail]

Bugtracker

Bugs are tracked in the issues section of this repository. Before submitting an issue please read over existing issues to ensure yours is unique.

If the issue does look like a new bug:

• Create a new issue
• Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots and screencasts can help here.
• Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, Operating System, any installed SilverStripe modules.

Please report security issues to the module maintainers directly. Please don't file security issues in the bugtracker.

Development and contribution

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.