rollbar-haskell's Introduction

Rollbar Haskell

A group of libraries written in Haskell to communicate with Rollbar API. Inspired by bugsnag-haskell.

rollbar-cli - Simple CLI tool to perform commons tasks such as tracking deploys.
rollbar-client - Core library to communicate with Rollbar API.
rollbar-wai - Provides error reporting capabilities to WAI based applications through Rollbar API.
rollbar-yesod - Provides error reporting capabilities to Yesod applications through Rollbar API.

Requirements

Install one of the following set of tools (or all of them):
- GHC and cabal.
- stack.
Set up a Rollbar account, create a project, and generate an access token.
- To get an access token, go to your project's Settings and then to Project Access Tokens, where you can copy or create an access token with scope post_server_item.

Getting Started

Cabal

Compile the projects:

cabal update
cabal configure --enable-tests
cabal build all

Run all tests:

env ROLLBAR_TOKEN=<token> cabal test all

Stack

Compile the projects:

stack build

Run all tests:

env ROLLBAR_TOKEN=<token> stack test

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Sebastián Estrella}
💻

_{William R. Arellano}
💻

_{Juan Pedro Villa Isaza}
💻 💡

_{David Mazarro}
💻 🚧

_{Sebastian Avalos}
💻

_psilospore
💻

_{Isaac Snow}
📖

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT, see the LICENSE file.

Contributing

Do you want to contribute to this project? Please take a look at our contributing guideline to know how you can help us build it.

Check out our libraries | Join our team

rollbar-haskell's People

Contributors

Stargazers

Watchers

rollbar-haskell's Issues

Add "all contributors" section

createItem not serializing `Nothing`s correctly

We are using katip for logging. So we want to create a Rollbar.Item from a Katip.Item and we have this function

mkRollbarItem :: Katip.LogItem a => Katip.Item a -> Rollbar.Item
mkRollbarItem katipItem =
  let payload =
        Rollbar.PayloadMessage $
          Rollbar.Message
            { Rollbar.messageBody =
                LT.toStrict . TB.toLazyText . coerce $
                  Katip._itemMessage katipItem
            , Rollbar.messageMetadata = katipItemToObject katipItem
            }
   in
      Rollbar.Item
        { Rollbar.itemEnvironment = Rollbar.Environment "production"
        , Rollbar.itemBody = Rollbar.Body payload
        , Rollbar.itemLevel =
            katipSeverityToRollbarLevel $
              Katip._itemSeverity katipItem
        , Rollbar.itemPlatform = Nothing
        , Rollbar.itemLanguage = Just "Haskell"
        , Rollbar.itemFramework = Nothing
        , Rollbar.itemRequest = Nothing
        , Rollbar.itemServer = Nothing
        , Rollbar.itemNotifier = Rollbar.Notifier "" ""
        }

Note that both Rollbar.itemServer and Rollbar.itemPlatform are listed as Maybes in the Rollbar.Client docs. And yet, we get this error. The ellipsis is irrelevant stuff

(StatusCodeException (Response {responseStatus = Status {statusCode = 422, statusMessage = "Unprocessable Entity"}, ... "{\n \"err\": 1,\n \"message\": \"Invalid format. data.platform should be string. data.server should be object.\"\n}")))

So we did

let rollbarItem = mkRollbarItem katipItem
_ <- Debug.trace (LBS.unpack $ Aeson.encode rollbarItem) (Rollbar.createItem rollbarItem)

and noticed that platform, server, and other Nothings were serialized as {"server":null, "platform":null, ...}, which seems to make rollbar api unhappy.

stackbuilders / rollbar-haskell Goto Github PK