Skip to content

Commit

Permalink
better docs
Browse files Browse the repository at this point in the history
  • Loading branch information
swiknaba committed May 14, 2024
1 parent 72ab47f commit da18506
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions lib/kirei/logging/logger.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ module Kirei
# Example Usage:
#
# Kirei::Logging::Logger.call(
# level: :info,
# level: Kirei::Logging::Level::INFO,
# label: "Request started",
# meta: {
# key: "value",
Expand All @@ -19,7 +19,9 @@ module Kirei
#
# Kirei::App.config.log_transformer = Proc.new { _1 }
#
# By default, "meta" is flattened, and sensitive values are masked using see `Kirei::App.config.sensitive_keys`.
# By default, "meta" is flattened, and sensitive values are masked using sane defaults that you
# can finetune via `Kirei::App.config.sensitive_keys`.
#
# You can also build on top of the provided log transformer:
#
# Kirei::App.config.log_transformer = Proc.new do |meta|
Expand All @@ -30,7 +32,7 @@ module Kirei
#
# NOTE:
# * The log transformer must return an array of strings to allow emitting multiple lines per log event.
# * When ever possible, key names follow OpenTelemetry Semantic Conventions, https://opentelemetry.io/docs/concepts/semantic-conventions/
# * Whenever possible, key names follow OpenTelemetry Semantic Conventions, https://opentelemetry.io/docs/concepts/semantic-conventions/
#
module Logging
class Logger
Expand Down

0 comments on commit da18506

Please sign in to comment.