📈 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!
TypeScript chartsclickhousedockergdprgoogle-analyticsmetricsmonitoringmysqlnestjsprivacyredisself-hostedselfhostedstatisticstailwindcssweb-analyticswebanalyticswebsite
add region code
Blue Mousec9a98f66ab46
diff --git a/backend/apps/cloud/src/analytics/analytics.controller.ts b/backend/apps/cloud/src/analytics/analytics.controller.tsindex 081c8a194..9f1bfc889 100644--- a/backend/apps/cloud/src/analytics/analytics.controller.ts+++ b/backend/apps/cloud/src/analytics/analytics.controller.ts@@ -1089,7 +1089,7 @@ export class AnalyticsController {await this.analyticsService.processInteractionSD(psid, errorDTO.pid)- const { city, region, country } = getGeoDetails(ip, errorDTO.tz)+ const { city, region, regionCode, country } = getGeoDetails(ip, errorDTO.tz)const { deviceType, browserName, browserVersion, osName, osVersion } =await this.analyticsService.getRequestInformation(headers)@@ -1111,6 +1111,7 @@ export class AnalyticsController {errorDTO.lc,country,region,+ regionCode,city,name,message,@@ -1195,7 +1196,10 @@ export class AnalyticsController {}}- const { city, region, country } = getGeoDetails(ip, eventsDTO.tz)+ const { city, region, regionCode, country } = getGeoDetails(+ ip,+ eventsDTO.tz,+ )const { deviceType, browserName, browserVersion, osName, osVersion } =await this.analyticsService.getRequestInformation(headers)@@ -1226,6 +1230,7 @@ export class AnalyticsController {eventsDTO.co,country,region,+ regionCode,city,eventsDTO.meta,)@@ -1313,7 +1318,7 @@ export class AnalyticsController {)}- const { city, region, country } = getGeoDetails(ip, logDTO.tz)+ const { city, region, regionCode, country } = getGeoDetails(ip, logDTO.tz)const { deviceType, browserName, browserVersion, osName, osVersion } =await this.analyticsService.getRequestInformation(headers)@@ -1337,6 +1342,7 @@ export class AnalyticsController {logDTO.co,country,region,+ regionCode,city,logDTO.meta,)@@ -1364,6 +1370,7 @@ export class AnalyticsController {browserVersion,country,region,+ regionCode,city,dns,tls,@@ -1437,7 +1444,7 @@ export class AnalyticsController {await this.analyticsService.processInteractionSD(psid, logDTO.pid)- const { city, region, country } = getGeoDetails(ip)+ const { city, region, regionCode, country } = getGeoDetails(ip)const { deviceType, browserName, browserVersion, osName, osVersion } =await this.analyticsService.getRequestInformation(headers)@@ -1461,6 +1468,7 @@ export class AnalyticsController {null,country,region,+ regionCode,city,null,)diff --git a/backend/apps/cloud/src/analytics/utils/transformers.ts b/backend/apps/cloud/src/analytics/utils/transformers.tsindex 4507592f8..22793b9c1 100644--- a/backend/apps/cloud/src/analytics/utils/transformers.ts+++ b/backend/apps/cloud/src/analytics/utils/transformers.ts@@ -42,6 +42,7 @@ export const trafficTransformer = (co: string | null,cc: string | null,rg: string | null,+ rgc: string | null,ct: string | null,meta: Record<string, string> | null,) => {@@ -64,6 +65,7 @@ export const trafficTransformer = (co: co || null,cc: cc || null,rg: rg || null,+ rgc: rgc || null,ct: ct || null,...processMetaKV(meta),created: dayjs.utc().format('YYYY-MM-DD HH:mm:ss'),@@ -90,6 +92,7 @@ export const customEventTransformer = (co: string | null,cc: string | null,rg: string | null,+ rgc: string | null,ct: string | null,meta: Record<string, string> | null,) => {@@ -113,6 +116,7 @@ export const customEventTransformer = (co: co || null,cc: cc || null,rg: rg || null,+ rgc: rgc || null,ct: ct || null,...processMetaKV(meta),created: dayjs.utc().format('YYYY-MM-DD HH:mm:ss'),@@ -133,6 +137,7 @@ export const errorEventTransformer = (lc: string | null,cc: string | null,rg: string | null,+ rgc: string | null,ct: string | null,name: string | null,message: string | null,@@ -156,6 +161,7 @@ export const errorEventTransformer = (lc: lc || null,cc: cc || null,rg: rg || null,+ rgc: rgc || null,ct: ct || null,name: name || null,message: message || null,@@ -177,6 +183,7 @@ export const performanceTransformer = (brv: string | null,cc: string | null,rg: string | null,+ rgc: string | null,ct: string | null,dns: number,tls: number,@@ -196,6 +203,7 @@ export const performanceTransformer = (brv: brv || null,cc: cc || null,rg: rg || null,+ rgc: rgc || null,ct: ct || null,dns: _round(dns),tls: _round(tls),diff --git a/backend/apps/cloud/src/common/utils.ts b/backend/apps/cloud/src/common/utils.tsindex d9f1069c8..0995a028f 100644--- a/backend/apps/cloud/src/common/utils.ts+++ b/backend/apps/cloud/src/common/utils.ts@@ -247,6 +247,7 @@ if (fs.existsSync(PRODUCTION_GEOIP_DB_PATH)) {interface IPGeoDetails {country: string | nullregion: string | null+ regionCode: string | nullcity: string | null}@@ -254,19 +255,19 @@ export const getGeoDetails = (ip: string, tz?: string): IPGeoDetails => {// Stage 1: Using IP address based geo lookupconst data = lookup.get(ip)- console.log('data:', JSON.stringify(data, null, 2))-const country = data?.country?.iso_code || null// TODO: Add city overrides, for example, Colinton -> Edinburgh, etc.const city = data?.city?.names?.en || null// TODO: Store ISO code, not region nameconst region = data?.subdivisions?.[0]?.names?.en || null+ const regionCode = data?.subdivisions?.[0]?.iso_code || nullif (country) {return {country,city,region,+ regionCode,}}@@ -277,6 +278,7 @@ export const getGeoDetails = (ip: string, tz?: string): IPGeoDetails => {country: tzCountry,city: null,region: null,+ regionCode: null,}}diff --git a/backend/apps/community/src/analytics/analytics.controller.ts b/backend/apps/community/src/analytics/analytics.controller.tsindex 00b70ca7c..93694ba09 100644--- a/backend/apps/community/src/analytics/analytics.controller.ts+++ b/backend/apps/community/src/analytics/analytics.controller.ts@@ -900,7 +900,10 @@ export class AnalyticsController {const { deviceType, browserName, browserVersion, osName, osVersion } =await this.analyticsService.getRequestInformation(headers)- const { city, region, country } = getGeoDetails(ip, eventsDTO.tz)+ const { city, region, regionCode, country } = getGeoDetails(+ ip,+ eventsDTO.tz,+ )const [, psid] = await this.analyticsService.generateAndStoreSessionId(eventsDTO.pid,@@ -928,6 +931,7 @@ export class AnalyticsController {eventsDTO.co,country,region,+ regionCode,city,eventsDTO.meta,)@@ -1014,7 +1018,7 @@ export class AnalyticsController {)}- const { city, region, country } = getGeoDetails(ip, logDTO.tz)+ const { city, region, regionCode, country } = getGeoDetails(ip, logDTO.tz)const { deviceType, browserName, browserVersion, osName, osVersion } =await this.analyticsService.getRequestInformation(headers)@@ -1038,6 +1042,7 @@ export class AnalyticsController {logDTO.co,country,region,+ regionCode,city,logDTO.meta,)@@ -1065,6 +1070,7 @@ export class AnalyticsController {browserVersion,country,region,+ regionCode,city,dns,tls,@@ -1140,7 +1146,7 @@ export class AnalyticsController {const { deviceType, browserName, browserVersion, osName, osVersion } =await this.analyticsService.getRequestInformation(headers)- const { city, region, country } = getGeoDetails(ip, null)+ const { city, region, regionCode, country } = getGeoDetails(ip, null)const transformed = trafficTransformer(psid,@@ -1161,6 +1167,7 @@ export class AnalyticsController {null,country,region,+ regionCode,city,null,)@@ -1416,7 +1423,7 @@ export class AnalyticsController {await this.analyticsService.processInteractionSD(psid, errorDTO.pid)- const { city, region, country } = getGeoDetails(ip, errorDTO.tz)+ const { city, region, regionCode, country } = getGeoDetails(ip, errorDTO.tz)const { deviceType, browserName, browserVersion, osName, osVersion } =await this.analyticsService.getRequestInformation(headers)@@ -1438,6 +1445,7 @@ export class AnalyticsController {errorDTO.lc,country,region,+ regionCode,city,name,message,diff --git a/backend/apps/community/src/analytics/utils/transformers.ts b/backend/apps/community/src/analytics/utils/transformers.tsindex 4507592f8..22793b9c1 100644--- a/backend/apps/community/src/analytics/utils/transformers.ts+++ b/backend/apps/community/src/analytics/utils/transformers.ts@@ -42,6 +42,7 @@ export const trafficTransformer = (co: string | null,cc: string | null,rg: string | null,+ rgc: string | null,ct: string | null,meta: Record<string, string> | null,) => {@@ -64,6 +65,7 @@ export const trafficTransformer = (co: co || null,cc: cc || null,rg: rg || null,+ rgc: rgc || null,ct: ct || null,...processMetaKV(meta),created: dayjs.utc().format('YYYY-MM-DD HH:mm:ss'),@@ -90,6 +92,7 @@ export const customEventTransformer = (co: string | null,cc: string | null,rg: string | null,+ rgc: string | null,ct: string | null,meta: Record<string, string> | null,) => {@@ -113,6 +116,7 @@ export const customEventTransformer = (co: co || null,cc: cc || null,rg: rg || null,+ rgc: rgc || null,ct: ct || null,...processMetaKV(meta),created: dayjs.utc().format('YYYY-MM-DD HH:mm:ss'),@@ -133,6 +137,7 @@ export const errorEventTransformer = (lc: string | null,cc: string | null,rg: string | null,+ rgc: string | null,ct: string | null,name: string | null,message: string | null,@@ -156,6 +161,7 @@ export const errorEventTransformer = (lc: lc || null,cc: cc || null,rg: rg || null,+ rgc: rgc || null,ct: ct || null,name: name || null,message: message || null,@@ -177,6 +183,7 @@ export const performanceTransformer = (brv: string | null,cc: string | null,rg: string | null,+ rgc: string | null,ct: string | null,dns: number,tls: number,@@ -196,6 +203,7 @@ export const performanceTransformer = (brv: brv || null,cc: cc || null,rg: rg || null,+ rgc: rgc || null,ct: ct || null,dns: _round(dns),tls: _round(tls),diff --git a/backend/apps/community/src/common/utils.ts b/backend/apps/community/src/common/utils.tsindex fcf1c8194..7ba17ff87 100644--- a/backend/apps/community/src/common/utils.ts+++ b/backend/apps/community/src/common/utils.ts@@ -976,6 +976,7 @@ interface IPGeoDetails {country: string | nullregion: string | nullcity: string | null+ regionCode: string | null}const getGeoDetails = (ip: string, tz?: string): IPGeoDetails => {@@ -986,12 +987,14 @@ const getGeoDetails = (ip: string, tz?: string): IPGeoDetails => {// TODO: Add city overrides, for example, Colinton -> Edinburgh, etc.const city = data?.city?.names?.en || nullconst region = data?.subdivisions?.[0]?.names?.en || null+ const regionCode = data?.subdivisions?.[0]?.iso_code || nullif (country) {return {country,city,region,+ regionCode,}}@@ -1002,6 +1005,7 @@ const getGeoDetails = (ip: string, tz?: string): IPGeoDetails => {country: tzCountry,city: null,region: null,+ regionCode: null,}}diff --git a/backend/migrations/clickhouse/2025_10_08.js b/backend/migrations/clickhouse/2025_10_08.jsnew file mode 100644index 000000000..bc753c69f--- /dev/null+++ b/backend/migrations/clickhouse/2025_10_08.js@@ -0,0 +1,11 @@+const { queriesRunner, dbName } = require('./setup')++const queries = [+ // Add region code column+ `ALTER TABLE ${dbName}.analytics ADD COLUMN IF NOT EXISTS rgc Nullable(String) AFTER rg`,+ `ALTER TABLE ${dbName}.customEV ADD COLUMN IF NOT EXISTS rgc Nullable(String) AFTER rg`,+ `ALTER TABLE ${dbName}.errors ADD COLUMN IF NOT EXISTS rgc Nullable(String) AFTER rg`,+ `ALTER TABLE ${dbName}.performance ADD COLUMN IF NOT EXISTS rgc Nullable(String) AFTER rg`,+]++queriesRunner(queries)diff --git a/backend/migrations/clickhouse/initialise_database.js b/backend/migrations/clickhouse/initialise_database.jsindex 87dba8730..8d3b7bf6d 100644--- a/backend/migrations/clickhouse/initialise_database.js+++ b/backend/migrations/clickhouse/initialise_database.js@@ -25,6 +25,7 @@ const CLICKHOUSE_INIT_QUERIES = [co Nullable(String),cc Nullable(FixedString(2)),rg LowCardinality(Nullable(String)),+ rgc LowCardinality(Nullable(String)),ct Nullable(String),meta Nested(@@ -69,6 +70,7 @@ const CLICKHOUSE_INIT_QUERIES = [co Nullable(String),cc Nullable(FixedString(2)),rg LowCardinality(Nullable(String)),+ rgc LowCardinality(Nullable(String)),ct Nullable(String),meta Nested(@@ -92,6 +94,7 @@ const CLICKHOUSE_INIT_QUERIES = [brv Nullable(String),cc Nullable(FixedString(2)),rg LowCardinality(Nullable(String)),+ rgc LowCardinality(Nullable(String)),ct Nullable(String),dns Nullable(UInt32),tls Nullable(UInt32),@@ -123,6 +126,7 @@ const CLICKHOUSE_INIT_QUERIES = [lc LowCardinality(Nullable(String)),cc LowCardinality(Nullable(FixedString(2))),rg LowCardinality(Nullable(String)),+ rgc LowCardinality(Nullable(String)),ct Nullable(String),name String,message Nullable(String),