co-log-sys (empty) → 0.1.0.0
raw patch · 11 files changed
+864/−0 lines, 11 filesdep +aesondep +base-nopreludedep +co-log-coresetup-changed
Dependencies added: aeson, base-noprelude, co-log-core, co-log-sys, fmt, loot-prelude, microlens, monad-control, mtl, network, universum, unix
Files
- LICENSE.md +355/−0
- README.md +43/−0
- Setup.hs +2/−0
- co-log-sys.cabal +78/−0
- src/Colog/Syslog.hs +13/−0
- src/Colog/Syslog/Actions.hs +28/−0
- src/Colog/Syslog/Config.hs +91/−0
- src/Colog/Syslog/Handler.hs +97/−0
- src/Colog/Syslog/Message.hs +32/−0
- src/Colog/Syslog/Priority.hs +123/−0
- test/Spec.hs +2/−0
+ LICENSE.md view
@@ -0,0 +1,355 @@+Mozilla Public License Version 2.0+==================================++### 1. Definitions++**1.1. “Contributor”** + means each individual or legal entity that creates, contributes to+ the creation of, or owns Covered Software.++**1.2. “Contributor Version”** + means the combination of the Contributions of others (if any) used+ by a Contributor and that particular Contributor's Contribution.++**1.3. “Contribution”** + means Covered Software of a particular Contributor.++**1.4. “Covered Software”** + means Source Code Form to which the initial Contributor has attached+ the notice in Exhibit A, the Executable Form of such Source Code+ Form, and Modifications of such Source Code Form, in each case+ including portions thereof.++**1.5. “Incompatible With Secondary Licenses”** + means++* **(a)** that the initial Contributor has attached the notice described+ in Exhibit B to the Covered Software; or+* **(b)** that the Covered Software was made available under the terms of+ version 1.1 or earlier of the License, but not also under the+ terms of a Secondary License.++**1.6. “Executable Form”** + means any form of the work other than Source Code Form.++**1.7. “Larger Work”** + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software.++**1.8. “License”** + means this document.++**1.9. “Licensable”** + means having the right to grant, to the maximum extent possible,+ whether at the time of the initial grant or subsequently, any and+ all of the rights conveyed by this License.++**1.10. “Modifications”** + means any of the following:++* **(a)** any file in Source Code Form that results from an addition to,+ deletion from, or modification of the contents of Covered+ Software; or+* **(b)** any new file in Source Code Form that contains any Covered+ Software.++**1.11. “Patent Claims” of a Contributor** + means any patent claim(s), including without limitation, method,+ process, and apparatus claims, in any patent Licensable by such+ Contributor that would be infringed, but for the grant of the+ License, by the making, using, selling, offering for sale, having+ made, import, or transfer of either its Contributions or its+ Contributor Version.++**1.12. “Secondary License”** + means either the GNU General Public License, Version 2.0, the GNU+ Lesser General Public License, Version 2.1, the GNU Affero General+ Public License, Version 3.0, or any later versions of those+ licenses.++**1.13. “Source Code Form”** + means the form of the work preferred for making modifications.++**1.14. “You” (or “Your”)** + means an individual or a legal entity exercising rights under this+ License. For legal entities, “You” includes any entity that+ controls, is controlled by, or is under common control with You. For+ purposes of this definition, “control” means **(a)** the power, direct+ or indirect, to cause the direction or management of such entity,+ whether by contract or otherwise, or **(b)** ownership of more than+ fifty percent (50%) of the outstanding shares or beneficial+ ownership of such entity.+++### 2. License Grants and Conditions++#### 2.1. Grants++Each Contributor hereby grants You a world-wide, royalty-free,+non-exclusive license:++* **(a)** under intellectual property rights (other than patent or trademark)+ Licensable by such Contributor to use, reproduce, make available,+ modify, display, perform, distribute, and otherwise exploit its+ Contributions, either on an unmodified basis, with Modifications, or+ as part of a Larger Work; and+* **(b)** under Patent Claims of such Contributor to make, use, sell, offer+ for sale, have made, import, and otherwise transfer either its+ Contributions or its Contributor Version.++#### 2.2. Effective Date++The licenses granted in Section 2.1 with respect to any Contribution+become effective for each Contribution on the date the Contributor first+distributes such Contribution.++#### 2.3. Limitations on Grant Scope++The licenses granted in this Section 2 are the only rights granted under+this License. No additional rights or licenses will be implied from the+distribution or licensing of Covered Software under this License.+Notwithstanding Section 2.1(b) above, no patent license is granted by a+Contributor:++* **(a)** for any code that a Contributor has removed from Covered Software;+ or+* **(b)** for infringements caused by: **(i)** Your and any other third party's+ modifications of Covered Software, or **(ii)** the combination of its+ Contributions with other software (except as part of its Contributor+ Version); or+* **(c)** under Patent Claims infringed by Covered Software in the absence of+ its Contributions.++This License does not grant any rights in the trademarks, service marks,+or logos of any Contributor (except as may be necessary to comply with+the notice requirements in Section 3.4).++#### 2.4. Subsequent Licenses++No Contributor makes additional grants as a result of Your choice to+distribute the Covered Software under a subsequent version of this+License (see Section 10.2) or under the terms of a Secondary License (if+permitted under the terms of Section 3.3).++#### 2.5. Representation++Each Contributor represents that the Contributor believes its+Contributions are its original creation(s) or it has sufficient rights+to grant the rights to its Contributions conveyed by this License.++#### 2.6. Fair Use++This License is not intended to limit any rights You have under+applicable copyright doctrines of fair use, fair dealing, or other+equivalents.++#### 2.7. Conditions++Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted+in Section 2.1.+++### 3. Responsibilities++#### 3.1. Distribution of Source Form++All distribution of Covered Software in Source Code Form, including any+Modifications that You create or to which You contribute, must be under+the terms of this License. You must inform recipients that the Source+Code Form of the Covered Software is governed by the terms of this+License, and how they can obtain a copy of this License. You may not+attempt to alter or restrict the recipients' rights in the Source Code+Form.++#### 3.2. Distribution of Executable Form++If You distribute Covered Software in Executable Form then:++* **(a)** such Covered Software must also be made available in Source Code+ Form, as described in Section 3.1, and You must inform recipients of+ the Executable Form how they can obtain a copy of such Source Code+ Form by reasonable means in a timely manner, at a charge no more+ than the cost of distribution to the recipient; and++* **(b)** You may distribute such Executable Form under the terms of this+ License, or sublicense it under different terms, provided that the+ license for the Executable Form does not attempt to limit or alter+ the recipients' rights in the Source Code Form under this License.++#### 3.3. Distribution of a Larger Work++You may create and distribute a Larger Work under terms of Your choice,+provided that You also comply with the requirements of this License for+the Covered Software. If the Larger Work is a combination of Covered+Software with a work governed by one or more Secondary Licenses, and the+Covered Software is not Incompatible With Secondary Licenses, this+License permits You to additionally distribute such Covered Software+under the terms of such Secondary License(s), so that the recipient of+the Larger Work may, at their option, further distribute the Covered+Software under the terms of either this License or such Secondary+License(s).++#### 3.4. Notices++You may not remove or alter the substance of any license notices+(including copyright notices, patent notices, disclaimers of warranty,+or limitations of liability) contained within the Source Code Form of+the Covered Software, except that You may alter any license notices to+the extent required to remedy known factual inaccuracies.++#### 3.5. Application of Additional Terms++You may choose to offer, and to charge a fee for, warranty, support,+indemnity or liability obligations to one or more recipients of Covered+Software. However, You may do so only on Your own behalf, and not on+behalf of any Contributor. You must make it absolutely clear that any+such warranty, support, indemnity, or liability obligation is offered by+You alone, and You hereby agree to indemnify every Contributor for any+liability incurred by such Contributor as a result of warranty, support,+indemnity or liability terms You offer. You may include additional+disclaimers of warranty and limitations of liability specific to any+jurisdiction.+++### 4. Inability to Comply Due to Statute or Regulation++If it is impossible for You to comply with any of the terms of this+License with respect to some or all of the Covered Software due to+statute, judicial order, or regulation then You must: **(a)** comply with+the terms of this License to the maximum extent possible; and **(b)**+describe the limitations and the code they affect. Such description must+be placed in a text file included with all distributions of the Covered+Software under this License. Except to the extent prohibited by statute+or regulation, such description must be sufficiently detailed for a+recipient of ordinary skill to be able to understand it.+++### 5. Termination++**5.1.** The rights granted under this License will terminate automatically+if You fail to comply with any of its terms. However, if You become+compliant, then the rights granted under this License from a particular+Contributor are reinstated **(a)** provisionally, unless and until such+Contributor explicitly and finally terminates Your grants, and **(b)** on an+ongoing basis, if such Contributor fails to notify You of the+non-compliance by some reasonable means prior to 60 days after You have+come back into compliance. Moreover, Your grants from a particular+Contributor are reinstated on an ongoing basis if such Contributor+notifies You of the non-compliance by some reasonable means, this is the+first time You have received notice of non-compliance with this License+from such Contributor, and You become compliant prior to 30 days after+Your receipt of the notice.++**5.2.** If You initiate litigation against any entity by asserting a patent+infringement claim (excluding declaratory judgment actions,+counter-claims, and cross-claims) alleging that a Contributor Version+directly or indirectly infringes any patent, then the rights granted to+You by any and all Contributors for the Covered Software under Section+2.1 of this License shall terminate.++**5.3.** In the event of termination under Sections 5.1 or 5.2 above, all+end user license agreements (excluding distributors and resellers) which+have been validly granted by You or Your distributors under this License+prior to termination shall survive termination.+++### 6. Disclaimer of Warranty++> Covered Software is provided under this License on an “as is”+> basis, without warranty of any kind, either expressed, implied, or+> statutory, including, without limitation, warranties that the+> Covered Software is free of defects, merchantable, fit for a+> particular purpose or non-infringing. The entire risk as to the+> quality and performance of the Covered Software is with You.+> Should any Covered Software prove defective in any respect, You+> (not any Contributor) assume the cost of any necessary servicing,+> repair, or correction. This disclaimer of warranty constitutes an+> essential part of this License. No use of any Covered Software is+> authorized under this License except under this disclaimer.++### 7. Limitation of Liability++> Under no circumstances and under no legal theory, whether tort+> (including negligence), contract, or otherwise, shall any+> Contributor, or anyone who distributes Covered Software as+> permitted above, be liable to You for any direct, indirect,+> special, incidental, or consequential damages of any character+> including, without limitation, damages for lost profits, loss of+> goodwill, work stoppage, computer failure or malfunction, or any+> and all other commercial damages or losses, even if such party+> shall have been informed of the possibility of such damages. This+> limitation of liability shall not apply to liability for death or+> personal injury resulting from such party's negligence to the+> extent applicable law prohibits such limitation. Some+> jurisdictions do not allow the exclusion or limitation of+> incidental or consequential damages, so this exclusion and+> limitation may not apply to You.+++### 8. Litigation++Any litigation relating to this License may be brought only in the+courts of a jurisdiction where the defendant maintains its principal+place of business and such litigation shall be governed by laws of that+jurisdiction, without reference to its conflict-of-law provisions.+Nothing in this Section shall prevent a party's ability to bring+cross-claims or counter-claims.+++### 9. Miscellaneous++This License represents the complete agreement concerning the subject+matter hereof. If any provision of this License is held to be+unenforceable, such provision shall be reformed only to the extent+necessary to make it enforceable. Any law or regulation which provides+that the language of a contract shall be construed against the drafter+shall not be used to construe this License against a Contributor.+++### 10. Versions of the License++#### 10.1. New Versions++Mozilla Foundation is the license steward. Except as provided in Section+10.3, no one other than the license steward has the right to modify or+publish new versions of this License. Each version will be given a+distinguishing version number.++#### 10.2. Effect of New Versions++You may distribute the Covered Software under the terms of the version+of the License under which You originally received the Covered Software,+or under the terms of any subsequent version published by the license+steward.++#### 10.3. Modified Versions++If you create software not governed by this License, and you want to+create a new license for such software, you may create and use a+modified version of this License if you rename the license and remove+any references to the name of the license steward (except to note that+such modified license differs from this License).++#### 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses++If You choose to distribute Source Code Form that is Incompatible With+Secondary Licenses under the terms of this version of the License, the+notice described in Exhibit B of this License must be attached.++## Exhibit A - Source Code Form License Notice++ This Source Code Form is subject to the terms of the Mozilla Public+ License, v. 2.0. If a copy of the MPL was not distributed with this+ file, You can obtain one at http://mozilla.org/MPL/2.0/.++If it is not possible or desirable to put the notice in a particular+file, then You may include the notice in a location (such as a LICENSE+file in a relevant directory) where a recipient would be likely to look+for such a notice.++You may add additional accurate notices of copyright ownership.++## Exhibit B - “Incompatible With Secondary Licenses” Notice++ This Source Code Form is "Incompatible With Secondary Licenses", as+ defined by the Mozilla Public License, v. 2.0.
+ README.md view
@@ -0,0 +1,43 @@+# co-log-sys++This is a logging library based on [`co-log-core`](https://github.com/kowainik/co-log/tree/master/co-log-core)+that implements a syslog backend.++For more info about how [`co-log`](https://github.com/kowainik/co-log/tree/master/co-log)+works we advise you to read [its presentation blogpost](https://kowainik.github.io/posts/2018-09-25-co-log).++NOTE: It's somewhat opinionated in that:+- it uses the `fmt` library for formatting+- uses `universum` as a `Prelude` alternative++## Example of usage [↑](#co-log-sys)++This is a simple example using the `withLogMessageSyslog` function:++```haskell+example :: IO ()+example = withLogMessageSyslog basicSyslogConfig $ \logMessageSyslog -> do+ let logMessageStdout = cmap fmtMessageFlat logTextStdout+ logAction = logMessageSyslog <> logMessageStdout+ unLogAction logAction $ Message Emergency "NOTICE ME HERE"+ where+ basicSyslogConfig = SyslogConfig+ { collector = AutoLocal+ , facility = User+ , appName = "example"+ }+```++## Contributions [↑](#co-log-sys)++If you'd like to contribute or file a Bug Report, please read our [Contributors Guide](docs/CONTRIBUTING.md).++## License [↑](#co-log-sys)++[MPL 2.0](LICENSE.md)++## About Serokell [↑](#co-log-sys)++`co-log-sys` is maintained by [Serokell](https://serokell.io/).+We love open source software.+See which [services](https://serokell.io/#services) we provide and [drop us a line](mailto:hi@serokell.io) if you are interested.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ co-log-sys.cabal view
@@ -0,0 +1,78 @@+-- This file has been generated from package.yaml by hpack version 0.28.2.+--+-- see: https://github.com/sol/hpack+--+-- hash: 520cc0cb2a37c01624683b0e8a29dd4bc16b83353cb40ca2b7fc01a4d32c015d++name: co-log-sys+version: 0.1.0.0+synopsis: Syslog implementation on top of 'co-log-core'+description: Please see the README on GitHub at <https://github.com/serokell/co-log-sys#readme>+category: Logging+homepage: https://github.com/serokell/co-log-sys#readme+bug-reports: https://github.com/serokell/co-log-sys/issues+author: Serokell+maintainer: Serokell <hi@serokell.io>+copyright: 2018 Serokell+license: MPL-2.0+license-file: LICENSE.md+build-type: Simple+cabal-version: >= 1.10+extra-source-files:+ README.md++source-repository head+ type: git+ location: https://github.com/serokell/co-log-sys++library+ exposed-modules:+ Colog.Syslog+ Colog.Syslog.Actions+ Colog.Syslog.Config+ Colog.Syslog.Handler+ Colog.Syslog.Message+ Colog.Syslog.Priority+ other-modules:+ Paths_co_log_sys+ hs-source-dirs:+ src+ default-extensions: ApplicativeDo BangPatterns FlexibleContexts LambdaCase MultiWayIf NegativeLiterals OverloadedLabels OverloadedStrings PatternSynonyms PolyKinds RankNTypes RecordWildCards RecursiveDo StandaloneDeriving TupleSections+ ghc-options: -Weverything -Wno-missing-exported-signatures -Wno-missing-import-lists -Wno-missed-specialisations -Wno-all-missed-specialisations -Wno-unsafe -Wno-safe -Wno-missing-local-signatures -Wno-monomorphism-restriction -Wno-implicit-prelude -Wno-orphans+ build-depends:+ aeson+ , base-noprelude >=4.7 && <5+ , co-log-core+ , fmt+ , loot-prelude+ , microlens+ , monad-control+ , mtl+ , network+ , universum+ , unix+ default-language: Haskell2010++test-suite co-log-sys-test+ type: exitcode-stdio-1.0+ main-is: Spec.hs+ other-modules:+ Paths_co_log_sys+ hs-source-dirs:+ test+ default-extensions: ApplicativeDo BangPatterns FlexibleContexts LambdaCase MultiWayIf NegativeLiterals OverloadedLabels OverloadedStrings PatternSynonyms PolyKinds RankNTypes RecordWildCards RecursiveDo StandaloneDeriving TupleSections+ ghc-options: -Weverything -Wno-missing-exported-signatures -Wno-missing-import-lists -Wno-missed-specialisations -Wno-all-missed-specialisations -Wno-unsafe -Wno-safe -Wno-missing-local-signatures -Wno-monomorphism-restriction -Wno-implicit-prelude -Wno-orphans -threaded -rtsopts -with-rtsopts=-N+ build-depends:+ aeson+ , base-noprelude >=4.7 && <5+ , co-log-core+ , co-log-sys+ , fmt+ , loot-prelude+ , microlens+ , monad-control+ , mtl+ , network+ , universum+ , unix+ default-language: Haskell2010
+ src/Colog/Syslog.hs view
@@ -0,0 +1,13 @@+module Colog.Syslog+ ( module Colog.Syslog.Actions+ , module Colog.Syslog.Config+ , module Colog.Syslog.Handler+ , module Colog.Syslog.Message+ , module Colog.Syslog.Priority+ ) where++import Colog.Syslog.Actions+import Colog.Syslog.Config+import Colog.Syslog.Handler+import Colog.Syslog.Message+import Colog.Syslog.Priority
+ src/Colog/Syslog/Actions.hs view
@@ -0,0 +1,28 @@+module Colog.Syslog.Actions+ ( -- * Syslog actions+ withLogMessageSyslog+ , withLogMessageSyslogGeneric+ ) where++import Colog.Core.Action (LogAction (..))++import Colog.Syslog.Config+import Colog.Syslog.Handler +import Colog.Syslog.Message++import Control.Monad.Trans.Control (MonadBaseControl)++-- | Sends a log using Syslog, implemented using continuation-passing style+-- (like for printing on file) because it's more efficient to open the connection+-- once at the beginning and it guarantees that the socket used will get closed.+withLogMessageSyslog :: MonadIO m => SyslogConfig -> (LogAction m Message -> IO r) -> IO r+withLogMessageSyslog config action = withSyslog config $ action . logSyslogMessage++-- | Like 'withLogMessageSyslog', but without the IO restriction on the continuation+-- function. NOTE: this allows more flexibility, but may also be slower+withLogMessageSyslogGeneric+ :: (MonadBaseControl IO n, MonadIO m)+ => SyslogConfig+ -> (LogAction m Message -> n r) -> n r+withLogMessageSyslogGeneric config action = withSyslogGeneric config $+ action . logSyslogMessage
+ src/Colog/Syslog/Config.hs view
@@ -0,0 +1,91 @@+module Colog.Syslog.Config+ ( -- * Configuration+ SyslogConfig (..)+ -- * Collector+ , Collector (..)+ -- * Re-exports+ , Family (..)+ , HostName+ , PortNumber+ ) where++import Colog.Syslog.Priority (Facility (..))++import Data.Aeson (FromJSON(..), ToJSON(..), Value (..), withText, withObject,+ withScientific, (.:), (.:?), (.!=), (.=), object)+import Fmt ((+|), (|+))+import Network.Socket (Family (..), HostName, PortNumber)++-- | Configuration for Syslog+data SyslogConfig = SyslogConfig+ { collector :: !Collector -- ^ Where the messages will be delivered+ , facility :: !Facility -- ^ Indicates the sending process type+ , appName :: !Text -- ^ A name to recognize the sending application+ } deriving (Show, Read, Eq)++instance FromJSON SyslogConfig where+ parseJSON = withObject "SyslogConfig" $ \v -> SyslogConfig+ <$> v .:? "collector" .!= AutoLocal+ <*> v .:? "facility" .!= User+ <*> v .: "app-name"++instance ToJSON SyslogConfig where+ toJSON SyslogConfig {..} = object+ [ "collector" .= collector+ , "facility" .= facility+ , "app-name" .= appName+ ]++-- | Represents a receiver for Syslog messages+data Collector+ = AutoLocal -- ^ Automatic local syslog destination+ | Local String -- ^ Path to local Unix FIFO. Not supported under Windows.+ | Remote Family HostName PortNumber+ -- ^ Remote server, it's made of:+ -- * Network Address 'Family' (usually AF_INET or AF_INET6)+ -- * Remote 'HostName' (can also be localhost)+ -- * 'PortNumber', for syslog is usually 514+ deriving (Show, Read, Eq)++instance FromJSON Collector where+ parseJSON = withObject "Collector" $ \v -> do+ collectorType <- v .: "collector-type"+ case collectorType :: Text of+ "auto" -> return AutoLocal+ "local" -> Local+ <$> v .:? "fifo-path" .!= "/dev/log"+ "remote" -> Remote+ <$> v .:? "family" .!= AF_INET+ <*> v .:? "hostname" .!= "localhost"+ <*> v .:? "port-number" .!= 514+ _ -> fail "Parsing Collector failed: unknown \"collector-type\""++instance ToJSON Collector where+ toJSON = \case+ AutoLocal -> object+ [ "collector-type" .= ("auto" :: Text)+ ]+ Local fifoPath -> object+ [ "collector-type" .= ("local" :: Text)+ , "fifo-path" .= fifoPath+ ]+ Remote family hostname portNum -> object+ [ "collector-type" .= ("remote" :: Text)+ , "family" .= family+ , "hostname" .= hostname+ , "port-number" .= portNum+ ]++-- Orphan Instances+instance FromJSON Family where+ parseJSON = withText "Family" $ \t ->+ maybe (fail $ "Unknown Family: \""+|t|+"\"") pure . readMaybe $ toString t++instance ToJSON Family where+ toJSON = String . show++instance FromJSON PortNumber where+ parseJSON = withScientific "PortNumber" $ pure . round++instance ToJSON PortNumber where+ toJSON = Number . fromIntegral
+ src/Colog/Syslog/Handler.hs view
@@ -0,0 +1,97 @@+module Colog.Syslog.Handler+ ( SyslogHandler (shClose)+ , mkSyslogHandler+ , withSyslog+ , withSyslogGeneric+ , logSyslogMessage+ ) where++import Colog.Core.Action (LogAction (..))++import Colog.Syslog.Config (SyslogConfig (..), Collector (..))+import Colog.Syslog.Message (Message (..))+import Colog.Syslog.Priority (Priority (..))++import Control.Exception (IOException)+import Network.Socket hiding (send, sendTo, recv, recvFrom)+import Network.Socket.ByteString+import System.Info (os)+import System.Posix.Process (getProcessID)+import Fmt ((+|), (|+), (|++|), (+||), (||+))++import Control.Monad.Trans.Control (MonadBaseControl, liftBaseOp)++-- | An Handler for Syslog connections+data SyslogHandler = SyslogHandler+ { shSend :: Message -> IO ()+ , shClose :: IO ()+ }++-- | Creates a 'SyslogHandler' from a 'SyslogConfig'+mkSyslogHandler :: SyslogConfig -> IO SyslogHandler+mkSyslogHandler SyslogConfig {..} = do+ (skt, sAddr, sType) <- openSyslogSocket collector+ let shSend = \Message {..} -> do+ pid <- if+ | onWindows -> return "[windows]"+ | otherwise -> getProcessID >>= \p -> return ("["+||p||+"]" :: Text)+ let priority = Priority facility msgSeverity+ msg = encodeUtf8+ (""+|priority|++|appName|++|pid|+": "+|msgContent|+"\0" :: Text)+ void $ case sType of+ Datagram -> sendTo skt msg sAddr+ _ -> send skt msg -- 'Stream' is the only possibility here+ shClose = close skt+ return $ SyslogHandler {..}++-- | Opens a connection to the specified 'Collector', gives back socket's infos+openSyslogSocket :: Collector -> IO (Socket, SockAddr, SocketType)+openSyslogSocket = \case+ AutoLocal -> if+ | onWindows -> openSyslogSocket $ Remote AF_INET "localhost" 514+ | onMacOs -> openSyslogSocket $ Local "/var/run/syslog"+ | otherwise -> openSyslogSocket $ Local "/dev/log"+ Local path -> if+ | onWindows -> fail "Local is not supported on Windows, you'll \+ \probably want to use AutoLocal instead"+ | otherwise -> do+ let unixAddr = SockAddrUnix path+ -- make a 'Stream' socket and try to connect to it+ skt <- socket AF_UNIX Stream defaultProtocol+ tryRes <- try $ connect skt unixAddr+ -- if it failed, use a 'Datagram' socket+ case tryRes :: Either IOException () of+ Right _ -> return (skt, unixAddr, Stream)+ Left _ -> do+ close skt+ dskt <- socket AF_UNIX Datagram defaultProtocol+ return (dskt, unixAddr, Datagram)+ Remote family hostName port -> do+ let hints = defaultHints+ { addrFlags = [AI_NUMERICSERV]+ , addrFamily = family+ , addrSocketType = Datagram+ }+ addrInfo:_ <- getAddrInfo (Just hints) (Just hostName) (Just $ show port)+ skt <- socket family Datagram defaultProtocol+ return (skt, addrAddress addrInfo, Datagram)++-- | Uses continuation-passing style for Syslog, similar to 'withFile' with 'Handle's+withSyslog :: SyslogConfig -> (SyslogHandler -> IO r) -> IO r+withSyslog config = bracket (mkSyslogHandler config) shClose++-- | Like 'withSyslog', but without the IO restriction on the continuation+-- function. NOTE: this allows more flexibility, but may also be slower+withSyslogGeneric :: MonadBaseControl IO m => SyslogConfig -> (SyslogHandler -> m r) -> m r+withSyslogGeneric config = liftBaseOp (bracket (mkSyslogHandler config) shClose)++-- | Uses a 'SyslogHandler' to make a 'LogAction' that logs 'Message's+logSyslogMessage :: MonadIO m => SyslogHandler -> LogAction m Message+logSyslogMessage SyslogHandler{..} = LogAction $ liftIO . shSend++-- Utility definitions for OS checking+onWindows :: Bool+onWindows = os == "mingw32"++onMacOs :: Bool+onMacOs = os == "darwin"
+ src/Colog/Syslog/Message.hs view
@@ -0,0 +1,32 @@+module Colog.Syslog.Message+ ( -- * Message type+ Message (..)+ -- * Lenses+ , severity+ , content+ -- * Formatting+ , fmtMessageFlat+ ) where++import Colog.Syslog.Priority (Severity(..))++import Fmt ((|+), (|++|))+import Lens.Micro (Lens', lens)++-- | This Type contains the info strictly REQUIRED by a syslog message+data Message = Message+ { msgSeverity :: !Severity -- ^ message 'Severity'+ , msgContent :: !Text -- ^ message content+ } deriving (Show)++-- | 'Lens' for a 'Message' severity+severity :: Lens' Message Severity+severity = lens msgSeverity $ \message svr -> message { msgSeverity = svr }++-- | 'Lens' for a 'Message' content+content :: Lens' Message Text+content = lens msgContent $ \message cnt -> message { msgContent = cnt }++-- | Simple formatting function to 'Text'+fmtMessageFlat :: Message -> Text+fmtMessageFlat Message {..} = msgSeverity|++|msgContent|+""
+ src/Colog/Syslog/Priority.hs view
@@ -0,0 +1,123 @@+module Colog.Syslog.Priority+ ( -- * Priority+ Priority (..)+ , priorityValue+ -- * Severity+ , Severity (..)+ , severityCode+ -- * Facility+ , Facility (..)+ , facilityCode+ ) where++import Data.Aeson (FromJSON(..), ToJSON(..), Value (..), withText, withObject,+ (.:), (.=), object)+import Data.Bits ((.|.), shiftL)+import Fmt (Buildable (build), fmt, (+|), (|+))+import Text.Show (Show (show))++-- | Represents the priority of a syslog message, as per RFC5424+data Priority = Priority Facility Severity+ deriving (Eq, Read)++-- NOTE: the angular parenthesis are important: they are required by the protocol+instance Buildable Priority where+ build p = "<"+|(priorityValue p)|+">"++instance Show Priority where+ show = fmt . build++instance FromJSON Priority where+ parseJSON = withObject "Priority" $ \v -> Priority+ <$> v .: "facility"+ <*> v .: "severity"++instance ToJSON Priority where+ toJSON (Priority facility severity) = object+ [ "facility" .= facility+ , "severity" .= severity+ ]++-- | Calculate the 'Priority' value of a message, as per RFC5424+priorityValue :: Priority -> Int+priorityValue (Priority fac sev) = facilityCode fac .|. severityCode sev+++-- | Represents the severity of a syslog message, as per RFC5424+data Severity+ = Emergency -- ^ System is unusable+ | Alert -- ^ Action must be taken immediately+ | Critical -- ^ Critical conditions+ | Error -- ^ Error conditions+ | Warning -- ^ Warning conditions+ | Notice -- ^ Normal but significant condition+ | Info -- ^ Informational messages+ | Debug -- ^ Debug-level messages+ deriving (Eq, Show, Read, Bounded, Enum)++-- | 'Ord' instance uses the 'Enum' instance reversed, so Severities can be+-- ordered correctly and 'Enum' can give us the right 'severityCode'+instance Ord Severity where+ compare l r = compare (fromEnum r) (fromEnum l)++instance Buildable Severity where+ build = \case+ Emergency -> "[Emergency] "+ Alert -> "[Alert] "+ Critical -> "[Critical] "+ Error -> "[Error] "+ Warning -> "[Warning] "+ Notice -> "[Notice] "+ Info -> "[Info] "+ Debug -> "[Debug] "++instance FromJSON Severity where+ parseJSON = withText "Severity" $ \t ->+ maybe (fail $ "Unknown Severity: \""+|t|+"\"") pure . readMaybe $ toString t++instance ToJSON Severity where+ toJSON = String . Prelude.show++-- | Numerical code for a 'Severity'. Used to calculate the 'priorityValue'.+severityCode :: Severity -> Int+severityCode = fromEnum+++-- | Represents the machine process that created a syslog event, as per RFC5424+data Facility+ = Kernel -- ^ Kernel messages+ | User -- ^ User-level messages. Unless something else applies, this should be your first choice.+ | Mail -- ^ Mail system+ | Daemon -- ^ System daemons+ | Auth -- ^ Security/Authorization messages+ | Syslog -- ^ Messages generated internally by syslogd+ | Lpr -- ^ Line printer subsystem+ | News -- ^ Network news subsystem+ | Uucp -- ^ UUCP subsystem+ | Cron -- ^ Cron messages+ | AuthPriv -- ^ Private Security/Authorization messages+ | Ftp -- ^ FTP daemon+ | Ntp -- ^ NTP subsystem+ | LogAudit -- ^ Log audit+ | LogAlert -- ^ Log alert+ | Clock -- ^ Clock daemon+ | Local0 -- ^ LOCAL 0 to 7 are not used by UNIX and can be used freely+ | Local1+ | Local2+ | Local3+ | Local4+ | Local5+ | Local6+ | Local7+ deriving (Eq, Show, Read, Bounded, Enum)++instance FromJSON Facility where+ parseJSON = withText "Facility" $ \t ->+ maybe (fail $ "Unknown Facility: \""+|t|+"\"") pure . readMaybe $ toString t++instance ToJSON Facility where+ toJSON = String . Prelude.show++-- | Numerical code for a 'Facility'. Used to calculate the 'priorityValue'.+facilityCode :: Facility -> Int+facilityCode fac = shiftL (fromEnum fac) 3
+ test/Spec.hs view
@@ -0,0 +1,2 @@+main :: IO ()+main = putStrLn "Test suite not yet implemented"