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.

Sign up for GitHub

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

Jump to bottom

docs: Add package level docs for logging lib #338

Merged
merged 1 commit into from
Apr 12, 2022
Merged

docs: Add package level docs for logging lib #338

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions logging/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Copyright 2022 Democratized Data Foundation
//
// Use of this software is governed by the Business Source License
// included in the file licenses/BSL.txt.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0, included in the file
// licenses/APL.txt.

/*
Package logging abstracts away any underlying logging library providing
a single contact-point for the dependency allowing relatively easy
swapping out should we want to.

This package allows configuration to be loaded and globally applied
after logger instances have been created, utilising an internal thread-safe
registry of named logger instances to apply the config to.

Configuration may be applied globally, or to logger instances of a specific
name, with the named-configuration being used over the global settings if
both are provided.

All configuration options are optional.
*/
package logging