# Cacheflow

Colorized logging for Memcached and Redis

Works with the Rails cache, as well as [Dalli](https://github.com/petergoldstein/dalli) and [Redis](https://github.com/redis/redis-rb) clients directly

[![Build Status](https://github.com/ankane/cacheflow/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/cacheflow/actions)

## Installation

Add this line to your application’s Gemfile:

```ruby
gem "cacheflow", group: :development
```

When your log level is set to `DEBUG` (Rails default in development), all commands to Memcached and Redis are logged.

## Features

To silence logging, use:

```ruby
Cacheflow.silence do
  # code
end
```

To silence logging for [Sidekiq](https://github.com/mperham/sidekiq) commands, create an initializer with:

```ruby
Cacheflow.silence_sidekiq!
```

## Data Protection

If you use Cacheflow in an environment with [personal data](https://en.wikipedia.org/wiki/Personally_identifiable_information) and store that data in Memcached or Redis, it can end up in your app logs. To avoid this, silence logging for those calls.

## History

View the [changelog](https://github.com/ankane/cacheflow/blob/master/CHANGELOG.md)

## Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help:

- [Report bugs](https://github.com/ankane/cacheflow/issues)
- Fix bugs and [submit pull requests](https://github.com/ankane/cacheflow/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features

To get started with development:

```sh
git clone https://github.com/ankane/cacheflow.git
cd cacheflow
bundle install
bundle exec rake test
```