服务器端无服务器网站分析工具——serverless-website-analytics使用指南

服务器端无服务器网站分析工具——serverless-website-analytics使用指南

serverless-website-analyticsA CDK construct that consists of a serverless backend, frontend and client side code to track website analytics项目地址:https://gitcode.com/gh_mirrors/se/serverless-website-analytics

---

项目介绍

serverless-website-analytics 是一个基于 AWS Cloud Development Kit (CDK) 的开源构建，专为实现隐私保护、成本高效的网站数据分析设计。它集成了服务器端、前端以及数据摄入API，适用于小型到中型网站，特别适合那些每日访问量在千万以下的站点。该方案注重简单性与低成本运营，实现了“按需扩展至零”的目标，允许用户仅为其使用的AWS服务付费。

项目快速启动

环境准备

确保你的开发环境已安装了 Node.js 和 NPM。此外，需要 AWS CLI 配置好了有效凭证，并且你的 AWS 账户支持 CDK 所需的服务。

安装依赖

首先，在你的项目目录下，通过npm安装serverless-website-analytics构造库：

npm install serverless-website-analytics

集成到CDK项目

在CDK项目中导入并配置该构造：

import { Stack, Construct } from 'cdk-lib';
import { ServerlessWebsiteAnalytics } from 'serverless-website-analytics';

export class YourAppStack extends Stack {
    constructor(scope: Construct, id: string, props?: StackProps) {
        super(scope, id, props);
        
        // 初始化并配置Serverless Website Analytics
        new ServerlessWebsiteAnalytics(this, 'MyWebAnalytic', {
            environment: 'prod',
            awsEnv: {
                account: this.account,
                region: this.region,
            },
            sites: ['yourwebsite.com'],
            allowedOrigins: ['*'],
            auth: {
                cognito: {
                    loginSubDomain: 'login',
                    users: [{ name: 'UserFullname', email: 'user@example.com' }],
                },
            },
            // 可选：自定义域名配置
            domain: {
                name: 'your-custom-domain.com'
            }
        });
    }
}

完成上述步骤后，即可部署你的CDK堆栈，从而在AWS上搭建起网站分析的基础架构。

前端集成

接着，在前端项目中安装客户端库：

npm install serverless-website-analytics-client

初始化客户端并跟踪页面视图（假设使用的是React）：

import * as swaClient from 'serverless-website-analytics-client';

// 在应用程序启动时初始化
function App() {
    useEffect(() => {
        swaClient.analyticsPageInit('yourwebsite.com', 'https://your-backend-api-url');
    }, []);

    // 每当路由改变时调用
    const handleRouteChange = (newPageName) => {
        swaClient.analyticsPageChange(newPageName);
    };

    return (
        // ...你的应用程序组件...
    );
}

export default App;

应用案例与最佳实践

• 隐私保护: 利用Cognito进行用户认证，保障数据收集过程符合隐私法规。
• 多站点管理: 单一实例可支持多个站点的分析，便于统一管理。
• 低成本监控: 通过合理的AWS服务选择和配置，保持分析成本最低。

最佳实践包括限制访问源以增加安全性，定期审查数据使用情况来优化费用，并对重要页面变化实施特别跟踪。

典型生态项目结合

虽然该项目本身是独立的，但在实际应用中可以与其他AWS服务如CloudFront、Lambda或Amplify紧密结合，增强动态内容的处理能力，提高用户体验。通过集成Amplify库，开发者能在现代web应用中轻松实现登录认证与数据上报，进一步提升网站的互动性和分析深度。

---

本指南提供了一个基本框架，帮助您快速理解和启动serverless-website-analytics项目。实际部署过程中，依据您的具体需求调整配置参数，并确保前端与后端的良好对接，以达到最佳的分析效果。

serverless-website-analyticsA CDK construct that consists of a serverless backend, frontend and client side code to track website analytics项目地址:https://gitcode.com/gh_mirrors/se/serverless-website-analytics