New panic handler is not documented in the sentry crate

[kornelski]

It's hard to find documentation on replacement for register_panic_handler()

Documentation search: https://docs.rs/sentry/0.19.0/sentry/?search=panic finds https://docs.rs/sentry/0.19.0/sentry/integrations/panic/fn.panic_handler.html

but that function is just:

pub fn panic_handler(info: &PanicInfo)

but documentation doesn't have an example how this function is meant to be used. To me it looks like some internal callback, so I'm not sure if I'm supposed to install a panic hook myself.

The changelog says:

• The integrations module was completely rewritten.

but there's no information how the new integrations look like.

[Swatinem]

The PanicIntegration is enabled by default:

sentry-rust/sentry/src/defaults.rs

Lines 15 to 25 in 36218ea

	/// When the `default_integrations` option is set to `true` (by default), the
	/// following integrations will be added *before* any manually defined
	/// integrations, depending on enabled feature flags:
	///
	/// 1. [`AttachStacktraceIntegration`] (`feature = "backtrace"`)
	/// 2. [`DebugImagesIntegration`] (`feature = "debug-images"`)
	/// 3. [`ErrorChainIntegration`] (`feature = "error-chain"`)
	/// 4. [`ContextIntegration`] (`feature = "contexts"`)
	/// 5. [`FailureIntegration`] (`feature = "failure"`)
	/// 6. [`PanicIntegration`] (`feature = "panic"`)
	/// 7. [`ProcessStacktraceIntegration`] (`feature = "backtrace"`)

And it will set itself as the panic handler automatically on setup, so no need to do that manually:

sentry-rust/sentry-panic/src/lib.rs

Lines 55 to 61 in 36218ea

	INIT.call_once(|| {
	let next = panic::take_hook();
	panic::set_hook(Box::new(move |info| {
	panic_handler(info);
	next(info);
	}));
	});

Does that sufficiently answer your question? Or what kind of documentation would make this clearer?

[kornelski]

Yes, thank you. Automatic is much better than I expected — I thought I'd have to write a replacement for the function that has been removed.