You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Sources/Pulse/Pulse.docc/Articles/GettingStarted.md
+13-9Lines changed: 13 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Learn how to integrate Pulse.
10
10
https://github.com/kean/Pulse
11
11
```
12
12
13
-
Add both **Pulse** and **PulseUI** libraries to your app. **PulseProxy** is optional and provides a quick, convenient way to capture network traffic to evaluate the framework.
13
+
Add **Pulse** and **PulseUI** libraries to your app.
14
14
15
15
-**Option 2**. Use precompiled binary frameworks from the [latest release](https://github.com/kean/Pulse/releases).
16
16
@@ -44,9 +44,9 @@ NetworkLogger.enableProxy()
44
44
#endif
45
45
```
46
46
47
-
> note: **PulseProxy** uses method swizzling and private APIs and it is not recommended that you include it in the production builds of your app.
47
+
> important: **PulseProxy** uses swizzling and private APIs and it is not recommended that you include it in the production builds of your app.
48
48
49
-
### 2.2. Collect Regular Messages
49
+
### 2.2. Collect Logs
50
50
51
51
To store regular log messages, use [LoggerStore](https://kean-docs.github.io/pulse/documentation/pulse/loggerstore).
> info: As an alternative to using `LoggerStore` directly, you can use Pulse as a SwiftLog backend using [PersistentLogHandler](https://kean-docs.github.io/pulseloghandler/documentation/pulseloghandler/persistentloghandler) struct from [PulseLogHandler](https://kean-docs.github.io/pulseloghandler/documentation/pulseloghandler) which is a [Swift package distributed separately](https://github.com/kean/PulseLogHandler). This way you can have more than one logger at once.
63
-
64
-
Logs are stored persistently and the store automatically removes old messages and limits the overall size (configurable). It uses a number of space [optimizations techniques](https://kean.blog/post/pulse-2#space-savings), including fast [lzfse](https://developer.apple.com/documentation/compression/algorithm/lzfse) compression.
62
+
> tip: Alternatively, you can use it as a SwiftLog backend using [PersistentLogHandler](https://kean-docs.github.io/pulseloghandler/documentation/pulseloghandler/persistentloghandler) from a [PulseLogHandler](https://github.com/kean/PulseLogHandler) package.
65
63
66
64
## 3. Integrate PulseUI Framework
67
65
68
-
To view logs and network requests from your app, use [PulseUI](https://kean-docs.github.io/pulseui/documentation/pulseui/)framework. The framework is centered around a single screen: `ConsoleView`. On iOS, you can push it into the existing navigation stack or present it modally.
66
+
[**PulseUI**](https://kean-docs.github.io/pulseui/documentation/pulseui/)allows you to view logs and network requests directly from your app. The framework is centered around a single screen: `ConsoleView`. On iOS, you can push it into the existing navigation stack or present it modally.
69
67
70
68
```swift
69
+
importPulseUI
70
+
71
71
NavigationLink(destination: ConsoleView()) {
72
72
Text("Console")
73
73
}
74
74
```
75
75
76
-
> Note: There are some additional steps required for some platforms. For more information see the PulseUI [documentation](https://kean-docs.github.io/pulseui/documentation/pulseui/).
76
+
> tip: For more information, see the PulseUI [documentation](https://kean-docs.github.io/pulseui/documentation/pulseui/).
77
77
78
-
## 4. Configure Remote Logging with Pulse Pro
78
+
## 4. Get Pulse Pro
79
79
80
80
In addition to the frameworks and the on-device view, Pulse also provides a separate professional macOS app called [Pulse Pro](https://kean.blog/pulse/pro) that you can use for viewing the previously shared logs or even viewing the logs from the device remotely in real-time.
81
81
@@ -103,3 +103,7 @@ Open the Pulse console from the app, go to Settings, enable "Remote Logging", an
103
103

104
104
105
105
Once the connection is established, open Pulse Pro and select the device in the sidebar. The next time you launch the app, the connection will happen automatically.
106
+
107
+
## Next Steps
108
+
109
+
Learn how to configure Pulse to best suit your app needs in<doc:NextSteps> and explore additional networking debugging techniques in<doc:NetworkLogging-Article>.
Learn how to configure Pulse to best suit your app needs.
4
+
5
+
## Logger
6
+
7
+
### Configure Store
8
+
9
+
``LoggerStore`` is the primary way to configure how logs are stored. It uses a database to record logs in an efficient binary format and employes a number of space [optimizations techniques](https://kean.blog/post/pulse-2#space-savings), including fast [lzfse](https://developer.apple.com/documentation/compression/algorithm/lzfse) compression. The store automatically limits how much spaces it takes and also removed old logs.
10
+
11
+
You can configure the logger be replacing the default store.
0 commit comments