logdna / logdna/ruby

Include Rails log_tags in metadata

Open
#37 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
19
Forks
18
PR merge metrics
No merged PRs in 30d

Description

I've made this change locally. But I think it could go in the public gem. I'm using `ActiveSupport::TaggedLogging` in Rails to include log tags like this:

```ruby
# This is the default in Rails, but could include more stuff if desired
config.log_tags = [:request_id]

# Send logs to LogDNA
log_dna_logger = Logdna::Ruby.new(
Rails.application.secrets.log_dna_api_key, {
env: "development",
app: "ShayHi",
level: Logger::DEBUG
}
)
# Wrap LogDNA logger in TaggedLogging to add log tags
config.logger = ActiveSupport::TaggedLogging.new(log_dna_logger)
```

I then modified `Logdna::Ruby#log` to include the tags in the metadata

```ruby
def log(message = nil, opts = {})
# MY NEW CODE BELOW vvv
if formatter.current_tags.present?
opts[:meta] = (opts[:meta] || {}).merge(tags: formatter.current_tags.join(" "))
end
# MY NEW CODE ABOVE ^^^
if message.nil? && block_given?
message = yield
end
if message.nil?
@internal_logger.debug("provide either a message or block")
return
end
message = message.to_s.encode("UTF-8")
@client.write_to_buffer(message, default_opts.merge(opts).merge(
timestamp: (Time.now.to_f * 1000).to_i
))
end
```

Logs now look like this:

tags

This is particularly useful for including the Rails request_id in the log metadata. I can open a PR if this is something you're interested in adding to the gem for everyone.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating Logdna::Ruby#log and the logger setup used with ActiveSupport::TaggedLogging. Verify how current tags should be added to log metadata while preserving existing metadata, then confirm that tagged Rails logs include the request_id in the resulting metadata.

Written by the indexing model from the issue text.

Assessment

Tech stack
rails, ruby
Domain
observability-sre
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.