Echo: Add config option to prevent duplicate page views for GA4 (#57619)

2022-11-09 15:09:19 +01:00
parent 463f993186
commit 008c554d7f
11 changed files with 77 additions and 56 deletions
@@ -8,27 +8,28 @@ import (
 )

 type IndexViewData struct {
-	User                    *CurrentUser
-	Settings                map[string]interface{}
-	AppUrl                  string
-	AppSubUrl               string
-	GoogleAnalyticsId       string
-	GoogleAnalytics4Id      string
-	GoogleTagManagerId      string
-	NavTree                 *navtree.NavTreeRoot
-	BuildVersion            string
-	BuildCommit             string
-	Theme                   string
-	NewGrafanaVersionExists bool
-	NewGrafanaVersion       string
-	AppName                 string
-	AppNameBodyClass        string
-	FavIcon                 template.URL
-	AppleTouchIcon          template.URL
-	AppTitle                string
-	Sentry                  *setting.Sentry
-	ContentDeliveryURL      string
-	LoadingLogo             template.URL
+	User                                *CurrentUser
+	Settings                            map[string]interface{}
+	AppUrl                              string
+	AppSubUrl                           string
+	GoogleAnalyticsId                   string
+	GoogleAnalytics4Id                  string
+	GoogleAnalytics4SendManualPageViews bool
+	GoogleTagManagerId                  string
+	NavTree                             *navtree.NavTreeRoot
+	BuildVersion                        string
+	BuildCommit                         string
+	Theme                               string
+	NewGrafanaVersionExists             bool
+	NewGrafanaVersion                   string
+	AppName                             string
+	AppNameBodyClass                    string
+	FavIcon                             template.URL
+	AppleTouchIcon                      template.URL
+	AppTitle                            string
+	Sentry                              *setting.Sentry
+	ContentDeliveryURL                  string
+	LoadingLogo                         template.URL
 	// Nonce is a cryptographic identifier for use with Content Security Policy.
 	Nonce string
 }
@@ -124,6 +124,7 @@ func (hs *HTTPServer) getFrontendSettingsMap(c *models.ReqContext) (map[string]i
 		"queryHistoryEnabled":                 hs.Cfg.QueryHistoryEnabled,
 		"googleAnalyticsId":                   setting.GoogleAnalyticsId,
 		"googleAnalytics4Id":                  setting.GoogleAnalytics4Id,
+		"GoogleAnalytics4SendManualPageViews": setting.GoogleAnalytics4SendManualPageViews,
 		"rudderstackWriteKey":                 setting.RudderstackWriteKey,
 		"rudderstackDataPlaneUrl":             setting.RudderstackDataPlaneUrl,
 		"rudderstackSdkUrl":                   setting.RudderstackSdkUrl,
@@ -98,27 +98,28 @@ func (hs *HTTPServer) setIndexViewData(c *models.ReqContext) (*dtos.IndexViewDat
 			HelpFlags1:                 c.HelpFlags1,
 			HasEditPermissionInFolders: hasEditPerm,
 		},
-		Settings:                settings,
-		Theme:                   prefs.Theme,
-		AppUrl:                  appURL,
-		AppSubUrl:               appSubURL,
-		GoogleAnalyticsId:       setting.GoogleAnalyticsId,
-		GoogleAnalytics4Id:      setting.GoogleAnalytics4Id,
-		GoogleTagManagerId:      setting.GoogleTagManagerId,
-		BuildVersion:            setting.BuildVersion,
-		BuildCommit:             setting.BuildCommit,
-		NewGrafanaVersion:       hs.grafanaUpdateChecker.LatestVersion(),
-		NewGrafanaVersionExists: hs.grafanaUpdateChecker.UpdateAvailable(),
-		AppName:                 setting.ApplicationName,
-		AppNameBodyClass:        "app-grafana",
-		FavIcon:                 "public/img/fav32.png",
-		AppleTouchIcon:          "public/img/apple-touch-icon.png",
-		AppTitle:                "Grafana",
-		NavTree:                 navTree,
-		Sentry:                  &hs.Cfg.Sentry,
-		Nonce:                   c.RequestNonce,
-		ContentDeliveryURL:      hs.Cfg.GetContentDeliveryURL(hs.License.ContentDeliveryPrefix()),
-		LoadingLogo:             "public/img/grafana_icon.svg",
+		Settings:                            settings,
+		Theme:                               prefs.Theme,
+		AppUrl:                              appURL,
+		AppSubUrl:                           appSubURL,
+		GoogleAnalyticsId:                   setting.GoogleAnalyticsId,
+		GoogleAnalytics4Id:                  setting.GoogleAnalytics4Id,
+		GoogleAnalytics4SendManualPageViews: setting.GoogleAnalytics4SendManualPageViews,
+		GoogleTagManagerId:                  setting.GoogleTagManagerId,
+		BuildVersion:                        setting.BuildVersion,
+		BuildCommit:                         setting.BuildCommit,
+		NewGrafanaVersion:                   hs.grafanaUpdateChecker.LatestVersion(),
+		NewGrafanaVersionExists:             hs.grafanaUpdateChecker.UpdateAvailable(),
+		AppName:                             setting.ApplicationName,
+		AppNameBodyClass:                    "app-grafana",
+		FavIcon:                             "public/img/fav32.png",
+		AppleTouchIcon:                      "public/img/apple-touch-icon.png",
+		AppTitle:                            "Grafana",
+		NavTree:                             navTree,
+		Sentry:                              &hs.Cfg.Sentry,
+		Nonce:                               c.RequestNonce,
+		ContentDeliveryURL:                  hs.Cfg.GetContentDeliveryURL(hs.License.ContentDeliveryPrefix()),
+		LoadingLogo:                         "public/img/grafana_icon.svg",
 	}

 	if !hs.AccessControl.IsDisabled() {
@@ -137,13 +137,14 @@ var (
 	appliedEnvOverrides          []string

 	// analytics
-	GoogleAnalyticsId       string
-	GoogleAnalytics4Id      string
-	GoogleTagManagerId      string
-	RudderstackDataPlaneUrl string
-	RudderstackWriteKey     string
-	RudderstackSdkUrl       string
-	RudderstackConfigUrl    string
+	GoogleAnalyticsId                   string
+	GoogleAnalytics4Id                  string
+	GoogleAnalytics4SendManualPageViews bool
+	GoogleTagManagerId                  string
+	RudderstackDataPlaneUrl             string
+	RudderstackWriteKey                 string
+	RudderstackSdkUrl                   string
+	RudderstackConfigUrl                string

 	// LDAP
 	LDAPEnabled           bool
@@ -995,6 +996,8 @@ func (cfg *Cfg) Load(args CommandLineArgs) error {
 	cfg.CheckForPluginUpdates = analytics.Key("check_for_plugin_updates").MustBool(true)
 	GoogleAnalyticsId = analytics.Key("google_analytics_ua_id").String()
 	GoogleAnalytics4Id = analytics.Key("google_analytics_4_id").String()
+	GoogleAnalytics4SendManualPageViews = analytics.Key("google_analytics_4_send_manual_page_views").MustBool(false)
+
 	GoogleTagManagerId = analytics.Key("google_tag_manager_id").String()
 	RudderstackWriteKey = analytics.Key("rudderstack_write_key").String()
 	RudderstackDataPlaneUrl = analytics.Key("rudderstack_data_plane_url").String()