Export logs programatically (without presenting console)

[darrarski]

Q: Is there a way to export logs programmatically, without presenting the PulseUI console to the user?

We still want to have the console in the app, because it's great and useful for more advanced users and our development team. However, for casual users, we need something easier to use, like a single button in the app, that on tap brings the share sheet with the logs file ready for export.

[kean]

Hey, yes, you can export the store using LoggerStore/copy, which creates a .pulse file. PulseUI supports other export options: HTML, Plain Text PDF. These are not currently publicly available, but it would make a lot of sense to open them up to everyone.

[darrarski]

Hi @kean! Thanks for the support.

I'm experiencing issues when exporting the logs with LoggerStore/copy function. Here is what I do:

let store = LoggerStore.shared
let dateFormatter = DateFormatter()
dateFormatter.dateFormat = "yyyy-MM-dd-HH-mm-ss"
let filename = "app-logs-\(dateFormatter.string(from: Date()))"
let url = URL.temporaryDirectory
  .appending(component: filename)
  .appendingPathExtension("pulse")
try store.copy(to: url)

I can see the file is created at provided URL. According to documentation, it's a SQLite file, but I'm struggling with reading its contents. All I can see are the following tables:

but no logs. I can open the file in Pulse Pro, and my app's logs are there. However, the labels are missing:

Moreover, I can't access log details. When tapping on the following icon, the Pulse Pro app is crashing:

I can browse the logs with any issues using in-app PulseUI console, and all the informations are present there, including labels and details.

I'm using the latest versions of Pulse (3.5.4) and Pulse Pro (2.0.1).

---

By the way, there is a typo in Pulse.LoggerStore.Error.fileAleadyExists: "aleady" → "already".

[kean]

According to documentation, it's a SQLite file, but I'm struggling with reading its contents.

I use SQLite as a document format. The logs (Core Data) database is just one of the files in this SQLite database. It isn't optimal if you want to view the Core Data database directly.

Pulse actually supports two document formats: a single document (SQLite-based) or a package (a special kind of folder on Apple file systems). I think it's worth making the second option public. It does use a bit more space and it makes it harder to share it as it's a folder, and not a single file.

Moreover, I can't access log details. When tapping on the following icon, the Pulse Pro app is crashing:

Pulse Pro 2 no longer (fully) supports Pulse 3 because it had some significant changes to the store format. I'm currently working on a new Pulse app for macOS (Pulse Pro replacement) written in SwiftUI. The first alpha version shipped just yesterday. It fully supports Pulse 3 and has a lot of new features from PulseUI 3, such as the new search.

By the way, there is a typo in Pulse.LoggerStore.Error.fileAleadyExists: "aleady" → "already".
Write

Thanks, will fix!