paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 15 Packages Projects Releases Wiki Activity

Add Google Analytics

Browse Source 
Specity a Google Analytics Tracking ID in the `app-config.yaml` to
enable Google Analytics tracking.

```
app:
  title:
  baseUrl:
  googleAnalyticsTrackingId: UA-000000-0
```

If the `googleAnalyticsTrackingId` is not supplied, no tracking script
is added to the application and no tracking can occur.

Includes Helm chart changes to allow overriding the GA Tracking ID.
This commit is contained in:
David Tuite
2020-10-16 13:39:15 +01:00
parent 14f9daf942
commit 71de0d8aee
5 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app-config.yaml
+1
View File
@@ -1,6 +1,7 @@
app:
title: Backstage Example App
baseUrl: http://localhost:7000
googleAnalyticsTrackingId: # UA-000000-0
backend:
baseUrl: http://localhost:7000
contrib/chart/backstage/templates/backstage-app-config.yaml
+1
View File
@@ -13,6 +13,7 @@ metadata:
data:
APP_CONFIG_app_baseUrl: {{ .Values.appConfig.app.baseUrl | quote | quote }}
APP_CONFIG_app_title: {{ .Values.appConfig.app.title | quote | quote }}
APP_CONFIG_app_googleAnalyticsTrackingId: {{ .Values.appConfig.app.googleAnalyticsTrackingId | quote | quote }}
APP_CONFIG_backend_baseUrl: {{ .Values.appConfig.backend.baseUrl | quote | quote }}
APP_CONFIG_backend_cors_origin: {{ .Values.appConfig.backend.cors.origin | quote | quote }}
APP_CONFIG_techdocs_storageUrl: {{ .Values.appConfig.techdocs.storageUrl | quote | quote }}
contrib/chart/backstage/values.yaml
+1
View File
@@ -86,6 +86,7 @@ appConfig:
app:
baseUrl: https://demo.example.com
title: Backstage
googleAnalyticsTrackingId:
backend:
baseUrl: https://demo.example.com
listen:
packages/app/public/index.html
+17
View File
@@ -48,6 +48,23 @@
}
</style>
<title><%= app.title %></title>
<% if (app.googleAnalyticsTrackingId && typeof app.googleAnalyticsTrackingId
=== 'string') { %>
<script
async
src="https://www.googletagmanager.com/gtag/js?id=<%= app.googleAnalyticsTrackingId %>"
></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() {
dataLayer.push(arguments);
}
gtag('js', new Date());
gtag('config', '<%= app.googleAnalyticsTrackingId %>');
</script>
<% } %>
</head>
<body style="margin: 0;">
<noscript>You need to enable JavaScript to run this app.</noscript>
packages/cli/src/lib/bundler/config.ts
+3
View File
@@ -111,6 +111,9 @@ export async function createConfig(
app: {
title: options.config.getString('app.title'),
baseUrl: validBaseUrl.href,
googleAnalyticsTrackingId: options.config.getOptionalString(
'app.googleAnalyticsTrackingId',
),
},
},
}),