feat: add Amplitude API key to Docker entrypoint script (#29477)

Co-authored-by: CodingOnStar <hanxujiang@dify.ai>

docker/docker-compose-template.yaml

@@ -136,6 +136,7 @@ services:
     environment:
       CONSOLE_API_URL: ${CONSOLE_API_URL:-}
       APP_API_URL: ${APP_API_URL:-}
+      AMPLITUDE_API_KEY: ${AMPLITUDE_API_KEY:-}
       NEXT_PUBLIC_COOKIE_DOMAIN: ${NEXT_PUBLIC_COOKIE_DOMAIN:-}
       SENTRY_DSN: ${WEB_SENTRY_DSN:-}
       NEXT_TELEMETRY_DISABLED: ${NEXT_TELEMETRY_DISABLED:-0}

docker/docker-compose.yaml

@@ -773,6 +773,7 @@ services:
     environment:
       CONSOLE_API_URL: ${CONSOLE_API_URL:-}
       APP_API_URL: ${APP_API_URL:-}
+      AMPLITUDE_API_KEY: ${AMPLITUDE_API_KEY:-}
       NEXT_PUBLIC_COOKIE_DOMAIN: ${NEXT_PUBLIC_COOKIE_DOMAIN:-}
       SENTRY_DSN: ${WEB_SENTRY_DSN:-}
       NEXT_TELEMETRY_DISABLED: ${NEXT_TELEMETRY_DISABLED:-0}

web/.env.example

@@ -70,3 +70,6 @@ NEXT_PUBLIC_ENABLE_SINGLE_DOLLAR_LATEX=false
 
 # The maximum number of tree node depth for workflow
 NEXT_PUBLIC_MAX_TREE_DEPTH=50
+
+# The api key of amplitude
+NEXT_PUBLIC_AMPLITUDE_API_KEY=

web/app/components/base/amplitude/AmplitudeProvider.tsx

@@ -11,13 +11,19 @@ export type IAmplitudeProps = {
   sessionReplaySampleRate?: number
 }
 
+// Check if Amplitude should be enabled
+export const isAmplitudeEnabled = () => {
+  const apiKey = process.env.NEXT_PUBLIC_AMPLITUDE_API_KEY
+  return IS_CLOUD_EDITION && !!apiKey
+}
+
 const AmplitudeProvider: FC<IAmplitudeProps> = ({
   apiKey = process.env.NEXT_PUBLIC_AMPLITUDE_API_KEY ?? '',
   sessionReplaySampleRate = 1,
 }) => {
   useEffect(() => {
-    // Only enable in Saas edition
+    // Only enable in Saas edition with valid API key
-    if (!IS_CLOUD_EDITION)
+    if (!isAmplitudeEnabled())
       return
 
     // Initialize Amplitude

web/app/components/base/amplitude/index.ts

@@ -1,2 +1,2 @@
-export { default } from './AmplitudeProvider'
+export { default, isAmplitudeEnabled } from './AmplitudeProvider'
 export { resetUser, setUserId, setUserProperties, trackEvent } from './utils'

web/app/components/base/amplitude/utils.ts

@@ -1,4 +1,5 @@
 import * as amplitude from '@amplitude/analytics-browser'
+import { isAmplitudeEnabled } from './AmplitudeProvider'
 
 /**
  * Track custom event
@@ -6,6 +7,8 @@ import * as amplitude from '@amplitude/analytics-browser'
  * @param eventProperties Event properties (optional)
  */
 export const trackEvent = (eventName: string, eventProperties?: Record<string, any>) => {
+  if (!isAmplitudeEnabled())
+    return
   amplitude.track(eventName, eventProperties)
 }
 
@@ -14,6 +17,8 @@ export const trackEvent = (eventName: string, eventProperties?: Record<string, a
  * @param userId User ID
  */
 export const setUserId = (userId: string) => {
+  if (!isAmplitudeEnabled())
+    return
   amplitude.setUserId(userId)
 }
 
@@ -22,6 +27,8 @@ export const setUserId = (userId: string) => {
  * @param properties User properties
  */
 export const setUserProperties = (properties: Record<string, any>) => {
+  if (!isAmplitudeEnabled())
+    return
   const identifyEvent = new amplitude.Identify()
   Object.entries(properties).forEach(([key, value]) => {
     identifyEvent.set(key, value)
@@ -33,5 +40,7 @@ export const setUserProperties = (properties: Record<string, any>) => {
  * Reset user (e.g., when user logs out)
  */
 export const resetUser = () => {
+  if (!isAmplitudeEnabled())
+    return
   amplitude.reset()
 }

web/docker/entrypoint.sh

@@ -25,6 +25,8 @@ export NEXT_PUBLIC_SENTRY_DSN=${SENTRY_DSN}
 export NEXT_PUBLIC_SITE_ABOUT=${SITE_ABOUT}
 export NEXT_TELEMETRY_DISABLED=${NEXT_TELEMETRY_DISABLED}
 
+export NEXT_PUBLIC_AMPLITUDE_API_KEY=${AMPLITUDE_API_KEY}
+
 export NEXT_PUBLIC_TEXT_GENERATION_TIMEOUT_MS=${TEXT_GENERATION_TIMEOUT_MS}
 export NEXT_PUBLIC_CSP_WHITELIST=${CSP_WHITELIST}
 export NEXT_PUBLIC_ALLOW_EMBED=${ALLOW_EMBED}