Files
container/Sources/ContainerCommands/Image/ImageInspect.swift
T
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

80 lines
2.7 KiB
Swift

//===----------------------------------------------------------------------===//
// Copyright © 2025-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 ArgumentParser
import ContainerAPIClient
import ContainerLog
import ContainerizationError
import Foundation
import Logging
import SwiftProtobuf
extension Application {
public struct ImageInspect: AsyncLoggableCommand {
public static let configuration = CommandConfiguration(
commandName: "inspect",
abstract: "Display information about one or more images")
@OptionGroup
public var logOptions: Flags.Logging
@Argument(help: "Images to inspect")
var images: [String]
public init() {}
struct InspectError: Error {
let succeeded: [String]
let failed: [(String, Error)]
}
public func run() async throws {
var printable = [any Codable]()
var succeededImages: [String] = []
var allErrors: [(String, Error)] = []
let result = try await ClientImage.get(names: images)
for image in result.images {
guard !Utility.isInfraImage(name: image.reference) else { continue }
printable.append(try await image.details())
succeededImages.append(image.reference)
}
for missing in result.error {
allErrors.append((missing, ContainerizationError(.notFound, message: "Image not found")))
}
if !printable.isEmpty {
print(try printable.jsonArray())
}
if !allErrors.isEmpty {
for (name, error) in allErrors {
log.error(
"image inspect failed",
metadata: [
"name": "\(name)",
"error": "\(error.localizedDescription)",
])
}
throw InspectError(succeeded: succeededImages, failed: allErrors)
}
}
}
}