haihongren/nr-salesforce-event-streaming

New Relic Salesforce事件流集成Docker镜像部署

更多详情请参考https://github.com/newrelic-experimental/nr-salesforce-event-streaming

镜像概述与主要用途

本Docker镜像提供New Relic与Salesforce事件流的集成能力，可将Salesforce平台产生的事件流数据（如登录事件、登出事件、URI访问事件等）实时传输至New Relic平台，实现Salesforce事件的集中监控、分析与告警。

核心功能与特性

• 多事件流支持：可订阅Salesforce多种标准事件流（如LoginEventStream、LogoutEventStream等）
• 灵活认证方式：支持基本用户名密码认证和OAuth2客户端凭证流
• 安全配置：支持密码混淆存储，保护敏感信息
• 代理支持：可选配置网络代理，适应企业网络环境
• 自定义标签：可添加事件标签，便于New Relic中数据分类与筛选
• 自动事件类型创建：在New Relic中自动生成规范化事件类型（如SFLoginEventStream）

使用场景与适用范围

适用于需要监控Salesforce用户活动、系统操作事件的企业IT团队，可帮助：

• 跟踪Salesforce用户登录/登出行为
• 分析URI访问模式与系统使用情况
• 实时监控Salesforce事件并结合New Relic进行告警与性能分析
• 满足合规审计需求，记录关键操作事件

使用方法与配置说明

1. 配置环境变量文件

创建envfile.txt文件，配置以下环境变量：

### 启用环境变量配置
NR_SF_ENV_CONF=true

### New Relic连接信息（必填）
NR_SF_INSIGHTS_URL=https://insights-collector.newrelic.com/v1/accounts/<你的New Relic RPM ID>/events
NR_SF_INSIGHTS_INSERT_KEY=<你的New Relic插入密钥>

### Salesforce连接信息（必填）
NR_SF_URL=https://<你的Salesforce实例>.my.salesforce.com
NR_SF_TOPICS=/event/LoginEventStream,/event/LogoutEventStream,/event/LightningUriEventStream,/event/UriEventStream

### 基本用户名密码认证（二选一）
NR_SF_USERNAME=<你的Salesforce登录ID>
### 推荐使用混淆密码（优先）或明文密码（测试用）
NR_SF_PASSWORD_OBFUSCATED=<你的混淆密码>
#NR_SF_PASSWORD=<明文密码> 

### OAuth2客户端凭证流（二选一，与基本认证互斥）
#NR_SF_CLIENT_ID=<你的客户端ID>
#NR_SF_CLIENT_SECRET=<你的客户端密钥>
#参考：https://help.salesforce.com/s/articleView?id=sf.connected_app_client_credentials_setup.htm&type=5

### 密码混淆密钥（必填，用于生成混淆密码）
NEW_RELIC_CONFIG_OBSCURING_KEY=<你的密码混淆密钥>

### 如何生成NR_SF_PASSWORD_OBFUSCATED #####
# 使用命令：newrelic agent config obfuscate --key '<你的混淆密钥>' --value '<你的Salesforce密码>'
###################################################

### 代理配置（可选）
# NR_SF_PROXY_HOST: <你的网络代理主机>
# NR_SF_PROXY_PORT: <你的网络代理端口>
# NR_SF_PROXY_USER: <你的网络代理用户名>
#### 推荐使用混淆代理密码（优先）或明文代理密码（测试用）
# NR_SF_PROXY_PASSWORD_OBFUSCATED: <你的混淆代理密码>
# NR_SF_PROXY_PASSWORD: <你的明文代理密码>

### 事件标签（可选）
NR_SF_LABELS=source=NR_Salesforce_Event_Streaming,env=production

2. 启动Docker容器

使用以下命令启动容器：

bash
docker run --env-file envfile.txt -d docker.xuanyuan.run/haihongren/nr-salesforce-event-streaming:1.1.2

3. 验证部署状态

3.1 检查容器日志

通过容器ID查看日志，确认集成是否成功连接并订阅事件流：

bash
docker logs <容器ID>

成功订阅会显示类似以下日志：

23:42:18 INFO ==>subscribed: https://<你的SF实例>.my.salesforce.comSubscription [/event/LoginEventStream:-1]
23:42:19 INFO ==>subscribed: https://<你的SF实例>.my.salesforce.comSubscription [/event/LogoutEventStream:-1]
23:42:21 INFO ==>subscribed: https://<你的SF实例>.my.salesforce.comSubscription [/event/LightningUriEventStream:-1]
23:42:22 INFO ==>subscribed: https://<你的SF实例>.my.salesforce.comSubscription [/event/UriEventStream:-1]

3.2 在New Relic中查看事件类型

集成会自动创建以SF+<事件流名称>命名的事件类型。使用默认配置时，将创建以下事件类型：

• SFLoginEventStream
• SFLogoutEventStream
• SFLightningUriEventStream
• SFUriEventStream

可在New Relic Insights中通过这些事件类型查询和分析数据。