https://github.com/basecamp/full_request_logger

Make full request logs accessible via web UI
https://github.com/basecamp/full_request_logger

Last synced: 3 months ago
JSON representation

Make full request logs accessible via web UI

• Host: GitHub
• URL: https://github.com/basecamp/full_request_logger
• Owner: basecamp
• License: mit
• Archived: true
• Created: 2019-09-30T21:34:46.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-07-15T00:11:08.000Z (over 2 years ago)
• Last Synced: 2024-07-20T07:08:10.611Z (4 months ago)
• Language: Ruby
• Size: 46.9 KB
• Stars: 303
• Watchers: 17
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

README

        
# Full Request Logger

Easy access to full request logs via a web UI. The recorder attaches to the existing Rails.logger instance,

and captures a copy of each log line into a per-thread buffer. When the request is over, the middleware makes

the recorder store all the log lines that were recorded for that request as a compressed batch to an auto-expiring Redis key.

Thus you no longer have to grep through log files or wrestle with logging pipelines to instantly see all the

log lines relevant to a request you just made. This is ideal for when you're testing a feature in the wild with

production-levels of data, which may reveal performance or other issues that you didn't catch in development.

## Installation

```ruby

# Gemfile

gem 'full_request_logger'

```

## Configuration

Add to development.rb and/or production.rb. Default time-to-live (TTL) for each recorded request is 10 minutes,

and the default Redis storage is assumed to live on localhost, but both can be overwritten. Only configuration needed

is the enabled setting.

```ruby

config.full_request_logger.enabled = true

config.full_request_logger.ttl     = 1.hour

config.full_request_logger.redis   = { host: "127.0.0.1", port: 6379, timeout: 1 }

```

You can restrict which requests will be stored by setting an eligibility function that gets to evaluate the request:

```ruby

config.full_request_logger.eligibility = ->(request) { request.params[:full_request_log] == "1" }

```

This makes it easier to use the logger on a busy site that would otherwise result in a lot of needless redis writes.

The request logs access can be protected behind http basic by adding the following credentials

(using `./bin/rails credentials:edit --environment production`):

```

full_request_logger:

  name: someone

  password: something

```

## Usage

Access request logs via `/rails/conductor/full_request_logger/request_logs`.

## License

Full Request Logger is released under the [MIT License](https://opensource.org/licenses/MIT).