Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update links related to logger #747

Merged
merged 1 commit into from
Jul 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ mix test
mix format
```

CI will also run [dialyzer](http://erlang.org/doc/man/dialyzer.html) using the [Dialyxir library](https://github.com/jeremyjh/dialyxir) to check the typespecs, but this can be onerous to install and run. It is okay to submit changes without running it. If you want to run it locally, run:
CI will also run [dialyzer](https://www.erlang.org/doc/apps/dialyzer/dialyzer.html) using the [Dialyxir library](https://github.com/jeremyjh/dialyxir) to check the typespecs, but this can be onerous to install and run. It is okay to submit changes without running it. If you want to run it locally, run:

```bash
mix dialyzer
Expand Down
2 changes: 1 addition & 1 deletion lib/sentry.ex
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ defmodule Sentry do

* Manually — see `capture_exception/2` and `capture_message/2`.

* Through an [Erlang `:logger`](https://www.erlang.org/doc/man/logger) handler —
* Through an [Erlang `:logger`](https://www.erlang.org/doc/apps/kernel/logger.html) handler —
see `Sentry.LoggerHandler`.

* Through an Elixir `Logger` backend — see `Sentry.LoggerBackend`.
Expand Down
2 changes: 1 addition & 1 deletion lib/sentry/logger_backend.ex
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ defmodule Sentry.LoggerBackend do
>
> This module will eventually become **legacy**. Elixir `Logger` backends will
> eventually be deprecated in favor of Erlang [`:logger`
> handlers](https://erlang.org/doc/man/logger_chapter.html#handlers).
> handlers](https://www.erlang.org/doc/apps/kernel/logger_chapter.html#handlers).
>
> Sentry already has a `:logger` handler, `Sentry.LoggerHandler`. In new projects
> and wherever possible, use `Sentry.LoggerHandler` in favor of this backend.
Expand Down
4 changes: 2 additions & 2 deletions lib/sentry/logger_handler.ex
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ defmodule Sentry.LoggerHandler do
@options_schema NimbleOptions.new!(options_schema)

@moduledoc """
A highly-configurable [`:logger` handler](https://erlang.org/doc/man/logger_chapter.html#handlers)
A highly-configurable [`:logger` handler](https://www.erlang.org/doc/apps/kernel/logger_chapter.html#handlers)
that reports logged messages and crashes to Sentry.

*This module is available since v9.0.0 of this library*.
Expand Down Expand Up @@ -144,7 +144,7 @@ defmodule Sentry.LoggerHandler do
## Usage

To add this handler to your system, see [the documentation for handlers in
Elixir](https://hexdocs.pm/logger/1.15.5/Logger.html#module-erlang-otp-handlers).
Elixir](https://hexdocs.pm/logger/Logger.html#module-erlang-otp-handlers).

You can configure this handler in the `:logger` key under your application's configuration,
potentially alongside other `:logger` handlers:
Expand Down