diff --git a/LICENSE b/LICENSE index f436199..bb46ed3 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2023 Second Bounce Ltd +Copyright (c) 2023-24 Second Bounce Ltd Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index c8db01d..c7bd76b 100644 --- a/README.md +++ b/README.md @@ -6,37 +6,32 @@ log4ngx is a Typescript logging framework for Angular projects, based on concepts used in Log4j, Log4net, etc. -> **Current Status** -> The library is now complete enough to be used in production if the `ConsoleAppender` and -`LocalStorageAppender` are sufficient for your needs. Documentation is being completed in the -repository and will be updated as progress is made - as soon as it is in a reasonably complete -state, a proper link will be made available here. -> -> Until then, the [demo project](tree/main/projects/demo/) contains examples of configuring and -using the library. - ## Concepts +### Loggers + +`Loggers` provide access to the methods for logging messages at the required `Level`. Each class - +i.e. component, module or service - will usually define its own `Logger` which will identify that +class within any messages logged via it. + ### LogService The `LogService` is the factory with which you instantiate `Loggers` in each of the components, services, etc, in which you wish to log messages. Behind the scenes, it also orchestrates the dispatch of messages from the `Loggers` to the appropriate `Appenders`. +### Appenders + +`Appenders` are responsible for sending log entries to the underlying target or service. +Configuration will normally depend on the target/service, but all `Appenders` are configured with +the layout format for messages logged to them. + ### LogServiceConfig The `LogService` is configured using an instance of the `LogServiceConfig`, typically created in your application's main module. The configuration defines the parameters used with each `Appender` and how each `Appender` relates to the various `Loggers`. -### Loggers - -`Loggers` provide access to the methods for logging messages at the required `Level`. Each class - -i.e. component, module or service - will usually define its own `Logger` which will identify that -class within any messages logged via it. - -### Appenders - -`Appenders` are responsible for sending log entries to the underlying target or service. -Configuration will normally depend on the target/service, but all `Appenders` are configured with -the layout format for messages logged to them. +For more information about using and configuring log4ngx, see . +The [demo project](projects/demo/) also contains examples of configuring and using the +library. diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 74732f0..a74e408 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAACpWU0W6CMBSGX2XpNZubboZ4ZxgjZk6MmN0YQyoca7NaSCnGZPHdl6mIsNp213zn+09PT1l8Iwl7iQYoACkpJ3eRxEJCihyUY7lBA5RmSbkFLovOGYnPyMNGbhly0BflKRq4PdftP7oH52L0Mr6mpBRY0oyrfA3AZMvLFaPJPc5prdpmacmg6Jy+xTinTUvXQcmGslQAR4PFRTXMc+ApiCnDCWwyloIoainwcttQqvBWt1d9VnQtTBguClAqm5qnbmt8RcbAytdiLbQRiB1NwMZ6RnXSMeyAaV1HQqvIEswimQlM7M6sKtAHkGdO9h/HnTGYr0iD0maONWaQEeORfxGThHLi74BLo6oCdcJqsqe3WisplyDWOFHv9YluPcaX/u3tttMri3Qpqh2xi7pdqc+rbto2pckb3MS++5rV3kI4icKxHw+nU3/y6s/iefjuT2r7DguKV61frLqoGdPrXnceesNxNA9nw+CfUZpKbV4QR/7sc+T5sRdO3kaBZZi67E/S8rD8AdzRb5o4BwAA" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAACpWU0WqDMBSGX2Xk2q1by4p4J85JWdFSy25KkVRPNSwmEqMMRt99bK21ujS6a7/z/T85idsvJOFTIgt5ICVh6V0osZCQIAMVWGbIQgmPqxyYLCdnJDojD5nMKTLQB2EJssyZac4fzaNxMTqcHUhaCSwJZypfBxiyFdWekvgeF6RV5TypKJST07cIF6RrmRoozghNBDBkbS8quyiAJSBWFMeQcZqAKFspsCrvKFV4r+1Vz4ZuhTHFZQlKZVfzNO0dX8kpjPL1WJ12CTVQreyX0Cp4jGkoucDpuHqqAX1AGoKoSQwD2gYbkKWD/X6QIQlhqVsDk4OqBtQJm2M4vYFWSZgEccCx+r6c6N4lf57fvjXj9MohXYpqoeOibk/q85pNj03p8gPudHz7ltVuIfDDYOlG9mrl+i/uOtoEb67f2mssCN73fl3qoW7MbHrdPHDsZbgJ1rb3zyjNpDbPi0J3/b5w3MgJ/NeFNzJMPfYnaXfcfQOoYWhfkAYAAA==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 07bbae1..584d455 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACr2dXW/buBKG/8qBcuvNih+ipNwVbbYottsuNj17ExSB1lZco/4IbCXbnqD//YASZc2QQ4uS1VyljTUzL6WHw9HQUp6j/e7fQ3R1+xx9XW0X0VUmskzF2SzaFpsyuorellW12i7/c1MV+6pcRLPocb+OrqLFbv64KbfV4VdzxJ054vJLtVlHs2i+Lg6H8hBdRdGPmc/76932frV83BfVarclfKPPT3rmR58Pj/+sV/NfiofV0eFmt3hcl4dfm4/uiofVSV+MdwpfPTyU20W5P/oyFtBXewzhdBY9FPtyW2FdXaiEdcLnu+2h2j/Oq114tAts1Bf5aAzPXCy74Rb159dP2jBYAzbqNFSHxS+rwy8P+11Vzht4xmhabVfVqliv/leGS0I2o86K4kzKo4b6R3B0c/QEcde75W+7/aYYcDWgyQQKyv1+tx+qARtNROVQIKeIvK8/fb9bLlfb5cBpQdpOPjuaKNf6hA+V1hpNocnNmH+ui3n5ZbdelPvDUVm5fdyQuuDRI/IoU8f478uncj0i4EVrGAwNGiGtZbdcgrVjiJjWckI1f5SHQ7Esx8jpTCfU82m1KQ9VsXkYowgaT6jpTVGNOkHGbkIl7w67sWI60wn13HzZ7auxiqDxxFerWm1GXzFjOzHTY3GeVsl/q/nYq9WZTqgHL1ED1LjL1DRaPhTjLhU0nlrTGSnasp9a2U1VzL+O1tVaT6jq9X59P0aPsZtylR+l4/0UKniinMKruWk+Slptq3J/X8zperA5eEzFFXPP7VFwwMH3SWZkHhEP+93TalHuP+2+ltsRamz7iWS5t3Dhkkbdy52WQ93PhQsaeWPnSuKoCXTYrcuQTot16Ms0XKigQ/su9hjPanWQgoZ1PAL1BLaDSEFndoVOKBzWmiHFOZnHqFptv5T71QSqgho3pDR6zk+tL7CtQyr0JYHzNQ5r+pzA7ifqGtYSIjUO7Az952cMoLdjdEJ5f+PofMmiy9OvP364+fj++u7Vn39ef3hz/dfdp4+/X384an8q9qviH6u/T9uMWDBghWWpDSq0SJsXqLf8cadKftNVYye0+ouynyE6tFY7IXjK9D1VJXdC7rS5PKTOuyn3T6t5yJJtjnzRKg/GHFnktQP0pN9F+c/jcqiS1mgiDWVg8kcaytA+TJiG1fZ+N1SCsZlIwXo3+Do0JhPFr/bF4Hlw0RpNpOHfYr8dKsHYjFcAswLeriEU1Aecu2Du7u/DYlw0R/aOrZHtiXZfVEXgmC7aY8+L2DuhQcTgeXwyYh84IGAoLyfj9aULEC80S5yM15umQcDg7GxHxDc8i5N3OyBec+R50ZZlNWDqXYDDzzuvT8X68WTSA0HbY8+L2NcgAAFDG5LOmcU314vV4WFdfP8QHhhbDB8vTKi7ebG+qXb7YhnUU6OOf5mSyxt5aOFFDtl7deaPe+3i9/L7SHHQfmJtX8vvf+7L+9W3cdKg+cTK1rvl9bbaf39TrlebVTWSqQvKzcRKN8W3N8X3wzh9nfHZqoY3dv2yhnV3hygLbPH6pZ3Z5x12bXtzuVfm2KbH4FnS31Q9OTvG34sPUxrYAPZrPbNzMJzRc/D82QqHNYX9an9SZ3j4UHrbw31jmK5H3CMeNIrff3z96v3Np49/vXo7rFt8wvDMljElPqhv7Dc8917YrTFGKTi/2OjtxXoKjnFyJ6s8Tsu2q49xYs8sQ05LDNg96NM35Wo63T5Cn+qzNxNGURzUog+gd9q1dqq9hT7hP6FMcKTjhLs0DcfANIsPPze5ruvvbfdPfyLqRWcbMOmtUXrkFOaUjRMErc+RhJbot3c313/9/e719d3rjx9+e/c2bH2mrcZcLdQqWQbsRnVHvVRbZHnOLhQY1InWH34wIUAFNJpAg254FdX8yxAJwGacAuva95+B5cu1wo6xRlzvJSqIhzU/QeDg7qcdEd+sHQ7lvuf2p4t5PPrMqP3tehA0vF9/MmbvlgQIGbwncTJi76YLiBi863IyYv/GEggZvrN0Mmb/9hmIGb5/djJmz14wjBi4B+zGS+wHw0IrlOVUt35NhfEhpP63gl4g08DB95TGaPspWEfwLlSAhLbA0cMKKJEsKbb1aEnWshTWQuqOe7klCkUcs1Adh+a5IJXzSGCQkmrIw4AhOta9W6OOhkFg9sZ3J2qYiMGztE/JxnoiKUjGJvwxpBANQYsQVjBoKaLi4zkpt8tvf9RvkeiR0R34YrPSCjliWoLR/fg8i1bbRfktunqOnsr9Qb+Y4yril+Iyj2bR/apcL/T7QtrCcr7bbJpU1b61I/psDvu71BL0wc3Rv8bR7DaeCXaZimTGzD8+f57dtl7qI+pftM6639QeWDS75TMpL5McGzLHkCFDHs1uRRtaUqG544EjDyKa3SZUaOEYCmQoo9mtmvH0kokUGUrHUCLDJJrdpjOhLmOVIcPEMUyQoYpmtxllqBxDhQzTaHabU1JTxzBFhlk0u2XxjOeXmWWZOZYZssy1JaMsc8cyxyxoNBinxslcjpgFksaDCdKYYAnDxDQZTJLGLkYMc8Q0HYwkibkoMcwS04QwNRPiMhFWZBcnhnlimhKWzkR+KROJjV2kGGaKaVJYRhq7WDHMFdO0sJw0dtFimC2mgeExecJcuhjGi2lmOCONXcAYJoxrZjiZb7hLGMeE8TpXCdLYJYxb6UozwyVpTCQqTBjXzHCSMO4SxjFhXDPDlc6QCcOEcZcwjgnjmhmekpFdwjgmjGtmeEYau4RxTBjXzPCcNHYJ45gwrpkRJGHcJYxjwrhmRpCEcZcwjgkTmhlBEiZcwgQmTDBfuhYuYAIDJuoFkcx/wgVMWEuh8KZ7QayGGDAhvRlfuIAJDJjQyAhyXggXMIEBE8q3EguXL4H5EqlvTRUuXgLjJTLfQi5cugSmS+Tea+zCJTBcMvZeJunCJTFcknkvk3Tpkpguyb1Ls3TpkpguKbxLs3TpklaxJb1LsyTqLUyXrOkiE6d06ZKYLqmBEYo0dvGSGC/prbyki5fEeMnMO5Wly5fEfMncz4gLmMSAJbGXkcQFLMGAJRoZQa4ViQtYggFLuG8qJy5fCeYr0cQIci4nLl8J5ivxL4+Jy1diFfQ1XzkZmajpMV+JJkbGVA2VuHwlmK9EIyPJRSpxAUswYIlGRpKzOXEBSzBgSe6tWBMXsAQDpjQykqyhlAuYwoApjYyU1AlTLmAKA6a49zorlzCFCVPCe8KUS5jChCnphUS5hClMmEq8bCuXMGXdNtaEkelPEXeOmDBVE0amP+USpjBhqiaMzAXKJUxhwpR3iVQuYAoDltaAkTVn6gKWYsDSGjCy5kxdwFIMWOrNYKnLV4r5SuteBFmvpi5fKeYr1cQkjJoWqctXivlKNTEJJ41dvlLMV6qJSQRp7PKVWq0JbwGWEs0JjFfqLcBSl64U05V66UpdulJMV+YvwDKXrgzTlfkLsMylK8N0Zf4CLHPxyjBemb8Ay1y8MoxX5i/AMhevDOOV1XiR5X3m4pVhvLIaLzJ9ZS5eGcYrS72zInP5yqzuV+adFRnR/8KAZbl3VmQuYRkmLI99dOYuYDkGLGfeujF3AcsxYDn3op27gOUYsFz4m34uYDkGLK/zF7nQ5C5gOQYsrwEjF5rcBSzHgOU1YORikbuA5RiwvAaMXCxyF7AcA5ZrZBSZ8HMXsNzqsOa+lSYnWqx2j1Uzo+j+WUx1Wa02a6yxUXTLPiYarbHVaY25v2cZE73W2Gq2xsI3+OYj29xqt8bSN7+aj2xzq+Eaa4AUWb82n9n2Vs81Vt5yrvnMtrfarnHqrSWbz2x7q/Ma+yv/5jPb3mq+xrm3im4+s+0t+uqmPV3CM6rH7zT5mfeeiZFtfou+unWvyPWIUZ1+u9Vfd+9VQscn8LO7/afa/VS/32741z18ReZKRrX87Z5/3cZXZLpkVNffbvvXnXx69lF9f7vxX/fyPdsGVOvf7v0z/70no7r/Vvuf1R19z+UjNgCYtQPA6qa+Z8+E2ANg1iYA4/6bUEZsAzBrH4DVrX1FLliM2Alg1lYA496tS0bsBbS/qzeQn0r9tyDeNRvJt7fNs+3P0Z3ZWpZJu8/9HCkVXT3/+NFtJV89/wC7yfozHaf+ew7AQ+eAB9o3z4F1LrrN9ueIxY2Z5M3PbIhT/TXSzi0YmhjkZG6+Dda5EkChiAc52zbfSep8KQVGy5JBzh7Qq9zBGQRjZcMGi/wkWecnD8Wh9tN8TarzlHaOksZSZM3PNAvza76PCk6cgJiEnbg5/rsmnTOIXKgn/Q6Vu/a83VXNsysAEnARZLA87ZSiV4CJJUZ5IzAG6Mmwy2t8Htpv5wNn8BKHn8PjF2LAhQWqDCuq+ZmYLJCan3ne/NT1YfMPlpp/cBkmoX7pMBhFDPJXGJnmtQNf9WsHwNQBjtKwKbioX+0NmAQuWJiWxfHd6cANmCc87MKY72GD0wISQWLOtUrakx+GTveUALjUKNUHimteyVGbwYUHSEzDcrL5Lho4VQA9bthLzE/F2+G20PGwtaiOcm8etAI5moHcajA3oSQzoc3il5n/52Ec1QGP3/QDowNniIdds9qVfaY5mOk8LBXVfg7Nu8aBoxw4SoMcmW+Vg8sO8qJibRYIu/7LsjJfDgX+AAIqTJN2Yx5aAWQzSHawHv0Xu6AbkALCfDTPM4CZC85xYmaski3KYQOEL7noPAOaTHoWJvmmgW4POyflwbOWB3n5Wn5/ME87g+wL/KRmtFmYKocIBgu0Nim0OaD9BQtUa602QCYPdKCfuzw0z12eKD4SMC2ysDkKPVMViAQkpWGpmnLpliEJKJSysLxUP+oBpIFpkqj2ioRqrL9muzFfIgYzGACub8ECnd2Z2uiuGShxacB5zAOZ3C1L/Yj8ontEHvgDa2hqZngWVi6sd0tiYQIn09Towiz5sr0bM/hn5v952EroZkkGlhJ2rCeGeHNxUgB93fkJ92UvdAreRrG2xORhifj40DC4UmC0eeikrL8F79xPKXjiWPCkIep2BS53HoyNcURMZpAt87AafFN8W9TvVABeQM2amgmdhSVIovBhcCa36SGwFLaZgEnQTA5TdQgzKaT5vTL/T83PPG75Djst9QsvQY4Dp0SFIdi+VsG9NQW+hKlrpZnredh5aR5UQE6Hdn6a99E4RTiD87cV167hYaeu8eybOww2DszFk2Z2Z2F5/qD/bJZTvIBEHJgkDu1fbwXqhlZ8zv0ebMGFXQnwmBYQAlA/3lYH3oeal+ECesGwkrBF77GaO2cYJOTAFfmpeVUlUAIypwobTfPELnABLnRipo1ql4c4wOfnWfSweijXq20ZXd1+/vHj/xBao1TvdwAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACr2dXW/buBKG/8pCufVmxQ9RUu6KNlsU29MWTc/eGEWgtRVXqG0ZspJtT9D/fkCJsmc0pE3Jaq+8G2uGL8mHw+FIcp+Dqvx3H9zMn4OvxXYZ3CQiSVSYzIJttsmDm+B1XtfFdvXbXZ1Vdb4MZsFjtQ5ugmW5eNzk23r/h7ni3lxx/aXerINZsFhn+32+D26C4MfM5f1luX0oVo9VVhfl1uIbfX/SMz/43D3+sy4Wv2e74uBwUy4f1/n+j/ar+2xXnPTF+FHhi90u3y7z6uDLWEBf3TUWp7Ngl1X5tsa6jk1F7Ch8UW73dfW4qEv/1q6w0bmWD8Zw5EJ57G7WfH/7pA29NWCjo4Z6v/y92P++q8o6X7TwjNFUbIu6yNbF/3J/Schm1KgozqQ8aGg+vFs3V0/Q7rpc/VlWm2zAbECTCRTkVVVWQzVgo4moHArkFC1Xzbdvy9Wq2K4GLgur7eSro23lVg/4UGmd0RSaaMT8sM4W+Zdyvcyr/UFZvn3cWHXBq0fEUaYO7b/Nn/L1iAavOkNvaFAP7VrK1QrsHUPEdJYTqvlPvt9nq3yMnKPphHo+FZt8X2eb3RhF0HhCTa+yetQAGbsJlbzZl2PFHE0n1HP3pazqsYqg8cSzVReb0TNmbCdmeizO0yr5b70YO1tH0wn14C1qgBq6TU2j5V02bqqg8dSaLgjRPfupld3V2eLraF2d9YSqXlbrhzF6jN2Uu/woHW+nUMEjRRKv9tB8kFRs67x6yBb2fLC9eEzGFXLH8ci7wcHnJNMzh4hdVT4Vy7z6VH7NtyPU9O0nkkWPcP6SRp3lTsuxnef8BY082FFJHBWB9uU696m09C79NQUXW6ND6y79Pl5U6rAKGlbx8NTjWQ6yCrqwKnRC4bDSjFUciTxGVbH9klfFBKq8CjdWafY1P7U+z7KOVaErCFyucVjR5wR2P1HXsJKQVePAytBvP6MDZytGJ5SfLxxdLlkc4/TL9+/u3r+9vX/x4cPtu1e3H+8/vf/r9t1B+1NWFdk/vfq+3WbEhgEzrJ5ar0TLavML8i13u1MFv+mysRNa3UnZzxDtm6udEDxl+J4qkzshd9pYfjLPw4VZS8RpLrh0aZQPD35tXLVXnk2VWtmO1h6yOvPs01V37WUt5ufiNmgx962cnGzx36zaejZoLr2svWL7UHq2Zy69rL1l/s/jyrPB7trBLeLUZnkyrwHttVde1toqrwcsvStw+WXj+pStH09m5qDR7trLWjx3FAAN+pYeyMjiNHpZ7Hfr7Ps7/4axxfD+woBaLrL1XV1W2crr9Gy7/tccoZ0tDz1HW7vsnJ3FY6Vd/JV/HykO2k+s7Wv+/UOVPxTfxkmD5hMrW5er221dfX+Vr4tNUY9k6srmZmKlm+zbq+z7fpy+o/HFqoaXcNyyhtVxhijzLOa4pV1Y0Rk2t2djuVPm2OPN4FVyvnxycnWMz7qHKfUs9bi1XnhGGM7oJXj+bIXDyj9utT+pBjS8K2cLQef6MF016Ix4UBJ6+/7li7d3n95/fPF6WF3ohOGFxSGbeK8Kkdvw0rMwzTFGKbg82ThbdXEkHOPkTpZ5nJbdzz7Gib0wDTkt0aNOeE7flLvpdBXDc6ovLhuOotirGOdB77R77VRVxHPCf0KaQKTjgLu6y6unYpF7hll8+aXBdd08oXl++VtavTraeiz6Xi8dcjIzZOMEQetLJKEt+vX93e3Hv9+8vL1/+f7dn29e++3Pdqsxs4VKJZ3k05lOd9WvKoug9oYXQw6dcmR4C/P+zJBeX0GjCTToeiJ+DNpDAzSaQIMuumX14ssQCcBmnIIef+dHYPXrynGHtkYwt0JJ+bACLGjYuwLbbxEfGPf7vDpzBDu2ebj6wlbP3zIAjfrfMzjZ5tnbIqBJ7/siJ1s8e+MHtOh95+dki+dvboEm/e9unWzz/C080Kb/PbyTba5Lb3raS0e0F/VfQ/HNklZTHT/bLOedzxmk1+gVMvXs/Jn0HN0C89bhfSfMQ0KXZOlueaRpPSl969GSetuSXxnreN2v26JQi2M2qkPXHBNSkxeQvJTUQ1498tGxPnt7lmgYBObZ9ulC9RMxeJWeU7Lpvf/gJWPj/9KDjwavTQgrGLQVHdv/PAuK7TL/Ftw8B095tdcvwd8E/Fpcp8EseCjy9VK/m9+lVYtys2kXaveGfPDZXPZ3rteFvri9+o8wmM3DmWDXnKsZM//x+fNs3nlprmj+0Dk7/qXxwILZnM+kuE5ihgwZMWTIkAezueialramOfHAkQcRzOaRrWlBDAUylMFsrmY8vWYhblESQ4kMo2A2j2ciuhYiRYYRMYyQoQpm88RmqIihQoZxMJunM66uZSiRYUwMY2SYBLM5C22dTIhlgixTbclslimxTDELGg3Gbf1klCPWA0njwYTV2MISholpMpi0GlOMGOaIaTqYlSRGUWKYJaYJYWom+HUSJtiY4sQwT0xTwuKZSK5jHmNjihTDTDFNCkusxhQrhrlimhaWWo0pWgyzxTQwPLQOGKWLYbyYZoYzqzEFjGHCuGaGW+MNp4RxTBhvYpWwGlPCeC9caWa4tBpbAhUmjGtmuJUwTgnjmDCumeFWwjgljGPCuGaGx9aWKWEcE8Y1MzyxGlPCOCaMa2Z4ajWmhHFMGNfMCCthnBLGMWFcMyOshHFKGMeECc2MsBImKGECEyaYK1wLCpjAgIlmQ7TGP0EBE72tUDjDvbDshhgwIZ0RX1DABAZMaGSEdV0ICpjAgAnl2okF5UtgvkTs2lMFxUtgvETi2sgFpUtgukTqnGMKl8BwydA5TZLCJTFckjmnSVK6JKZLcufWLCldEtMlhXNrlpQu2Uu2pHNrlpZ8C9MlG7qsgVNSuiSmS2pghLIaU7wkxks6My9J8ZIYL5k4l7KkfEnMl0zdjFDAJAYsCp2MRBSwCAMWMWcqE1HAIgxY1IQv60YTUcAiDFikkRHWVCaigEUYsMi9P0YUsKiX0TeAWfOgyJLUY8AijYwMrcYUsAgDFmlmJLMaU8IiTFikmZHWXSqihEWYsEgzI615UEQJizBhSjMjrfFeUcIUJkw590dFAVMYMKWRkdZQoChgCgOmNDLSGgoUBUxhwJTzvKgoXwrzpTQx0rosFOVL9U6NDV/WZaEsB0fMl2r4spKtKF8K86U0MZGVbEX5UpgvlTpPuxQvhfGKQ9fOHFO6YkxX7KQrpnTFmK6YO6NuTOmKMV2xcEbdmNIVY7pi6dyZY4pXjPGKI+fOHFO8YoxXrJw7c0zxinuFCQ1MZE2yY0ttAuMVN3hZw1dM8YoxXnHqXBUx5SvGfCWhc1UkFLAEA5Yw56pIKGEJJizhLjoTCliCAUuEM6FIKGAJBiyR7lIQBSzBgCWRE+2EApZgwBKNTGTdaBIKWIIBSxrArBtNQgFLetWvBjDrZpFY6l8YsEQjE1k3i4QClmDAUo1MZA34KQUsxYClzLXTpJSvFPOVamQi62E9pYClGLC0qaVaD+spBSzFgKXN/mg9rKcUsBQDlrpLYCkFLMWApc7zY0r5SjFfqTPBTyleKcYr1cAoa/BLKV5pr76aOhO/1FJh7ZdYQ2fO2X6HzcHfjD1zJrztd337XqE15M5su/2ub9+rtYbuVL/9rm/fK7eGDWz2Ow6hpeAa9iquoSZIWWNS+13fvld0DRvkpF2/pewa9uquYeyuF4eWymvYK72GDXr2YnVoKb6GveprqHlS1uDWfte37/HXVO2tS47ZavykyM/cdWdrmb+HX1votw+frdLfL/U31XvH9NmK/f1qf1vut+Nrq/f3C/5NDd+xfGwlf/O35hbgU65/OftNeytwPm/fD34O7s3NQXm4e/4cRElw8/zjx/Fm4M3zD3A/UH+n22l+/Rp4ODrgnvbtuzRHFwyIYGFrJnn7GcsBTvVjcEe30dGrGORkYZ5mOboSQKEIBznbts9UHH2pCPbWd8xbZzv0w7dgBKHPYZ1FfiLgJxkkrX3M4+gpBly1liIxM+o5fuZ5OjBw7Ogz9RPXPW9qfgT+6AsSN8hTjoYrAYr86F+0v2px3w3/fd2+RgBYA3MgoyFObYtAgPUpRnmzrAYFFCpvn4cnbMCUAkeGEtV+KvP/KTOf5u+M+eGzaH6KEWgOQZzyhKd9RfurfkUbxDtAtvIb0GXzg6cAPqCF+WlZHn5RFrgRoEt+FJvnRUFvwJqKYjPUqZ+vw0PMYD5Bz1K/yG1+tKCxgsLAKlB+S8s8KQMGCODFDU+R+dQ5pgHKbxIb7w/mFRQQeWFQMgibJqRBNzJbWizaz2RAg4fnj0CvQNDhfquvcdUfYQ5A5gMk7dvfWwWOUuAo9nJknnUFyxN0KhLdFPntZKu8No+sAXzA2oj8eNZuzKP0IMKDvqXecvQ/WgK9gFXhF73ah6xBd4CHqIuEoa+v41v/R49gvI0/YZa/8huuYl+SuAbWAvPz8jX/vjOvf4LeQnFGXeznj4DAQAxgXQxg3QjGXQzwizC9LQV0l3vK0y+i7dsX0U6kABHwHPutKOjZlgdIMA7KD2SbS5oMRCCViv02s+a5c7BpoPTfb9dYl6v7fftazH2ryTKKoMuJ7/yscv167/L4ei8YQhALlCEn8VuD63Jl2TrAoja5sTChT3anILOlxGazSrxHpxfHGAj2zCTkqV/Qb53RiVcCTtsQX/2dSEno6ZDo+VJq3ncEEw/8Jb7Lp3l4lhxjFAwfoTdE++6FQCAKzEDqTY1xZFl2YPQTvyxgk31bNq+DAy8AQWUYTPxSSUtmwkDcZodp9EO2zwRYa2apCRO1hVkTstuvzN9j85mYtZL6zXzzU30gqMODq9+u0L0QTk9yYI6EUSW7Ufaju32+GzkdWm9pf0mDJMcMLrpOnNkgYz+gWs+upcNgfDBzI018i/3CxV7/0x4kywDbBfdbSPvuX5gD6oamZOT0BQtffjMBXu4AQgDp7JCP+K3Bx3pBRgecm7gfY0/tD+SBjQ50TfmNTvuOHqAU9CqKunTLo1efZ8Gu2OXrYpsHN/PPP378H0D0fnJHcAAA"; \ No newline at end of file diff --git a/docs/classes/public_api.Appender.html b/docs/classes/public_api.Appender.html index 0d5e851..f35768e 100644 --- a/docs/classes/public_api.Appender.html +++ b/docs/classes/public_api.Appender.html @@ -1,4 +1,4 @@ -Appender | log4ngx

Class AppenderAbstract

Hierarchy (view full)

Constructors

constructor +Appender | log4ngx

Class AppenderAbstract

Hierarchy (view full)

Constructors

constructor

Accessors

errorFormat logFormat name @@ -7,4 +7,4 @@ initialize renderError renderLoggingEvent -

Constructors

constructor

Accessors

errorFormat

logFormat

name

Methods

append

Protected AbstractappendEvent

initialize

ProtectedrenderError

ProtectedrenderLoggingEvent

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Constructors

constructor

Accessors

errorFormat

logFormat

name

Methods

append

Protected AbstractappendEvent

initialize

ProtectedrenderError

ProtectedrenderLoggingEvent

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/docs/classes/public_api.ConsoleAppender.html b/docs/classes/public_api.ConsoleAppender.html index e0cb18a..ea8e729 100644 --- a/docs/classes/public_api.ConsoleAppender.html +++ b/docs/classes/public_api.ConsoleAppender.html @@ -1,4 +1,4 @@ -ConsoleAppender | log4ngx

Class ConsoleAppender

Hierarchy (view full)

Constructors

constructor +ConsoleAppender | log4ngx

Class ConsoleAppender

Hierarchy (view full)

Constructors

constructor

Accessors

errorFormat logFormat name @@ -7,4 +7,4 @@ initialize renderError renderLoggingEvent -

Constructors

constructor

Accessors

errorFormat

logFormat

name

Methods

append

ProtectedappendEvent

initialize

ProtectedrenderError

ProtectedrenderLoggingEvent

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Constructors

constructor

Accessors

errorFormat

logFormat

name

Methods

append

ProtectedappendEvent

initialize

ProtectedrenderError

ProtectedrenderLoggingEvent

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/docs/classes/public_api.Level.html b/docs/classes/public_api.Level.html index 0fda15c..cc671be 100644 --- a/docs/classes/public_api.Level.html +++ b/docs/classes/public_api.Level.html @@ -1,4 +1,4 @@ -Level | log4ngx

Class Level

Properties

name +Level | log4ngx

Class Level

Properties

name value debug error @@ -9,4 +9,4 @@

Accessors

displayName

Methods

add getLevel -

Properties

Readonlyname

name: string

Readonlyvalue

value: number

Static Readonlydebug

debug: Level = ...

Static Readonlyerror

error: Level = ...

Static Readonlyfatal

fatal: Level = ...

Static Readonlyinfo

info: Level = ...

Static Readonlyoff

off: Level = ...

Static Readonlywarn

warn: Level = ...

Accessors

displayName

  • get displayName(): string

  • Returns string

  • set displayName(displayName): void

  • Parameters

    • displayName: string

    Returns void

Methods

Staticadd

  • add(value, name, displayName): Level

  • Parameters

    • value: number
    • name: string
    • displayName: string

    Returns Level

StaticgetLevel

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
+

Properties

Readonlyname

name: string

Readonlyvalue

value: number

Static Readonlydebug

debug: Level = ...

Static Readonlyerror

error: Level = ...

Static Readonlyfatal

fatal: Level = ...

Static Readonlyinfo

info: Level = ...

Static Readonlyoff

off: Level = ...

Static Readonlywarn

warn: Level = ...

Accessors

displayName

  • get displayName(): string

  • Returns string

  • set displayName(displayName): void

  • Parameters

    • displayName: string

    Returns void

Methods

Staticadd

  • add(value, name, displayName): Level

  • Parameters

    • value: number
    • name: string
    • displayName: string

    Returns Level

StaticgetLevel

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
diff --git a/docs/classes/public_api.LocalStorageAppender.html b/docs/classes/public_api.LocalStorageAppender.html index 4b43e04..ec14788 100644 --- a/docs/classes/public_api.LocalStorageAppender.html +++ b/docs/classes/public_api.LocalStorageAppender.html @@ -7,7 +7,7 @@ To access other days' logs, check for localStorage values whose key starts with keyPrefix.

maxDays controls the maximum number of days for which log entries are retained. Once this is reached, the oldest day's logs will be deleted.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Accessors

currentKey errorFormat keyPrefix @@ -21,7 +21,7 @@ renderError renderLoggingEvent

Constructors

constructor

Accessors

currentKey

errorFormat

keyPrefix

logEntryDelimiter

logFormat

maxDays

name

Methods

append

ProtectedappendEvent

initialize

ProtectedrenderError

ProtectedrenderLoggingEvent

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Returns string

errorFormat

keyPrefix

logEntryDelimiter

logFormat

maxDays

name

Methods

append

ProtectedappendEvent

initialize

ProtectedrenderError

ProtectedrenderLoggingEvent

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/docs/classes/public_api.LogService.html b/docs/classes/public_api.LogService.html index d6f8f0a..e3e6e0f 100644 --- a/docs/classes/public_api.LogService.html +++ b/docs/classes/public_api.LogService.html @@ -1,7 +1,10 @@ LogService | log4ngx

Class LogService

export class MyComponent {
  private readonly _log: Logger;

  constructor(logService: LogService) {
    this._log = logService.getLogger(this);
  }
}
-

Constructors

constructor -

Methods

dispatch +

Constructors

constructor +

Methods

configure +dispatch getLogger -

Constructors

constructor

Methods

dispatch

getLogger

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

configure

dispatch

getLogger

  • getLogger(name): Logger

  • Parameters

    • name: string

    Returns Logger

  • getLogger(instance): Logger

  • Parameters

    • instance: object

      IMPORTANT This overload should not be used if your build system minifies or otherwise mangles +class names and you intend including the class name in your log output.

      +

    Returns Logger

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/public_api.Logger.html b/docs/classes/public_api.Logger.html index 0b87ee4..867d616 100644 --- a/docs/classes/public_api.Logger.html +++ b/docs/classes/public_api.Logger.html @@ -1,7 +1,7 @@ Logger | log4ngx

Class Logger

The Logger class provides access to the methods for logging messages at the required Level.

Typically, each component or service will instantiate its own Logger instance, which will include the logger's Logger.name in the logged message.

-

Constructors

constructor +

Constructors

constructor

Properties

name

Methods

assert debug @@ -14,94 +14,94 @@

Logger instances should NOT be instantiated directly using this constructor as the instance will not be registered and cached within the LogService. (This will mean that every instance of the parent class will end up with its own duplicate copy, rather than sharing a single instance.) -Instead, use the LogService.getLogger, i.e.

+Instead, use the LogService.getLogger() method, i.e.

   this._log = logService.getLogger('MyComponent');
-

Parameters

Returns Logger

Properties

Readonlyname

name: string

A name, usually that of the 'parent' component, that will be logged with each message.

-

Methods

assert

Properties

Readonlyname

name: string

A name, usually that of the 'parent' component, that will be logged with each message.

+

Methods

assert

  • assert(condition, message): void

  • Logs the message if condition is false.

    The log entry is recorded as Level.error.

    Parameters

    • condition: undefined | boolean

      A boolean value or statement that determines if the message is logged or not.

    • message: string

      The text message to be logged.

      -

    Returns void

  • assert(condition, error): void

  • Logs the message if condition is false.

    +

Returns void

  • assert(condition, error): void

  • Logs the message if condition is false.

    The log entry is recorded as Level.error.

    Parameters

    • condition: undefined | boolean

      A boolean value or statement that determines if the message is logged or not.

    • error: Error

      An Error object to be logged.

      -

    Returns void

  • assert(condition, message, error): void

  • Logs the message if condition is false.

    +

    • Returns void

  • assert(condition, message, error): void

  • Logs the message if condition is false.

    The log entry is recorded as Level.error.

    Parameters

    • condition: undefined | boolean

      A boolean value or statement that determines if the message is logged or not.

    • message: string

      The text message to be logged.

    • error: Error

      An Error object to be logged.

      -

    Returns void

  • assert(condition, message, data): void

  • Logs the message if condition is false.

    +

    • Returns void

  • assert(condition, message, data): void

  • Logs the message if condition is false.

    The log entry is recorded as Level.error.

    Parameters

    • condition: undefined | boolean

      A boolean value or statement that determines if the message is logged or not.

    • message: string
    • data: object

      An object to be logged.

      -

    Returns void

    • debug

    Returns void

    debug

    Returns void

  • debug(error): void

  • Logs the message as Level.debug.

    Parameters

    • error: Error

      An Error object to be logged.

      -

    Returns void

  • debug(message, error): void

  • Logs the message as Level.debug.

    +

    • Returns void

  • debug(message, error): void

  • Logs the message as Level.debug.

    Parameters

    • message: string

      The text message to be logged.

    • error: Error

      An Error object to be logged.

      -

    Returns void

  • debug(message, data): void

  • Logs the message as Level.debug.

    +

    • Returns void

  • debug(message, data): void

  • Logs the message as Level.debug.

    Parameters

    • message: string

      The text message to be logged.

    • data: object

      An object to be logged.

      -

    Returns void

    • error

    Returns void

    error

    Returns void

  • error(error): void

  • Logs the message as Level.error.

    Parameters

    • error: Error

      An Error object to be logged.

      -

    Returns void

  • error(message, error): void

  • Logs the message as Level.error.

    +

    • Returns void

  • error(message, error): void

  • Logs the message as Level.error.

    Parameters

    • message: string

      The text message to be logged.

    • error: Error

      An Error object to be logged.

      -

    Returns void

  • error(message, data): void

  • Logs the message as Level.error.

    +

    • Returns void

  • error(message, data): void

  • Logs the message as Level.error.

    Parameters

    • message: string

      The text message to be logged.

    • data: object

      An object to be logged.

      -

    Returns void

    • fatal

    Returns void

    fatal

    Returns void

  • fatal(error): void

  • Logs the message as Level.fatal.

    Parameters

    • error: Error

      An Error object to be logged.

      -

    Returns void

  • fatal(message, error): void

  • Logs the message as Level.fatal.

    +

    • Returns void

  • fatal(message, error): void

  • Logs the message as Level.fatal.

    Parameters

    • message: string

      The text message to be logged.

    • error: Error

      An Error object to be logged.

      -

    Returns void

  • fatal(message, data): void

  • Logs the message as Level.fatal.

    +

    • Returns void

  • fatal(message, data): void

  • Logs the message as Level.fatal.

    Parameters

    • message: string

      The text message to be logged.

    • data: object

      An object to be logged.

      -

    Returns void

    • info

    Returns void

    info

    Returns void

  • info(error): void

  • Logs the message as Level.info.

    Parameters

    • error: Error

      An Error object to be logged.

      -

    Returns void

  • info(message, error): void

  • Logs the message as Level.info.

    +

    • Returns void

  • info(message, error): void

  • Logs the message as Level.info.

    Parameters

    • message: string

      The text message to be logged.

    • error: Error

      An Error object to be logged.

      -

    Returns void

  • info(message, data): void

  • Logs the message as Level.info.

    +

    • Returns void

  • info(message, data): void

  • Logs the message as Level.info.

    Parameters

    • message: string

      The text message to be logged.

    • data: object

      An object to be logged.

      -

    Returns void

    • log

    Returns void

    log

    Returns void

  • log(levelName, error): void

  • Logs the message as the specified level.

    Parameters

    • levelName: string

      The name of the level.

    • error: Error

      An Error object to be logged.

      If no Level has been defined for the specified levelName, the message will be ignored.

      -

    Returns void

  • log(levelName, message, error): void

  • Logs the message as the specified level.

    +

    • Returns void

  • log(levelName, message, error): void

  • Logs the message as the specified level.

    Parameters

    • levelName: string

      The name of the level.

    • message: string

      The text message to be logged.

    • error: Error

      An Error object to be logged.

      If no Level has been defined for the specified levelName, the message will be ignored.

      -

    Returns void

  • log(levelName, message, data): void

  • Logs the message as the specified level.

    +

    • Returns void

  • log(levelName, message, data): void

  • Logs the message as the specified level.

    Parameters

    • levelName: string

      The name of the level.

    • message: string

      The text message to be logged.

    • data: object

      An object to be logged.

      If no Level has been defined for the specified levelName, the message will be ignored.

      -

    Returns void

    • warn

    Returns void

    warn

    Returns void

  • warn(error): void

  • Logs the message as Level.warn.

    Parameters

    • error: Error

      An Error object to be logged.

      -

    Returns void

  • warn(message, error): void

  • Logs the message as Level.warn.

    +

    • Returns void

  • warn(message, error): void

  • Logs the message as Level.warn.

    Parameters

    • message: string

      The text message to be logged.

    • error: Error

      An Error object to be logged.

      -

    Returns void

  • warn(message, data): void

  • Logs the message as Level.warn.

    +

    • Returns void

  • warn(message, data): void

  • Logs the message as Level.warn.

    Parameters

    • message: string

      The text message to be logged.

    • data: object

      An object to be logged.

      -

    Returns void

    • Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/classes/public_api.LoggingEvent.html b/docs/classes/public_api.LoggingEvent.html index 9d504b0..1baca33 100644 --- a/docs/classes/public_api.LoggingEvent.html +++ b/docs/classes/public_api.LoggingEvent.html @@ -1,7 +1,7 @@ -LoggingEvent | log4ngx

    Class LoggingEvent

    Constructors

    constructor +LoggingEvent | log4ngx

    Class LoggingEvent

    Constructors

    constructor

    Properties

    error? level loggerName message timestamp -

    Constructors

    constructor

    Properties

    Optionalerror

    error?: Error

    level

    level: Level

    loggerName

    loggerName: string

    message

    message: string

    Readonlytimestamp

    timestamp: number = ...

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    Optionalerror

    error?: Error

    level

    level: Level

    loggerName

    loggerName: string

    message

    message: string

    Readonlytimestamp

    timestamp: number = ...

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/docs/coverage.svg b/docs/coverage.svg index dd03396..faf7f69 100644 --- a/docs/coverage.svg +++ b/docs/coverage.svg @@ -11,7 +11,7 @@ docs % docs % - 57% - 57% + 60% + 60% \ No newline at end of file diff --git a/docs/documents/Configuration.html b/docs/documents/Configuration.html index b0220c9..a86ad28 100644 --- a/docs/documents/Configuration.html +++ b/docs/documents/Configuration.html @@ -1,5 +1,5 @@ Configuration | log4ngx

    Configuration

    The configuration is defined using the LogServiceConfig interface. This can be done directly within main.ts and passed into the providers:

    -
    const loggingConfig: LogServiceConfig = {
      loggers: [
        {
          loggerName: '',
          level: 'warn',
          appenderNames: [
            'console'
          ]
        }
      ],
      appenders: [
        {
          name: 'console',
          providerToken: CONSOLE_APPENDER_TOKEN,
          logFormat: `[${AppenderPlaceholders.Level}] ${AppenderPlaceholders.Logger} ${AppenderPlaceholders.Message}${AppenderPlaceholders.Error}`
        }
      ]
    };

    const appConfig = {
      providers: [
        ...
        importProvidersFrom(Log4ngxModule),
        { provide: CONSOLE_APPENDER_TOKEN, useClass: ConsoleAppender },
        { provide: LOG_SERVICE_CONFIG_TOKEN, useValue: loggingConfig }
      ]
    };

    bootstrapApplication(AppComponent, appConfig)
        .catch(error => console.error(error));
+
    const loggingConfig: LogServiceConfig = {
      loggers: [
        {
          loggerName: '',
          level: 'warn',
          appenderNames: [
            'console'
          ]
        }
      ],
      appenders: [
        {
          name: 'console',
          providerToken: CONSOLE_APPENDER_TOKEN,
          logFormat: `[${AppenderPlaceholders.Level}] ${AppenderPlaceholders.Logger} ${AppenderPlaceholders.Message}${AppenderPlaceholders.Error}`
        }
      ]
    };

    const appConfig = {
      providers: [
        ...
        { provide: CONSOLE_APPENDER_TOKEN, useClass: ConsoleAppender },
        { provide: LOG_SERVICE_CONFIG_TOKEN, useValue: loggingConfig }
      ]
    };

    bootstrapApplication(AppComponent, appConfig)
        .catch(error => console.error(error));
 
    
 
 
    Alternatively, you can use environment-specific configurations (see environment-specific configurations) which would allow you to log 'debug'-level statements in development, but only 'info'-level and above in production.  Then you will just reference the appropriate section of your environment from within the application config:
    
diff --git a/docs/enums/public_api.AppenderPlaceholders.html b/docs/enums/public_api.AppenderPlaceholders.html
index e8bdeb5..4246488 100644
--- a/docs/enums/public_api.AppenderPlaceholders.html
+++ b/docs/enums/public_api.AppenderPlaceholders.html
@@ -1,6 +1,6 @@
 AppenderPlaceholders | log4ngx
    Enumeration AppenderPlaceholders
    Placeholder constants for use in the AppenderConfig.logFormat and/or
 AppenderConfig.errorFormat properties.
    
-
    Enumeration Members
    Crlf
+
    Enumeration Members
    Crlf
 Date
 Datetime
 Error
@@ -17,22 +17,22 @@
 Timestamp
 UtcDate
 
     Enumeration Members
    Crlf
    Crlf: "{crlf}"
    Carriage return/line feed characters, i.e. '\r\n'.
    
-
    Date
    Date: "{date}"
    The log timestamp converted to the default date format, e.g. 'Mon Aug 07 2017'.
    
-
    Datetime
    Datetime: "{datetime}"
    The log timestamp converted to locale-specific date/time format, e.g. '07/08/2017, 15:53:34'.
    
-
    Error
    Error: "{error}"
    The logged error (if any), formatted according to AppenderConfig.errorFormat.
    
-
    ErrorMessage
    ErrorMessage: "{error-message}"
    The logged Error's message property.
    
+
    Date
    Date: "{date}"
    The log timestamp converted to the default date format, e.g. 'Mon Aug 07 2017'.
    
+
    Datetime
    Datetime: "{datetime}"
    The log timestamp converted to locale-specific date/time format, e.g. '07/08/2017, 15:53:34'.
    
+
    Error
    Error: "{error}"
    The logged error (if any), formatted according to AppenderConfig.errorFormat.
    
+
    ErrorMessage
    ErrorMessage: "{error-message}"
    The logged Error's message property.
    
 
    Note that this placeholder is only valid within AppenderConfig.errorFormat.
    
-
    ErrorName
    ErrorName: "{error-name}"
    The logged Error's name property.
    
+
    ErrorName
    ErrorName: "{error-name}"
    The logged Error's name property.
    
 
    Note that this placeholder is only valid within AppenderConfig.errorFormat.
    
-
    ErrorStack
    ErrorStack: "{error-stack}"
    The logged Error's stack property.
    
+
    ErrorStack
    ErrorStack: "{error-stack}"
    The logged Error's stack property.
    
 
    Note that this placeholder is only valid within AppenderConfig.errorFormat.
    
-
    IsoDate
    IsoDate: "{date-iso}"
    The log timestamp converted to ISO format, e.g. '2017-08-07T14:53:34.329Z'.
    
-
    Level
    Level: "{level}"
    The Level.displayName property.
    
-
    Lf
    Lf: "{lf}"
    Linefeed character, i.e. '\n'.
    
-
    Logger
    Logger: "{logger}"
    The Logger.name property.
    
-
    Message
    Message: "{message}"
    The log message.
    
-
    ShortDate
    ShortDate: "{date-short}"
    The log timestamp converted to locale-specific date format, e.g. '07/08/2017'.
    
-
    Time
    Time: "{time}"
    The log timestamp converted to locale-specific time format, e.g. '15:53:34'.
    
-
    Timestamp
    Timestamp: "{timestamp}"
    The log timestamp as a number.
    
-
    UtcDate
    UtcDate: "{date-utc}"
    The log timestamp converted to UTC format, e.g. 'Mon, 07 Aug 2017 14:53:34 GMT'.
    
-
    Settings
    Member Visibility
    On This Page
    Enumeration Members
    
+
    IsoDate
    IsoDate: "{date-iso}"
    The log timestamp converted to ISO format, e.g. '2017-08-07T14:53:34.329Z'.
    
+
    Level
    Level: "{level}"
    The Level.displayName property.
    
+
    Lf
    Lf: "{lf}"
    Linefeed character, i.e. '\n'.
    
+
    Logger
    Logger: "{logger}"
    The Logger.name property.
    
+
    Message
    Message: "{message}"
    The log message.
    
+
    ShortDate
    ShortDate: "{date-short}"
    The log timestamp converted to locale-specific date format, e.g. '07/08/2017'.
    
+
    Time
    Time: "{time}"
    The log timestamp converted to locale-specific time format, e.g. '15:53:34'.
    
+
    Timestamp
    Timestamp: "{timestamp}"
    The log timestamp as a number.
    
+
    UtcDate
    UtcDate: "{date-utc}"
    The log timestamp converted to UTC format, e.g. 'Mon, 07 Aug 2017 14:53:34 GMT'.
    
+

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/docs/index.html b/docs/index.html index 78a9798..15ae990 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,33 +1,8 @@ -log4ngx

    log4ngx

    log4ngx

    log4ngx is a Typescript logging framework for Angular projects, based on concepts used in Log4j, Log4net, etc.

    +log4ngx

    log4ngx

    log4ngx

    log4ngx is a Typescript logging framework for Angular projects, based on concepts used in Log4j, +Log4net, etc.

    Concepts

    Loggers

    Loggers provide access to the methods for logging messages at the required Level. Each class - i.e. component, module or service - will usually define its own Logger which will identify that class within any messages logged via it.

    LogService

    The LogService is the factory with which you instantiate Loggers in each of the components, services, etc, in which you wish to log messages. Behind the scenes, it also orchestrates the dispatch of messages from the Loggers to the appropriate Appenders.

    Appenders

    Appenders are responsible for sending log entries to the underlying target or service. Configuration will normally depend on the target/service, but all Appenders are configured with the layout format for messages logged to them.

    LogServiceConfig

    The LogService is configured using an instance of the LogServiceConfig, typically created in your application's main module. The configuration defines the parameters used with each Appender and how each Appender relates to the various Loggers.

    -

    For more information about using and configuring log4ngx, see https://secondbounce.github.io/log4ngx/.

    -

    TODO

      -
    • Make sure all classes, interfaces and their public/protected methods are documented
      • -
    -

    Docs

      -
    • Getting Started -
        -
      • installing
        • -
      • configuring
        • -
      • usage
        • -
      -
      • -
    • Customising -
        -
      • Writing a custom appender
        • -
      • Writing a custom level
        • -
      -
      • -
    • API -
        -
      • Classes
        • -
      • Interfaces
        • -
      • Constants
        • -
      • Utility
        • -
      -
      • -
    -

    Settings

    Member Visibility

    On This Page

    log4ngx
    +

    For more information about using and configuring log4ngx, see https://secondbounce.github.io/log4ngx/. The demo project (in the projects/demo/ folder of the repo) also contains examples of configuring and using the library.

    +

    Settings

    Member Visibility

    On This Page

    log4ngx
    diff --git a/docs/interfaces/public_api.AppenderConfig.html b/docs/interfaces/public_api.AppenderConfig.html index f90a267..b7e3f36 100644 --- a/docs/interfaces/public_api.AppenderConfig.html +++ b/docs/interfaces/public_api.AppenderConfig.html @@ -1,5 +1,5 @@ AppenderConfig | log4ngx

    Interface AppenderConfig

    Interface defining the basic configuration for all Appender classes.

    -
    interface AppenderConfig {
        errorFormat?: string;
        logFormat: string;
        name: string;
        providerToken: InjectionToken<Appender>;
    }

    Hierarchy (view full)

    Properties

    errorFormat? +
    interface AppenderConfig {
        errorFormat?: string;
        logFormat: string;
        name: string;
        providerToken: InjectionToken<Appender>;
    }

    Hierarchy (view full)

    Properties

    errorFormat? logFormat name providerToken @@ -7,9 +7,9 @@ included with a log entry.

    The format string may include both string literals and AppenderPlaceholders which will be replaced with the corresponding value.

    -

    logFormat

    logFormat: string

    The string format for each log entry.

    +

    logFormat

    logFormat: string

    The string format for each log entry.

    The format string may include both string literals and AppenderPlaceholders which will be replaced with the corresponding value.

    -

    name

    name: string

    The name of the appender configuration. This value is referenced in LoggerConfig.appenderNames.

    -

    providerToken

    providerToken: InjectionToken<Appender>

    The InjectionToken provided for the required Appender.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    name

    name: string

    The name of the appender configuration. This value is referenced in LoggerConfig.appenderNames.

    +

    providerToken

    providerToken: InjectionToken<Appender>

    The InjectionToken provided for the required Appender.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/public_api.ConsoleAppenderConfig.html b/docs/interfaces/public_api.ConsoleAppenderConfig.html index 2e6b27a..f60c310 100644 --- a/docs/interfaces/public_api.ConsoleAppenderConfig.html +++ b/docs/interfaces/public_api.ConsoleAppenderConfig.html @@ -1,5 +1,5 @@ ConsoleAppenderConfig | log4ngx

    Interface ConsoleAppenderConfig

    Interface defining the basic configuration for all Appender classes.

    -
    interface ConsoleAppenderConfig {
        errorFormat?: string;
        logFormat: string;
        name: string;
        providerToken: InjectionToken<Appender>;
    }

    Hierarchy (view full)

    Properties

    errorFormat? +
    interface ConsoleAppenderConfig {
        errorFormat?: string;
        logFormat: string;
        name: string;
        providerToken: InjectionToken<Appender>;
    }

    Hierarchy (view full)

    Properties

    errorFormat? logFormat name providerToken @@ -7,9 +7,9 @@ included with a log entry.

    The format string may include both string literals and AppenderPlaceholders which will be replaced with the corresponding value.

    -

    logFormat

    logFormat: string

    The string format for each log entry.

    +

    logFormat

    logFormat: string

    The string format for each log entry.

    The format string may include both string literals and AppenderPlaceholders which will be replaced with the corresponding value.

    -

    name

    name: string

    The name of the appender configuration. This value is referenced in LoggerConfig.appenderNames.

    -

    providerToken

    providerToken: InjectionToken<Appender>

    The InjectionToken provided for the required Appender.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    name

    name: string

    The name of the appender configuration. This value is referenced in LoggerConfig.appenderNames.

    +

    providerToken

    providerToken: InjectionToken<Appender>

    The InjectionToken provided for the required Appender.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/public_api.LocalStorageAppenderConfig.html b/docs/interfaces/public_api.LocalStorageAppenderConfig.html index 2df58ab..6c7e546 100644 --- a/docs/interfaces/public_api.LocalStorageAppenderConfig.html +++ b/docs/interfaces/public_api.LocalStorageAppenderConfig.html @@ -1,5 +1,5 @@ LocalStorageAppenderConfig | log4ngx

    Interface LocalStorageAppenderConfig

    Interface defining the configuration of LocalStorageAppender objects.

    -
    interface LocalStorageAppenderConfig {
        errorFormat?: string;
        keyPrefix?: string;
        logEntryDelimiter?: string;
        logFormat: string;
        maxDays?: number;
        name: string;
        providerToken: InjectionToken<Appender>;
    }

    Hierarchy (view full)

    Properties

    errorFormat? +
    interface LocalStorageAppenderConfig {
        errorFormat?: string;
        keyPrefix?: string;
        logEntryDelimiter?: string;
        logFormat: string;
        maxDays?: number;
        name: string;
        providerToken: InjectionToken<Appender>;
    }

    Hierarchy (view full)

    Properties

    errorFormat? keyPrefix? logEntryDelimiter? logFormat @@ -10,12 +10,12 @@ included with a log entry.

    The format string may include both string literals and AppenderPlaceholders which will be replaced with the corresponding value.

    -

    OptionalkeyPrefix

    keyPrefix?: string

    Defines the prefix used for the key when adding items to localStorage.

    -

    OptionallogEntryDelimiter

    logEntryDelimiter?: string

    String value used as a delimiter between each log entry

    -

    logFormat

    logFormat: string

    The string format for each log entry.

    +

    OptionalkeyPrefix

    keyPrefix?: string

    Defines the prefix used for the key when adding items to localStorage.

    +

    OptionallogEntryDelimiter

    logEntryDelimiter?: string

    String value used as a delimiter between each log entry

    +

    logFormat

    logFormat: string

    The string format for each log entry.

    The format string may include both string literals and AppenderPlaceholders which will be replaced with the corresponding value.

    -

    OptionalmaxDays

    maxDays?: number

    Maximum number of days' logs to be retained in localStorage

    -

    name

    name: string

    The name of the appender configuration. This value is referenced in LoggerConfig.appenderNames.

    -

    providerToken

    providerToken: InjectionToken<Appender>

    The InjectionToken provided for the required Appender.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalmaxDays

    maxDays?: number

    Maximum number of days' logs to be retained in localStorage

    +

    name

    name: string

    The name of the appender configuration. This value is referenced in LoggerConfig.appenderNames.

    +

    providerToken

    providerToken: InjectionToken<Appender>

    The InjectionToken provided for the required Appender.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/public_api.LogServiceConfig.html b/docs/interfaces/public_api.LogServiceConfig.html index 881dc4f..f53bcec 100644 --- a/docs/interfaces/public_api.LogServiceConfig.html +++ b/docs/interfaces/public_api.LogServiceConfig.html @@ -1,3 +1,3 @@ -LogServiceConfig | log4ngx

    Interface LogServiceConfig

    interface LogServiceConfig {
        appenders: AppenderConfig[];
        loggers: LoggerConfig[];
    }

    Properties

    appenders +LogServiceConfig | log4ngx

    Interface LogServiceConfig

    interface LogServiceConfig {
        appenders: AppenderConfig[];
        loggers: LoggerConfig[];
    }

    Properties

    appenders loggers -

    Properties

    appenders

    appenders: AppenderConfig[]

    loggers

    loggers: LoggerConfig[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    appenders

    appenders: AppenderConfig[]

    loggers

    loggers: LoggerConfig[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/public_api.LoggerConfig.html b/docs/interfaces/public_api.LoggerConfig.html index 4d0e384..2f45c30 100644 --- a/docs/interfaces/public_api.LoggerConfig.html +++ b/docs/interfaces/public_api.LoggerConfig.html @@ -1,10 +1,10 @@ LoggerConfig | log4ngx

    Interface LoggerConfig

    Interface defining the configuration for each Logger instance.

    -
    interface LoggerConfig {
        appenderNames: string[];
        level: string;
        loggerName: string;
    }

    Properties

    appenderNames +
    interface LoggerConfig {
        appenderNames: string[];
        level: string;
        loggerName: string;
    }

    Properties

    appenderNames level loggerName

    Properties

    appenderNames

    appenderNames: string[]

    The name of each Appender that log entries will be sent to.

    -

    level

    level: string

    The name of the lowest level to be logged.

    -

    loggerName

    loggerName: string

    The name of the Logger instance for which this configuration refers. If left blank, +

    level

    level: string

    The name of the lowest level to be logged.

    +

    loggerName

    loggerName: string

    The name of the Logger instance for which this configuration refers. If left blank, this configuration will be used for all Logger instances that don't have a defined configuration.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/modules/public_api.html b/docs/modules/public_api.html index 2a64bcb..733deff 100644 --- a/docs/modules/public_api.html +++ b/docs/modules/public_api.html @@ -1,10 +1,8 @@ -public-api | log4ngx

    Module public-api

    Index

    Enumerations

    AppenderPlaceholders +public-api | log4ngx

    Module public-api

    Index

    Enumerations

    AppenderPlaceholders

    Classes

    Appender ConsoleAppender -ConsoleService Level LocalStorageAppender -Log4ngxModule LogService Logger LoggingEvent diff --git a/docs/variables/public_api.CONSOLE_APPENDER_TOKEN.html b/docs/variables/public_api.CONSOLE_APPENDER_TOKEN.html index 4a1fa6f..0793e92 100644 --- a/docs/variables/public_api.CONSOLE_APPENDER_TOKEN.html +++ b/docs/variables/public_api.CONSOLE_APPENDER_TOKEN.html @@ -1,2 +1,2 @@ CONSOLE_APPENDER_TOKEN | log4ngx

    Variable CONSOLE_APPENDER_TOKENConst

    CONSOLE_APPENDER_TOKEN: InjectionToken<Appender> = ...

    The InjectionToken to be used when referencing the ConsoleAppender for DI.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/variables/public_api.LOCALSTORAGE_APPENDER_TOKEN.html b/docs/variables/public_api.LOCALSTORAGE_APPENDER_TOKEN.html index 26ab1d7..4f816e0 100644 --- a/docs/variables/public_api.LOCALSTORAGE_APPENDER_TOKEN.html +++ b/docs/variables/public_api.LOCALSTORAGE_APPENDER_TOKEN.html @@ -1,2 +1,2 @@ LOCALSTORAGE_APPENDER_TOKEN | log4ngx

    Variable LOCALSTORAGE_APPENDER_TOKENConst

    LOCALSTORAGE_APPENDER_TOKEN: InjectionToken<Appender> = ...

    The InjectionToken to be used when referencing the LocalStorageAppender for DI.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/variables/public_api.LOG_SERVICE_CONFIG_TOKEN.html b/docs/variables/public_api.LOG_SERVICE_CONFIG_TOKEN.html index dc195b0..f6f249c 100644 --- a/docs/variables/public_api.LOG_SERVICE_CONFIG_TOKEN.html +++ b/docs/variables/public_api.LOG_SERVICE_CONFIG_TOKEN.html @@ -1,2 +1,2 @@ LOG_SERVICE_CONFIG_TOKEN | log4ngx

    Variable LOG_SERVICE_CONFIG_TOKENConst

    LOG_SERVICE_CONFIG_TOKEN: InjectionToken<LogServiceConfig> = ...

    The InjectionToken to be used when referencing the LogServiceConfig for DI.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/package.json b/package.json index 77ffec3..de01ec1 100644 --- a/package.json +++ b/package.json @@ -6,14 +6,16 @@ "license": "MIT", "repository": { "type": "git", - "url": "https://github.com/secondbounce/log4ngx.git" + "url": "git+https://github.com/secondbounce/log4ngx.git" }, "bugs": { "url": "https://github.com/secondbounce/log4ngx/issues" }, "keywords": [ "angular", - "log4", + "log", + "log4j", + "logger", "logging", "typescript" ], @@ -67,4 +69,4 @@ "typescript": "~5.4.5", "typescript-eslint": "^8.4.0" } -} \ No newline at end of file +} diff --git a/projects/log4ngx/LICENSE b/projects/log4ngx/LICENSE new file mode 100644 index 0000000..bb46ed3 --- /dev/null +++ b/projects/log4ngx/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023-24 Second Bounce Ltd + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/projects/log4ngx/README.md b/projects/log4ngx/README.md index 9520858..c79af28 100644 --- a/projects/log4ngx/README.md +++ b/projects/log4ngx/README.md @@ -1,6 +1,7 @@ # log4ngx -log4ngx is a Typescript logging framework for Angular projects, based on concepts used in Log4j, Log4net, etc. +log4ngx is a Typescript logging framework for Angular projects, based on concepts used in Log4j, +Log4net, etc. ## Concepts @@ -20,4 +21,4 @@ The `LogService` is the factory with which you instantiate `Loggers` in each of The `LogService` is configured using an instance of the `LogServiceConfig`, typically created in your application's main module. The configuration defines the parameters used with each `Appender` and how each `Appender` relates to the various `Loggers`. -For more information about using and configuring log4ngx, see . +For more information about using and configuring log4ngx, see . The demo project (in the _projects/demo/_ folder of the repo) also contains examples of configuring and using the library. diff --git a/projects/log4ngx/package.json b/projects/log4ngx/package.json index 619308a..ea06ffc 100644 --- a/projects/log4ngx/package.json +++ b/projects/log4ngx/package.json @@ -6,14 +6,16 @@ "license": "MIT", "repository": { "type": "git", - "url": "https://github.com/secondbounce/log4ngx.git" + "url": "git+https://github.com/secondbounce/log4ngx.git" }, "bugs": { "url": "https://github.com/secondbounce/log4ngx/issues" }, "keywords": [ "angular", - "log4", + "log", + "log4j", + "logger", "logging", "typescript" ], @@ -24,4 +26,4 @@ "dependencies": { "tslib": "^2.6.3" } -} \ No newline at end of file +} diff --git a/projects/log4ngx/src/lib/log.service.ts b/projects/log4ngx/src/lib/log.service.ts index 2f5321c..b92fc44 100644 --- a/projects/log4ngx/src/lib/log.service.ts +++ b/projects/log4ngx/src/lib/log.service.ts @@ -7,6 +7,19 @@ import { Logger } from './logger'; import { LoggerConfig } from './logger-config'; import { LoggingEvent } from './logging-event'; +/** + * + * + * ``` typescript + * export class MyComponent { + * private readonly _log: Logger; + * + * constructor(logService: LogService) { + * this._log = logService.getLogger(this); + * } + * } + * ``` + */ @Injectable({ providedIn: 'root' }) @@ -45,6 +58,13 @@ export class LogService { } public getLogger(name: string): Logger; + /** + * + * @param instance + * + * IMPORTANT This overload should not be used if your build system minifies or otherwise mangles + * class names and you intend including the class name in your log output. + */ public getLogger(instance: object): Logger; public getLogger(nameOrObject: string | object): Logger { let name: string; diff --git a/projects/log4ngx/src/lib/logger.ts b/projects/log4ngx/src/lib/logger.ts index 0dfafc6..b8c3136 100644 --- a/projects/log4ngx/src/lib/logger.ts +++ b/projects/log4ngx/src/lib/logger.ts @@ -18,7 +18,7 @@ export class Logger { * `Logger` instances should **NOT** be instantiated directly using this constructor as the instance * will not be registered and cached within the {@link LogService}. (This will mean that every instance * of the parent class will end up with its own duplicate copy, rather than sharing a single instance.) - * Instead, use the {@link LogService.getLogger}, i.e. + * Instead, use the {@link LogService.getLogger}() method, i.e. * ``` * this._log = logService.getLogger('MyComponent'); * ```