Sha256: 751d0bdc9afe3949f3781892b58c0c30987c65a6b0d1ec8c23188b1f98ab9064

Contents?: true

Size: 1.81 KB

Versions: 7

Compression:

Stored size: 1.81 KB

Contents

# getaround_utils

Backend shared utility classes

## Railties

### GetaroundUtils::Railties::Lograge

Enables lograge (http logs) with favored default.
```
# config/application.rb
require 'getaround_utils/railties/lograge'
```

For more details, [read the spec](spec/getaround_utils/railties/lograge_spec.rb)

## Mixins

### GetaroundUtils::Mixins::Loggable

Enables lograge (http logs) with favored default.
```
class MyClass
  include Getaround::Mixins::Loggable

  def append_infos_to_loggable(payload)
    payload[:static] = 'value'
  end

  def action
    loggable(:info, 'hello', dynamic: 'value')
  end
end

MyClass.new.action # :info message="hello" origin="MyClass" static="value" dynamic="value"

```

For more details, [read the spec](spec/getaround_utils/mixins/loggable.rb)


## Patches

### GetaroundUtils::Patches::KeyValueLogTags

Enables parse-able key-value tags in ActiveRecord::TaggedLogger
```
# config/application.rb
require 'getaround_utils/patches/key_value_log_tags'
GetaroundUtils::Patches::KeyValueLogTags.enable
```

For more details, [read the spec](spec/getaround_utils/patches/key_value_log_tags_spec.rb)


### GetaroundUtils::Patches::KeyValueSidekiqExceptions

Enables parse-able exception logging from Sidekiq
```
# config/application.rb
require 'getaround_utils/patches/key_value_sidekiq_exceptions'
GetaroundUtils::Patches::KeyValueSidekiqExceptions.enable
```

For more details, [read the spec](spec/getaround_utils/patches/key_value_sidekiq_exceptions_spec.rb)


## Misc

### GetaroundUtils::LogFormatters::DeepKeyValue

This log formatter will serialize an object of any depth into a key-value string.
It supports basic scalars (ie: `Hash`,`Array`,`Numeric`,`String`) and will call "#inspect" for any other type.

For more details, [read the spec](spec/getaround_utils/log_formatters/deep_key_value_spec.rb)


Version data entries

7 entries across 7 versions & 1 rubygems

Version Path
getaround_utils-0.1.17 README.md
getaround_utils-0.1.15 README.md
getaround_utils-0.1.14 README.md
getaround_utils-0.1.13 README.md
getaround_utils-0.1.12 README.md
getaround_utils-0.1.11 README.md
getaround_utils-0.1.9 README.md