agrafix/Spock

Custom logging using e.g. katip/monad-logger

Open

#137 opened on Dec 13, 2017

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Haskell (596 stars) (54 forks)batch import
enhancementhelp wanted

Description

Hey folks, thanks for writing Spock!

This might not be the place for this request but I was wondering if you could perhaps add some advice to the documentation about how Spock users should go about adding logging to a Spock application. I know there are things like wai-extras that have a wai middleware for logging requests but, at least in the applications I work on, I'd also like to do some custom logging.

Specifically, I'm interested in how I should go about integrating with common libraries like monad-logger or katip but I'd appreciate any general advice you have.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic HaskellFamiliarity with Spock web framework
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Look at the existing Spock documentation and examples for logging. Research monad logger and katip libraries to understand how they integrate with WAI and Spock. Consider adding a section in the documentation or a sample application demonstrating custom logging.