Skip to content
This repository has been archived by the owner on Dec 8, 2020. It is now read-only.

Commit

Permalink
Update readme with @metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
binarylogic committed Feb 16, 2017
1 parent a73926e commit 7ad9c7b
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Use `Logger` as normal:
```elixir
logger.info("My log message")

# My log message @timber.io {"level": "info", "context": {...}}
# My log message @metadata {"level": "info", "context": {...}}
```

Timber will never deviate from the public `::Logger` interface in *any* way.
Expand All @@ -140,7 +140,7 @@ Timber will never deviate from the public `::Logger` interface in *any* way.
Logger.warn message: "Payment rejected", type: :payment_rejected,
data: {customer_id: "abcd1234", amount: 100, reason: "Card expired"}

# Payment rejected @timber.io {"level": "warn", "event": {"payment_rejected": {"customer_id": "abcd1234", "amount": 100, "reason": "Card expired"}}, "context": {...}}
# Payment rejected @metadata {"level": "warn", "event": {"payment_rejected": {"customer_id": "abcd1234", "amount": 100, "reason": "Card expired"}}, "context": {...}}
```

2. Log a Struct (recommended)
Expand All @@ -155,7 +155,7 @@ Timber will never deviate from the public `::Logger` interface in *any* way.
end
Logger.warn PaymentRejectedEvent.new("abcd1234", 100, "Card expired")

# Payment rejected @timber.io {"level": "warn", "event": {"payment_rejected": {"customer_id": "abcd1234", "amount": 100, "reason": "Card expired"}}, "context": {...}}
# Payment rejected @metadata {"level": "warn", "event": {"payment_rejected": {"customer_id": "abcd1234", "amount": 100, "reason": "Card expired"}}, "context": {...}}
```

* `:type` is how Timber classifies the event, it creates a namespace for the data you send.
Expand All @@ -170,13 +170,13 @@ send, and make it easier to search, graph, alert, etc.

```ruby
logger.info({key: "value"})
# {"key": "value"} @timber.io {"level": "info", "context": {...}}
# {"key": "value"} @metadata {"level": "info", "context": {...}}

logger.info('{"key": "value"}')
# {"key": "value"} @timber.io {"level": "info", "context": {...}}
# {"key": "value"} @metadata {"level": "info", "context": {...}}

logger.info('key=value')
# key=value @timber.io {"level": "info", "context": {...}}
# key=value @metadata {"level": "info", "context": {...}}
```

---
Expand All @@ -198,7 +198,7 @@ value.
logger.info("My log message")
end

# My log message @timber.io {"level": "info", "context": {"build": {"version": "1.0.0"}}}
# My log message @metadata {"level": "info", "context": {"build": {"version": "1.0.0"}}}
```

This adds data to the context keyspaced by `build`.
Expand All @@ -217,7 +217,7 @@ value.
logger.info("My log message")
end

# My log message @timber.io {"level": "info", "context": {"build": {"version": "1.0.0"}}}
# My log message @metadata {"level": "info", "context": {"build": {"version": "1.0.0"}}}
```

</p></details>
Expand All @@ -238,7 +238,7 @@ gem 'timber'
*Replace* any existing `config.logger=` calls in `config/environments/production.rb` with:

```ruby
# config/environments/production.rb (or staging, etc)
# config/environments/production.rb

config.logger = ActiveSupport::TaggedLogging.new(Timber::Logger.new(STDOUT))
```
Expand Down Expand Up @@ -298,10 +298,13 @@ The recommended strategy for Heroku is to setup a

<details><summary><strong>All other platforms (Network / HTTP)</strong></summary><p>

1. *Use* the Timber Network logger backend in `config/environments/production.rb`:
1. *Specify* the Timber Network logger backend in `config/environments/production.rb`:

Replace any existing `config.logger =` calls with:

```ruby
# config/environments/production.rb (or staging, etc)

network_log_device = Timber::LogDevices::Network.new(ENV['TIMBER_LOGS_KEY'])
config.logger = Timber::Logger.new(network_log_device) # <-- Use network_log_device instead of STDOUT
```
Expand Down

0 comments on commit 7ad9c7b

Please sign in to comment.