dwyl/learn-elixir

Logging and Stack Tracing In Elixir/Erlang

Open

#149 opened on Dec 28, 2019

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Elixir (113 forks)batch import
discussenhancementhelp wantedstarter

Repository metrics

Stars
 (1,695 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

At present we do not have a section in this guide on Logging or Error tracing. This is an omission as it is an important step in building apps that are maintainable.

This looks like a good starting point: https://timber.io/blog/the-ultimate-guide-to-logging-in-elixir/ PDF Snapshot: The-Ultimate-Guide-To-Logging-In-Elixir.pdf

Todo

  • do a bunch of research into stack tracing and logging in Elixir
  • Figure out how to do logging on Heroku (and any other relevant IaaS/PaaS provider)
  • Write it up!

Relevant reading:

Hopefully we can avoid this: https://github.com/dwyl/library/blob/221152bfd4185e5c83747f591b1c66d6a75ce183/lib/library_web/controllers/login_controller.ex#L19

Contributor guide

Research direction
Research Elixir's Logger module and stack trace facilities. Investigate logging on Heroku (e.g., using Timber or other services). Write up findings.
Tech stack
elixir
Domain
documentationbackend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Elixir
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70