8000 feat(provider): Add 'Splunk' Provider by brunano21 · Pull Request #280 · angulartics/angulartics2 · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

feat(provider): Add 'Splunk' Provider #280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 2, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,7 @@ System.config({
* [Woopra](/src/lib/providers/woopra)
* [Clicky](/src/lib/providers/clicky)
* [IBM Digital Analytics](/src/lib/providers/ibm-digital-analytics)
* [Splunk](/src/lib/providers/splunk)

### For other providers

Expand Down
3 changes: 2 additions & 1 deletion build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ const MODULE_NAMES = [
'woopra',
'clicky',
'amplitude',
'ibm-digital-analytics'
'splunk',
'ibm-digital-analytics',
];


Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,8 @@
"Fil Maj <maj.fil@gmail.com> (https://github.com/filmaj)",
"Adam Yost <swimmadude66@users.noreply.github.com> (https://github.com/swimmadude66)",
"Adam S. Kirschner <accounts@adamskirschner.com> (https://github.com/hikirsch)",
"Tyler Danielson <tysdanielson@gmail.com> (https://github.com/tydanielson)"
"Tyler Danielson <tysdanielson@gmail.com> (https://github.com/tydanielson)",
"Bruno Bruzzano <brunano21@gmail.com> (https://github.com/brunano21)"
],
"keywords": [
"angular2",
Expand Down
4 changes: 4 additions & 0 deletions src/app/providers/providers.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ export class ProvidersComponent {
name: 'segment',
display: 'Segment',
type: 'Analytics',
}, {
name: 'splunk',
display: 'Splunk',
type: 'Analytics',
}, {
name: 'woopra',
display: 'Woopra',
Expand Down
41 changes: 41 additions & 0 deletions src/assets/svg/splunk.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
56 changes: 56 additions & 0 deletions src/lib/providers/splunk/README.md
ED4F
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<img
src="../../../assets/svg/splunk.svg"
alt="Splunk logo"
height="100px"
width="200px" />

# Splunk
__homepage__: [splunk.com](https://www.splunk.com/)
__docs__: [Splunk Collector API](https://github.com/splunk/splunk-demo-collector-for-analyticsjs#api)
__import__: `import { Angulartics2Mixpanel } from 'angulartics2/mixpanel';`

## Setup
1. Add tracking code [provided by Splunk](https://www.splunk.com/blog/2013/10/17/still-using-3rd-party-web-analytics-providers-build-your-own-using-splunk.html) to right above the `</head>` closing tag.
```
<script type="text/javascript"> var sp=sp||[];(function(){var e=["init","identify","track","trackLink","pageview"],t=function(e){return function(){sp.push([e].concat(Array.prototype.slice.call(arguments,0)))}};for(var n=0;n<e.length;n++)sp[e[n]]=t(e[n])})(),sp.load=function(e,o){sp._endpoint=e;if(o){sp.init(o)};var t=document.createElement("script");t.type="text/javascript",t.async=!0,t.src=("https:"===document.location.protocol?"https://":"http://")+"d21ey8j28ejz92.cloudfront.net/analytics/v1/sp.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(t,n)};
sp.load("https://www.example.com"); // Replace with your own collector URL
</script>
```
In the last line of above script, make sure to replace https://www.example.com with the address of your data collector.

2. [Setup Angulartics](https://github.com/angulartics/angulartics2/tree/next#installation) using `Angulartics2Splunk`.
```ts
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { RouterModule, Routes } from '@angular/router';

import { Angulartics2Module } from 'angulartics2';
import { Angulartics2Splunk } from 'angulartics2/splunk';

const ROUTES: Routes = [
{ path: '', component: HomeComponent },
{ path: 'about', component: AboutComponent },
];

@NgModule({
imports: [
BrowserModule,
RouterModule.forRoot(ROUTES),

// added to imports
Angulartics2Module.forRoot([Angulartics2Splunk]),
],
declarations: [AppComponent],
bootstrap: [AppComponent],
})
```
3. __Required__: Import your providers in the root component. This starts the tracking of route changes.
```ts
// component
import { Angulartics2Splunk } from 'angulartics2/splunk';

@Component({ ... })
export class AppComponent {
constructor(angulartics2Splunk: Angulartics2Splunk) {}
}
```
18 changes: 18 additions & 0 deletions src/lib/providers/splunk/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"$schema": "../../../../node_modules/ng-packagr/package.schema.json",
"name": "angulartics2/splunk",
"description": "The splunk module",
"homepage": "https://angulartics.github.io/angulartics2/",
"author": "Bruno Bruzzano <brunano21@gmail.com> (http://github.com/brunano21)",
"repository": "angulartics/angulartics2",
"license": "MIT",
"ngPackage": {
"lib": {
"entryFile": "splunk.ts",
"umdModuleIds": {
"angulartics2": "angulartics2"
}
},
"dest": "../../../../dist/packages-dist/splunk"
}
}
55 changes: 55 additions & 0 deletions src/lib/providers/splunk/splunk.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
import {
fakeAsync,
inject,
ComponentFixture,
TestBed,
} from '@angular/core/testing';

import { Angulartics2 } from 'angulartics2';
import { advance, createRoot, RootCmp, TestModule } from '../../test.mocks';
import { Angulartics2Splunk } from './splunk';

jasmine.DEFAULT_TIMEOUT_INTERVAL = 5000;
declare var window: any;

describe('Angulartics2Splunk', () => {

let fixture: ComponentFixture<any>;
let sp: any;

beforeEach(() => {
TestBed.configureTestingModule({
imports: [TestModule],
providers: [Angulartics2Splunk],
});

window.sp = sp = {
pageview: jasmine.createSpy('pageview'),
track: jasmine.createSpy('track')
};
});

it('should track pages',
fakeAsync(inject([Angulartics2, Angulartics2Splunk],
(angulartics2: Angulartics2, angulartics2Splunk: Angulartics2Splunk) => {
fixture = createRoot(RootCmp);
angulartics2.pageTrack.next({ path: '/abc' });
advance(fixture);
expect(sp.pageview).toHaveBeenCalledWith('/abc');
}),
),
);

it('should track events',
fakeAsync(inject([Angulartics2, Angulartics2Splunk],
(angulartics2: Angulartics2, angulartics2Splunk: Angulartics2Splunk) => {
fixture = createRoot(RootCmp);
angulartics2.eventTrack.next({ action: 'do', properties: { category: 'cat' } });
advance(fixture);
expect(sp.track).toHaveBeenCalledWith('do', {
category: 'cat',
});
}),
),
);
});
42 changes: 42 additions & 0 deletions src/lib/providers/splunk/splunk.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
import { Injectable } from '@angular/core';

import { Angulartics2 } from 'angulartics2';

declare var sp: any;

@Injectable()
export class Angulartics2Splunk {

constructor(private angulartics2: Angulartics2) {
if (typeof (sp) === 'undefined') {
console.warn('Splunk not found');
}

this.angulartics2.pageTrack
.pipe(this.angulartics2.filterDeveloperMode())
.subscribe((x) => this.pageTrack(x.path));
this.angulartics2.eventTrack
.pipe(this.angulartics2.filterDeveloperMode())
.subscribe((x) => this.eventTrack(x.action, x.properties));
}

pageTrack(path: string) {
try {
sp.pageview(path);
} catch (e) {
if (!(e instanceof ReferenceError)) {
throw e;
}
}
}

eventTrack(action: string, properties: any) {
try {
sp.track(action, properties);
} catch (e) {
if (!(e instanceof ReferenceError)) {
throw e;
}
}
}
}
0