View Source README

Hex.pm version][hexpm version]][hexpm] [![Hex.pm Downloads][hexpm downloads]][hexpm] [![Hex.pm Documentation][hexdocs documentation] [Erlang Versions License

Filezcache - cache s3 and other files on disk

This is a file caching system optimized for use with cowmachine but can also be used with other services.

It has some unique properties:

  • Lookups return file references (if possible) which can be used with sendfile
  • Cached files can be streamed to requestors while they are being filled
  • On startup the cache is repopulated with existing files
  • Lookups return data formats directly useable for cowmachine serving

The system uses the file system to store files and a disk log. The files are stored in priv/data/ and the disk log in priv/journal.

The disk log is used to rebuild the cache after a start. Files present on disk but not mentioned in the disk log are deleted.

Example 

$ ./rebar3 shell
===> Verifying dependencies...
===> Analyzing applications...
===> Compiling filezcache
Erlang/OTP 26 [erts-14.2.1] [source] [64-bit] [smp:10:10] [ds:10:10:10] [async-threads:1] [jit]
Eshell V14.2.1 (press Ctrl+G to abort, type help(). for help)
1> application:ensure_all_started(filezcache).
ok
2> filezcache:lookup(mykey).
{error, enoent}
3> filezcache:insert(mykey, <<"foobar">>).
{ok,<0.173.0>}.
4> filezcache:lookup(mykey).
{ok,{file,6,"priv/data/4J0I2F06043V5P0V603D4O4I6L1J5M1B4I5Y2B2C606W28131H164Z421M4X6221"}}
5> filezcache:insert(mykey, <<>>).
{error,{already_started,<0.173.0>}}
6> filezcache:delete(mykey).
ok

Configuration keys

  • max_bytes Maximum size of the cache in bytes, defaults to 10GiB (10737418240 bytes)
  • journal_dir Directory for the disk log, defaults to priv/journal
  • data_dir Directory for the cached files, defaults to priv/data

TODO

There are some known issues that need to be resolved:

  • Add timeouts to filezcache_entry states wait_for_data and streaming