buMixpanelPlugin
0.1.2alpha
for sf 1.4sf 1.3 MIT
This plugin aims to provide an easy to use integration of mixpanel into your project.
After a quick setup, all your actions can be automatically tracked in real-time.
The configurations are editable in yaml, and you can add events to be tracked on your actions, to better explain what you want to be analyzed.
Please read the README for more details on how to install and use.
Developers
| Name |
Status |
Email |
Luís Faceira |
lead |
moc.ibueb <<ta>> ariecaf.siul
|
License
Copyright (c) 2010-2011 Ubiprism Lda.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Releases for sf 1.4
| Version |
License |
API |
Released |
|
0.1.2alpha
|
MIT license |
0.1.0alpha
|
07/08/2011 |
|
0.1.1alpha
|
MIT license |
0.1.0alpha
|
25/01/2011 |
|
0.1.0alpha
|
MIT license |
0.1.0alpha
|
25/01/2011 |
Releases for sf 1.3
| Version |
License |
API |
Released |
|
0.1.2alpha
|
MIT license |
0.1.0alpha
|
07/08/2011 |
|
0.1.1alpha
|
MIT license |
0.1.0alpha
|
25/01/2011 |
|
0.1.0alpha
|
MIT license |
0.1.0alpha
|
25/01/2011 |
Changelog for release 0.1.2 - 07/08/2011
- Added support for the name_tag feature that allows to set the actual user's names for event tracking
Other releases
Release 0.1.2 - 07/08/2011
- Added support for the name_tag feature that allows to set the actual user's names for event tracking
Release 0.1.1 - 25/01/2011
- Updated the installation instructions since it's now available on the symfony's official pear channel for plugins
Release 0.1.0 - 25/01/2011
- First deployment - most of the wanted features developed! In need of testing!
This plugin aims to ease the integration of mixpanel into a symfony project!
Features:
- Bundles the javascript library
- Everything is configurable in yaml, app/mod/action levels
- Enables auto-tracking of all symfony actions and its parameters
- Allows to easily track an event and user properties
- Allows to easily set a name_tag for every event, so the user is always identified
- Some view-layer helpers
How to Install/Configure:
Get a mixpanel account, if you haven't got one
http://www.mixpanel.com
Install the plugin
You can either download it (and extract it into plugins/) or install it through symfony's pear channel:
php symfony plugin:install buMixpanelPlugin --stability="alpha"
Add buMixpanelFilter to your filters.yml file
# insert your own filters here
bu_mixpanel_plugin:
class: buMixpanelFilter
Configure your project token in your app.yml file
all:
bu_mixpanel_plugin:
params:
token: insertYourTokenHere
Publish the plugins assets
php symfony plugin:publish-assets
Clear cache
php symfony cc
How to use
After configuring as explained above, it should automatically track your symfony internal actions and parameters
Just go to your mixpanel project page to see the actions being registered in real-time.
If you want a better control of what is tracked and how, here's the main things you can do:
- Set the param "auto_tracking_enabled" to false in your app.yml
- Set the global "enabled" to false in a certain environemnt or module
- Register your event manually using $this->getMixpanelTracker()->addEvent($eventName,$eventProperties);
- Set user-level properties upon login using $this->getMixpanelTracker()->addSuperProperty($propertyName, $propertyValue);
TODO:
- Add helper for mixpanel platform, to generate charts to be displayed, easily
- Allow backend invisible event tracking without javascript
- Allow events to be configured in the module.yml
- Integrate with sfGuard for optionally auto-registering user properties
- Get feedback