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

[6.1] Wrap various convert subtasks in signpost intervals #1126

Merged

Conversation

d-ronnqvist
Copy link
Contributor

This cherry pick contains two commits:

  • Explanation: This adds no-op shims for signposting and logging, making it easier for us to add low-overhead logging or performance metrics in the code. The main reason for cherry-picking this is that it could reduce future risk if another cherry-pick does any logging. The alternative would be to cherry-pick this later or to modify later cherry-picks to remove any logging of signposting in them.
  • Scope: Other cherry-picks that utilize signposting or logging will fail to build on the 6.1 branch. Higher chance of merge conflicts when cherry-picking from "main" to "release/6.1".
  • Issue: rdar://141210010
  • Risk: Low.
  • Testing: Existing automated tests pass. Manually tested signpost output using log stream --predicate 'subsystem=="org.swift.docc"' --signpost
  • Reviewer: @patshaughnessy
  • Original PR: Wrap various convert subtasks in signpost intervals #1112

and:

  • Explanation: This fixes a regression caused by rdar://141210010 where the DocC benchmark tools failed to build.
  • Scope: DocC's benchmark tools fail to build
  • Issue: rdar://141185270
  • Risk: Low. Separate tool only used for benchmarking.
  • Testing: Existing automated tests pass. Manually tested running the DocC benchmark tools.
  • Reviewer: @franklinsch
  • Original PR: Update benchmark tool to same macOS version as DocC #1124

rdar://141210010

* Add a no-op shim for os.OSSignpost

* Bump platform versions to be able to use OSSignposter

* Fix deprecation warnings about UTType API

* Wrap various major convert tasks in signpost intervals

* Add a no-op shim for os.Logger

* Add support for interpolating errors in no-op log messages

* Address code review feedback:

- Add signpost intervals around a few more tasks
@d-ronnqvist
Copy link
Contributor Author

@swift-ci please test

@d-ronnqvist d-ronnqvist merged commit 7564732 into swiftlang:release/6.1 Dec 10, 2024
2 checks passed
@d-ronnqvist d-ronnqvist deleted the signposts-and-logging-6.1 branch December 10, 2024 14:05
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