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

Link to ianpartridge/swift-log-syslog backend impl #73

Merged
merged 3 commits into from
Jun 25, 2019

Conversation

ktoso
Copy link
Member

@ktoso ktoso commented May 20, 2019

@ianpartridge implemented a backend for syslog (awesome :-)) so we should link to it so people are easily able to discover it (and any other future implementations we'd want to link to).

The style of this section closely follows swift metrics, where we also have a section about "existing backends."

Sounds good to add like this @ianpartridge or should we reword somehow?

// cc @tomerd @weissi

@ianpartridge implemented a backend for syslog (awesome :-)) so we should link to it so people are easily able to discover it (and any other future implementations we'd want to link to).

The style of this section closely follows swift metrics, where we also have a section about "existing backends."

Sounds good to add like this @ianpartridge or should we reword somehow?

// cc @tomerd @weissi
@ktoso ktoso requested a review from weissi May 20, 2019 02:23
@@ -6,7 +6,7 @@ First things first: This is the beginning of a community-driven open-source proj

What `SwiftLog` provides today can be found in the [API docs][api-docs].

## Great, what's the tl;dr
## Getting started
Copy link
Member Author

Choose a reason for hiding this comment

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

Aligning wording style between sswg repos (a bit too casual for a h2 I thought...), sounds good?

@@ -54,6 +54,13 @@ LoggingSystem.bootstrap(StreamLogHandler.standardError)

For further information, please check the [API documentation][api-docs].

#### Selecting a logging backend implementation (applications only)
Copy link
Member Author

Choose a reason for hiding this comment

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

Following the style of https://github.com/apple/swift-metrics#selecting-a-metrics-backend-implementation-applications-only and right after the default logger behavior is described; seems like a good spot for this

Copy link
Contributor

@ianpartridge ianpartridge left a comment

Choose a reason for hiding this comment

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

Cool, thanks. Just one nit.

README.md Outdated

As the API has just launched, not many implementations exist yet. If you are interested in implementing one see the "Implementation considerations" section below explaining how to do so. List of existing SwiftLog API compatible libraries:

- [ianpatridge/swift-log-**syslog**](https://github.com/ianpartridge/swift-log-syslog) – a [syslog](https://en.wikipedia.org/wiki/Syslog) backend,
Copy link
Contributor

Choose a reason for hiding this comment

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

patridge -> partridge

Copy link
Member Author

Choose a reason for hiding this comment

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

Whoops, terribly sorry about this 🙇 Fixing right away.

README.md Outdated Show resolved Hide resolved
Copy link
Member

@weissi weissi left a comment

Choose a reason for hiding this comment

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

Thanks, looks great! Just need to fix Ian's name :)

Co-Authored-By: Johannes Weiss <johannesweiss@apple.com>
@ktoso ktoso requested a review from weissi May 20, 2019 11:33
@ktoso
Copy link
Member Author

ktoso commented May 20, 2019

Sorry about the typo @ianpartridge, fixed :-) Merge at will.

@tomerd
Copy link
Member

tomerd commented May 20, 2019

thanks @ktoso

@tomerd tomerd added the patch-version-bump-only For PRs that when merged will only cause a bump of the patch version, ie. 1.0.x -> 1.0.(x+1) label Jun 25, 2019
@tomerd tomerd merged commit 9fc3834 into master Jun 25, 2019
@ktoso ktoso deleted the readme-add-syslog-link branch June 25, 2019 06:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
patch-version-bump-only For PRs that when merged will only cause a bump of the patch version, ie. 1.0.x -> 1.0.(x+1)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants