Skip to content

Commit 9e33cc2

Browse files
committed
Add "Quantum Integration" page to the docs
1 parent 14559ff commit 9e33cc2

File tree

3 files changed

+9
-39
lines changed

3 files changed

+9
-39
lines changed

mix.exs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,16 @@ defmodule Sentry.Mixfile do
3232
"CHANGELOG.md",
3333
"pages/setup-with-plug-and-phoenix.md",
3434
"pages/oban-integration.md",
35+
"pages/quantum-integration.md",
3536
"pages/upgrade-8.x.md",
3637
"pages/upgrade-9.x.md",
3738
"pages/upgrade-10.x.md"
3839
],
3940
groups_for_extras: [
4041
Integrations: [
4142
"pages/setup-with-plug-and-phoenix.md",
42-
"pages/oban-integration.md"
43+
"pages/oban-integration.md",
44+
"pages/quantum-integration.md"
4345
],
4446
"Upgrade Guides": [~r{^pages/upgrade}]
4547
],

pages/oban-integration.md

Lines changed: 1 addition & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,4 @@
22

33
The Sentry SDK supports integrating with [Oban](https://github.com/sorentwo/oban), one of the most widely-used job-scheduling libraries in the Elixir ecosystem.
44

5-
The Oban integration is available since *v10.2.0* of the Sentry SDK, and it requires:
6-
7-
1. Oban to be a dependency of your application.
8-
1. Oban version 2.17.6 or greater.
9-
1. Elixir 1.13 or later, since that is required by Oban itself.
10-
11-
## Automatic Error Capturing
12-
13-
*Available since 10.3.0*.
14-
15-
You can enable automatic capturing of errors that happen in Oban jobs. This includes jobs that return `{:error, reason}`, raise an exception, exit, and so on.
16-
17-
To enable support:
18-
19-
```elixir
20-
config :sentry,
21-
integrations: [
22-
oban: [
23-
capture_errors: true
24-
]
25-
]
26-
```
27-
28-
## Cron Support
29-
30-
To enable support for monitoring Oban jobs via [Sentry Cron](https://docs.sentry.io/product/crons/), make sure the following `:oban` configuration is in your Sentry configuration:
31-
32-
```elixir
33-
config :sentry,
34-
# ...,
35-
integrations: [
36-
oban: [
37-
cron: [enabled: true]
38-
]
39-
]
40-
```
41-
42-
This configuration will report started, completed, and failed job, alongside their duration. It will use the worker name as the `monitor_slug` of the reported cron.
5+
For documentation and setup instructions, see the [Sentry website](https://docs.sentry.io/platforms/elixir/integrations/oban/).

pages/quantum-integration.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Quantum Integration
2+
3+
The Sentry SDK supports integrating with [Quantum](https://github.com/quantum-elixir/quantum-core), a popular Elixir library for scheduling cron jobs.
4+
5+
For documentation and setup instructions, see the [Sentry website](https://docs.sentry.io/platforms/elixir/integrations/quantum/).

0 commit comments

Comments
 (0)