Skip to content

armgit / peel

Public Imported from GitHub
0

Uninstall Mac apps with every file they leave behind, and see why each belongs. Free up space, fine-tune macOS, and set up Terminal.

List the logs Homebrew's services write in Space

Țugui Dragoș39ee2cb3f426
diff --git a/GUIDE.md b/GUIDE.md
index dbe140b4..7fbf48fb 100644
--- a/GUIDE.md
+++ b/GUIDE.md
@@ -122,7 +122,9 @@ deletes for good. Once Xcode is gone, the Simulators area says to install it aga
Library at the top of the disk, Space also lists the caches and logs apps keep for every
account, and the crash reports macOS keeps. Those an administrator owns go through Peel's helper, and what macOS
keeps there for its own services is never listed. In your own Logs, the folder macOS saves crash reports in stays and
-only the reports are offered, since macOS can't make that folder again. Nothing is selected for you: Select
+only the reports are offered, since macOS can't make that folder again. The logs Homebrew's services write in
+`/opt/homebrew/var/log` are offered file by file, and the folders they sit in stay, since a service expects to find
+the folder it writes in. Nothing is selected for you: Select
Recommended takes what Peel could measure in an area and nothing holds back. Peel can also warn you, with a
notification that opens Space, when less than a tenth of your disk is available: turn it on in Settings > General.
diff --git a/Localization/Peel/Localizable.xcstrings b/Localization/Peel/Localizable.xcstrings
index 9f47aa8b..e947a2de 100644
--- a/Localization/Peel/Localizable.xcstrings
+++ b/Localization/Peel/Localizable.xcstrings
@@ -49202,6 +49202,112 @@
}
}
},
+ "Homebrew Service Logs" : {
+ "localizations" : {
+ "cs" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Protokoly služeb Homebrew"
+ }
+ },
+ "de" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Protokolle der Homebrew-Dienste"
+ }
+ },
+ "es" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Registros de servicios de Homebrew"
+ }
+ },
+ "fr" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Historiques des services Homebrew"
+ }
+ },
+ "it" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Log dei servizi di Homebrew"
+ }
+ },
+ "ja" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Homebrewサービスのログ"
+ }
+ },
+ "ko" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Homebrew 서비스 로그"
+ }
+ },
+ "nl" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Logs van Homebrew-diensten"
+ }
+ },
+ "pl" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Dzienniki usług Homebrew"
+ }
+ },
+ "pt" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Registros de Serviços do Homebrew"
+ }
+ },
+ "ro" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Jurnale ale serviciilor Homebrew"
+ }
+ },
+ "ru" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Журналы служб Homebrew"
+ }
+ },
+ "sv" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Loggar för Homebrew-tjänster"
+ }
+ },
+ "tr" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Homebrew Hizmet Günlükleri"
+ }
+ },
+ "uk" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Журнали служб Homebrew"
+ }
+ },
+ "zh-Hans" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Homebrew服务日志"
+ }
+ },
+ "zh-Hant" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Homebrew服務記錄檔"
+ }
+ }
+ }
+ },
"Homebrew adds the links missing from its taps’ manual pages and shell completions, and points a tap whose main branch was renamed at the new name. It deletes nothing." : {
"localizations" : {
"cs" : {
@@ -71664,6 +71770,112 @@
}
}
},
+ "Logs that the services Homebrew runs, such as a database or a web server, write in Homebrew’s folder. Only the logs are offered, never the folders they sit in, since a service expects to find the folder it writes in." : {
+ "localizations" : {
+ "cs" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Protokoly, které do složky Homebrew zapisují služby, jež Homebrew spouští, například databáze nebo webový server. Nabízejí se jen protokoly, nikdy složky, ve kterých leží, protože služba počítá s tím, že najde složku, do které zapisuje."
+ }
+ },
+ "de" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Protokolle, die von Homebrew ausgeführte Dienste, etwa eine Datenbank oder ein Webserver, in den Ordner von Homebrew schreiben. Angeboten werden nur die Protokolle, nie die Ordner, in denen sie liegen, da ein Dienst erwartet, den Ordner vorzufinden, in den er schreibt."
+ }
+ },
+ "es" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Registros que los servicios que ejecuta Homebrew, como una base de datos o un servidor web, escriben en la carpeta de Homebrew. Solo se ofrecen los registros, nunca las carpetas en las que están, porque un servicio espera encontrar la carpeta en la que escribe."
+ }
+ },
+ "fr" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Les historiques que les services exécutés par Homebrew, comme une base de données ou un serveur web, écrivent dans le dossier de Homebrew. Seuls les historiques sont proposés, jamais les dossiers qui les contiennent, car un service s’attend à trouver le dossier dans lequel il écrit."
+ }
+ },
+ "it" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Log che i servizi eseguiti da Homebrew, come un database o un server web, scrivono nella cartella di Homebrew. Vengono proposti solo i log, mai le cartelle che li contengono, perché un servizio si aspetta di trovare la cartella in cui scrive."
+ }
+ },
+ "ja" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "データベースやWebサーバなど、Homebrewが実行するサービスが、Homebrewのフォルダに書き込むログです。ゴミ箱に入れる候補になるのはログだけで、ログが入っているフォルダは、サービスが書き込み先としてそこにあるものと想定しているため、決して候補になりません。"
+ }
+ },
+ "ko" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "데이터베이스나 웹 서버 등 Homebrew가 실행하는 서비스가 Homebrew의 폴더에 기록하는 로그입니다. 로그만 제안되며, 로그가 들어 있는 폴더는 절대 제안되지 않습니다. 서비스가 로그를 기록하는 폴더를 찾을 수 있어야 하기 때문입니다."
+ }
+ },
+ "nl" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Logs die in de map van Homebrew worden geschreven door de diensten die Homebrew uitvoert, zoals een database of een webserver. Alleen de logs worden aangeboden, nooit de mappen waarin ze staan, want een dienst verwacht de map te vinden waarin hij schrijft."
+ }
+ },
+ "pl" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Dzienniki zapisywane w folderze Homebrew przez usługi, które Homebrew uruchamia, na przykład bazę danych lub serwer www. Proponowane są tylko dzienniki, nigdy foldery nadrzędne, ponieważ usługa spodziewa się znaleźć folder, w którym zapisuje dziennik."
+ }
+ },
+ "pt" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Registros que os serviços executados pelo Homebrew, como um banco de dados ou um servidor web, gravam na pasta do Homebrew. Só os registros são oferecidos, nunca as pastas onde eles ficam, porque um serviço espera encontrar a pasta em que grava."
+ }
+ },
+ "ro" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Jurnale pe care serviciile rulate de Homebrew, cum ar fi o bază de date sau un server web, le scriu în dosarul Homebrew. Sunt propuse doar jurnalele, niciodată dosarele în care se află, deoarece un serviciu se așteaptă să găsească dosarul în care scrie."
+ }
+ },
+ "ru" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Журналы, которые запускаемые Homebrew службы, например база данных или веб-сервер, записывают в папку Homebrew. Предлагаются только журналы, но никогда не папки, в которых они лежат, потому что служба ожидает найти папку, в которую записывает."
+ }
+ },
+ "sv" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Loggar som de tjänster Homebrew kör, till exempel en databas eller en webbserver, skriver i Homebrews mapp. Bara loggarna erbjuds, aldrig mapparna som de ligger i, eftersom en tjänst förväntar sig att hitta mappen som den skriver i."
+ }
+ },
+ "tr" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Homebrew’un çalıştırdığı, veritabanı veya web sunucusu gibi hizmetlerin Homebrew’un klasörüne yazdığı günlükler. Yalnızca günlükler sunulur; içinde bulundukları klasörler ise hiçbir zaman sunulmaz, çünkü bir hizmet, yazdığı klasörü orada bulmayı bekler."
+ }
+ },
+ "uk" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Журнали, що їх записують у папку Homebrew служби, які він запускає, як-от база даних чи вебсервер. Пропонуються лише журнали, але ніколи не папки, у яких вони лежать, бо служба очікує знайти папку, у яку записує."
+ }
+ },
+ "zh-Hans" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Homebrew运行的服务(例如数据库或网页服务器)在Homebrew的文件夹中写入的日志。只会列出日志以供移除,绝不会列出它们所在的文件夹,因为服务需要它写入日志的文件夹存在。"
+ }
+ },
+ "zh-Hant" : {
+ "stringUnit" : {
+ "state" : "translated",
+ "value" : "Homebrew執行的服務(例如資料庫或網頁伺服器)寫入Homebrew的檔案夾中的記錄檔。只會列出記錄檔供你移除,絕不會列出它們所在的檔案夾,因為服務預期它寫入的檔案夾存在。"
+ }
+ }
+ }
+ },
"Looked at ^[%lld item](inflect: true)" : {
"localizations" : {
"cs" : {
diff --git a/Packages/PeelCore/Sources/PeelCore/Space/SpaceRemoval.swift b/Packages/PeelCore/Sources/PeelCore/Space/SpaceRemoval.swift
index e96d9dd1..4993b670 100644
--- a/Packages/PeelCore/Sources/PeelCore/Space/SpaceRemoval.swift
+++ b/Packages/PeelCore/Sources/PeelCore/Space/SpaceRemoval.swift
@@ -173,15 +173,19 @@ public enum SpaceRemoval {
var refused: [URL: GuardRefusal] = [:]
let systemCaches = SystemCaches(environment: environment)
let filesOnly = Set(item.onlyFilesIn.map(PathPattern.comparablePath))
- func sort(_ folder: URL, leaving owned: [[String]], owner: String?) {
+ func sort(_ folder: URL, leaving owned: [[String]], owner: String?, onlyFiles inside: Bool = false) {
let children = try? FileManager.default.contentsOfDirectory(at: folder, includingPropertiesForKeys: nil)
- let onlyFiles = filesOnly.contains(PathPattern.comparablePath(of: folder))
+ let onlyFiles = inside || filesOnly.contains(PathPattern.comparablePath(of: folder))
for child in children ?? [] {
let name = child.lastPathComponent
if item.leavesMacOSsOwn, SpaceInventory.isMacOSsOwn(name) { continue }
if onlyFiles, child.isRealFolder { continue }
let app = owner ?? running[Naming.normalized(name)]
let listed = owned.filter { fnmatch($0[0], name, FNM_CASEFOLD) == 0 }
+ if item.keepsItsFolders, child.isRealFolder, !listed.contains(where: { $0.count == 1 }) {
+ sort(child, leaving: listed.map { Array($0.dropFirst()) }, owner: app, onlyFiles: true)
+ continue
+ }
if app == nil, !listed.isEmpty, !listed.contains(where: { $0.count == 1 }), child.isRealFolder {
sort(child, leaving: listed.map { Array($0.dropFirst()) }, owner: owner)
continue
diff --git a/Packages/PeelCore/Sources/PeelCore/Space/SpaceReport.swift b/Packages/PeelCore/Sources/PeelCore/Space/SpaceReport.swift
index 7f07dc2e..d370157d 100644
--- a/Packages/PeelCore/Sources/PeelCore/Space/SpaceReport.swift
+++ b/Packages/PeelCore/Sources/PeelCore/Space/SpaceReport.swift
@@ -35,6 +35,9 @@ public struct SpaceItem: Sendable, Hashable, Identifiable {
public var holdsBackRecentWrites = false
/// The folders of `urls` where macOS files reports into folders of its own, so only their files are offered.
public var onlyFilesIn: [URL] = []
+ /// True when the area offers no folder, only files: those in its folders and in the folders directly inside them,
+ /// since a program expects to find the folder it writes in.
+ public var keepsItsFolders = false
/// The commands that free an area Peel leaves alone, as its tool's documentation gives them. Peel shows them to
/// copy and never runs them: they delete for good.
public var commands: [String] = []
@@ -126,6 +129,7 @@ public enum SpaceInventory {
var leavesMacOSsOwn = false
var holdsBackRecentWrites = false
var onlyFilesIn: [String] = []
+ var keepsItsFolders = false
var commands: [Command] = []
var managedBy: ManagingApps?
@@ -145,7 +149,7 @@ public enum SpaceInventory {
/// True when the area's size is what it offers, child by child, rather than its places measured whole: one
/// place may sit inside another of its own, which would count twice.
- var measuresWhatItOffers: Bool { leavesMacOSsOwn || !onlyFilesIn.isEmpty }
+ var measuresWhatItOffers: Bool { leavesMacOSsOwn || !onlyFilesIn.isEmpty || keepsItsFolders }
func onlyFilesIn(home: URL, root: URL) -> [URL] {
onlyFilesIn.map { path in
@@ -386,6 +390,17 @@ public enum SpaceInventory {
leavesMacOSsOwn: true,
onlyFilesIn: ["/Library/Logs/DiagnosticReports"]
),
+ // Homebrew's services write their logs in its `var/log`, some in a folder of their own, such as nginx's.
+ // `brew services start` makes such a folder, and launchd makes a missing log file again but never a folder
+ // (`man launchd.plist`), so only the files go. A log a running service holds open frees nothing when moved.
+ Definition(
+ id: "homebrew-logs",
+ category: .development,
+ paths: ["/opt/homebrew/var/log"],
+ handling: .trash,
+ holdsBackRecentWrites: true,
+ keepsItsFolders: true
+ ),
]
/// The total size of `urls` less what is excluded inside them, or nil when any of it could not be measured. A
@@ -430,7 +445,8 @@ public enum SpaceInventory {
}
/// What an area can offer in its `folders`: every child that is not one of the folders themselves, only the files
- /// where macOS files its reports into folders, and nothing named for macOS in an area that leaves macOS's own out.
+ /// where macOS files its reports into folders, nothing named for macOS in an area that leaves macOS's own out, and
+ /// the files of each child folder in place of the folder in an area that keeps its folders.
private static func offered(in folders: [URL], of definition: Definition, home: URL, root: URL) -> [URL] {
let paths = Set(folders.map(PathPattern.comparablePath))
let filesOnly = Set(definition.onlyFilesIn(home: home, root: root).map(PathPattern.comparablePath))
@@ -439,10 +455,18 @@ public enum SpaceInventory {
guard let names = try? FileManager.default.contentsOfDirectory(atPath: folder.path(percentEncoded: false))
else { return [folder] }
let kept = definition.leavesMacOSsOwn ? names.filter { !isMacOSsOwn($0) } : names
- return kept.map { folder.appending(path: $0) }.filter { child in
+ let children = kept.map { folder.appending(path: $0) }.filter { child in
!paths.contains(PathPattern.comparablePath(of: child))
&& !(filesOnly.contains(PathPattern.comparablePath(of: folder)) && child.isRealFolder)
}
+ guard definition.keepsItsFolders else { return children }
+ return children.flatMap { child -> [URL] in
+ let path = child.path(percentEncoded: false)
+ guard child.isRealFolder, let inside = try? FileManager.default.contentsOfDirectory(atPath: path) else {
+ return [child]
+ }
+ return inside.map { child.appending(path: $0) }.filter { !$0.isRealFolder }
+ }
}
}
@@ -560,6 +584,7 @@ public enum SpaceInventory {
leavesMacOSsOwn: definition.leavesMacOSsOwn,
holdsBackRecentWrites: definition.holdsBackRecentWrites,
onlyFilesIn: definition.onlyFilesIn(home: home, root: root),
+ keepsItsFolders: definition.keepsItsFolders,
commands: definition.commands.filter { $0.isKnown(simctlRuntimeHelp: help) }.map(\.line),
managingAppIsMissing: definition.managedBy.map { !$0.oneIsOnThisMac } ?? false
)
diff --git a/Packages/PeelCore/Tests/PeelCoreTests/SpaceRemovalTests.swift b/Packages/PeelCore/Tests/PeelCoreTests/SpaceRemovalTests.swift
index 022ee483..11132cee 100644
--- a/Packages/PeelCore/Tests/PeelCoreTests/SpaceRemovalTests.swift
+++ b/Packages/PeelCore/Tests/PeelCoreTests/SpaceRemovalTests.swift
@@ -297,6 +297,36 @@ struct SpaceRemovalTests {
#expect(removalGuard.refusal(of: reports) == .staysItself)
}
+ @Test func offersTheLogsHomebrewsServicesWriteButNeverTheirFolders() async throws {
+ let directory = try TemporaryDirectory()
+ let anHourAgo = Date.now.addingTimeInterval(-3600)
+ for path in ["redis.log", "nginx/error.log", "nginx/old/archived.log", "[email protected]"] {
+ let file = try directory.file("root/opt/homebrew/var/log/\(path)", bytes: 4_000)
+ guard path != "[email protected]" else { continue }
+ try FileManager.default.setAttributes(
+ [.modificationDate: anHourAgo], ofItemAtPath: file.path(percentEncoded: false)
+ )
+ }
+ let report = await SpaceInventory.scan(
+ home: directory.url.appending(path: "home", directoryHint: .isDirectory),
+ root: directory.url.appending(path: "root", directoryHint: .isDirectory),
+ minimumSize: 1, measure: FileSize.measure
+ )
+ let logs = try #require(report.items.first { $0.id == "homebrew-logs" })
+ let folder = try #require(logs.urls.first)
+
+ let plan = await SpaceRemoval.plan(for: logs, environment: environment(directory), running: [:])
+
+ let offered = plan.removable.map {
+ $0.path(percentEncoded: false).components(separatedBy: "/opt/homebrew/var/log/").last ?? ""
+ }
+ #expect(offered.sorted() == ["nginx/error.log", "[email protected]", "redis.log"])
+ #expect(plan.heldBack.filter { $0.value == .writtenRecently }.map(\.key.lastPathComponent) == ["[email protected]"])
+ #expect(logs.size.map { $0 >= 12_000 && $0 < 16_000 } == true)
+ let removalGuard = RemovalGuard(environment: environment(directory), exclusions: .none)
+ #expect(removalGuard.refusal(of: folder) == .staysItself)
+ }
+
@Test func putsBackTheAccountsCrashReportsFolderOnlyAsAFolder() throws {
let directory = try TemporaryDirectory()
try directory.directory("home/Library/Logs")
diff --git a/Peel/Views/Space/SpaceText.swift b/Peel/Views/Space/SpaceText.swift
index efb865aa..bbc0c408 100644
--- a/Peel/Views/Space/SpaceText.swift
+++ b/Peel/Views/Space/SpaceText.swift
@@ -175,6 +175,10 @@ nonisolated extension SpaceItem {
title: "Logs for All Users",
detail: "Logs that apps wrote for every account on this Mac, and the crash reports macOS keeps, in the Library at the top of the disk. What macOS writes there for its own services isn’t listed, and what an open app uses stays. What an administrator owns goes through Peel’s helper."
),
+ "homebrew-logs": Words(
+ title: "Homebrew Service Logs",
+ detail: "Logs that the services Homebrew runs, such as a database or a web server, write in Homebrew’s folder. Only the logs are offered, never the folders they sit in, since a service expects to find the folder it writes in."
+ ),
"battlenet-cache": Words(
title: "Battle.net Cache",
detail: "What the Battle.net app caches for every account on this Mac. Blizzard says removing it doesn’t affect your games, and the app makes it again. Since it belongs to every account, it is listed and never selected."
diff --git a/SAFETY.md b/SAFETY.md
index f7ca6e2a..806e9e44 100644
--- a/SAFETY.md
+++ b/SAFETY.md
@@ -166,7 +166,10 @@ app's own uninstaller.
The folder your account's crash reports are saved in, `~/Library/Logs/DiagnosticReports`, never moves: macOS's
analytics helper can't make it again once it is gone, and crash reports would stop being saved. Space offers only
-the reports in it, as it does in `/Library/Logs/DiagnosticReports`.
+the reports in it, as it does in `/Library/Logs/DiagnosticReports`. In `/opt/homebrew/var/log`, where Homebrew's
+services write their logs, Space offers files alone, those in the folders there included, and never a folder:
+`brew services start` makes the folder a service logs into, and launchd makes a missing log file again but never a
+missing folder, so a service whose folder had gone would not start at the next login.
A move to the Trash, or back from it, never replaces what is already at the new name. Most disks refuse that by
themselves; on one that cannot, such as exFAT, Peel first takes the name with an empty placeholder, which only a
@@ -335,6 +338,8 @@ Never selected for you, even when found:
- A cache in `~/Library/Caches`, or in the folder macOS gives your account for caches, that something wrote to in
the last 15 minutes: Peel knows an open app's caches only by the app's names, and a program may still be using
one under a name of its own.
+- A log in `/opt/homebrew/var/log` that something wrote to in the last 15 minutes: a running service may hold it
+ open, and moving it would free nothing.
- `/Users/Shared`: it belongs to every account, not just yours.
- A project you worked on this week, and a download that changed in the last day, which may still be going.
- A folder with a repository, a wallet, a signing key, or a password database (KeePass's `.kdbx`, KeePassXC's `.keyx`)