Files
J Logan d29947121f CI observability enhancements. (#1193)
- Adds a a `--log-root` option to `swift system start`, propagating the
value as `CONTAINER_LOG_ROOT` to services for logging to files instead
of the OS log facility. This is not a "production" capability as it
neither merges nor rotates logs.
- Currently we don't collect logs on CI builds, and we don't have
permission to run the `log` command there. The PR adds `--log-root` to
the CI test phase, archives the results, and uploads the archive as an
artifact.
- Use FilePath from swift-system for the log root. Foundation URL is a
bit of a footgun for filesystem paths, so unless we identify a
showstopper, we should incrementally transition to this type everywhere
except where we really need network URLs.
- Output the hostname of the CI runner at the start of the test phase so
we can identify runner-specific issues where they exist.
- Fix formatting for log messages with multiple metadata items, and fix
unstructured messages on instances that weren't found using `grep -r
'log\.' Sources`.
- Adds command reference documentation for `--log-root`.
2026-02-19 17:47:41 -08:00

65 lines
3.0 KiB
Swift

//===----------------------------------------------------------------------===//
// Copyright © 2026 Apple Inc. and the container project authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//===----------------------------------------------------------------------===//
import ContainerXPC
import ContainerizationError
import Foundation
import SystemPackage
public enum ClientHealthCheck {
static let serviceIdentifier = "com.apple.container.apiserver"
}
extension ClientHealthCheck {
private static func newClient() -> XPCClient {
XPCClient(service: serviceIdentifier)
}
public static func ping(timeout: Duration? = XPCClient.xpcRegistrationTimeout) async throws -> SystemHealth {
let client = Self.newClient()
let request = XPCMessage(route: .ping)
let reply = try await client.send(request, responseTimeout: timeout)
guard let appRootValue = reply.string(key: .appRoot), let appRoot = URL(string: appRootValue) else {
throw ContainerizationError(.internalError, message: "failed to decode appRoot in health check")
}
guard let installRootValue = reply.string(key: .installRoot), let installRoot = URL(string: installRootValue) else {
throw ContainerizationError(.internalError, message: "failed to decode installRoot in health check")
}
let logRoot = reply.string(key: .logRoot).map { FilePath($0) }
guard let apiServerVersion = reply.string(key: .apiServerVersion) else {
throw ContainerizationError(.internalError, message: "failed to decode apiServerVersion in health check")
}
guard let apiServerCommit = reply.string(key: .apiServerCommit) else {
throw ContainerizationError(.internalError, message: "failed to decode apiServerCommit in health check")
}
guard let apiServerBuild = reply.string(key: .apiServerBuild) else {
throw ContainerizationError(.internalError, message: "failed to decode apiServerBuild in health check")
}
guard let apiServerAppName = reply.string(key: .apiServerAppName) else {
throw ContainerizationError(.internalError, message: "failed to decode apiServerAppName in health check")
}
return .init(
appRoot: appRoot,
installRoot: installRoot,
logRoot: logRoot,
apiServerVersion: apiServerVersion,
apiServerCommit: apiServerCommit,
apiServerBuild: apiServerBuild,
apiServerAppName: apiServerAppName
)
}
}