Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Undo 5.7 package files, not needed yet #232

Merged
merged 2 commits into from
Aug 24, 2022
Merged

Conversation

ktoso
Copy link
Member

@ktoso ktoso commented Aug 24, 2022

Overdid it a bit, 5.7 files not needed yet.

@ktoso ktoso requested a review from yim-lee August 24, 2022 02:29
Copy link
Member

@yim-lee yim-lee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@ktoso ktoso merged commit ce09fe6 into apple:main Aug 24, 2022
@ktoso ktoso deleted the package-fixup branch August 24, 2022 03:33
renovate bot added a commit to cgrindel/rules_swift_package_manager that referenced this pull request Mar 30, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [apple/swift-log](https://togithub.com/apple/swift-log) | minor |
`from: "1.4.4"` -> `from: "1.5.2"` |

---

### Release Notes

<details>
<summary>apple/swift-log</summary>

### [`v1.5.2`](https://togithub.com/apple/swift-log/releases/tag/1.5.2)

[Compare
Source](https://togithub.com/apple/swift-log/compare/1.5.1...1.5.2)

#### Primary change

Address too aggressive warning logging on LogHandlers that do not
support `MetadataProvider`. The warning would be emitted too frequently,
resulting in flooding logs with warnings. Instead, the warning is now
emitted once per log handler type.

#### What's Changed

- Avoid logging warnings when handler does not support metadataproviders
by [@&#8203;ktoso](https://togithub.com/ktoso) in
[apple/swift-log#252
- Handle providers properly in multiplex log handler by
[@&#8203;ktoso](https://togithub.com/ktoso) in
[apple/swift-log#254
- Add CI for Swift 5.8 and update nightly to Ubuntu 22.04 by
[@&#8203;yim-lee](https://togithub.com/yim-lee) in
[apple/swift-log#255

**Full Changelog**:
apple/swift-log@1.5.1...1.5.2

### [`v1.5.1`](https://togithub.com/apple/swift-log/releases/tag/1.5.1)

[Compare
Source](https://togithub.com/apple/swift-log/compare/1.5.0...1.5.1)

#### Summary

This patch release focuses on minor cleanups to ergonomics of setting
metadata providers with the default stream log handlers, and fixes a bug
in the default handler not printing the provided extra metadata by
default (it does now).

Thank you to [@&#8203;slashmo](https://togithub.com/slashmo) for quickly
noticing and providing a patch for the latter!

#### What's Changed

- Allow passing explicit provider into the stream handlers by
[@&#8203;ktoso](https://togithub.com/ktoso) in
[apple/swift-log#250
- Emit correct metadata from StreamLogHandler by
[@&#8203;slashmo](https://togithub.com/slashmo) in
[apple/swift-log#251

**Full Changelog**:
apple/swift-log@1.5.0...1.5.1

### [`v1.5.0`](https://togithub.com/apple/swift-log/releases/tag/1.5.0)

[Compare
Source](https://togithub.com/apple/swift-log/compare/1.4.4...1.5.0)

### Changes

#### Swift version support

This release drops support for Swift 5.0.

Swift 5.1+ remain supported for the time being.

#### Logger.MetadataProvider

This release introduces metadata providers!

They are an additional way to add metadata to your log statements
automatically whenever a log statement is about to be made. This works
extremely well with systems like distributed tracing, that may pick up
trace identifiers and other information from the task-local context from
where the log statement is being made.

The feature came with a [swift evolution style
proposal](https://togithub.com/apple/swift-log/blob/main/proposals/0001-metadata-providers.md)
introduction to the "why?" and "how?" of this feature you may find
interesting.

Metadata providers are used like this:

```swift
import Logging

enum Namespace { 
  @&#8203;TaskLocal static var simpleTraceID: String?
}

let simpleTraceIDMetadataProvider = Logger.MetadataProvider { 
    guard let traceID = Namespace.simpleTraceID else {
        return [:]
    }
    return ["simple-trace-id": .string(traceID)]
 }

LoggingSystem.bootstrap({ label, metadataProvider in
    myCoolLogHandler(label: label, metadataProvider: metadataProvider)
}, metadataProvider: simpleTraceIDMetadataProvider)
```

which in turn makes every `Logger` on this `LoggingSystem` add this
contextual metadata to log statements automatically:

```swift
let log = Logger(label: "hello")

Namespace.$simpleTraceID.withValue("1234-5678") {
  test()
}

func test() {
  log.info("test log statement")
}

// [info] [simple-trace-id: 1234-5678] test log statement
```

##### Adoption in `LogHandler`s

In order to support this new feature in your log handlers, please make
it accept a `MetadataProvider?` at creation, and store it as:

```swift
struct MyHandler: LogHandler {
    // ... 
    public var metadataProvider: Logger.MetadataProvider?
    // ...
}
```

#### What's Changed

##### Highlight

- Metadata Providers (e.g. for Distributed Tracing) in LogHandlers by
[@&#8203;ktoso](https://togithub.com/ktoso) in
[apple/swift-log#238

##### Other changes

- \[docs] Minimal docc setup and landing page by
[@&#8203;ktoso](https://togithub.com/ktoso) in
[apple/swift-log#226
- \=docc Make docs use symbol references by
[@&#8203;ktoso](https://togithub.com/ktoso) in
[apple/swift-log#230
- \=docc Move to multiple Package.swift files by
[@&#8203;ktoso](https://togithub.com/ktoso) in
[apple/swift-log#231
- Undo 5.7 package files, not needed yet by
[@&#8203;ktoso](https://togithub.com/ktoso) in
[apple/swift-log#232
- Update README: Add missing Source param by
[@&#8203;Rusik](https://togithub.com/Rusik) in
[apple/swift-log#233
- Fix build for wasm by [@&#8203;ahti](https://togithub.com/ahti) in
[apple/swift-log#236
- Add .spi.yml for Swift Package Index DocC support by
[@&#8203;yim-lee](https://togithub.com/yim-lee) in
[apple/swift-log#240
- Fixes link to Supabase repository in README.md by
[@&#8203;timobollwerk](https://togithub.com/timobollwerk) in
[apple/swift-log#245

#### New Contributors

- [@&#8203;Rusik](https://togithub.com/Rusik) made their first
contribution in
[apple/swift-log#233
- [@&#8203;ahti](https://togithub.com/ahti) made their first
contribution in
[apple/swift-log#236
- [@&#8203;timobollwerk](https://togithub.com/timobollwerk) made their
first contribution in
[apple/swift-log#245

**Full Changelog**:
apple/swift-log@1.4.4...1.5.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://app.renovatebot.com/dashboard#github/cgrindel/swift_bazel).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4yMi4xIiwidXBkYXRlZEluVmVyIjoiMzUuMjIuMSJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants