lexicality/gmod-sentry

Find out how terrible your workshop addons are in one easy place

Sentry integration for Garry's Mod

Track errors as they happen on your server, find out which workshop addon is making your players quit and track bugs without having to rely on user reports.

Requirements

• A server host that lets you install binary modules
• gmsv_luaerror.dll Installed in your server's lua/bin folder
• An account on sentry.io or a custom sentry installation

Setup

1. Download and install the correct version of luaerror from your server (eg gmsv_luaerror_linux.dll)
2. Set up a project in Sentry
3. Find your DSN
4. Upload sentry.lua to lua/includes/modules on the server
5. Create lua/autorun/server/sentry.lua on the server with the contents

   require( "sentry" )
   sentry.Setup( "YOUR DSN HERE", { server_name = "SHORT NAME FOR SERVER" } )

6. Start collecting errors!

Customisation

sentry.Setup()

You can pass a number of fields to sentry.Setup:

• server_name: Tags your server in the sentry UI. If you have more than one server, this is useful for filtering between them. If you don't set it, your server's public hostname will be used.
• environment: Used for setting up Environments on sentry. Not very useful if you don't run a testing server.
• release: Used by the Releases feature in Sentry.
• tags: Any additional tags you want every error from this server to be tagged with
• no_detour: If you don't want the module to override certain functions (because you've already overriden them) then pass them in here.

Example:

sentry.Setup(
	"https://[email protected]/1337",
	{
		server_name = "server 7",
		environment = "production",
		release = "v23",
		tags = { foo = "bar" },
		no_detour = { "hook.Call" },
	}
)

Transactions

By default this module will detour a number of Lua entry points to attempt to instrument as many things with useful transaction names as possible.

This means your errors will be tagged with things such as hook/PlayerInitialSpawn/DarkRP_DoorData or net/GModSave, but you may wish to use your own names for functions. You can use sentry.ExecuteInTransaction to do this.

Example:

function DoDatabaseSave( ply )
	-- snip
end
hook.Add( "PlayerDisconnected", "Save Player Data", function( ply )
	sentry.ExecuteInTransaction( "My Save System", DoDatabaseSave, ply )
end)

Documentation

A generated LDoc file is available at https://lexicality.github.io/gmod-sentry

gmod-sentry's Issues

Add support for breadcrumbs

https://docs.sentry.io/enriching-error-data/breadcrumbs/
https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/

August 2020 Update causes a lua panic under certain conditions

I haven't been able to investigate this very well myself as I'm on holiday, however the August 2020 update has caused a lua panic on our server during bootup (doesn't seem to occur 100% of the time)

This patchnote imparticular is likely the root cause.

Hopefully this can be fixed, or a workaround found.

Incompatibility with luadev

At startup while gmod-sentry is trying to get version data the following happens:

error: bad argument #1 to 'pairs' (table expected, got function)
  File "[C]", in pairs
  File "addons/luadev/lua/autorun/tinylua.lua", line 33, in tinylua
  File "addons/luadev/lua/autorun/easylua.lua", line 726, in __index
  File "lua/includes/modules/sentry.lua", line 211, in func
  File "lua/includes/modules/sentry.lua", line 862, in ExecuteTransaction
  File "lua/includes/modules/sentry.lua", line 1205, in <unknown>
  File "[C]", in xpcall
  File "lua/includes/modules/sentry.lua", line 864, in <unknown>

looks like it's caused by these, which is: https://github.com/Metastruct/luadev/blob/8b53bec879869fba6df097c3144fc8d79352275a/lua/autorun/easylua.lua#L809

No clientside errors?

I can't see support for clientside LUA errors, is this deliberately or not done yet?

Re-running the setup script causes crash

Seemingly gmod enters an infinite lua loop if I try to re-run the described sentry.lua script I've put in autorun. Naturally, this is not that's normally done but when developing I'd like to re-initialize sentry.

Add detour for mysqloo

• Add a function specifically for reporting SQL errors
• See if we can automatically wrap all callbacks in transactions
• Automatic breadcrumb capture? (#6)

Maybe support the new Unified API

• https://develop.sentry.dev/sdk/unified-api/