55 |
56 | /// Write to file
57 | public func write(_ string: String) {
58 | string.withCString { ptr in
59 | flockfile(file)
60 | defer {
61 | funlockfile(file)
62 | }
63 | _ = fputs(ptr, file)
64 | }
65 | }
66 |
67 | internal static let stderr = StdioOutputStream(file: systemStderr)
68 | internal static let stdout = StdioOutputStream(file: systemStdout)
69 | }
70 |
71 | // Prevent name clashes
72 | #if os(macOS) || os(tvOS) || os(iOS) || os(watchOS)
73 | let systemStderr = Darwin.stderr
74 | let systemStdout = Darwin.stdout
75 | #else
76 | let systemStderr = Glibc.stderr!
77 | let systemStdout = Glibc.stdout!
78 | #endif
79 |
--------------------------------------------------------------------------------
/Sources/LoggingFormatAndPipe/Formatter.swift:
--------------------------------------------------------------------------------
1 | //
2 | // Formatter.swift
3 | // LoggingFormatAndPipe
4 | //
5 | // Created by Ian Grossberg on 7/22/19.
6 | //
7 |
8 | import Logging
9 | import Foundation
10 |
11 | /// Possible log format components
12 | public enum LogComponent {
13 | /// Timestamp of log
14 | /// Specifying your timestamp format can be done by providing a DateFormatter through `Formatter.timestampFormatter`
15 | case timestamp
16 |
17 | /// Log level
18 | case level
19 | /// The actual message
20 | case message
21 | /// Log metadata
22 | case metadata
23 | /// The log's originating file
24 | case file
25 | /// The log's originating function
26 | case function
27 | /// The log's originating line number
28 | case line
29 |
30 | /// Literal text
31 | case text(String)
32 | /// A group of `LogComponents`, not using the specified `separator`
33 | case group([LogComponent])
34 |
35 | /// All basic log format component types
36 | public static var allNonmetaComponents: [LogComponent] {
37 | return [
38 | .timestamp,
39 | .level,
40 | .message,
41 | .metadata,
42 | .file,
43 | .function,
44 | .line
45 | ]
46 | }
47 | }
48 |
49 | /// Log Formatter
50 | public protocol Formatter {
51 | /// Timestamp formatter
52 | var timestampFormatter: DateFormatter { get }
53 |
54 | /// Formatter's chance to format the log
55 | /// - Parameter level: log level
56 | /// - Parameter message: actual message
57 | /// - Parameter prettyMetadata: optional metadata that has already been "prettified"
58 | /// - Parameter file: log's originating file
59 | /// - Parameter function: log's originating function
60 | /// - Parameter line: log's originating line
61 | /// - Returns: Result of formatting the log
62 | func processLog(level: Logger.Level,
63 | message: Logger.Message,
64 | prettyMetadata: String?,
65 | file: String, function: String, line: UInt) -> String
66 |
67 | }
68 |
69 | extension Formatter {
70 | /// Common usage component formatter
71 | /// - Parameter _: component to format
72 | /// - Parameter now: log's Date
73 | /// - Parameter level: log level
74 | /// - Parameter message: actual message
75 | /// - Parameter prettyMetadata: optional metadata that has already been "prettified"
76 | /// - Parameter file: log's originating file
77 | /// - Parameter function: log's originating function
78 | /// - Parameter line: log's originating line
79 | /// - Returns: Result of formatting the component
80 | public func processComponent(_ component: LogComponent, now: Date, level: Logger.Level,
81 | message: Logger.Message,
82 | prettyMetadata: String?,
83 | file: String, function: String, line: UInt) -> String {
84 | switch component {
85 | case .timestamp:
86 | return self.timestampFormatter.string(from: now)
87 | case .level:
88 | return "\(level)"
89 | case .message:
90 | return "\(message)"
91 | case .metadata:
92 | return "\(prettyMetadata.map { "\($0)" } ?? "")"
93 | case .file:
94 | return "\(file)"
95 | case .function:
96 | return "\(function)"
97 | case .line:
98 | return "\(line)"
99 | case .text(let string):
100 | return string
101 | case .group(let logComponents):
102 | return logComponents.map({ (component) -> String in
103 | self.processComponent(component, now: now, level: level, message: message, prettyMetadata: prettyMetadata, file: file, function: function, line: line)
104 | }).joined()
105 | }
106 | }
107 | }
108 |
--------------------------------------------------------------------------------
/Sources/LoggingFormatAndPipe/BasicFormatter.swift:
--------------------------------------------------------------------------------
1 | //
2 | // BasicFormatter.swift
3 | // LoggingFormatAndPipe
4 | //
5 | // Created by Ian Grossberg on 7/26/19.
6 | //
7 |
8 | import Logging
9 | import Foundation
10 |
11 | /// Your basic, customizable log formatter
12 | /// `BasicFormatter` does not need any setup and will automatically include all log components
13 | /// It can also be given a linear sequence of log components and it will build formatted logs in that order
14 | public struct BasicFormatter: Formatter {
15 | /// Log format sequential specification
16 | public let format: [LogComponent]
17 | /// Log component separator
18 | public let separator: String?
19 | /// Log timestamp component formatter
20 | public let timestampFormatter: DateFormatter
21 |
22 | /// Default timestamp component formatter
23 | static public var timestampFormatter: DateFormatter {
24 | let result = DateFormatter()
25 | result.dateFormat = "yyyy-MM-dd'T'HH:mm:ssZ"
26 | return result
27 | }
28 |
29 | /// Default init
30 | /// - Parameters:
31 | /// - _: Log format specification(default: `LogComponent.allNonmetaComponents`)
32 | /// - separator: Log component separator (default: " ")
33 | /// - timestampFormatter: Log timestamp component formatter (default: `BasicFormatter.timestampFormatter`)
34 | public init(_ format: [LogComponent] = LogComponent.allNonmetaComponents, separator: String = " ", timestampFormatter: DateFormatter = BasicFormatter.timestampFormatter) {
35 | self.format = format
36 | self.separator = separator
37 | self.timestampFormatter = timestampFormatter
38 | }
39 |
40 | /// Our main log formatting method
41 | /// - Parameters:
42 | /// - level: log level
43 | /// - message: actual message
44 | /// - prettyMetadata: optional metadata that has already been "prettified"
45 | /// - file: log's originating file
46 | /// - function: log's originating function
47 | /// - line: log's originating line
48 | /// - Returns: Result of formatting the log
49 | public func processLog(level: Logger.Level,
50 | message: Logger.Message,
51 | prettyMetadata: String?,
52 | file: String, function: String, line: UInt) -> String {
53 | let now = Date()
54 |
55 | return self.format.map({ (component) -> String in
56 | return self.processComponent(component, now: now, level: level, message: message, prettyMetadata: prettyMetadata, file: file, function: function, line: line)
57 | }).filter({ (string) -> Bool in
58 | return string.count > 0
59 | }).joined(separator: self.separator ?? "")
60 | }
61 |
62 | /// [apple/swift-log](https://github.com/apple/swift-log)'s log format
63 | ///
64 | /// `{timestamp} {level}: {message}`
65 | ///
66 | /// *Example:*
67 | ///
68 | /// `2019-07-30T13:49:07-0400 error: Test error message`
69 | public static let apple = BasicFormatter(
70 | [
71 | .timestamp,
72 | .group([
73 | .level,
74 | .text(":"),
75 | ]),
76 | .message
77 | ]
78 | )
79 |
80 | /// Adorkable's go-to log format 😘
81 | ///
82 | /// `{timestamp} ▶ {level} ▶ {file}:{line} ▶ {function} ▶ {message} ▶ {metadata}`
83 | ///
84 | /// *Example:*
85 | ///
86 | /// `2019-07-30T13:49:07-0400 ▶ error ▶ /asdf/swift-log-format-and-pipe/Tests/LoggingFormatAndPipeTests/FormatterTests.swift:25 ▶ testFormatter(_:) ▶ Test error message`
87 | public static let adorkable = BasicFormatter(
88 | [
89 | .timestamp,
90 | .level,
91 | .group([
92 | .file,
93 | .text(":"),
94 | .line
95 | ]),
96 | .function,
97 | .message,
98 | .metadata
99 | ],
100 | separator: " ▶ "
101 | )
102 | }
103 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # LoggingFormatAndPipe
2 | **LoggingFormatAndPipe** provides a [Swift Logging API](https://github.com/apple/swift-log) Handler which allows you to customized both your log messages' formats as well as their destinations.
3 |
4 | If you don't like the default log format change it to one you would like. If you want one destination to be formatted differently than your other destination you can with ease. Or send the same format to multiple destinations!
5 |
6 |
7 | Installation | Getting Started | Documentation
8 |
9 |
10 | ## Installation
11 |
12 | ### SwiftPM
13 |
14 | To use the **LoggingFormatAndPipe** library in your project add the following in your `Package.swift`:
15 |
16 | ```swift
17 | .package(url: "https://github.com/adorkable/swift-log-format-and-pipe.git", .from("0.1.2")),
18 | ```
19 |
20 |
21 | ## Getting Started
22 |
23 | `LoggingFormatAndPipe.Handler` expects both a `Formatter` and a `Pipe`
24 |
25 | ```swift
26 | let logger = Logger(label: "example") { _ in
27 | return LoggingFormatAndPipe.Handler(
28 | formatter: ...,
29 | pipe: ...
30 | )
31 | }
32 | ```
33 |
34 | *Example:*
35 |
36 | ```swift
37 | let logger = Logger(label: "example") { _ in
38 | return LoggingFormatAndPipe.Handler(
39 | formatter: BasicFormatter.adorkable,
40 | pipe: LoggerTextOutputStreamPipe.standardOutput
41 | )
42 | }
43 | ```
44 |
45 | ## Formatting
46 | There are a number of ways of customizing the format but are generally composed of a combination of `LogComponents`:
47 |
48 | * `.timestamp` - Timestamp of log
49 | * `.level` - Log level
50 | * `.message` - The actual message
51 | * `.metadata` - Log metadata
52 | * `.file` - The log's originating file
53 | * `.line` - The log's originating line number in the file
54 | * `.function` - The log's originating function
55 | * `.text(String)` - Static text
56 | * `.group([LogComponents])` - Formatters may separate specified `LogComponents` in various ways as per their format, `.group` tells the Formatter to combine the `LogComponents` without using its separation
57 |
58 | ### BasicFormatter
59 | `BasicFormatter` allows you to specify a sequence of `LogComponents` and a separator string and automatically processes them into a single line for each new log message.
60 |
61 | It includes already setup static instances:
62 |
63 | * `.apple` - [apple/swift-log](https://github.com/apple/swift-log) format
64 |
65 | `{timestamp} {level}: {message}`
66 |
67 | *Example:*
68 |
69 | `2019-07-30T13:49:07-0400 error: Test error message`
70 | * `.adorkable` - Adorkable's standard format 😘
71 |
72 | `{timestamp} ▶ {level} ▶ {file}:{line} ▶ {function} ▶ {message} ▶ {metadata}`
73 |
74 | *Example:*
75 |
76 | `2019-07-30T13:49:07-0400 ▶ error ▶ /asdf/swift-log-format-and-pipe/Tests/LoggingFormatAndPipeTests/FormatterTests.swift:25 ▶ testFormatter(_:) ▶ Test error message`
77 |
78 | #### Customizing a BasicFormatter
79 | If none of these work you can customize your own instance!
80 |
81 | Suppose you want a special short log format with a timestamp, the level, the file it originated in, and the message itself:
82 |
83 | ```swift
84 | let myFormat = BasicFormatter(
85 | [
86 | .timestamp,
87 | .level,
88 | .file,
89 | .message
90 | ]
91 | )
92 | ```
93 |
94 | To change the separator from a single space specify the separator parameter:
95 |
96 | ```swift
97 | let myFormat = BasicFormatter(
98 | ...,
99 | separator: "|"
100 | )
101 | ```
102 |
103 | Note that `BasicFormatter` will not add an empty string and separator for a `nil` metadata.
104 |
105 | To change the timestamp from the default:
106 |
107 | ```swift
108 | let myDateFormat = DateFormatter()
109 | myDateFormat.dateFormat = "yyyy-MM-dd'T'HH:mm:ssZZZZZ"
110 | let myFormat = BasicFormatter(
111 | ...,
112 | timestampFormatter: myDateFormat
113 | )
114 | ```
115 |
116 | ### Implementing Formatter
117 | You can also create your own `Formatter` conforming object by implementing:
118 |
119 | * `var timestampFormatter: DateFormatter { get }`
120 | * `func processLog(level: Logger.Level,
121 | message: Logger.Message,
122 | prettyMetadata: String?,
123 | file: String, function: String, line: UInt) -> String`
124 |
125 | More formatters to come!
126 |
127 | ## Piping
128 | Pipes specify where your formatted log lines end up going to. Included already are:
129 |
130 | * `LoggerTextOutputStreamPipe.standardOutput` - log lines to `stdout`
131 | * `LoggerTextOutputStreamPipe.standardError` - log lines to `stderr`
132 |
133 | More pipes to come!
134 |
135 | ### Implementing Pipe
136 | You can also create your own `Pipe` conforming object by implementing:
137 |
138 | * `func handle(_ formattedLogLine: String)`
139 |
140 | Easy!
141 |
142 | Now you've got your use-case formatted log lines traveling this way and then, what a charm 🖤
143 |
144 | ## API Documentation
145 | For more insight into the library API documentation is found in the repo [here](http://adorkable.github.io/swift-log-format-and-pipe/)
146 |
--------------------------------------------------------------------------------
/docs/css/highlight.css:
--------------------------------------------------------------------------------
1 | /* Credit to https://gist.github.com/wataru420/2048287 */
2 | .highlight {
3 | /* Comment */
4 | /* Error */
5 | /* Keyword */
6 | /* Operator */
7 | /* Comment.Multiline */
8 | /* Comment.Preproc */
9 | /* Comment.Single */
10 | /* Comment.Special */
11 | /* Generic.Deleted */
12 | /* Generic.Deleted.Specific */
13 | /* Generic.Emph */
14 | /* Generic.Error */
15 | /* Generic.Heading */
16 | /* Generic.Inserted */
17 | /* Generic.Inserted.Specific */
18 | /* Generic.Output */
19 | /* Generic.Prompt */
20 | /* Generic.Strong */
21 | /* Generic.Subheading */
22 | /* Generic.Traceback */
23 | /* Keyword.Constant */
24 | /* Keyword.Declaration */
25 | /* Keyword.Pseudo */
26 | /* Keyword.Reserved */
27 | /* Keyword.Type */
28 | /* Literal.Number */
29 | /* Literal.String */
30 | /* Name.Attribute */
31 | /* Name.Builtin */
32 | /* Name.Class */
33 | /* Name.Constant */
34 | /* Name.Entity */
35 | /* Name.Exception */
36 | /* Name.Function */
37 | /* Name.Namespace */
38 | /* Name.Tag */
39 | /* Name.Variable */
40 | /* Operator.Word */
41 | /* Text.Whitespace */
42 | /* Literal.Number.Float */
43 | /* Literal.Number.Hex */
44 | /* Literal.Number.Integer */
45 | /* Literal.Number.Oct */
46 | /* Literal.String.Backtick */
47 | /* Literal.String.Char */
48 | /* Literal.String.Doc */
49 | /* Literal.String.Double */
50 | /* Literal.String.Escape */
51 | /* Literal.String.Heredoc */
52 | /* Literal.String.Interpol */
53 | /* Literal.String.Other */
54 | /* Literal.String.Regex */
55 | /* Literal.String.Single */
56 | /* Literal.String.Symbol */
57 | /* Name.Builtin.Pseudo */
58 | /* Name.Variable.Class */
59 | /* Name.Variable.Global */
60 | /* Name.Variable.Instance */
61 | /* Literal.Number.Integer.Long */ }
62 | .highlight .c {
63 | color: #999988;
64 | font-style: italic; }
65 | .highlight .err {
66 | color: #a61717;
67 | background-color: #e3d2d2; }
68 | .highlight .k {
69 | color: #000000;
70 | font-weight: bold; }
71 | .highlight .o {
72 | color: #000000;
73 | font-weight: bold; }
74 | .highlight .cm {
75 | color: #999988;
76 | font-style: italic; }
77 | .highlight .cp {
78 | color: #999999;
79 | font-weight: bold; }
80 | .highlight .c1 {
81 | color: #999988;
82 | font-style: italic; }
83 | .highlight .cs {
84 | color: #999999;
85 | font-weight: bold;
86 | font-style: italic; }
87 | .highlight .gd {
88 | color: #000000;
89 | background-color: #ffdddd; }
90 | .highlight .gd .x {
91 | color: #000000;
92 | background-color: #ffaaaa; }
93 | .highlight .ge {
94 | color: #000000;
95 | font-style: italic; }
96 | .highlight .gr {
97 | color: #aa0000; }
98 | .highlight .gh {
99 | color: #999999; }
100 | .highlight .gi {
101 | color: #000000;
102 | background-color: #ddffdd; }
103 | .highlight .gi .x {
104 | color: #000000;
105 | background-color: #aaffaa; }
106 | .highlight .go {
107 | color: #888888; }
108 | .highlight .gp {
109 | color: #555555; }
110 | .highlight .gs {
111 | font-weight: bold; }
112 | .highlight .gu {
113 | color: #aaaaaa; }
114 | .highlight .gt {
115 | color: #aa0000; }
116 | .highlight .kc {
117 | color: #000000;
118 | font-weight: bold; }
119 | .highlight .kd {
120 | color: #000000;
121 | font-weight: bold; }
122 | .highlight .kp {
123 | color: #000000;
124 | font-weight: bold; }
125 | .highlight .kr {
126 | color: #000000;
127 | font-weight: bold; }
128 | .highlight .kt {
129 | color: #445588; }
130 | .highlight .m {
131 | color: #009999; }
132 | .highlight .s {
133 | color: #d14; }
134 | .highlight .na {
135 | color: #008080; }
136 | .highlight .nb {
137 | color: #0086B3; }
138 | .highlight .nc {
139 | color: #445588;
140 | font-weight: bold; }
141 | .highlight .no {
142 | color: #008080; }
143 | .highlight .ni {
144 | color: #800080; }
145 | .highlight .ne {
146 | color: #990000;
147 | font-weight: bold; }
148 | .highlight .nf {
149 | color: #990000; }
150 | .highlight .nn {
151 | color: #555555; }
152 | .highlight .nt {
153 | color: #000080; }
154 | .highlight .nv {
155 | color: #008080; }
156 | .highlight .ow {
157 | color: #000000;
158 | font-weight: bold; }
159 | .highlight .w {
160 | color: #bbbbbb; }
161 | .highlight .mf {
162 | color: #009999; }
163 | .highlight .mh {
164 | color: #009999; }
165 | .highlight .mi {
166 | color: #009999; }
167 | .highlight .mo {
168 | color: #009999; }
169 | .highlight .sb {
170 | color: #d14; }
171 | .highlight .sc {
172 | color: #d14; }
173 | .highlight .sd {
174 | color: #d14; }
175 | .highlight .s2 {
176 | color: #d14; }
177 | .highlight .se {
178 | color: #d14; }
179 | .highlight .sh {
180 | color: #d14; }
181 | .highlight .si {
182 | color: #d14; }
183 | .highlight .sx {
184 | color: #d14; }
185 | .highlight .sr {
186 | color: #009926; }
187 | .highlight .s1 {
188 | color: #d14; }
189 | .highlight .ss {
190 | color: #990073; }
191 | .highlight .bp {
192 | color: #999999; }
193 | .highlight .vc {
194 | color: #008080; }
195 | .highlight .vg {
196 | color: #008080; }
197 | .highlight .vi {
198 | color: #008080; }
199 | .highlight .il {
200 | color: #009999; }
201 |
--------------------------------------------------------------------------------
/docs/docsets/LoggingFormatAndPipe.docset/Contents/Resources/Documents/css/highlight.css:
--------------------------------------------------------------------------------
1 | /* Credit to https://gist.github.com/wataru420/2048287 */
2 | .highlight {
3 | /* Comment */
4 | /* Error */
5 | /* Keyword */
6 | /* Operator */
7 | /* Comment.Multiline */
8 | /* Comment.Preproc */
9 | /* Comment.Single */
10 | /* Comment.Special */
11 | /* Generic.Deleted */
12 | /* Generic.Deleted.Specific */
13 | /* Generic.Emph */
14 | /* Generic.Error */
15 | /* Generic.Heading */
16 | /* Generic.Inserted */
17 | /* Generic.Inserted.Specific */
18 | /* Generic.Output */
19 | /* Generic.Prompt */
20 | /* Generic.Strong */
21 | /* Generic.Subheading */
22 | /* Generic.Traceback */
23 | /* Keyword.Constant */
24 | /* Keyword.Declaration */
25 | /* Keyword.Pseudo */
26 | /* Keyword.Reserved */
27 | /* Keyword.Type */
28 | /* Literal.Number */
29 | /* Literal.String */
30 | /* Name.Attribute */
31 | /* Name.Builtin */
32 | /* Name.Class */
33 | /* Name.Constant */
34 | /* Name.Entity */
35 | /* Name.Exception */
36 | /* Name.Function */
37 | /* Name.Namespace */
38 | /* Name.Tag */
39 | /* Name.Variable */
40 | /* Operator.Word */
41 | /* Text.Whitespace */
42 | /* Literal.Number.Float */
43 | /* Literal.Number.Hex */
44 | /* Literal.Number.Integer */
45 | /* Literal.Number.Oct */
46 | /* Literal.String.Backtick */
47 | /* Literal.String.Char */
48 | /* Literal.String.Doc */
49 | /* Literal.String.Double */
50 | /* Literal.String.Escape */
51 | /* Literal.String.Heredoc */
52 | /* Literal.String.Interpol */
53 | /* Literal.String.Other */
54 | /* Literal.String.Regex */
55 | /* Literal.String.Single */
56 | /* Literal.String.Symbol */
57 | /* Name.Builtin.Pseudo */
58 | /* Name.Variable.Class */
59 | /* Name.Variable.Global */
60 | /* Name.Variable.Instance */
61 | /* Literal.Number.Integer.Long */ }
62 | .highlight .c {
63 | color: #999988;
64 | font-style: italic; }
65 | .highlight .err {
66 | color: #a61717;
67 | background-color: #e3d2d2; }
68 | .highlight .k {
69 | color: #000000;
70 | font-weight: bold; }
71 | .highlight .o {
72 | color: #000000;
73 | font-weight: bold; }
74 | .highlight .cm {
75 | color: #999988;
76 | font-style: italic; }
77 | .highlight .cp {
78 | color: #999999;
79 | font-weight: bold; }
80 | .highlight .c1 {
81 | color: #999988;
82 | font-style: italic; }
83 | .highlight .cs {
84 | color: #999999;
85 | font-weight: bold;
86 | font-style: italic; }
87 | .highlight .gd {
88 | color: #000000;
89 | background-color: #ffdddd; }
90 | .highlight .gd .x {
91 | color: #000000;
92 | background-color: #ffaaaa; }
93 | .highlight .ge {
94 | color: #000000;
95 | font-style: italic; }
96 | .highlight .gr {
97 | color: #aa0000; }
98 | .highlight .gh {
99 | color: #999999; }
100 | .highlight .gi {
101 | color: #000000;
102 | background-color: #ddffdd; }
103 | .highlight .gi .x {
104 | color: #000000;
105 | background-color: #aaffaa; }
106 | .highlight .go {
107 | color: #888888; }
108 | .highlight .gp {
109 | color: #555555; }
110 | .highlight .gs {
111 | font-weight: bold; }
112 | .highlight .gu {
113 | color: #aaaaaa; }
114 | .highlight .gt {
115 | color: #aa0000; }
116 | .highlight .kc {
117 | color: #000000;
118 | font-weight: bold; }
119 | .highlight .kd {
120 | color: #000000;
121 | font-weight: bold; }
122 | .highlight .kp {
123 | color: #000000;
124 | font-weight: bold; }
125 | .highlight .kr {
126 | color: #000000;
127 | font-weight: bold; }
128 | .highlight .kt {
129 | color: #445588; }
130 | .highlight .m {
131 | color: #009999; }
132 | .highlight .s {
133 | color: #d14; }
134 | .highlight .na {
135 | color: #008080; }
136 | .highlight .nb {
137 | color: #0086B3; }
138 | .highlight .nc {
139 | color: #445588;
140 | font-weight: bold; }
141 | .highlight .no {
142 | color: #008080; }
143 | .highlight .ni {
144 | color: #800080; }
145 | .highlight .ne {
146 | color: #990000;
147 | font-weight: bold; }
148 | .highlight .nf {
149 | color: #990000; }
150 | .highlight .nn {
151 | color: #555555; }
152 | .highlight .nt {
153 | color: #000080; }
154 | .highlight .nv {
155 | color: #008080; }
156 | .highlight .ow {
157 | color: #000000;
158 | font-weight: bold; }
159 | .highlight .w {
160 | color: #bbbbbb; }
161 | .highlight .mf {
162 | color: #009999; }
163 | .highlight .mh {
164 | color: #009999; }
165 | .highlight .mi {
166 | color: #009999; }
167 | .highlight .mo {
168 | color: #009999; }
169 | .highlight .sb {
170 | color: #d14; }
171 | .highlight .sc {
172 | color: #d14; }
173 | .highlight .sd {
174 | color: #d14; }
175 | .highlight .s2 {
176 | color: #d14; }
177 | .highlight .se {
178 | color: #d14; }
179 | .highlight .sh {
180 | color: #d14; }
181 | .highlight .si {
182 | color: #d14; }
183 | .highlight .sx {
184 | color: #d14; }
185 | .highlight .sr {
186 | color: #009926; }
187 | .highlight .s1 {
188 | color: #d14; }
189 | .highlight .ss {
190 | color: #990073; }
191 | .highlight .bp {
192 | color: #999999; }
193 | .highlight .vc {
194 | color: #008080; }
195 | .highlight .vg {
196 | color: #008080; }
197 | .highlight .vi {
198 | color: #008080; }
199 | .highlight .il {
200 | color: #009999; }
201 |
--------------------------------------------------------------------------------
/docs/Enums.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Enumerations Reference
5 |
45 | LoggingFormatAndPipe Reference
46 |
49 |
50 |
51 |
52 |
90 |
91 |
92 |
93 |
94 |
95 |
Enumerations
96 |
The following enumerations are available globally.
97 |
98 |
100 |
101 |
102 |
103 |
104 |
105 |
106 |
113 |
114 |
115 |
116 |
117 |
118 |
Possible log format components
119 |
120 |
See more
121 |
123 |
Declaration
124 |
125 |
Swift
126 |
public enum LogComponent
127 |
128 |
129 |
134 |
136 |
137 |
138 |
140 |
141 |
142 |
Enumerations Reference
5 |
45 | LoggingFormatAndPipe Reference
46 |
49 |
50 |
51 |
52 |
90 |
91 |
92 |
93 |
94 |
95 |
Enumerations
96 |
The following enumerations are available globally.
97 |
98 |
100 |
101 |
102 |
103 |
104 |
105 |
106 |
113 |
114 |
115 |
116 |
117 |
118 |
Possible log format components
119 |
120 |
See more
121 |
123 |
Declaration
124 |
125 |
Swift
126 |
public enum LogComponent
127 |
128 |
129 |
134 |
136 |
137 |
138 |
140 |
141 |
142 |
Pipe Protocol Reference
5 |
45 | LoggingFormatAndPipe Reference
46 |
49 |
50 |
51 |
52 |
90 |
91 |
92 |
93 |
94 |
95 |
Pipe
96 |
97 |
98 |
public protocol Pipe
99 |
100 |
101 |
102 |
Log PIpe
103 |
104 |
106 |
107 |
108 |
109 |
110 |
111 |
112 |
119 |
120 |
121 |
122 |
123 |
124 |
Pipe’s chance to send a formatted line where it deems
125 |
126 |
128 |
Declaration
129 |
130 |
Swift
131 |
func handle ( _ formattedLogLine : String )
132 |
133 |
134 |
136 |
Parameters
137 |
138 |
139 |
140 |
141 |
142 | _
143 |
144 |
145 |
146 |
147 |
The formatted log to handle
148 |
150 |
151 |
152 |
153 |
158 |
160 |
161 |
162 |
164 |
165 |
166 |
Pipe Protocol Reference
5 |
45 | LoggingFormatAndPipe Reference
46 |
49 |
50 |
51 |
52 |
90 |
91 |
92 |
93 |
94 |
95 |
Pipe
96 |
97 |
98 |
public protocol Pipe
99 |
100 |
101 |
102 |
Log PIpe
103 |
104 |
106 |
107 |
108 |
109 |
110 |
111 |
112 |
119 |
120 |
121 |
122 |
123 |
124 |
Pipe’s chance to send a formatted line where it deems
125 |
126 |
128 |
Declaration
129 |
130 |
Swift
131 |
func handle ( _ formattedLogLine : String )
132 |
133 |
134 |
136 |
Parameters
137 |
138 |
139 |
140 |
141 |
142 | _
143 |
144 |
145 |
146 |
147 |
The formatted log to handle
148 |
150 |
151 |
152 |
153 |
158 |
160 |
161 |
162 |
164 |
165 |
166 |
Protocols Reference
5 |
45 | LoggingFormatAndPipe Reference
46 |
49 |
50 |
51 |
52 |
90 |
91 |
92 |
93 |
94 |
95 |
Protocols
96 |
The following protocols are available globally.
97 |
98 |
100 |
101 |
102 |
103 |
104 |
105 |
106 |
107 |
108 | Formatter
111 |
112 |
114 |
115 |
116 |
117 |
118 |
Log Formatter
119 |
120 |
See more
121 |
123 |
Declaration
124 |
125 |
Swift
126 |
public protocol Formatter
127 |
128 |
129 |
134 |
136 |
137 |
138 |
139 |
140 |
141 |
142 |
143 | Pipe
146 |
147 |
149 |
150 |
151 |
152 |
153 |
Log PIpe
154 |
155 |
See more
156 |
158 |
Declaration
159 |
160 |
Swift
161 |
public protocol Pipe
162 |
163 |
164 |
169 |
171 |
172 |
173 |
175 |
176 |
177 |
Protocols Reference
5 |
45 | LoggingFormatAndPipe Reference
46 |
49 |
50 |
51 |
52 |
90 |
91 |
92 |
93 |
94 |
95 |
Protocols
96 |
The following protocols are available globally.
97 |
98 |
100 |
101 |
102 |
103 |
104 |
105 |
106 |
107 |
108 | Formatter
111 |
112 |
114 |
115 |
116 |
117 |
118 |
Log Formatter
119 |
120 |
See more
121 |
123 |
Declaration
124 |
125 |
Swift
126 |
public protocol Formatter
127 |
128 |
129 |
134 |
136 |
137 |
138 |
139 |
140 |
141 |
142 |
143 | Pipe
146 |
147 |
149 |
150 |
151 |
152 |
153 |
Log PIpe
154 |
155 |
See more
156 |
158 |
Declaration
159 |
160 |
Swift
161 |
public protocol Pipe
162 |
163 |
164 |
169 |
171 |
172 |
173 |
175 |
176 |
177 |
File handler we’re writing to
","parent_name":"StdioOutputStream"},"Structs/StdioOutputStream.html#/s:20LoggingFormatAndPipe17StdioOutputStreamV5writeyySSF":{"name":"write(_:)","abstract":"Write to file
","parent_name":"StdioOutputStream"},"Structs/LoggerTextOutputStreamPipe.html#/s:20LoggingFormatAndPipe022LoggerTextOutputStreamD0VyACs0fgH0_pcfc":{"name":"init(_:)","abstract":"Default init
","parent_name":"LoggerTextOutputStreamPipe"},"Structs/LoggerTextOutputStreamPipe.html#/s:20LoggingFormatAndPipe022LoggerTextOutputStreamD0V6handleyySSF":{"name":"handle(_:)","abstract":"Our main log handling pipe method
","parent_name":"LoggerTextOutputStreamPipe"},"Structs/LoggerTextOutputStreamPipe.html#/s:20LoggingFormatAndPipe022LoggerTextOutputStreamD0V08standardG0ACvpZ":{"name":"standardOutput","abstract":"Pipe logs to Standard Output (stdout)
","parent_name":"LoggerTextOutputStreamPipe"},"Structs/LoggerTextOutputStreamPipe.html#/s:20LoggingFormatAndPipe022LoggerTextOutputStreamD0V13standardErrorACvpZ":{"name":"standardError","abstract":"Pipe logs to Standard Error (stderr)
","parent_name":"LoggerTextOutputStreamPipe"},"Structs/Handler.html#/s:20LoggingFormatAndPipe7HandlerV9formatter4pipeAcA9Formatter_p_AA0D0_ptcfc":{"name":"init(formatter:pipe:)","abstract":"Default init
","parent_name":"Handler"},"Structs/Handler.html#/s:20LoggingFormatAndPipe7HandlerV9formatterAA9Formatter_pvp":{"name":"formatter","abstract":"Formatter we’re formatting with
","parent_name":"Handler"},"Structs/Handler.html#/s:20LoggingFormatAndPipe7HandlerV4pipeAA0D0_pvp":{"name":"pipe","abstract":"PIpe we’re piping to
","parent_name":"Handler"},"Structs/Handler.html#/s:20LoggingFormatAndPipe7HandlerV8logLevel0A06LoggerV0G0Ovp":{"name":"logLevel","abstract":"Log level specification, used by Logger to filter all log levels less severe then the specified
","parent_name":"Handler"},"Structs/Handler.html#/s:20LoggingFormatAndPipe7HandlerV3log5level7message8metadata4file8function4liney0A06LoggerV5LevelO_AM7MessageVSDySSAM13MetadataValueOGSgS2SSutF":{"name":"log(level:message:metadata:file:function:line:)","abstract":"Our main Logging Backend method
","parent_name":"Handler"},"Structs/Handler.html#/s:20LoggingFormatAndPipe7HandlerV8metadataSDySS0A06LoggerV13MetadataValueOGvp":{"name":"metadata","abstract":"Our Logging Backend metadata
","parent_name":"Handler"},"Structs/Handler.html#/s:20LoggingFormatAndPipe7HandlerV11metadataKey0A06LoggerV13MetadataValueOSgSS_tcip":{"name":"subscript(metadataKey:)","abstract":"Add, remove, or change the logging metadata.
","parent_name":"Handler"},"Structs/BasicFormatter.html#/s:20LoggingFormatAndPipe14BasicFormatterV6formatSayAA12LogComponentOGvp":{"name":"format","abstract":"Log format sequential specification
","parent_name":"BasicFormatter"},"Structs/BasicFormatter.html#/s:20LoggingFormatAndPipe14BasicFormatterV9separatorSSSgvp":{"name":"separator","abstract":"Log component separator
","parent_name":"BasicFormatter"},"Structs/BasicFormatter.html#/s:20LoggingFormatAndPipe14BasicFormatterV09timestampF0So06NSDateF0Cvp":{"name":"timestampFormatter","abstract":"Log timestamp component formatter
","parent_name":"BasicFormatter"},"Structs/BasicFormatter.html#/s:20LoggingFormatAndPipe14BasicFormatterV09timestampF0So06NSDateF0CvpZ":{"name":"timestampFormatter","abstract":"Default timestamp component formatter
","parent_name":"BasicFormatter"},"Structs/BasicFormatter.html#/s:20LoggingFormatAndPipe14BasicFormatterV_9separator09timestampF0ACSayAA12LogComponentOG_SSSo06NSDateF0Ctcfc":{"name":"init(_:separator:timestampFormatter:)","abstract":"Default init
","parent_name":"BasicFormatter"},"Structs/BasicFormatter.html#/s:20LoggingFormatAndPipe14BasicFormatterV10processLog5level7message14prettyMetadata4file8function4lineSS0A06LoggerV5LevelO_AM7MessageVSSSgS2SSutF":{"name":"processLog(level:message:prettyMetadata:file:function:line:)","abstract":"Our main log formatting method
","parent_name":"BasicFormatter"},"Structs/BasicFormatter.html#/s:20LoggingFormatAndPipe14BasicFormatterV5appleACvpZ":{"name":"apple","abstract":"apple/swift-log ‘s log format
","parent_name":"BasicFormatter"},"Structs/BasicFormatter.html#/s:20LoggingFormatAndPipe14BasicFormatterV9adorkableACvpZ":{"name":"adorkable","abstract":"Adorkable’s go-to log format 😘
","parent_name":"BasicFormatter"},"Structs/BasicFormatter.html":{"name":"BasicFormatter","abstract":"Your basic, customizable log formatter"},"Structs/Handler.html":{"name":"Handler","abstract":"
Logging Format and Pipe’s Logging Backend
"},"Structs/LoggerTextOutputStreamPipe.html":{"name":"LoggerTextOutputStreamPipe","abstract":"A pipe for sending logs to a TextOutputStream
"},"Structs/StdioOutputStream.html":{"name":"StdioOutputStream","abstract":"Copied from swift-log:Logging.swift until it is made public"},"Protocols/Pipe.html#/s:20LoggingFormatAndPipe0D0P6handleyySSF":{"name":"handle(_:)","abstract":"
Pipe’s chance to send a formatted line where it deems
","parent_name":"Pipe"},"Protocols/Formatter.html#/s:20LoggingFormatAndPipe9FormatterP09timestampE0So06NSDateE0Cvp":{"name":"timestampFormatter","abstract":"Timestamp formatter
","parent_name":"Formatter"},"Protocols/Formatter.html#/s:20LoggingFormatAndPipe9FormatterP10processLog5level7message14prettyMetadata4file8function4lineSS0A06LoggerV5LevelO_AM7MessageVSSSgS2SSutF":{"name":"processLog(level:message:prettyMetadata:file:function:line:)","abstract":"Formatter’s chance to format the log
","parent_name":"Formatter"},"Protocols/Formatter.html#/s:20LoggingFormatAndPipe9FormatterPAAE16processComponent_3now5level7message14prettyMetadata4file8function4lineSSAA03LogG0O_10Foundation4DateV0A06LoggerV5LevelOAS7MessageVSSSgS2SSutF":{"name":"processComponent(_:now:level:message:prettyMetadata:file:function:line:)","abstract":"Common usage component formatter
","parent_name":"Formatter"},"Protocols/Formatter.html":{"name":"Formatter","abstract":"Log Formatter
"},"Protocols/Pipe.html":{"name":"Pipe","abstract":"Log PIpe
"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO9timestampyA2CmF":{"name":"timestamp","abstract":"Timestamp of log","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO5levelyA2CmF":{"name":"level","abstract":"
Log level
","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO7messageyA2CmF":{"name":"message","abstract":"The actual message
","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO8metadatayA2CmF":{"name":"metadata","abstract":"Log metadata
","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO4fileyA2CmF":{"name":"file","abstract":"The log’s originating file
","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO8functionyA2CmF":{"name":"function","abstract":"The log’s originating function
","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO4lineyA2CmF":{"name":"line","abstract":"The log’s originating line number
","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO4textyACSScACmF":{"name":"text(_:)","abstract":"Literal text
","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO5groupyACSayACGcACmF":{"name":"group(_:)","abstract":"A group of LogComponents, not using the specified separator
","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO20allNonmetaComponentsSayACGvpZ":{"name":"allNonmetaComponents","abstract":"All basic log format component types
","parent_name":"LogComponent"},"Enums/LogComponent.html":{"name":"LogComponent","abstract":"Possible log format components
"},"Enums.html":{"name":"Enumerations","abstract":"The following enumerations are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally.
"},"Structs.html":{"name":"Structures","abstract":"The following structures are available globally.
"}}
--------------------------------------------------------------------------------
/docs/docsets/LoggingFormatAndPipe.docset/Contents/Resources/Documents/search.json:
--------------------------------------------------------------------------------
1 | {"Structs/StdioOutputStream.html#/s:20LoggingFormatAndPipe17StdioOutputStreamV4fileSpySo7__sFILEVGvp":{"name":"file","abstract":"File handler we’re writing to
","parent_name":"StdioOutputStream"},"Structs/StdioOutputStream.html#/s:20LoggingFormatAndPipe17StdioOutputStreamV5writeyySSF":{"name":"write(_:)","abstract":"Write to file
","parent_name":"StdioOutputStream"},"Structs/LoggerTextOutputStreamPipe.html#/s:20LoggingFormatAndPipe022LoggerTextOutputStreamD0VyACs0fgH0_pcfc":{"name":"init(_:)","abstract":"Default init
","parent_name":"LoggerTextOutputStreamPipe"},"Structs/LoggerTextOutputStreamPipe.html#/s:20LoggingFormatAndPipe022LoggerTextOutputStreamD0V6handleyySSF":{"name":"handle(_:)","abstract":"Our main log handling pipe method
","parent_name":"LoggerTextOutputStreamPipe"},"Structs/LoggerTextOutputStreamPipe.html#/s:20LoggingFormatAndPipe022LoggerTextOutputStreamD0V08standardG0ACvpZ":{"name":"standardOutput","abstract":"Pipe logs to Standard Output (stdout)
","parent_name":"LoggerTextOutputStreamPipe"},"Structs/LoggerTextOutputStreamPipe.html#/s:20LoggingFormatAndPipe022LoggerTextOutputStreamD0V13standardErrorACvpZ":{"name":"standardError","abstract":"Pipe logs to Standard Error (stderr)
","parent_name":"LoggerTextOutputStreamPipe"},"Structs/Handler.html#/s:20LoggingFormatAndPipe7HandlerV9formatter4pipeAcA9Formatter_p_AA0D0_ptcfc":{"name":"init(formatter:pipe:)","abstract":"Default init
","parent_name":"Handler"},"Structs/Handler.html#/s:20LoggingFormatAndPipe7HandlerV9formatterAA9Formatter_pvp":{"name":"formatter","abstract":"Formatter we’re formatting with
","parent_name":"Handler"},"Structs/Handler.html#/s:20LoggingFormatAndPipe7HandlerV4pipeAA0D0_pvp":{"name":"pipe","abstract":"PIpe we’re piping to
","parent_name":"Handler"},"Structs/Handler.html#/s:20LoggingFormatAndPipe7HandlerV8logLevel0A06LoggerV0G0Ovp":{"name":"logLevel","abstract":"Log level specification, used by Logger to filter all log levels less severe then the specified
","parent_name":"Handler"},"Structs/Handler.html#/s:20LoggingFormatAndPipe7HandlerV3log5level7message8metadata4file8function4liney0A06LoggerV5LevelO_AM7MessageVSDySSAM13MetadataValueOGSgS2SSutF":{"name":"log(level:message:metadata:file:function:line:)","abstract":"Our main Logging Backend method
","parent_name":"Handler"},"Structs/Handler.html#/s:20LoggingFormatAndPipe7HandlerV8metadataSDySS0A06LoggerV13MetadataValueOGvp":{"name":"metadata","abstract":"Our Logging Backend metadata
","parent_name":"Handler"},"Structs/Handler.html#/s:20LoggingFormatAndPipe7HandlerV11metadataKey0A06LoggerV13MetadataValueOSgSS_tcip":{"name":"subscript(metadataKey:)","abstract":"Add, remove, or change the logging metadata.
","parent_name":"Handler"},"Structs/BasicFormatter.html#/s:20LoggingFormatAndPipe14BasicFormatterV6formatSayAA12LogComponentOGvp":{"name":"format","abstract":"Log format sequential specification
","parent_name":"BasicFormatter"},"Structs/BasicFormatter.html#/s:20LoggingFormatAndPipe14BasicFormatterV9separatorSSSgvp":{"name":"separator","abstract":"Log component separator
","parent_name":"BasicFormatter"},"Structs/BasicFormatter.html#/s:20LoggingFormatAndPipe14BasicFormatterV09timestampF0So06NSDateF0Cvp":{"name":"timestampFormatter","abstract":"Log timestamp component formatter
","parent_name":"BasicFormatter"},"Structs/BasicFormatter.html#/s:20LoggingFormatAndPipe14BasicFormatterV09timestampF0So06NSDateF0CvpZ":{"name":"timestampFormatter","abstract":"Default timestamp component formatter
","parent_name":"BasicFormatter"},"Structs/BasicFormatter.html#/s:20LoggingFormatAndPipe14BasicFormatterV_9separator09timestampF0ACSayAA12LogComponentOG_SSSo06NSDateF0Ctcfc":{"name":"init(_:separator:timestampFormatter:)","abstract":"Default init
","parent_name":"BasicFormatter"},"Structs/BasicFormatter.html#/s:20LoggingFormatAndPipe14BasicFormatterV10processLog5level7message14prettyMetadata4file8function4lineSS0A06LoggerV5LevelO_AM7MessageVSSSgS2SSutF":{"name":"processLog(level:message:prettyMetadata:file:function:line:)","abstract":"Our main log formatting method
","parent_name":"BasicFormatter"},"Structs/BasicFormatter.html#/s:20LoggingFormatAndPipe14BasicFormatterV5appleACvpZ":{"name":"apple","abstract":"apple/swift-log ‘s log format
","parent_name":"BasicFormatter"},"Structs/BasicFormatter.html#/s:20LoggingFormatAndPipe14BasicFormatterV9adorkableACvpZ":{"name":"adorkable","abstract":"Adorkable’s go-to log format 😘
","parent_name":"BasicFormatter"},"Structs/BasicFormatter.html":{"name":"BasicFormatter","abstract":"Your basic, customizable log formatter"},"Structs/Handler.html":{"name":"Handler","abstract":"
Logging Format and Pipe’s Logging Backend
"},"Structs/LoggerTextOutputStreamPipe.html":{"name":"LoggerTextOutputStreamPipe","abstract":"A pipe for sending logs to a TextOutputStream
"},"Structs/StdioOutputStream.html":{"name":"StdioOutputStream","abstract":"Copied from swift-log:Logging.swift until it is made public"},"Protocols/Pipe.html#/s:20LoggingFormatAndPipe0D0P6handleyySSF":{"name":"handle(_:)","abstract":"
Pipe’s chance to send a formatted line where it deems
","parent_name":"Pipe"},"Protocols/Formatter.html#/s:20LoggingFormatAndPipe9FormatterP09timestampE0So06NSDateE0Cvp":{"name":"timestampFormatter","abstract":"Timestamp formatter
","parent_name":"Formatter"},"Protocols/Formatter.html#/s:20LoggingFormatAndPipe9FormatterP10processLog5level7message14prettyMetadata4file8function4lineSS0A06LoggerV5LevelO_AM7MessageVSSSgS2SSutF":{"name":"processLog(level:message:prettyMetadata:file:function:line:)","abstract":"Formatter’s chance to format the log
","parent_name":"Formatter"},"Protocols/Formatter.html#/s:20LoggingFormatAndPipe9FormatterPAAE16processComponent_3now5level7message14prettyMetadata4file8function4lineSSAA03LogG0O_10Foundation4DateV0A06LoggerV5LevelOAS7MessageVSSSgS2SSutF":{"name":"processComponent(_:now:level:message:prettyMetadata:file:function:line:)","abstract":"Common usage component formatter
","parent_name":"Formatter"},"Protocols/Formatter.html":{"name":"Formatter","abstract":"Log Formatter
"},"Protocols/Pipe.html":{"name":"Pipe","abstract":"Log PIpe
"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO9timestampyA2CmF":{"name":"timestamp","abstract":"Timestamp of log","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO5levelyA2CmF":{"name":"level","abstract":"
Log level
","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO7messageyA2CmF":{"name":"message","abstract":"The actual message
","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO8metadatayA2CmF":{"name":"metadata","abstract":"Log metadata
","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO4fileyA2CmF":{"name":"file","abstract":"The log’s originating file
","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO8functionyA2CmF":{"name":"function","abstract":"The log’s originating function
","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO4lineyA2CmF":{"name":"line","abstract":"The log’s originating line number
","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO4textyACSScACmF":{"name":"text(_:)","abstract":"Literal text
","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO5groupyACSayACGcACmF":{"name":"group(_:)","abstract":"A group of LogComponents, not using the specified separator
","parent_name":"LogComponent"},"Enums/LogComponent.html#/s:20LoggingFormatAndPipe12LogComponentO20allNonmetaComponentsSayACGvpZ":{"name":"allNonmetaComponents","abstract":"All basic log format component types
","parent_name":"LogComponent"},"Enums/LogComponent.html":{"name":"LogComponent","abstract":"Possible log format components
"},"Enums.html":{"name":"Enumerations","abstract":"The following enumerations are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally.
"},"Structs.html":{"name":"Structures","abstract":"The following structures are available globally.
"}}
--------------------------------------------------------------------------------
/docs/Structs/StdioOutputStream.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | StdioOutputStream Structure Reference
5 |
45 | LoggingFormatAndPipe Reference
46 |
49 |
50 |
51 |
52 |
90 |
91 |
92 |
93 |
94 |
95 |
StdioOutputStream
96 |
97 |
98 |
public struct StdioOutputStream : TextOutputStream
99 |
100 |
101 |
102 |
Copied from swift-log:Logging.swift until it is made public
103 | A wrapper to facilitate print-ing to stderr and stdio that
104 | ensures access to the underlying FILE is locked to prevent
105 | cross-thread interleaving of output.
106 |
107 |
109 |
110 |
111 |
112 |
113 |
114 |
115 |
116 |
117 | file
120 |
121 |
123 |
124 |
125 |
126 |
127 |
File handler we’re writing to
128 |
129 |
131 |
Declaration
132 |
133 |
Swift
134 |
public let file : UnsafeMutablePointer < FILE >
135 |
136 |
137 |
142 |
144 |
145 |
146 |
147 | write(_:)
150 |
151 |
153 |
154 |
155 |
156 |
157 |
Write to file
158 |
159 |
161 |
Declaration
162 |
163 |
Swift
164 |
public func write ( _ string : String )
165 |
166 |
167 |
172 |
174 |
175 |
176 |
178 |
179 |
180 |
StdioOutputStream Structure Reference
5 |
45 | LoggingFormatAndPipe Reference
46 |
49 |
50 |
51 |
52 |
90 |
91 |
92 |
93 |
94 |
95 |
StdioOutputStream
96 |
97 |
98 |
public struct StdioOutputStream : TextOutputStream
99 |
100 |
101 |
102 |
Copied from swift-log:Logging.swift until it is made public
103 | A wrapper to facilitate print-ing to stderr and stdio that
104 | ensures access to the underlying FILE is locked to prevent
105 | cross-thread interleaving of output.
106 |
107 |
109 |
110 |
111 |
112 |
113 |
114 |
115 |
116 |
117 | file
120 |
121 |
123 |
124 |
125 |
126 |
127 |
File handler we’re writing to
128 |
129 |
131 |
Declaration
132 |
133 |
Swift
134 |
public let file : UnsafeMutablePointer < FILE >
135 |
136 |
137 |
142 |
144 |
145 |
146 |
147 | write(_:)
150 |
151 |
153 |
154 |
155 |
156 |
157 |
Write to file
158 |
159 |
161 |
Declaration
162 |
163 |
Swift
164 |
public func write ( _ string : String )
165 |
166 |
167 |
172 |
174 |
175 |
176 |
178 |
179 |
180 |
Structures Reference
5 |
45 | LoggingFormatAndPipe Reference
46 |
49 |
50 |
51 |
52 |
90 |
91 |
92 |
93 |
94 |
95 |
Structures
96 |
The following structures are available globally.
97 |
98 |
100 |
101 |
102 |
103 |
104 |
105 |
106 |
113 |
114 |
115 |
116 |
117 |
118 |
Your basic, customizable log formatter
119 | BasicFormatter does not need any setup and will automatically include all log components
120 | It can also be given a linear sequence of log components and it will build formatted logs in that order
121 |
122 |
See more
123 |
125 |
Declaration
126 |
127 |
Swift
128 |
public struct BasicFormatter : Formatter
129 |
130 |
131 |
136 |
138 |
139 |
140 |
141 |
142 |
143 |
144 |
145 | Handler
148 |
149 |
151 |
152 |
153 |
154 |
155 |
Logging Format and Pipe’s Logging Backend
156 |
157 |
See more
158 |
160 |
Declaration
161 |
162 |
Swift
163 |
public struct Handler : LogHandler
164 |
165 |
166 |
171 |
173 |
174 |
175 |
176 |
177 |
178 |
185 |
186 |
187 |
188 |
189 |
190 |
A pipe for sending logs to a TextOutputStream
191 |
192 |
See more
193 |
195 |
Declaration
196 |
197 |
Swift
198 |
public struct LoggerTextOutputStreamPipe : Pipe
199 |
200 |
201 |
206 |
208 |
209 |
216 |
217 |
218 |
219 |
220 |
221 |
Copied from swift-log:Logging.swift until it is made public
222 | A wrapper to facilitate print-ing to stderr and stdio that
223 | ensures access to the underlying FILE is locked to prevent
224 | cross-thread interleaving of output.
225 |
226 |
See more
227 |
229 |
Declaration
230 |
231 |
Swift
232 |
public struct StdioOutputStream : TextOutputStream
233 |
234 |
235 |
240 |
242 |
243 |
244 |
246 |
247 |
248 |
Structures Reference
5 |
45 | LoggingFormatAndPipe Reference
46 |
49 |
50 |
51 |
52 |
90 |
91 |
92 |
93 |
94 |
95 |
Structures
96 |
The following structures are available globally.
97 |
98 |
100 |
101 |
102 |
103 |
104 |
105 |
106 |
113 |
114 |
115 |
116 |
117 |
118 |
Your basic, customizable log formatter
119 | BasicFormatter does not need any setup and will automatically include all log components
120 | It can also be given a linear sequence of log components and it will build formatted logs in that order
121 |
122 |
See more
123 |
125 |
Declaration
126 |
127 |
Swift
128 |
public struct BasicFormatter : Formatter
129 |
130 |
131 |
136 |
138 |
139 |
140 |
141 |
142 |
143 |
144 |
145 | Handler
148 |
149 |
151 |
152 |
153 |
154 |
155 |
Logging Format and Pipe’s Logging Backend
156 |
157 |
See more
158 |
160 |
Declaration
161 |
162 |
Swift
163 |
public struct Handler : LogHandler
164 |
165 |
166 |
171 |
173 |
174 |
175 |
176 |
177 |
178 |
185 |
186 |
187 |
188 |
189 |
190 |
A pipe for sending logs to a TextOutputStream
191 |
192 |
See more
193 |
195 |
Declaration
196 |
197 |
Swift
198 |
public struct LoggerTextOutputStreamPipe : Pipe
199 |
200 |
201 |
206 |
208 |
209 |
216 |
217 |
218 |
219 |
220 |
221 |
Copied from swift-log:Logging.swift until it is made public
222 | A wrapper to facilitate print-ing to stderr and stdio that
223 | ensures access to the underlying FILE is locked to prevent
224 | cross-thread interleaving of output.
225 |
226 |
See more
227 |
229 |
Declaration
230 |
231 |
Swift
232 |
public struct StdioOutputStream : TextOutputStream
233 |
234 |
235 |
240 |
242 |
243 |
244 |
246 |
247 |
248 |
LoggingFormatAndPipe Reference
5 |
44 | LoggingFormatAndPipe Reference
45 |
48 |
49 |
50 |
51 |
89 |
90 |
91 |
92 |
93 |
94 |
95 |
96 |
97 |
LoggingFormatAndPipe provides a Swift Logging API Handler which allows you to customized both your log messages’ formats as well as their destinations.
98 |
99 |
If you don’t like the default log format change it to one you would like. If you want one destination to be formatted differently than your other destination you can with ease. Or send the same format to multiple destinations!
100 |
101 |
102 | Installation | Getting Started | Documentation
103 |
104 |
Installation
105 |
SwiftPM
106 |
107 |
To use the LoggingFormatAndPipe library in your project add the following in your Package.swift:
108 |
. package ( url : "https://github.com/adorkable/swift-log-format-and-pipe.git" , . from ( "0.1.2" )),
109 |
110 |
Getting Started
111 |
112 |
LoggingFormatAndPipe.Handler expects both a Formatter Pipe
113 |
let logger = Logger ( label : "example" ) { _ in
114 | return LoggingFormatAndPipe . Handler (
115 | formatter : ... ,
116 | pipe : ...
117 | )
118 | }
119 |
120 |
121 |
Example:
122 |
let logger = Logger ( label : "example" ) { _ in
123 | return LoggingFormatAndPipe . Handler (
124 | formatter : BasicFormatter . adorkable ,
125 | pipe : LoggerTextOutputStreamPipe . standardOutput
126 | )
127 | }
128 |
129 |
130 |
131 |
There are a number of ways of customizing the format but are generally composed of a combination of LogComponents:
132 |
133 |
134 | .timestamp - Timestamp of log.level - Log level.message - The actual message.metadata - Log metadata.file - The log’s originating file.line - The log’s originating line number in the file.function - The log’s originating function.text(String) - Static text.group([LogComponents]) - Formatters may separate specified LogComponents in various ways as per their format, .group tells the Formatter to combine the LogComponents without using its separation
144 |
145 |
146 |
BasicFormatter LogComponents and a separator string and automatically processes them into a single line for each new log message.
147 |
148 |
It includes already setup static instances:
149 |
150 |
153 |
154 |
{timestamp} {level}: {message}
155 |
156 |
Example:
157 |
158 |
2019-07-30T13:49:07-0400 error: Test error message
159 |
160 |
161 | .adorkable - Adorkable’s standard format 😘
163 |
164 |
{timestamp} ▶ {level} ▶ {file}:{line} ▶ {function} ▶ {message} ▶ {metadata}
165 |
166 |
Example:
167 |
168 |
2019-07-30T13:49:07-0400 ▶ error ▶ /asdf/swift-log-format-and-pipe/Tests/LoggingFormatAndPipeTests/FormatterTests.swift:25 ▶ testFormatter(_:) ▶ Test error message
169 |
170 |
171 |
If none of these work you can customize your own instance!
172 |
173 |
Suppose you want a special short log format with a timestamp, the level, the file it originated in, and the message itself:
174 |
let myFormat = BasicFormatter (
175 | [
176 | . timestamp ,
177 | . level ,
178 | . file ,
179 | . message
180 | ]
181 | )
182 |
183 |
184 |
To change the separator from a single space specify the separator parameter:
185 |
let myFormat = BasicFormatter (
186 | ... ,
187 | separator : "|"
188 | )
189 |
190 |
191 |
Note that BasicFormatter nil metadata.
192 |
193 |
To change the timestamp from the default:
194 |
let myDateFormat = DateFormatter ()
195 | myDateFormat . dateFormat = "yyyy-MM-dd'T'HH:mm:ssZZZZZ"
196 | let myFormat = BasicFormatter (
197 | ... ,
198 | timestampFormatter : myDateFormat
199 | )
200 |
201 |
202 |
203 |
You can also create your own Formatter
204 |
205 |
206 | var timestampFormatter: DateFormatter { get }func processLog(level: Logger.Level,
208 | message: Logger.Message,
209 | prettyMetadata: String?,
210 | file: String, function: String, line: UInt) -> String
212 |
213 |
More formatters to come!
214 |
Piping
215 |
216 |
Pipes specify where your formatted log lines end up going to. Included already are:
217 |
218 |
222 |
223 |
More pipes to come!
224 |
Implementing Pipe
225 |
226 |
You can also create your own Pipe
227 |
228 |
229 | func handle(_ formattedLogLine: String)
231 |
232 |
Easy!
233 |
234 |
Now you’ve got your use-case formatted log lines traveling this way and then, what a charm 🖤
235 |
API Documentation
236 |
237 |
For more insight into the library API documentation is found in the repo here
238 |
239 |
241 |
242 |
243 |
244 |
LoggingFormatAndPipe Reference
5 |
44 | LoggingFormatAndPipe Reference
45 |
48 |
49 |
50 |
51 |
89 |
90 |
91 |
92 |
93 |
94 |
95 |
96 |
97 |
LoggingFormatAndPipe provides a Swift Logging API Handler which allows you to customized both your log messages’ formats as well as their destinations.
98 |
99 |
If you don’t like the default log format change it to one you would like. If you want one destination to be formatted differently than your other destination you can with ease. Or send the same format to multiple destinations!
100 |
101 |
102 | Installation | Getting Started | Documentation
103 |
104 |
Installation
105 |
SwiftPM
106 |
107 |
To use the LoggingFormatAndPipe library in your project add the following in your Package.swift:
108 |
. package ( url : "https://github.com/adorkable/swift-log-format-and-pipe.git" , . from ( "0.1.2" )),
109 |
110 |
Getting Started
111 |
112 |
LoggingFormatAndPipe.Handler expects both a Formatter Pipe
113 |
let logger = Logger ( label : "example" ) { _ in
114 | return LoggingFormatAndPipe . Handler (
115 | formatter : ... ,
116 | pipe : ...
117 | )
118 | }
119 |
120 |
121 |
Example:
122 |
let logger = Logger ( label : "example" ) { _ in
123 | return LoggingFormatAndPipe . Handler (
124 | formatter : BasicFormatter . adorkable ,
125 | pipe : LoggerTextOutputStreamPipe . standardOutput
126 | )
127 | }
128 |
129 |
130 |
131 |
There are a number of ways of customizing the format but are generally composed of a combination of LogComponents:
132 |
133 |
134 | .timestamp - Timestamp of log.level - Log level.message - The actual message.metadata - Log metadata.file - The log’s originating file.line - The log’s originating line number in the file.function - The log’s originating function.text(String) - Static text.group([LogComponents]) - Formatters may separate specified LogComponents in various ways as per their format, .group tells the Formatter to combine the LogComponents without using its separation
144 |
145 |
146 |
BasicFormatter LogComponents and a separator string and automatically processes them into a single line for each new log message.
147 |
148 |
It includes already setup static instances:
149 |
150 |
153 |
154 |
{timestamp} {level}: {message}
155 |
156 |
Example:
157 |
158 |
2019-07-30T13:49:07-0400 error: Test error message
159 |
160 |
161 | .adorkable - Adorkable’s standard format 😘
163 |
164 |
{timestamp} ▶ {level} ▶ {file}:{line} ▶ {function} ▶ {message} ▶ {metadata}
165 |
166 |
Example:
167 |
168 |
2019-07-30T13:49:07-0400 ▶ error ▶ /asdf/swift-log-format-and-pipe/Tests/LoggingFormatAndPipeTests/FormatterTests.swift:25 ▶ testFormatter(_:) ▶ Test error message
169 |
170 |
171 |
If none of these work you can customize your own instance!
172 |
173 |
Suppose you want a special short log format with a timestamp, the level, the file it originated in, and the message itself:
174 |
let myFormat = BasicFormatter (
175 | [
176 | . timestamp ,
177 | . level ,
178 | . file ,
179 | . message
180 | ]
181 | )
182 |
183 |
184 |
To change the separator from a single space specify the separator parameter:
185 |
let myFormat = BasicFormatter (
186 | ... ,
187 | separator : "|"
188 | )
189 |
190 |
191 |
Note that BasicFormatter nil metadata.
192 |
193 |
To change the timestamp from the default:
194 |
let myDateFormat = DateFormatter ()
195 | myDateFormat . dateFormat = "yyyy-MM-dd'T'HH:mm:ssZZZZZ"
196 | let myFormat = BasicFormatter (
197 | ... ,
198 | timestampFormatter : myDateFormat
199 | )
200 |
201 |
202 |
203 |
You can also create your own Formatter
204 |
205 |
206 | var timestampFormatter: DateFormatter { get }func processLog(level: Logger.Level,
208 | message: Logger.Message,
209 | prettyMetadata: String?,
210 | file: String, function: String, line: UInt) -> String
212 |
213 |
More formatters to come!
214 |
Piping
215 |
216 |
Pipes specify where your formatted log lines end up going to. Included already are:
217 |
218 |
222 |
223 |
More pipes to come!
224 |
Implementing Pipe
225 |
226 |
You can also create your own Pipe
227 |
228 |
229 | func handle(_ formattedLogLine: String)
231 |
232 |
Easy!
233 |
234 |
Now you’ve got your use-case formatted log lines traveling this way and then, what a charm 🖤
235 |
API Documentation
236 |
237 |
For more insight into the library API documentation is found in the repo here
238 |
239 |
241 |
242 |
243 |
244 |
LoggerTextOutputStreamPipe Structure Reference
5 |
45 | LoggingFormatAndPipe Reference
46 |
49 |
50 |
51 |
52 |
90 |
91 |
92 |
93 |
94 |
95 |
LoggerTextOutputStreamPipe
96 |
97 |
98 |
public struct LoggerTextOutputStreamPipe : Pipe
99 |
100 |
101 |
102 |
A pipe for sending logs to a TextOutputStream
103 |
104 |
106 |
107 |
108 |
109 |
110 |
111 |
112 |
113 |
114 | init(_:)
117 |
118 |
120 |
121 |
122 |
123 |
124 |
Default init
125 |
126 |
128 |
Declaration
129 |
130 |
Swift
131 |
public init ( _ stream : TextOutputStream )
132 |
133 |
134 |
136 |
Parameters
137 |
138 |
139 |
140 |
141 |
142 | _
143 |
144 |
145 |
146 |
147 |
Our stream to pipe to
148 |
150 |
151 |
152 |
153 |
158 |
160 |
161 |
168 |
169 |
170 |
171 |
172 |
173 |
Our main log handling pipe method
174 |
175 |
177 |
Declaration
178 |
179 |
Swift
180 |
public func handle ( _ formattedLogLine : String )
181 |
182 |
183 |
185 |
Parameters
186 |
187 |
188 |
189 |
190 |
191 | _
192 |
193 |
194 |
195 |
196 |
The formatted log to handle
197 |
199 |
200 |
201 |
202 |
207 |
209 |
210 |
211 |
212 |
213 |
214 |
221 |
222 |
223 |
224 |
225 |
226 |
Pipe logs to Standard Output (stdout)
227 |
228 |
230 |
Declaration
231 |
232 |
Swift
233 |
public static var standardOutput : LoggerTextOutputStreamPipe { get }
234 |
235 |
236 |
241 |
243 |
244 |
251 |
252 |
253 |
254 |
255 |
256 |
Pipe logs to Standard Error (stderr)
257 |
258 |
260 |
Declaration
261 |
262 |
Swift
263 |
public static var standardError : LoggerTextOutputStreamPipe { get }
264 |
265 |
266 |
271 |
273 |
274 |
275 |
277 |
278 |
279 |
LoggerTextOutputStreamPipe Structure Reference
5 |
45 | LoggingFormatAndPipe Reference
46 |
49 |
50 |
51 |
52 |
90 |
91 |
92 |
93 |
94 |
95 |
LoggerTextOutputStreamPipe
96 |
97 |
98 |
public struct LoggerTextOutputStreamPipe : Pipe
99 |
100 |
101 |
102 |
A pipe for sending logs to a TextOutputStream
103 |
104 |
106 |
107 |
108 |
109 |
110 |
111 |
112 |
113 |
114 | init(_:)
117 |
118 |
120 |
121 |
122 |
123 |
124 |
Default init
125 |
126 |
128 |
Declaration
129 |
130 |
Swift
131 |
public init ( _ stream : TextOutputStream )
132 |
133 |
134 |
136 |
Parameters
137 |
138 |
139 |
140 |
141 |
142 | _
143 |
144 |
145 |
146 |
147 |
Our stream to pipe to
148 |
150 |
151 |
152 |
153 |
158 |
160 |
161 |
168 |
169 |
170 |
171 |
172 |
173 |
Our main log handling pipe method
174 |
175 |
177 |
Declaration
178 |
179 |
Swift
180 |
public func handle ( _ formattedLogLine : String )
181 |
182 |
183 |
185 |
Parameters
186 |
187 |
188 |
189 |
190 |
191 | _
192 |
193 |
194 |
195 |
196 |
The formatted log to handle
197 |
199 |
200 |
201 |
202 |
207 |
209 |
210 |
211 |
212 |
213 |
214 |
221 |
222 |
223 |
224 |
225 |
226 |
Pipe logs to Standard Output (stdout)
227 |
228 |
230 |
Declaration
231 |
232 |
Swift
233 |
public static var standardOutput : LoggerTextOutputStreamPipe { get }
234 |
235 |
236 |
241 |
243 |
244 |
251 |
252 |
253 |
254 |
255 |
256 |
Pipe logs to Standard Error (stderr)
257 |
258 |
260 |
Declaration
261 |
262 |
Swift
263 |
public static var standardError : LoggerTextOutputStreamPipe { get }
264 |
265 |
266 |
271 |
273 |
274 |
275 |
277 |
278 |
279 |
38 | View on GitHub
39 | 
47 | Enumerations Reference
48 | 
38 | View on GitHub
39 | 
47 | Pipe Protocol Reference
48 |