josephwegner / pushpop-keen Goto Github PK

Keen IO plugin for Pushpop.

Add pushpop-keen to your Gemfile:

gem 'pushpop-keen'

or install it as a gem:

$ gem install pushpop-keen

The keen plugin gives you a DSL to specify Keen query parameters. Those query parameters are used to query data using the keen-gem.

Here's an example that shows many of the options you can specify:

job 'average response time for successful requests last month' do

  keen do
    event_collection  'checks'
    analysis_type     'average'
    target_property   'request.duration'
    group_by          'check.name'
    interval          'daily'
    timeframe         'last_month',
    filters           [{ property_name: "response.successful",
                         operator: "eq",
                         property_value: true }]
  end

end

A steps method is also supported for funnels, as well as analyses for doing a multi-analysis.

You can also very simply record events to Keen:

job 'send pageview'
  
  keen do
    record 'Pageview', path: '/a/path'   
  end

end

The keen plugin requires that the following environment variables are set:

• KEEN_PROJECT_ID
• KEEN_READ_KEY

Code and documentation issues and pull requests are welcome.