Path Reporting

The one stop shop for reporting at Path

This gem contains (or will contain) all the various types of reporting we need to do at Path. From metrics to analytics to performance and beyond, this gem is meant to enable us to report anything we need as simply as possible.

Install the gem and add to the application's Gemfile by executing:

$ bundle add path-reporting

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install path-reporting

First you will need to initialize and configure the module

Path::Reporting.init do |config|
  config.analytics.logger = Rails.logger
end

See our Configuration docs for more information on how to configure this module

After initialing the module, record an analytics event with the following code.

Path::Reporting.analytics.record(
  product_code: Constants::ANALYTICS_PRODUCT_CODE,
  product_area: Constants::ANALYTICS_PRODUCT_AREA_MATCHING,
  name: 'Preferred provider multiple valid matches',
  user: @contact.analytics_friendly_hash,
  user_type: Path::Reporting::UserType::PATIENT,
  trigger: Path::Reporting::Trigger::PAGE_VIEW,
  metadata: analytics_metadata,
)

Be sure to read our Analytics Guide (Internal Doc)

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/pathccm/reporting.