2023-06-10 07:45:52 +00:00
<!doctype html>
< html lang = "en" class = "no-js" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
< meta name = "description" content = "Single documentation place for all Insanus Mokrassar libraries" >
< meta name = "author" content = "Ovsiannikov Aleksei" >
< link rel = "canonical" href = "https://docs.inmo.dev/kslog/setup.html" >
< link rel = "prev" href = "index.html" >
< link rel = "next" href = "logging.html" >
< link rel = "icon" href = "../assets/images/favicon.png" >
< meta name = "generator" content = "mkdocs-1.4.3, mkdocs-material-9.1.15" >
< title > Setup - InMo Docs< / title >
< link rel = "stylesheet" href = "../assets/stylesheets/main.26e3688c.min.css" >
2023-06-10 08:09:32 +00:00
< link rel = "stylesheet" href = "../assets/stylesheets/palette.ecc896b0.min.css" >
2023-06-10 07:45:52 +00:00
< link rel = "preconnect" href = "https://fonts.gstatic.com" crossorigin >
< link rel = "stylesheet" href = "https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback" >
< style > : root { --md-text-font : "Roboto" ; --md-code-font : "Roboto Mono" } < / style >
< script > _ _md _scope = new URL ( ".." , location ) , _ _md _hash = e => [ ... e ] . reduce ( ( e , _ ) => ( e << 5 ) - e + _ . charCodeAt ( 0 ) , 0 ) , _ _md _get = ( e , _ = localStorage , t = _ _md _scope ) => JSON . parse ( _ . getItem ( t . pathname + "." + e ) ) , _ _md _set = ( e , _ , t = localStorage , a = _ _md _scope ) => { try { t . setItem ( a . pathname + "." + e , JSON . stringify ( _ ) ) } catch ( e ) { } } < / script >
2023-06-10 10:14:30 +00:00
< script id = "__analytics" > function _ _md _analytics ( ) { function n ( ) { dataLayer . push ( arguments ) } window . dataLayer = window . dataLayer || [ ] , n ( "js" , new Date ) , n ( "config" , "G-6VXMCYZWH7" ) , document . addEventListener ( "DOMContentLoaded" , function ( ) { document . forms . search && document . forms . search . query . addEventListener ( "blur" , function ( ) { this . value && n ( "event" , "search" , { search _term : this . value } ) } ) , document $ . subscribe ( function ( ) { var a = document . forms . feedback ; if ( void 0 !== a ) for ( var e of a . querySelectorAll ( "[type=submit]" ) ) e . addEventListener ( "click" , function ( e ) { e . preventDefault ( ) ; var t = document . location . pathname , e = this . getAttribute ( "data-md-value" ) ; n ( "event" , "feedback" , { page : t , data : e } ) , a . firstElementChild . disabled = ! 0 ; e = a . querySelector ( ".md-feedback__note [data-md-value='" + e + "']" ) ; e && ( e . hidden = ! 1 ) } ) , a . hidden = ! 1 } ) , location$ . subscribe ( function ( e ) { n ( "config" , "G-6VXMCYZWH7" , { page _path : e . pathname } ) } ) } ) ; var e = document . createElement ( "script" ) ; e . async = ! 0 , e . src = "https://www.googletagmanager.com/gtag/js?id=G-6VXMCYZWH7" , document . getElementById ( "__analytics" ) . insertAdjacentElement ( "afterEnd" , e ) } < / script >
< script > "undefined" != typeof _ _md _analytics && _ _md _analytics ( ) < / script >
2023-06-10 07:45:52 +00:00
< / head >
2023-06-10 08:09:32 +00:00
< body dir = "ltr" data-md-color-scheme = "default" data-md-color-primary = "teal" data-md-color-accent = "cyan" >
2023-06-10 07:45:52 +00:00
< script > var palette = _ _md _get ( "__palette" ) ; if ( palette && "object" == typeof palette . color ) for ( var key of Object . keys ( palette . color ) ) document . body . setAttribute ( "data-md-color-" + key , palette . color [ key ] ) < / script >
< input class = "md-toggle" data-md-toggle = "drawer" type = "checkbox" id = "__drawer" autocomplete = "off" >
< input class = "md-toggle" data-md-toggle = "search" type = "checkbox" id = "__search" autocomplete = "off" >
< label class = "md-overlay" for = "__drawer" > < / label >
< div data-md-component = "skip" >
< a href = "#setup" class = "md-skip" >
Skip to content
< / a >
< / div >
< div data-md-component = "announce" >
< / div >
< header class = "md-header" data-md-component = "header" >
< nav class = "md-header__inner md-grid" aria-label = "Header" >
< a href = "../index.html" title = "InMo Docs" class = "md-header__button md-logo" aria-label = "InMo Docs" data-md-component = "logo" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z" / > < / svg >
< / a >
< label class = "md-header__button md-icon" for = "__drawer" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z" / > < / svg >
< / label >
< div class = "md-header__title" data-md-component = "header-title" >
< div class = "md-header__ellipsis" >
< div class = "md-header__topic" >
< span class = "md-ellipsis" >
InMo Docs
< / span >
< / div >
< div class = "md-header__topic" data-md-component = "header-topic" >
< span class = "md-ellipsis" >
Setup
< / span >
< / div >
< / div >
< / div >
2023-06-10 08:09:32 +00:00
< form class = "md-header__option" data-md-component = "palette" >
< input class = "md-option" data-md-color-media = "" data-md-color-scheme = "default" data-md-color-primary = "teal" data-md-color-accent = "cyan" aria-label = "Switch to dark mode" type = "radio" name = "__palette" id = "__palette_1" >
< label class = "md-header__button md-icon" title = "Switch to dark mode" for = "__palette_2" hidden >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z" / > < / svg >
< / label >
< input class = "md-option" data-md-color-media = "" data-md-color-scheme = "slate" data-md-color-primary = "blue-grey" data-md-color-accent = "light-blue" aria-label = "Switch to light mode" type = "radio" name = "__palette" id = "__palette_2" >
< label class = "md-header__button md-icon" title = "Switch to light mode" for = "__palette_1" hidden >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z" / > < / svg >
< / label >
< / form >
2023-06-10 07:45:52 +00:00
< label class = "md-header__button md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg >
< / label >
< div class = "md-search" data-md-component = "search" role = "dialog" >
< label class = "md-search__overlay" for = "__search" > < / label >
< div class = "md-search__inner" role = "search" >
< form class = "md-search__form" name = "search" >
< input type = "text" class = "md-search__input" name = "query" aria-label = "Search" placeholder = "Search" autocapitalize = "off" autocorrect = "off" autocomplete = "off" spellcheck = "false" data-md-component = "search-query" required >
< label class = "md-search__icon md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z" / > < / svg >
< / label >
< nav class = "md-search__options" aria-label = "Search" >
< a href = "javascript:void(0)" class = "md-search__icon md-icon" title = "Share" aria-label = "Share" data-clipboard data-clipboard-text = "" data-md-component = "search-share" tabindex = "-1" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7 0-.24-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91 1.61 0 2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08Z" / > < / svg >
< / a >
< button type = "reset" class = "md-search__icon md-icon" title = "Clear" aria-label = "Clear" tabindex = "-1" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z" / > < / svg >
< / button >
< / nav >
< div class = "md-search__suggest" data-md-component = "search-suggest" > < / div >
< / form >
< div class = "md-search__output" >
< div class = "md-search__scrollwrap" data-md-scrollfix >
< div class = "md-search-result" data-md-component = "search-result" >
< div class = "md-search-result__meta" >
Initializing search
< / div >
< ol class = "md-search-result__list" role = "presentation" > < / ol >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "md-header__source" >
< a href = "https://github.com/InsanusMokrassar/docs" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > <!-- ! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc. --> < path d = "M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z" / > < / svg >
< / div >
< div class = "md-source__repository" >
InsanusMokrassar/docs
< / div >
< / a >
< / div >
< / nav >
< / header >
< div class = "md-container" data-md-component = "container" >
< nav class = "md-tabs" aria-label = "Tabs" data-md-component = "tabs" >
< div class = "md-grid" >
< ul class = "md-tabs__list" >
< li class = "md-tabs__item" >
< a href = "../index.html" class = "md-tabs__link" >
Home
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "../tgbotapi/introduction/before-any-bot-project.html" class = "md-tabs__link" >
Telegram Bot API
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "../krontab/introduction/including-in-project.html" class = "md-tabs__link" >
Krontab
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "index.html" class = "md-tabs__link md-tabs__link--active" >
KSLog
< / a >
< / li >
< / ul >
< / div >
< / nav >
< main class = "md-main" data-md-component = "main" >
< div class = "md-main__inner md-grid" >
< div class = "md-sidebar md-sidebar--primary" data-md-component = "sidebar" data-md-type = "navigation" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--primary md-nav--lifted" aria-label = "Navigation" data-md-level = "0" >
< label class = "md-nav__title" for = "__drawer" >
< a href = "../index.html" title = "InMo Docs" class = "md-nav__button md-logo" aria-label = "InMo Docs" data-md-component = "logo" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z" / > < / svg >
< / a >
InMo Docs
< / label >
< div class = "md-nav__source" >
< a href = "https://github.com/InsanusMokrassar/docs" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > <!-- ! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc. --> < path d = "M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z" / > < / svg >
< / div >
< div class = "md-source__repository" >
InsanusMokrassar/docs
< / div >
< / a >
< / div >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../index.html" class = "md-nav__link" >
Home
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_2" >
< label class = "md-nav__link" for = "__nav_2" id = "__nav_2_label" tabindex = "0" >
Telegram Bot API
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_2_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_2" >
< span class = "md-nav__icon md-icon" > < / span >
Telegram Bot API
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item md-nav__item--section md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_2_1" >
< label class = "md-nav__link" for = "__nav_2_1" id = "__nav_2_1_label" tabindex = "0" >
Introduction
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_2_1_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_2_1" >
< span class = "md-nav__icon md-icon" > < / span >
Introduction
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../tgbotapi/introduction/before-any-bot-project.html" class = "md-nav__link" >
Before any bot project
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../tgbotapi/introduction/including-in-your-project.html" class = "md-nav__link" >
Including in your project
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../tgbotapi/introduction/proxy-setup.html" class = "md-nav__link" >
Proxy setup
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../tgbotapi/introduction/first-bot.html" class = "md-nav__link" >
First bot
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--section md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_2_2" >
< label class = "md-nav__link" for = "__nav_2_2" id = "__nav_2_2_label" tabindex = "0" >
Updates retrieving
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_2_2_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_2_2" >
< span class = "md-nav__icon md-icon" > < / span >
Updates retrieving
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../tgbotapi/updates/updates-filters.html" class = "md-nav__link" >
Updates filters
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../tgbotapi/updates/long-polling.html" class = "md-nav__link" >
Long polling
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../tgbotapi/updates/webhooks.html" class = "md-nav__link" >
Webhooks
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../tgbotapi/updates/heroku.html" class = "md-nav__link" >
Heroku
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--section md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_2_3" >
< label class = "md-nav__link" for = "__nav_2_3" id = "__nav_2_3_label" tabindex = "0" >
Logic handling
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_2_3_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_2_3" >
< span class = "md-nav__icon md-icon" > < / span >
Logic handling
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../tgbotapi/logic/api-extensions.html" class = "md-nav__link" >
API Extensions
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../tgbotapi/logic/behaviour-builder-with-fsm.html" class = "md-nav__link" >
Behaviour Builder with FSM
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../tgbotapi/logic/behaviour-builder.html" class = "md-nav__link" >
Behaviour Builder
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../tgbotapi/logic/exceptions-handling.html" class = "md-nav__link" >
Exceptions handling
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../tgbotapi/logic/files-handling.html" class = "md-nav__link" >
Files handling
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../tgbotapi/logic/low-level-work-with-bots.html" class = "md-nav__link" >
Low-level work with bots
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../tgbotapi/logic/media-groups.html" class = "md-nav__link" >
Media Groups
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../tgbotapi/logic/types-conversations.html" class = "md-nav__link" >
Types conversations
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../tgbotapi/logic/updates-with-flows.html" class = "md-nav__link" >
Updates with flows
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--section md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_2_4" >
< label class = "md-nav__link" for = "__nav_2_4" id = "__nav_2_4_label" tabindex = "0" >
DSLs
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_2_4_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_2_4" >
< span class = "md-nav__icon md-icon" > < / span >
DSLs
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../tgbotapi/dsls/keyboards.html" class = "md-nav__link" >
Keyboards
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../tgbotapi/dsls/live-location.html" class = "md-nav__link" >
Live Location
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../tgbotapi/dsls/text.html" class = "md-nav__link" >
Text
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_3" >
< label class = "md-nav__link" for = "__nav_3" id = "__nav_3_label" tabindex = "0" >
Krontab
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_3_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_3" >
< span class = "md-nav__icon md-icon" > < / span >
Krontab
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item md-nav__item--section md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_3_1" >
< label class = "md-nav__link" for = "__nav_3_1" id = "__nav_3_1_label" tabindex = "0" >
Introduction
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_3_1_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_3_1" >
< span class = "md-nav__icon md-icon" > < / span >
Introduction
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../krontab/introduction/including-in-project.html" class = "md-nav__link" >
Including in project
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../krontab/introduction/how-to-use.html" class = "md-nav__link" >
How to use
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../krontab/introduction/faq.html" class = "md-nav__link" >
FAQ
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--section md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_3_2" >
< label class = "md-nav__link" for = "__nav_3_2" id = "__nav_3_2_label" tabindex = "0" >
Describing
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_3_2_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_3_2" >
< span class = "md-nav__icon md-icon" > < / span >
Describing
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../krontab/describing/string-format.html" class = "md-nav__link" >
String format
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../krontab/describing/krontabscheduler.html" class = "md-nav__link" >
KrontabScheduler
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--active md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_4" checked >
< div class = "md-nav__link md-nav__link--index " >
< a href = "index.html" > KSLog< / a >
< label for = "__nav_4" >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< / div >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_4_label" aria-expanded = "true" >
< label class = "md-nav__title" for = "__nav_4" >
< span class = "md-nav__icon md-icon" > < / span >
KSLog
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item md-nav__item--active" >
< input class = "md-nav__toggle md-toggle" type = "checkbox" id = "__toc" >
< label class = "md-nav__link md-nav__link--active" for = "__toc" >
Setup
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< a href = "setup.html" class = "md-nav__link md-nav__link--active" >
Setup
< / a >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#dependency-installation" class = "md-nav__link" >
Dependency installation
< / a >
< nav class = "md-nav" aria-label = "Dependency installation" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#gradle-groovy" class = "md-nav__link" >
Gradle (Groovy)
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#gradle-kotlin-script" class = "md-nav__link" >
Gradle (Kotlin Script)
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#maven-pom" class = "md-nav__link" >
Maven (pom)
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#setup-in-code" class = "md-nav__link" >
Setup in code
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#special-loggers" class = "md-nav__link" >
Special loggers
< / a >
< nav class = "md-nav" aria-label = "Special loggers" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#callbackkslog" class = "md-nav__link" >
CallbackKSLog
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#taglogger" class = "md-nav__link" >
TagLogger
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#filterkslog" class = "md-nav__link" >
FilterKSLog
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#typedkslog" class = "md-nav__link" >
TypedKSLog
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#automatical-loggers" class = "md-nav__link" >
Automatical loggers
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#jvm-specific-setup" class = "md-nav__link" >
JVM specific setup
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "logging.html" class = "md-nav__link" >
Logging
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-sidebar md-sidebar--secondary" data-md-component = "sidebar" data-md-type = "toc" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#dependency-installation" class = "md-nav__link" >
Dependency installation
< / a >
< nav class = "md-nav" aria-label = "Dependency installation" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#gradle-groovy" class = "md-nav__link" >
Gradle (Groovy)
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#gradle-kotlin-script" class = "md-nav__link" >
Gradle (Kotlin Script)
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#maven-pom" class = "md-nav__link" >
Maven (pom)
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#setup-in-code" class = "md-nav__link" >
Setup in code
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#special-loggers" class = "md-nav__link" >
Special loggers
< / a >
< nav class = "md-nav" aria-label = "Special loggers" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#callbackkslog" class = "md-nav__link" >
CallbackKSLog
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#taglogger" class = "md-nav__link" >
TagLogger
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#filterkslog" class = "md-nav__link" >
FilterKSLog
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#typedkslog" class = "md-nav__link" >
TypedKSLog
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#automatical-loggers" class = "md-nav__link" >
Automatical loggers
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#jvm-specific-setup" class = "md-nav__link" >
JVM specific setup
< / a >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" data-md-component = "content" >
< article class = "md-content__inner md-typeset" >
< a href = "https://github.com/InsanusMokrassar/docs/edit/master/docs/kslog/setup.md" title = "Edit this page" class = "md-content__button md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4v-2m10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1 2.1 2.1Z" / > < / svg >
< / a >
< a href = "https://github.com/InsanusMokrassar/docs/raw/master/docs/kslog/setup.md" title = "View source of this page" class = "md-content__button md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.15 8.15 0 0 1-1.23-2Z" / > < / svg >
< / a >
< h1 id = "setup" > Setup< a class = "headerlink" href = "#setup" title = "Permanent link" > ¶ < / a > < / h1 >
< h2 id = "dependency-installation" > Dependency installation< a class = "headerlink" href = "#dependency-installation" title = "Permanent link" > ¶ < / a > < / h2 >
< p > < a href = "https://maven-badges.herokuapp.com/maven-central/dev.inmo/kslog" > < img alt = "Maven Central" src = "https://maven-badges.herokuapp.com/maven-central/dev.inmo/kslog/badge.svg" / > < / a > < / p >
< h3 id = "gradle-groovy" > Gradle (Groovy)< a class = "headerlink" href = "#gradle-groovy" title = "Permanent link" > ¶ < / a > < / h3 >
2023-06-10 07:53:25 +00:00
< div class = "language-groovy highlight" > < pre > < span > < / span > < code > < span id = "__span-0-1" > < a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" > < / a > < span class = "n" > implementation< / span > < span class = "w" > < / span > < span class = "s2" > " dev.inmo:kslog:$kslog_version" < / span >
< / span > < / code > < / pre > < / div >
2023-06-10 07:45:52 +00:00
< h3 id = "gradle-kotlin-script" > Gradle (Kotlin Script)< a class = "headerlink" href = "#gradle-kotlin-script" title = "Permanent link" > ¶ < / a > < / h3 >
2023-06-10 07:53:25 +00:00
< div class = "language-kotlin highlight" > < pre > < span > < / span > < code > < span id = "__span-1-1" > < a id = "__codelineno-1-1" name = "__codelineno-1-1" href = "#__codelineno-1-1" > < / a > < span class = "n" > implementation< / span > < span class = "p" > (< / span > < span class = "s" > " dev.inmo:kslog:< / span > < span class = "si" > $< / span > < span class = "n" > kslog_version< / span > < span class = "s" > " < / span > < span class = "p" > )< / span >
< / span > < / code > < / pre > < / div >
2023-06-10 07:45:52 +00:00
< h3 id = "maven-pom" > Maven (pom)< a class = "headerlink" href = "#maven-pom" title = "Permanent link" > ¶ < / a > < / h3 >
2023-06-10 07:53:25 +00:00
< div class = "language-xml highlight" > < pre > < span > < / span > < code > < span id = "__span-2-1" > < a id = "__codelineno-2-1" name = "__codelineno-2-1" href = "#__codelineno-2-1" > < / a > < span class = "nt" > < dependency> < / span >
< / span > < span id = "__span-2-2" > < a id = "__codelineno-2-2" name = "__codelineno-2-2" href = "#__codelineno-2-2" > < / a > < span class = "w" > < / span > < span class = "nt" > < groupId> < / span > dev.inmo< span class = "nt" > < /groupId> < / span >
< / span > < span id = "__span-2-3" > < a id = "__codelineno-2-3" name = "__codelineno-2-3" href = "#__codelineno-2-3" > < / a > < span class = "w" > < / span > < span class = "nt" > < artifactId> < / span > kslog< span class = "nt" > < /artifactId> < / span >
< / span > < span id = "__span-2-4" > < a id = "__codelineno-2-4" name = "__codelineno-2-4" href = "#__codelineno-2-4" > < / a > < span class = "w" > < / span > < span class = "nt" > < version> < / span > ${kslog_version}< span class = "nt" > < /version> < / span >
< / span > < span id = "__span-2-5" > < a id = "__codelineno-2-5" name = "__codelineno-2-5" href = "#__codelineno-2-5" > < / a > < span class = "nt" > < /dependency> < / span >
< / span > < / code > < / pre > < / div >
2023-06-10 07:45:52 +00:00
< h2 id = "setup-in-code" > Setup in code< a class = "headerlink" href = "#setup-in-code" title = "Permanent link" > ¶ < / a > < / h2 >
< p > The main point in setup in your code is to setup default logger:< / p >
2023-06-10 07:53:25 +00:00
< div class = "language-kotlin highlight" > < pre > < span > < / span > < code > < span id = "__span-3-1" > < a id = "__codelineno-3-1" name = "__codelineno-3-1" href = "#__codelineno-3-1" > < / a > < span class = "n" > KSLog< / span > < span class = "p" > .< / span > < span class = "na" > default< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "n" > KSLog< / span > < span class = "p" > (< / span > < span class = "s" > " defaultTag" < / span > < span class = "p" > )< / span >
< / span > < / code > < / pre > < / div >
2023-06-10 07:45:52 +00:00
< p > You may use custom < code > messageFormatter< / code > in any of < code > KSLog< / code > factory to customize output of < code > KSLog< / code > logging. For example:< / p >
2023-06-10 07:53:25 +00:00
< div class = "language-kotlin highlight" > < pre > < span > < / span > < code > < span id = "__span-4-1" > < a id = "__codelineno-4-1" name = "__codelineno-4-1" href = "#__codelineno-4-1" > < / a > < span class = "n" > KSLog< / span > < span class = "p" > (< / span >
< / span > < span id = "__span-4-2" > < a id = "__codelineno-4-2" name = "__codelineno-4-2" href = "#__codelineno-4-2" > < / a > < span class = "w" > < / span > < span class = "s" > " loggingWithCustomFormat" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-4-3" > < a id = "__codelineno-4-3" name = "__codelineno-4-3" href = "#__codelineno-4-3" > < / a > < span class = "w" > < / span > < span class = "n" > messageFormatter< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "p" > {< / span > < span class = "w" > < / span > < span class = "n" > level< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "n" > tag< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "n" > message< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "n" > throwable< / span > < span class = "w" > < / span > < span class = "o" > -> < / span >
< / span > < span id = "__span-4-4" > < a id = "__codelineno-4-4" name = "__codelineno-4-4" href = "#__codelineno-4-4" > < / a > < span class = "w" > < / span > < span class = "n" > println< / span > < span class = "p" > (< / span > < span class = "s" > " [< / span > < span class = "si" > $< / span > < span class = "n" > level< / span > < span class = "s" > ] < / span > < span class = "si" > $< / span > < span class = "n" > tag< / span > < span class = "s" > - < / span > < span class = "si" > $< / span > < span class = "n" > message< / span > < span class = "s" > : < / span > < span class = "si" > $< / span > < span class = "n" > throwable< / span > < span class = "s" > " < / span > < span class = "p" > )< / span >
< / span > < span id = "__span-4-5" > < a id = "__codelineno-4-5" name = "__codelineno-4-5" href = "#__codelineno-4-5" > < / a > < span class = "w" > < / span > < span class = "p" > }< / span >
< / span > < span id = "__span-4-6" > < a id = "__codelineno-4-6" name = "__codelineno-4-6" href = "#__codelineno-4-6" > < / a > < span class = "p" > )< / span >
< / span > < / code > < / pre > < / div >
2023-06-10 07:45:52 +00:00
< p > Additionally you may use one of several different settings:< / p >
< ul >
< li > < code > minLoggingLevel< / code > - minimal logging level for the log which will be logged. The order of log level is next:< / li >
< li > DEBUG< / li >
< li > VERBOSE< / li >
< li > INFO< / li >
< li > WARNING< / li >
< li > ERROR< / li >
< li > ASSERT< / li >
< li > < code > levels< / code > - and iterable with the levels which should be logged< / li >
< li > < code > firstLevel< / code > ,< code > secondLevel< / code > ,< code > otherLevels< / code > - as < code > levels< / code > , but < code > vararg< / code > :)< / li >
< / ul >
< p > In case you are passing < code > minLoggingLevel< / code > , the < strong > level and more important levels< / strong > will be passed to logs. For example, when you are settings up your logger as in next snippet:< / p >
2023-06-10 07:53:25 +00:00
< div class = "language-kotlin highlight" > < pre > < span > < / span > < code > < span id = "__span-5-1" > < a id = "__codelineno-5-1" name = "__codelineno-5-1" href = "#__codelineno-5-1" > < / a > < span class = "kd" > val< / span > < span class = "w" > < / span > < span class = "nv" > logger< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "n" > KSLog< / span > < span class = "p" > (< / span >
< / span > < span id = "__span-5-2" > < a id = "__codelineno-5-2" name = "__codelineno-5-2" href = "#__codelineno-5-2" > < / a > < span class = "w" > < / span > < span class = "s" > " exampleTag" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-5-3" > < a id = "__codelineno-5-3" name = "__codelineno-5-3" href = "#__codelineno-5-3" > < / a > < span class = "w" > < / span > < span class = "n" > minLoggingLevel< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "n" > LogLevel< / span > < span class = "p" > .< / span > < span class = "na" > INFO< / span >
< / span > < span id = "__span-5-4" > < a id = "__codelineno-5-4" name = "__codelineno-5-4" href = "#__codelineno-5-4" > < / a > < span class = "p" > )< / span >
< / span > < / code > < / pre > < / div >
2023-06-10 07:45:52 +00:00
< p > The next levels will be logged with < code > logger< / code > :< / p >
< ul >
< li > < code > INFO< / code > < / li >
< li > < code > WARNING< / code > < / li >
< li > < code > ERROR< / code > < / li >
< li > < code > ASSERT< / code > < / li >
< / ul >
< h2 id = "special-loggers" > Special loggers< a class = "headerlink" href = "#special-loggers" title = "Permanent link" > ¶ < / a > < / h2 >
< h3 id = "callbackkslog" > CallbackKSLog< a class = "headerlink" href = "#callbackkslog" title = "Permanent link" > ¶ < / a > < / h3 >
< p > It is logger which will call incoming < code > performLogCallback< / code > on each logging. This logger can be create simply with one callback:< / p >
2023-06-10 07:53:25 +00:00
< div class = "language-kotlin highlight" > < pre > < span > < / span > < code > < span id = "__span-6-1" > < a id = "__codelineno-6-1" name = "__codelineno-6-1" href = "#__codelineno-6-1" > < / a > < span class = "n" > KSLog< / span > < span class = "w" > < / span > < span class = "p" > {< / span > < span class = "w" > < / span > < span class = "n" > level< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "n" > tag< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "n" > message< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "n" > throwable< / span > < span class = "w" > < / span > < span class = "o" > -> < / span >
< / span > < span id = "__span-6-2" > < a id = "__codelineno-6-2" name = "__codelineno-6-2" href = "#__codelineno-6-2" > < / a > < span class = "w" > < / span > < span class = "n" > println< / span > < span class = "p" > (< / span > < span class = "s" > " [< / span > < span class = "si" > $< / span > < span class = "n" > level< / span > < span class = "s" > ] < / span > < span class = "si" > $< / span > < span class = "n" > tag< / span > < span class = "s" > - < / span > < span class = "si" > $< / span > < span class = "n" > message< / span > < span class = "s" > : < / span > < span class = "si" > $< / span > < span class = "n" > throwable< / span > < span class = "s" > " < / span > < span class = "p" > )< / span >
< / span > < span id = "__span-6-3" > < a id = "__codelineno-6-3" name = "__codelineno-6-3" href = "#__codelineno-6-3" > < / a > < span class = "p" > }< / span >
< / span > < / code > < / pre > < / div >
2023-06-10 07:45:52 +00:00
< h3 id = "taglogger" > TagLogger< a class = "headerlink" href = "#taglogger" title = "Permanent link" > ¶ < / a > < / h3 >
< p > It is simple value class which can be used for zero-cost usage of some tag and calling for < code > KSLog.default< / code > . For example, if you will create tag logger with next code:< / p >
2023-06-10 07:53:25 +00:00
< div class = "language-kotlin highlight" > < pre > < span > < / span > < code > < span id = "__span-7-1" > < a id = "__codelineno-7-1" name = "__codelineno-7-1" href = "#__codelineno-7-1" > < / a > < span class = "kd" > val< / span > < span class = "w" > < / span > < span class = "nv" > logger< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "n" > TagLogger< / span > < span class = "p" > (< / span > < span class = "s" > " tagLoggerTag" < / span > < span class = "p" > )< / span >
< / span > < / code > < / pre > < / div >
2023-06-10 07:45:52 +00:00
< p > The < code > logger< / code > will call < code > KSLog.default< / code > with the tag < code > tagLoggerTag< / code > on each calling of logging.< / p >
< h3 id = "filterkslog" > FilterKSLog< a class = "headerlink" href = "#filterkslog" title = "Permanent link" > ¶ < / a > < / h3 >
< p > This pretty simple logger will call its < code > fallbackLogger< / code > only in cases when incoming < code > messageFilter< / code > will return true for logging:< / p >
2023-06-10 07:53:25 +00:00
< div class = "language-kotlin highlight" > < pre > < span > < / span > < code > < span id = "__span-8-1" > < a id = "__codelineno-8-1" name = "__codelineno-8-1" href = "#__codelineno-8-1" > < / a > < span class = "kd" > val< / span > < span class = "w" > < / span > < span class = "nv" > baseLogger< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "n" > KSLog< / span > < span class = "p" > (< / span > < span class = "s" > " base" < / span > < span class = "p" > )< / span > < span class = "w" > < / span > < span class = "c1" > // log everything with the tag `base` if not set other< / span >
< / span > < span id = "__span-8-2" > < a id = "__codelineno-8-2" name = "__codelineno-8-2" href = "#__codelineno-8-2" > < / a > < span class = "kd" > val< / span > < span class = "w" > < / span > < span class = "nv" > filtered< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "n" > baseLogger< / span > < span class = "p" > .< / span > < span class = "na" > filtered< / span > < span class = "w" > < / span > < span class = "p" > {< / span > < span class = "w" > < / span > < span class = "n" > _< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "n" > t< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "n" > _< / span > < span class = "w" > < / span > < span class = "o" > -> < / span >
< / span > < span id = "__span-8-3" > < a id = "__codelineno-8-3" name = "__codelineno-8-3" href = "#__codelineno-8-3" > < / a > < span class = "w" > < / span > < span class = "n" > t< / span > < span class = "w" > < / span > < span class = "o" > ==< / span > < span class = "w" > < / span > < span class = "s" > " base" < / span >
< / span > < span id = "__span-8-4" > < a id = "__codelineno-8-4" name = "__codelineno-8-4" href = "#__codelineno-8-4" > < / a > < span class = "p" > }< / span >
< / span > < / code > < / pre > < / div >
2023-06-10 07:45:52 +00:00
< p > In the example above < code > baseLogger< / code > will perform logs in two ways: when it has been called directly or when we call log performing with the tag < code > "base"< / code > or < code > null< / code > . Besides, you can see there extension < code > filtered< / code > which allow to create < code > FilterKSLog< / code > logger with simple lambda.< / p >
< h3 id = "typedkslog" > TypedKSLog< a class = "headerlink" href = "#typedkslog" title = "Permanent link" > ¶ < / a > < / h3 >
< p > This logger accepts map of types with the target loggers. You may build this logger with the special simple DSL:< / p >
2023-06-10 07:53:25 +00:00
< div class = "language-kotlin highlight" > < pre > < span > < / span > < code > < span id = "__span-9-1" > < a id = "__codelineno-9-1" name = "__codelineno-9-1" href = "#__codelineno-9-1" > < / a > < span class = "kd" > val< / span > < span class = "w" > < / span > < span class = "nv" > baseLogger< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "n" > KSLog< / span > < span class = "p" > (< / span > < span class = "s" > " base" < / span > < span class = "p" > )< / span > < span class = "w" > < / span > < span class = "c1" > // log everything with the tag `base` if not set other< / span >
< / span > < span id = "__span-9-2" > < a id = "__codelineno-9-2" name = "__codelineno-9-2" href = "#__codelineno-9-2" > < / a > < span class = "kd" > val< / span > < span class = "w" > < / span > < span class = "nv" > typed< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "n" > buildTypedLogger< / span > < span class = "w" > < / span > < span class = "p" > {< / span >
< / span > < span id = "__span-9-3" > < a id = "__codelineno-9-3" name = "__codelineno-9-3" href = "#__codelineno-9-3" > < / a > < span class = "w" > < / span > < span class = "n" > on< / span > < span class = "o" > < < / span > < span class = "kt" > Int< / span > < span class = "o" > > < / span > < span class = "p" > (< / span > < span class = "n" > baseLogger< / span > < span class = "p" > )< / span > < span class = "w" > < / span > < span class = "c1" > // log all ints to the baseLogger< / span >
< / span > < span id = "__span-9-4" > < a id = "__codelineno-9-4" name = "__codelineno-9-4" href = "#__codelineno-9-4" > < / a > < span class = "w" > < / span > < span class = "n" > on< / span > < span class = "o" > < < / span > < span class = "kt" > Float< / span > < span class = "o" > > < / span > < span class = "w" > < / span > < span class = "p" > {< / span > < span class = "w" > < / span > < span class = "n" > _< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "n" > _< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "n" > message< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "n" > _< / span > < span class = "w" > < / span > < span class = "o" > -> < / span > < span class = "c1" > // log all floats to the passed logger< / span >
< / span > < span id = "__span-9-5" > < a id = "__codelineno-9-5" name = "__codelineno-9-5" href = "#__codelineno-9-5" > < / a > < span class = "w" > < / span > < span class = "n" > println< / span > < span class = "p" > (< / span > < span class = "n" > message< / span > < span class = "p" > .< / span > < span class = "na" > toString< / span > < span class = "p" > ())< / span > < span class = "w" > < / span > < span class = "c1" > // just print all floats< / span >
< / span > < span id = "__span-9-6" > < a id = "__codelineno-9-6" name = "__codelineno-9-6" href = "#__codelineno-9-6" > < / a > < span class = "w" > < / span > < span class = "p" > }< / span >
< / span > < span id = "__span-9-7" > < a id = "__codelineno-9-7" name = "__codelineno-9-7" href = "#__codelineno-9-7" > < / a > < span class = "w" > < / span > < span class = "n" > default< / span > < span class = "w" > < / span > < span class = "p" > {< / span > < span class = "w" > < / span > < span class = "n" > level< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "n" > tag< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "n" > message< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "n" > throwable< / span > < span class = "w" > < / span > < span class = "o" > -> < / span >
< / span > < span id = "__span-9-8" > < a id = "__codelineno-9-8" name = "__codelineno-9-8" href = "#__codelineno-9-8" > < / a > < span class = "w" > < / span > < span class = "n" > KSLog< / span > < span class = "p" > .< / span > < span class = "na" > performLog< / span > < span class = "p" > (< / span > < span class = "n" > level< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "n" > tag< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "n" > message< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "n" > throwable< / span > < span class = "p" > )< / span >
< / span > < span id = "__span-9-9" > < a id = "__codelineno-9-9" name = "__codelineno-9-9" href = "#__codelineno-9-9" > < / a > < span class = "w" > < / span > < span class = "p" > }< / span >
< / span > < span id = "__span-9-10" > < a id = "__codelineno-9-10" name = "__codelineno-9-10" href = "#__codelineno-9-10" > < / a > < span class = "p" > }< / span >
< / span > < / code > < / pre > < / div >
2023-06-10 07:45:52 +00:00
< h3 id = "automatical-loggers" > Automatical loggers< a class = "headerlink" href = "#automatical-loggers" title = "Permanent link" > ¶ < / a > < / h3 >
< p > There are two things which can be useful in your code: < code > logger< / code > and < code > logTag< / code > extensions. < code > logTag< / code > is the autocalculated by your object classname tag. < code > logger< / code > extension can be used with applying to any object like in the next snippet:< / p >
2023-06-10 07:53:25 +00:00
< div class = "language-kotlin highlight" > < pre > < span > < / span > < code > < span id = "__span-10-1" > < a id = "__codelineno-10-1" name = "__codelineno-10-1" href = "#__codelineno-10-1" > < / a > < span class = "kd" > class< / span > < span class = "w" > < / span > < span class = "nc" > SomeClass< / span > < span class = "w" > < / span > < span class = "p" > {< / span >
< / span > < span id = "__span-10-2" > < a id = "__codelineno-10-2" name = "__codelineno-10-2" href = "#__codelineno-10-2" > < / a > < span class = "w" > < / span > < span class = "k" > init< / span > < span class = "w" > < / span > < span class = "p" > {< / span >
< / span > < span id = "__span-10-3" > < a id = "__codelineno-10-3" name = "__codelineno-10-3" href = "#__codelineno-10-3" > < / a > < span class = "w" > < / span > < span class = "n" > logger< / span > < span class = "p" > .< / span > < span class = "na" > i< / span > < span class = "p" > (< / span > < span class = "s" > " inited" < / span > < span class = "p" > )< / span >
< / span > < span id = "__span-10-4" > < a id = "__codelineno-10-4" name = "__codelineno-10-4" href = "#__codelineno-10-4" > < / a > < span class = "w" > < / span > < span class = "p" > }< / span >
< / span > < span id = "__span-10-5" > < a id = "__codelineno-10-5" name = "__codelineno-10-5" href = "#__codelineno-10-5" > < / a > < span class = "p" > }< / span >
< / span > < / code > < / pre > < / div >
2023-06-10 07:45:52 +00:00
< p > The code above will trigger calling of logging in < code > KSLog.default< / code > with level < code > LogLevel.INFO< / code > using tag < code > SomeClass< / code > and message < code > "inited"< / code > . As you could have guessed, < code > logger< / code > is using < code > TagLogger< / code > with < code > logTag< / code > underhood and the most expensive operation here is automatical calculation of < code > logTag< / code > .< / p >
< ul >
< li > Extension < code > logger< / code > < / li >
< / ul >
< h2 id = "jvm-specific-setup" > JVM specific setup< a class = "headerlink" href = "#jvm-specific-setup" title = "Permanent link" > ¶ < / a > < / h2 >
< p > For JVM you may setup additionally use java loggers as the second parameter of < code > KSLog< / code > factory. For example:< / p >
2023-06-10 07:53:25 +00:00
< div class = "language-kotlin highlight" > < pre > < span > < / span > < code > < span id = "__span-11-1" > < a id = "__codelineno-11-1" name = "__codelineno-11-1" href = "#__codelineno-11-1" > < / a > < span class = "n" > KSLog< / span > < span class = "p" > (< / span >
< / span > < span id = "__span-11-2" > < a id = "__codelineno-11-2" name = "__codelineno-11-2" href = "#__codelineno-11-2" > < / a > < span class = "w" > < / span > < span class = "s" > " yourTag" < / span >
< / span > < span id = "__span-11-3" > < a id = "__codelineno-11-3" name = "__codelineno-11-3" href = "#__codelineno-11-3" > < / a > < span class = "w" > < / span > < span class = "n" > Logger< / span > < span class = "p" > .< / span > < span class = "na" > getLogger< / span > < span class = "p" > (< / span > < span class = "s" > " YourJavaLoggerName" < / span > < span class = "p" > )< / span >
< / span > < span id = "__span-11-4" > < a id = "__codelineno-11-4" name = "__codelineno-11-4" href = "#__codelineno-11-4" > < / a > < span class = "p" > )< / span >
< / span > < / code > < / pre > < / div >
2023-06-10 07:45:52 +00:00
2023-06-10 10:14:30 +00:00
2023-06-10 07:45:52 +00:00
< / article >
< / div >
< / div >
< button type = "button" class = "md-top md-icon" data-md-component = "top" hidden >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z" / > < / svg >
Back to top
< / button >
< / main >
< footer class = "md-footer" >
< nav class = "md-footer__inner md-grid" aria-label = "Footer" >
< a href = "index.html" class = "md-footer__link md-footer__link--prev" aria-label = "Previous: KSLog" rel = "prev" >
< div class = "md-footer__button md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z" / > < / svg >
< / div >
< div class = "md-footer__title" >
< span class = "md-footer__direction" >
Previous
< / span >
< div class = "md-ellipsis" >
KSLog
< / div >
< / div >
< / a >
< a href = "logging.html" class = "md-footer__link md-footer__link--next" aria-label = "Next: Logging" rel = "next" >
< div class = "md-footer__title" >
< span class = "md-footer__direction" >
Next
< / span >
< div class = "md-ellipsis" >
Logging
< / div >
< / div >
< div class = "md-footer__button md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z" / > < / svg >
< / div >
< / a >
< / nav >
< div class = "md-footer-meta md-typeset" >
< div class = "md-footer-meta__inner md-grid" >
< div class = "md-copyright" >
Made with
< a href = "https://squidfunk.github.io/mkdocs-material/" target = "_blank" rel = "noopener" >
Material for MkDocs
< / a >
< / div >
< / div >
< / div >
< / footer >
< / div >
< div class = "md-dialog" data-md-component = "dialog" >
< div class = "md-dialog__inner md-typeset" > < / div >
< / div >
< script id = "__config" type = "application/json" > { "base" : ".." , "features" : [ "announce.dismiss" , "content.action.edit" , "content.action.view" , "content.code.annotate" , "content.code.copy" , "content.tooltips" , "navigation.footer" , "navigation.indexes" , "navigation.sections" , "navigation.tabs" , "navigation.top" , "navigation.tracking" , "search.highlight" , "search.share" , "search.suggest" , "toc.follow" ] , "search" : "../assets/javascripts/workers/search.208ed371.min.js" , "translations" : { "clipboard.copied" : "Copied to clipboard" , "clipboard.copy" : "Copy to clipboard" , "search.result.more.one" : "1 more on this page" , "search.result.more.other" : "# more on this page" , "search.result.none" : "No matching documents" , "search.result.one" : "1 matching document" , "search.result.other" : "# matching documents" , "search.result.placeholder" : "Type to start searching" , "search.result.term.missing" : "Missing" , "select.version" : "Select version" } } < / script >
< script src = "../assets/javascripts/bundle.b4d07000.min.js" > < / script >
< / body >
< / html >
