Module Logs_fmt

Contents

Instructions: Use this module in your project

In the IDE (CLion, Visual Studio Code, Xcode, etc.) you use for your DkSDK project:

  1. Add the following to your project's dependencies/CMakeLists.txt:

    Copy
    DkSDKProject_DeclareAvailable(logs
        CONSTRAINT "= 0.7.0+dune2"
        FINDLIBS logs logs.cli logs.fmt logs.lwt logs.threaded logs.top)
    DkSDKProject_MakeAvailable(logs)
  2. Add the Findlib::logs library to any desired targets in src/*/CMakeLists.txt:

    Copy
    target_link_libraries(YourPackage_YourLibraryName
         # ... existing libraries, if any ...
         Findlib::logs)
  3. Click your IDE's Build button

Not using DkSDK?

FIRST, do one or all of the following:

  1. Run:

    Copy
    opam install logs.0.7.0+dune2
  2. Edit your dune-project and add:

    Copy
    (package
      (name YourExistingPackage)
      (depends
      ; ... existing dependenices ...
      (logs (>= 0.7.0+dune2))))

    Then run:

    Copy
    dune build *.opam # if this fails, run: dune build
  3. Edit your <package>.opam file and add:

    Copy
    depends: [
      # ... existing dependencies ...
      "logs" {>= "0.7.0+dune2"}
    ]

    Then run:

    Copy
    opam install . --deps-only

FINALLY, add the logs.fmt library to any desired (library)and/or (executable) targets in your **/dune files:

Copy
(library
  (name YourLibrary)
  ; ... existing library options ...
  (libraries
    ; ... existing libraries ...
    logs.fmt))

(executable
  (name YourExecutable)
  ; ... existing executable options ...
  (libraries
    ; ... existing libraries ...
    logs.fmt))

Reporter

val reporter : ``?pp_header:``(Logs.level* ``string option``)``Fmt.t -> ``?app:Stdlib.Format.formatter -> ``?dst:Stdlib.Format.formatter ->``unit-> Logs.reporter

reporter is like Logs.format_reporter except ANSI colors may be used in message header rendering if the formatters are configured to do so; see Fmt.set_style_renderer and Fmt_tty.

Consult a full command line setup example.

Colored message headers

valapp_style :Fmt.style

app_style is the style used to render headers at app level.

valerr_style :Fmt.style

err_style is the style used to render headers at error level.

valwarn_style :Fmt.style

warn_style is the style used to render headers at warning level.

valinfo_style :Fmt.style

info_style is the style used to render headers at info level.

valdebug_style :Fmt.style

debug_style is the style used to render headers at debug level.

val pp_header : ``(Logs.level* ``string option``)``Fmt.t

pp_header is like Logs.pp_header but may use ANSI colors if the formatter is configured to do so, see Fmt.set_style_renderer and Fmt_tty.