├── .gitignore ├── .swift-version ├── .travis.yml ├── LICENCE.txt ├── Package.swift ├── README.md ├── Sources ├── CSyslog │ ├── module.modulemap │ └── shim.h └── LoggingSyslog │ └── SyslogLogHandler.swift └── Tests ├── LinuxMain.swift └── LoggingSyslogTests ├── SyslogLogHandlerTests.swift └── XCTestManifests.swift /.gitignore: -------------------------------------------------------------------------------- 1 | Package.resolved 2 | .DS_Store 3 | /.build 4 | /Packages 5 | /*.xcodeproj 6 | -------------------------------------------------------------------------------- /.swift-version: -------------------------------------------------------------------------------- 1 | 5.0.1 2 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | branches: 2 | only: 3 | - master 4 | 5 | # The matrix of builds should cover each combination of Swift version 6 | # and platform that is supported. The version of Swift used is specified 7 | # by .swift-version, unless SWIFT_SNAPSHOT is specified. 8 | matrix: 9 | include: 10 | - os: linux 11 | dist: xenial 12 | sudo: required 13 | services: docker 14 | env: DOCKER_IMAGE=swift:5.0-xenial 15 | - os: linux 16 | dist: xenial 17 | sudo: required 18 | services: docker 19 | env: DOCKER_IMAGE=swift:5.0-bionic 20 | - os: osx 21 | osx_image: xcode10.2 22 | sudo: required 23 | 24 | before_install: 25 | - git clone https://github.com/IBM-Swift/Package-Builder.git 26 | 27 | script: 28 | - ./Package-Builder/build-package.sh -projectDir $TRAVIS_BUILD_DIR 29 | -------------------------------------------------------------------------------- /LICENCE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /Package.swift: -------------------------------------------------------------------------------- 1 | // swift-tools-version:5.0 2 | 3 | import PackageDescription 4 | 5 | let package = Package( 6 | name: "swift-log-syslog", 7 | products: [ 8 | .library( 9 | name: "LoggingSyslog", 10 | targets: ["LoggingSyslog"]), 11 | ], 12 | dependencies: [ 13 | .package(url: "https://github.com/apple/swift-log.git", from: "1.0.0"), 14 | ], 15 | targets: [ 16 | .systemLibrary(name: "CSyslog"), 17 | .target( 18 | name: "LoggingSyslog", 19 | dependencies: ["Logging", .target(name: "CSyslog")]), 20 | .testTarget( 21 | name: "LoggingSyslogTests", 22 | dependencies: ["LoggingSyslog", "Logging"]), 23 | ] 24 | ) 25 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # LoggingSyslog 2 | 3 | This Swift package implements a logging backend that logs to [`syslog`](https://en.wikipedia.org/wiki/Syslog). 4 | 5 | It is an implementation of a [`LogHandler`](https://github.com/apple/swift-log#on-the-implementation-of-a-logging-backend-a-loghandler) as defined by the Swift Server Working Group logging API. 6 | 7 | ## Usage 8 | 9 | Add `https://github.com/ianpartridge/swift-log-syslog.git` as a dependency in your Package.swift. 10 | 11 | Then, during your application startup, do: 12 | 13 | ```swift 14 | import Logging 15 | import LoggingSyslog 16 | 17 | // Initialize the syslog logger 18 | LoggingSystem.bootstrap(SyslogLogHandler.init) 19 | ``` 20 | 21 | Elsewhere in your application, when you need to log, do: 22 | 23 | ```swift 24 | // Create a logger (or re-use one you already have) 25 | let logger = Logger(label: "MyApp") 26 | 27 | // Log! 28 | logger.info("Hello World!") 29 | ``` 30 | -------------------------------------------------------------------------------- /Sources/CSyslog/module.modulemap: -------------------------------------------------------------------------------- 1 | module CSyslog { 2 | header "shim.h" 3 | export * 4 | } 5 | -------------------------------------------------------------------------------- /Sources/CSyslog/shim.h: -------------------------------------------------------------------------------- 1 | #ifndef shim_h 2 | #define shim_h 3 | 4 | #include 5 | 6 | static inline void syslog_helper(int priority, const char *message) { 7 | syslog(priority, "%s", message); 8 | } 9 | 10 | #endif /* shim_h */ 11 | -------------------------------------------------------------------------------- /Sources/LoggingSyslog/SyslogLogHandler.swift: -------------------------------------------------------------------------------- 1 | import CSyslog 2 | import Logging 3 | 4 | /// A `LogHandler` which logs to `syslog(3)`. 5 | public struct SyslogLogHandler: LogHandler { 6 | 7 | /// Create a `SyslogLogHandler`. 8 | public init(label: String) { 9 | self.label = label 10 | } 11 | 12 | public let label: String 13 | 14 | public var logLevel: Logger.Level = .info 15 | 16 | public func log(level: Logger.Level, 17 | message: Logger.Message, 18 | metadata: Logger.Metadata?, 19 | file: String, function: String, line: UInt) { 20 | let prettyMetadata = metadata?.isEmpty ?? true 21 | ? self.prettyMetadata 22 | : self.prettify(self.metadata.merging(metadata!, uniquingKeysWith: { _, new in new })) 23 | 24 | let message = "\(self.label): \(prettyMetadata.map { " \($0)" } ?? "") \(message)" 25 | message.withCString { 26 | syslog_helper(level.asSyslogPriority(), $0) 27 | } 28 | } 29 | 30 | private var prettyMetadata: String? 31 | public var metadata = Logger.Metadata() { 32 | didSet { 33 | self.prettyMetadata = self.prettify(self.metadata) 34 | } 35 | } 36 | 37 | public subscript(metadataKey metadataKey: String) -> Logger.Metadata.Value? { 38 | get { 39 | return self.metadata[metadataKey] 40 | } 41 | set { 42 | self.metadata[metadataKey] = newValue 43 | } 44 | } 45 | 46 | private func prettify(_ metadata: Logger.Metadata) -> String? { 47 | return !metadata.isEmpty ? metadata.map { "\($0)=\($1)" }.joined(separator: " ") : nil 48 | } 49 | } 50 | 51 | extension Logger.Level { 52 | func asSyslogPriority() -> Int32 { 53 | switch self { 54 | case .trace: 55 | // syslog does not have "trace", so use debug for this 56 | return LOG_DEBUG 57 | case .debug: 58 | return LOG_DEBUG 59 | case .info: 60 | return LOG_INFO 61 | case .notice: 62 | return LOG_NOTICE 63 | case .warning: 64 | return LOG_WARNING 65 | case .error: 66 | return LOG_ERR 67 | case .critical: 68 | return LOG_CRIT 69 | } 70 | } 71 | } 72 | -------------------------------------------------------------------------------- /Tests/LinuxMain.swift: -------------------------------------------------------------------------------- 1 | import XCTest 2 | 3 | import LoggingSyslogTests 4 | 5 | var tests = [XCTestCaseEntry]() 6 | tests += LoggingSyslogTests.__allTests() 7 | 8 | XCTMain(tests) 9 | -------------------------------------------------------------------------------- /Tests/LoggingSyslogTests/SyslogLogHandlerTests.swift: -------------------------------------------------------------------------------- 1 | import Logging 2 | import LoggingSyslog 3 | import XCTest 4 | 5 | final class SyslogLogHandlerTests: XCTestCase { 6 | func testHelloWorld() { 7 | LoggingSystem.bootstrap(SyslogLogHandler.init) 8 | 9 | let logger = Logger(label: "SwiftLogSyslogTest") 10 | logger.info("Hello World!") 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /Tests/LoggingSyslogTests/XCTestManifests.swift: -------------------------------------------------------------------------------- 1 | #if !canImport(ObjectiveC) 2 | import XCTest 3 | 4 | extension SyslogLogHandlerTests { 5 | // DO NOT MODIFY: This is autogenerated, use: 6 | // `swift test --generate-linuxmain` 7 | // to regenerate. 8 | static let __allTests__SyslogLogHandlerTests = [ 9 | ("testHelloWorld", testHelloWorld), 10 | ] 11 | } 12 | 13 | public func __allTests() -> [XCTestCaseEntry] { 14 | return [ 15 | testCase(SyslogLogHandlerTests.__allTests__SyslogLogHandlerTests), 16 | ] 17 | } 18 | #endif 19 | --------------------------------------------------------------------------------