Skip to content

📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!

(feature) Cumulative mode (#197)

Andrii Romasiun469ee8f77f4f
diff --git a/apps/production/src/analytics/analytics.controller.ts b/apps/production/src/analytics/analytics.controller.ts
index 3df90089f..af7e2cd54 100644
--- a/apps/production/src/analytics/analytics.controller.ts
+++ b/apps/production/src/analytics/analytics.controller.ts
@@ -46,7 +46,7 @@ import { DEFAULT_TIMEZONE } from '../user/entities/user.entity'
import { RolesGuard } from '../auth/guards/roles.guard'
import { PageviewsDTO } from './dto/pageviews.dto'
import { EventsDTO } from './dto/events.dto'
-import { AnalyticsGET_DTO } from './dto/getData.dto'
+import { AnalyticsGET_DTO, ChartRenderMode } from './dto/getData.dto'
import { GetCustomEventMetadata } from './dto/get-custom-event-meta.dto'
import { GetUserFlowDTO } from './dto/getUserFlow.dto'
import { AppLoggerService } from '../logger/logger.service'
@@ -296,6 +296,7 @@ export class AnalyticsController {
to,
filters,
timezone = DEFAULT_TIMEZONE,
+ mode = ChartRenderMode.PERIODICAL,
} = data
this.analyticsService.validatePID(pid)
@@ -378,6 +379,7 @@ export class AnalyticsController {
filtersQuery,
paramsData,
safeTimezone,
+ mode,
)
} else {
result = await this.analyticsService.groupByTimeBucket(
@@ -390,6 +392,7 @@ export class AnalyticsController {
safeTimezone,
customEVFilterApplied,
appliedFilters,
+ mode,
)
}
@@ -471,6 +474,7 @@ export class AnalyticsController {
to,
filters,
timezone = DEFAULT_TIMEZONE,
+ mode = ChartRenderMode.PERIODICAL,
} = data
this.analyticsService.validatePID(pid)
@@ -520,6 +524,7 @@ export class AnalyticsController {
paramsData,
safeTimezone,
customEVFilterApplied,
+ mode,
)
return {
diff --git a/apps/production/src/analytics/analytics.service.ts b/apps/production/src/analytics/analytics.service.ts
index 912835a57..4a49a134b 100644
--- a/apps/production/src/analytics/analytics.service.ts
+++ b/apps/production/src/analytics/analytics.service.ts
@@ -56,7 +56,7 @@ import { PageviewsDTO } from './dto/pageviews.dto'
import { EventsDTO } from './dto/events.dto'
import { ProjectService } from '../project/project.service'
import { Project } from '../project/entity/project.entity'
-import { TimeBucketType } from './dto/getData.dto'
+import { ChartRenderMode, TimeBucketType } from './dto/getData.dto'
import { GetCustomEventMetadata } from './dto/get-custom-event-meta.dto'
import {
PerformanceCHResponse,
@@ -1225,13 +1225,14 @@ export class AnalyticsService {
timeBucket: TimeBucketType,
filtersQuery: string,
safeTimezone: string,
+ mode: ChartRenderMode,
): string {
const timeBucketFunc = timeBucketConversion[timeBucket]
const [selector, groupBy] = this.getGroupSubquery(timeBucket)
const tzFromDate = `toTimeZone(parseDateTimeBestEffort({groupFrom:String}), '${safeTimezone}')`
const tzToDate = `toTimeZone(parseDateTimeBestEffort({groupTo:String}), '${safeTimezone}')`
- return `
+ const baseQuery = `
SELECT
${selector},
avg(sdur) as sdur,
@@ -1248,20 +1249,33 @@ export class AnalyticsService {
) as subquery
GROUP BY ${groupBy}
ORDER BY ${groupBy}
+ `
+
+ if (mode === ChartRenderMode.CUMULATIVE) {
+ return `
+ SELECT
+ *,
+ sum(pageviews) OVER (ORDER BY ${groupBy}) as pageviews,
+ sum(uniques) OVER (ORDER BY ${groupBy}) as uniques
+ FROM (${baseQuery})
`
+ }
+
+ return baseQuery
}
generateCustomEventsAggregationQuery(
timeBucket: TimeBucketType,
filtersQuery: string,
safeTimezone: string,
+ mode: ChartRenderMode,
): string {
const timeBucketFunc = timeBucketConversion[timeBucket]
const [selector, groupBy] = this.getGroupSubquery(timeBucket)
const tzFromDate = `toTimeZone(parseDateTimeBestEffort({groupFrom:String}), '${safeTimezone}')`
const tzToDate = `toTimeZone(parseDateTimeBestEffort({groupTo:String}), '${safeTimezone}')`
- return `
+ const baseQuery = `
SELECT
${selector},
count() as count
@@ -1276,6 +1290,17 @@ export class AnalyticsService {
GROUP BY ${groupBy}
ORDER BY ${groupBy}
`
+
+ if (mode === ChartRenderMode.CUMULATIVE) {
+ return `
+ SELECT
+ *,
+ sum(count) OVER (ORDER BY ${groupBy}) as count
+ FROM (${baseQuery})
+ `
+ }
+
+ return baseQuery
}
generatePerformanceAggregationQuery(
@@ -1316,13 +1341,14 @@ export class AnalyticsService {
timeBucket: TimeBucketType,
filtersQuery: string,
safeTimezone: string,
+ mode: ChartRenderMode,
): string {
const timeBucketFunc = timeBucketConversion[timeBucket]
const [selector, groupBy] = this.getGroupSubquery(timeBucket)
const tzFromDate = `toTimeZone(parseDateTimeBestEffort({groupFrom:String}), '${safeTimezone}')`
const tzToDate = `toTimeZone(parseDateTimeBestEffort({groupTo:String}), '${safeTimezone}')`
- return `
+ const baseQuery = `
SELECT
${selector},
count() as count
@@ -1337,7 +1363,19 @@ export class AnalyticsService {
) as subquery
GROUP BY ${groupBy}
ORDER BY ${groupBy}
+ `
+
+ if (mode === ChartRenderMode.CUMULATIVE) {
+ return `
+ SELECT
+ *,
+ sum(pageviews) OVER (ORDER BY ${groupBy}) as pageviews,
+ sum(uniques) OVER (ORDER BY ${groupBy}) as uniques
+ FROM (${baseQuery})
`
+ }
+
+ return baseQuery
}
async groupByTimeBucket(
@@ -1350,6 +1388,7 @@ export class AnalyticsService {
safeTimezone: string,
customEVFilterApplied: boolean,
parsedFilters: Array<{ [key: string]: string }>,
+ mode: ChartRenderMode,
): Promise<object | void> {
let params: unknown = {}
let chart: unknown = {}
@@ -1383,6 +1422,7 @@ export class AnalyticsService {
paramsData,
safeTimezone,
customEVFilterApplied,
+ mode,
)
// @ts-ignore
@@ -1427,6 +1467,7 @@ export class AnalyticsService {
paramsData: any,
safeTimezone: string,
customEVFilterApplied: boolean,
+ mode: ChartRenderMode,
): Promise<object | void> {
const avgSdur = customEVFilterApplied
? 0
@@ -1439,6 +1480,7 @@ export class AnalyticsService {
timeBucket,
filtersQuery,
safeTimezone,
+ mode,
)
const result = <Array<TrafficCEFilterCHResponse>>(
@@ -1466,6 +1508,7 @@ export class AnalyticsService {
timeBucket,
filtersQuery,
safeTimezone,
+ mode,
)
const result = <Array<TrafficCHResponse>>(
@@ -1511,6 +1554,7 @@ export class AnalyticsService {
filtersQuery: string,
paramsData: object,
safeTimezone: string,
+ mode: ChartRenderMode,
): Promise<object | void> {
let params: unknown = {}
let chart: unknown = {}
@@ -1547,6 +1591,7 @@ export class AnalyticsService {
timeBucket,
filtersQuery,
safeTimezone,
+ mode,
)
const result = <Array<TrafficCEFilterCHResponse>>(
diff --git a/apps/production/src/analytics/dto/getData.dto.ts b/apps/production/src/analytics/dto/getData.dto.ts
index c51c3d227..870f59c98 100644
--- a/apps/production/src/analytics/dto/getData.dto.ts
+++ b/apps/production/src/analytics/dto/getData.dto.ts
@@ -10,6 +10,11 @@ export enum TimeBucketType {
YEAR = 'year',
}
+export enum ChartRenderMode {
+ PERIODICAL = 'periodical',
+ CUMULATIVE = 'cumulative',
+}
+
// eslint-disable-next-line @typescript-eslint/naming-convention
export class AnalyticsGET_DTO {
@ApiProperty()
@@ -40,4 +45,11 @@ export class AnalyticsGET_DTO {
default: DEFAULT_TIMEZONE,
})
timezone: string
+
+ @ApiProperty({
+ description:
+ 'Mode in which data in chart should be rendered, may be either periodical or cumulative',
+ default: ChartRenderMode.PERIODICAL,
+ })
+ mode?: ChartRenderMode
}
diff --git a/apps/selfhosted/src/analytics/analytics.controller.ts b/apps/selfhosted/src/analytics/analytics.controller.ts
index 82e577ae1..eeb873b48 100644
--- a/apps/selfhosted/src/analytics/analytics.controller.ts
+++ b/apps/selfhosted/src/analytics/analytics.controller.ts
@@ -44,7 +44,7 @@ import { DEFAULT_TIMEZONE } from '../user/entities/user.entity'
import { RolesGuard } from '../auth/guards/roles.guard'
import { PageviewsDTO } from './dto/pageviews.dto'
import { EventsDTO } from './dto/events.dto'
-import { AnalyticsGET_DTO } from './dto/getData.dto'
+import { AnalyticsGET_DTO, ChartRenderMode } from './dto/getData.dto'
import { GetFiltersDto } from './dto/get-filters.dto'
import { GetCustomEventMetadata } from './dto/get-custom-event-meta.dto'
import { GetUserFlowDTO } from './dto/getUserFlow.dto'
@@ -288,6 +288,7 @@ export class AnalyticsController {
to,
filters,
timezone = DEFAULT_TIMEZONE,
+ mode = ChartRenderMode.PERIODICAL,
} = data
this.analyticsService.validatePID(pid)
@@ -360,6 +361,7 @@ export class AnalyticsController {
safeTimezone,
customEVFilterApplied,
parsedFilters,
+ mode,
)
const customs = await this.analyticsService.processCustomEV(
@@ -421,6 +423,7 @@ export class AnalyticsController {
to,
filters,
timezone = DEFAULT_TIMEZONE,
+ mode = ChartRenderMode.PERIODICAL,
} = data
this.analyticsService.validatePID(pid)
@@ -466,6 +469,7 @@ export class AnalyticsController {
paramsData,
safeTimezone,
customEVFilterApplied,
+ mode,
)
return {
diff --git a/apps/selfhosted/src/analytics/analytics.service.ts b/apps/selfhosted/src/analytics/analytics.service.ts
index a67bb4cc3..19b49c7b3 100644
--- a/apps/selfhosted/src/analytics/analytics.service.ts
+++ b/apps/selfhosted/src/analytics/analytics.service.ts
@@ -50,7 +50,7 @@ import { EventsDTO } from './dto/events.dto'
import { ProjectService } from '../project/project.service'
import { Project } from '../project/entity/project.entity'
import { GetCustomEventMetadata } from './dto/get-custom-event-meta.dto'
-import { TimeBucketType } from './dto/getData.dto'
+import { TimeBucketType, ChartRenderMode } from './dto/getData.dto'
import {
PerformanceCHResponse,
CustomsCHResponse,
@@ -1167,13 +1167,14 @@ export class AnalyticsService {
timeBucket: TimeBucketType,
filtersQuery: string,
safeTimezone: string,
+ mode: ChartRenderMode,
): string {
const timeBucketFunc = timeBucketConversion[timeBucket]
const [selector, groupBy] = this.getGroupSubquery(timeBucket)
const tzFromDate = `toTimeZone(parseDateTimeBestEffort({groupFrom:String}), '${safeTimezone}')`
const tzToDate = `toTimeZone(parseDateTimeBestEffort({groupTo:String}), '${safeTimezone}')`
- return `
+ const baseQuery = `
SELECT
${selector},
avg(sdur) as sdur,
@@ -1191,19 +1192,32 @@ export class AnalyticsService {
GROUP BY ${groupBy}
ORDER BY ${groupBy}
`
+
+ if (mode === ChartRenderMode.CUMULATIVE) {
+ return `
+ SELECT
+ *,
+ sum(pageviews) OVER (ORDER BY ${groupBy}) as pageviews,
+ sum(uniques) OVER (ORDER BY ${groupBy}) as uniques
+ FROM (${baseQuery})
+ `
+ }
+
+ return baseQuery
}
generateCustomEventsAggregationQuery(
timeBucket: TimeBucketType,
filtersQuery: string,
safeTimezone: string,
+ mode: ChartRenderMode,
): string {
const timeBucketFunc = timeBucketConversion[timeBucket]
const [selector, groupBy] = this.getGroupSubquery(timeBucket)
const tzFromDate = `toTimeZone(parseDateTimeBestEffort({groupFrom:String}), '${safeTimezone}')`
const tzToDate = `toTimeZone(parseDateTimeBestEffort({groupTo:String}), '${safeTimezone}')`
- return `
+ const baseQuery = `
SELECT
${selector},
count() as count
@@ -1218,6 +1232,17 @@ export class AnalyticsService {
GROUP BY ${groupBy}
ORDER BY ${groupBy}
`
+
+ if (mode === ChartRenderMode.CUMULATIVE) {
+ return `
+ SELECT
+ *,
+ sum(count) OVER (ORDER BY ${groupBy}) as count
+ FROM (${baseQuery})
+ `
+ }
+
+ return baseQuery
}
generatePerformanceAggregationQuery(
@@ -1264,6 +1289,7 @@ export class AnalyticsService {
safeTimezone: string,
customEVFilterApplied: boolean,
parsedFilters: Array<{ [key: string]: string }>,
+ mode: ChartRenderMode,
): Promise<object | void> {
let params: unknown = {}
let chart: unknown = {}
@@ -1297,6 +1323,7 @@ export class AnalyticsService {
paramsData,
safeTimezone,
customEVFilterApplied,
+ mode,
)
// @ts-ignore
@@ -1340,6 +1367,7 @@ export class AnalyticsService {
paramsData: any,
safeTimezone: string,
customEVFilterApplied: boolean,
+ mode: ChartRenderMode,
): Promise<object | void> {
const avgSdur = customEVFilterApplied
? 0
@@ -1352,6 +1380,7 @@ export class AnalyticsService {
timeBucket,
filtersQuery,
safeTimezone,
+ mode,
)
const result = <Array<TrafficCEFilterCHResponse>>(
@@ -1378,6 +1407,7 @@ export class AnalyticsService {
timeBucket,
filtersQuery,
safeTimezone,
+ mode,
)
const result = <Array<TrafficCHResponse>>(
diff --git a/apps/selfhosted/src/analytics/dto/getData.dto.ts b/apps/selfhosted/src/analytics/dto/getData.dto.ts
index c51c3d227..870f59c98 100644
--- a/apps/selfhosted/src/analytics/dto/getData.dto.ts
+++ b/apps/selfhosted/src/analytics/dto/getData.dto.ts
@@ -10,6 +10,11 @@ export enum TimeBucketType {
YEAR = 'year',
}
+export enum ChartRenderMode {
+ PERIODICAL = 'periodical',
+ CUMULATIVE = 'cumulative',
+}
+
// eslint-disable-next-line @typescript-eslint/naming-convention
export class AnalyticsGET_DTO {
@ApiProperty()
@@ -40,4 +45,11 @@ export class AnalyticsGET_DTO {
default: DEFAULT_TIMEZONE,
})
timezone: string
+
+ @ApiProperty({
+ description:
+ 'Mode in which data in chart should be rendered, may be either periodical or cumulative',
+ default: ChartRenderMode.PERIODICAL,
+ })
+ mode?: ChartRenderMode
}
diff --git a/blog-posts b/blog-posts
index 24e9a99bc..5d5f76615 160000
--- a/blog-posts
+++ b/blog-posts
@@ -1 +1 @@
-Subproject commit 24e9a99bca44d3193c81998abfbd62e7410126fa
+Subproject commit 5d5f76615f8381a17b0d4993b3e015802fe991e9