logdna / logdna/ruby

Include Rails log_tags in metadata

Aperta
#37 1 commento 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Ruby
Stelle
19
Fork
18
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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:

# 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

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia individuando Logdna::Ruby#log e la configurazione del logger utilizzata con ActiveSupport::TaggedLogging. Verifica come aggiungere i tag correnti ai metadati del log preservando i metadati esistenti, quindi conferma che i log Rails con tag includano request_id nei metadati risultanti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
rails, ruby
Ambito
observability-sre
Tipo di issue
Funzionalità
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.