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

Commit

Permalink
Remove arrows
Browse files Browse the repository at this point in the history
  • Loading branch information
binarylogic committed Feb 14, 2017
1 parent 839a343 commit a3dbfb5
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 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 @timber.io {"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 @timber.io {"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 @timber.io {"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"}
# {"key": "value"}

logger.info('{"key": "value"}')
# => {"key": "value"}
# {"key": "value"}

logger.info('key=value')
# => key=value
# key=value
```

---
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 @timber.io {"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 @timber.io {"level": "info", "context": {"build": {"version": "1.0.0"}}}
```

</p></details>
Expand Down

0 comments on commit a3dbfb5

Please sign in to comment.