multi-tracker-plugin v1.0.0

Multi-Tracker-Plugin

Mutli Tracker Client: Provides the functionality to Track via multiple sources, for example: Google Analytics, Azure App Insights, etc.

Supports: GoogleAnalytics-4 & Azure AppInsights

Right now, These 2 above trackers are configured and definations have been defined, In future, will push other tracker definations to support further.

Usage

This Tracker Plugins provides EventTracker javascript plugin which requires few arguments, Please follow the example below, moreover, you may check Demo-Tracking.html

Code Snippet

Please Follow the code example.

1. Download the Tracking-Service.js from 'src' folder
2. Link the Google Analytics or Azure AppInsight, Refer to the Demo-Tracking.html page
3. Create EventTracker for GA-4

   // Google Analytics 4 - Example
   var _gaTracker = new EventTracker({
      trackerType: EventTracker.TrackerTypes.GoogleAnalytics,
      client: gtag,
      config: { GATrackingId: '<YOUR GA-4 Key HERE>', environment: 'test'},
      customDataCallBack: customDataCallBack // this object will always be sent with all Events
   });
   _gaTracker.TrackEvent('Authentication','Login','Some Other Info');
   // you may send an object as 4th argument, if you want extra object to track in this event
   // _gaTracker.TrackEvent('Authentication','Login','Some Other Info', {Username: 'Test Khan'});

4. Create EventTracker for Azure App Insight

 // Azure AppInsight - Example
 var _appInsight = new EventTracker({
   trackerType: EventTracker.TrackerTypes.AzureAppInsight,
   client: Microsoft.ApplicationInsights.ApplicationInsights,
   config: { instrumentationConnectionString: 'Copy connection string from Application Insights Resource Overview', environment:'test'},
   customDataCallBack: customDataCallBack // this object will always be sent with all Events
 });
 _appInsight.TrackEvent('Authentication','Login','Some Other Info');

5. Custom Object to send with every event:

  // customDataCallBack:: this object will always be sent with all Events, 
  // The dynamic callback method to return dynamic object with changable values
  var customDataCallBack = () => {
    return {
      ...{
        Email: 'test@gmail123.com',
        UserType: 'Operator',
        UserID: 123
      }
    };
  };

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Mahad Bin Mukhtar - @mahad-apex - mahad.mukhtar@breakthru.pk

Project Link: https://github.com/apexchat/Multi-Tracker-Plugin