lua-resty-rollbar

Simple module for OpenResty to send errors to Rollbar.

lua-resty-rollbar is a Lua Rollbar client that makes it easy to report errors to Rollbar with stack traces. Errors are sent to Rollbar asynchronously in a light thread.

Installation

The dependency is available on LuaRocks:

luarocks install lua-resty-rollbar 0.2.0-1

Usage

local rollbar = require 'resty.rollbar'

-- Set your Rollbar token
-- This token must have 'post_server_item' scope
rollbar.set_token('MY_TOKEN')
-- Set the set_environment. Defaults to 'development'
rollbar.set_environment('production')

function main()
	local res, err = do_something()
	if not res {
		-- Error reporting
		-- This function will automatically read request information (URI, method,...) if available before reporting the error to Rollbar
		rollbar.report(rollbar.ERR, err)

		-- If the error reporting occurs from outside a request context (eg. inside a timer), you can supply a third parameter to prevent
		-- an useless function call that will try to read non existing request information
		rollbar.report(rollbar.ERR, err, {})

		return
	}
end

Execute the tests

The tests are written using the busted unit testing framework. To ease the testing of this package, we provide a self contained Docker Compose file to execute the unit tests.

Run the Docker Compose container in a terminal:

docker compose up

In a different terminal, execute the tests with:

docker compose exec test busted specs

Publish

1. Open a new PR to update the library version in lib/resty/rollbar.lua. The version should follow the SemVer standard.
2. Get the PR merged
3. Create and push a new tag to the repository. The name of the tag will become the version. Version name should follow this pattern X.Y.Z-I, where X.Y.Z is the SemVer version and I an increment starting at 1. The increment should only be used if the same version should be republished.
4. A Github Actions will automatically generate and publish the release to Github. The release will also be published to LuaRocks automatically.