This integration subscribes to and replays SalesForce streaming events using EMP Connector. The event will be transformed and ingested into New Relic Insight.
Refer to the following links for more details.
- Basic username and password
- OAuth 2.0 Client Credentials Flow
### Use env variables for configuration
NR_SF_ENV_CONF=true
### New Relic connection info
NR_SF_INSIGHTS_URL=https://insights-collector.newrelic.com/v1/accounts/<YOUR New Relic RPM ID>/events
NR_SF_INSIGHTS_INSERT_KEY=<YOUR New Relic Insert Key>
### Salesforce connection info
NR_SF_URL=https://<YOUR Salesforce instance>.my.salesforce.com
NR_SF_TOPICS=/event/LoginEventStream,/event/LogoutEventStream,/event/LightningUriEventStream,/event/UriEventStream
###Authentication####
###option 1: basic username and password
NR_SF_USERNAME=<YOUR Salesforce login id>
### Use NR_SF_PASSWORD_OBFUSCATED(preferred) or NR_SF_PASSWORD (for testing)
NR_SF_PASSWORD_OBFUSCATED=<YOUR obfuscated password>
#NR_SF_PASSWORD=<Clear password>
###option2: Salesforce OAuth2 Client Credentials Flow
NR_SF_CLIENT_ID=<YOUR APP CLIENT ID>
NR_SF_CLIENT_SECRET=<YOUR APP CLIENT SECRET>
###Instructions on how to setup Oauth2 Client Credentials Flow
###https://help.salesforce.com/s/articleView?id=sf.connected_app_client_credentials_setup.htm&type=5
### Password obfuscation key
NEW_RELIC_CONFIG_OBSCURING_KEY=<YOUR Password Obfuscation Key>
### how to generate NR_SF_PASSWORD_OBFUSCATED #####
# newrelic agent config obfuscate --key '<your obfuscation key>' --value '<YOUR Salesforce password>'
###################################################
### Proxy configuration(optional)
# NR_SF_PROXY_HOST: <YOUR network proxy host>
# NR_SF_PROXY_PORT: <YOUR network proxy port>
# NR_SF_PROXY_USER: <YOUR network proxy user>
####Use NR_SF_PROXY_PASSWORD_OBFUSCATED(preferred) or NR_SF_PROXY_PASSWORD (for testing)
# NR_SF_PROXY_PASSWORD_OBFUSCATED: <YOUR network obfuscated password>
# NR_SF_PROXY_PASSWORD: <YOUR network obfuscated password>
### labels (optional)
NR_SF_LABELS=source=NR_Salesforce_Event_Streaming,env=production
docker run --env-file envfile.txt -d haihongren/nr-salesforce-event-streaming:1.1.1
docker logs <container id>
Look for ... INFO ==>subscribed: .... message to confirm the integration is able to connect and subscribe to the topics successfully.
23:42:18 INFO ==>subscribed: https://<YOUR SF Instance>.my.salesforce.comSubscription [/event/LoginEventStream:-1]
23:42:19 INFO ==>subscribed: https://<YOUR SF Instance>.my.salesforce.comSubscription [/event/LogoutEventStream:-1]
23:42:21 INFO ==>subscribed: https://<YOUR SF Instance>.my.salesforce.comSubscription [/event/LightningUriEventStream:-1]
23:42:22 INFO ==>subscribed: https://<YOUR SF Instance>.my.salesforce.comSubscription [/event/UriEventStream:-1]
The integation creates new event type using SF+<Topic Name> for the event type name.
With the default topic setting(NR_SF_TOPICS), the following new event types will be created.
SFLoginEventStream
SFLogoutEventStream
SFLightningUriEventStream
SFUriEventStream
- JRE 1.8+
- New Relic Information
- account ID and Insight insert key
- SalesForce Information
- login username, password and security token for the username
- Topic Channel
- Network Information
- Proxy username and password (if required)
Download and unzip the package nri-empcon-*.tar.gz to an existing directory
# mkdir -p /app/nri-empcon
# cd /app/nri-empcon
# tar xvfz nri-empcon-<VERSION>.tar.gz
Configure the following setting in config/empcon-config.yml
-
New Relic Insight Information
- insights_url
- insights_insert_key
-
SalesForce Connection Information
(Multi instances are supported, see the sample empcon-config.yml for reference)
- url
Your Salesforce instance URL - username and password
username - your SalesForce ''
password - your SalesForce '' - channel
The SalesForce topic to be subscribed to - replayfrom
-1replay event from the tip (new event)-2replay event from the earliest (in last 24 hours)
- any additional labels/attributes (optional)
- eventtype
The New Relic Insight event type of your choice for this instance
- url
-
Network Proxy (if required)
- proxy_host
- proxy_user
- proxy_password
-
Password obfuscatoin is supported for
proxy_passwordandpassword- use
proxy_password_obfuscatedandpassword_obfuscatedin place ofproxy_passwordandpasswordin the config file
- use
-
Use the following command line utility to generate obfucated value for the above password
# newrelic agent config obfuscate --key '<your obfucation key>' --value '<the password>'The documentation and download instruction for the command utility are available at below link:
Commandline utility -
Update the values for
proxy_password_obfuscatedandpassword_obfuscatedin the config file -
Update nri-empcon.sh with 'your obfucation key'
export NEW_RELIC_CONFIG_OBSCURING_KEY="<your obfucation key>"#cd /app/nri-empcon
#./nri-empcon.sh start
#./nri-empcon.sh status (check the status, make sure it is running)
#cd /app/nri-empcon
#./nri-empcon.sh stop
#cd /app/nri-empcon
#./nri-empcon.sh status
- logs/plugin.log
- logs/plugin.err
- Look for
c.n.fit.empcon.MonitoringConsumer - ==>subscribed:in the logs/plugin.log file. If found, it indicates the integration has successfully subscribed to the channel. If you have multiple instances defined in the configue file, you should expect multiplec.n.fit.empcon.MonitoringConsumer - ==>subscribed:message in the log file. - If
c.n.fit.empcon.MonitoringConsumer - ==>subscribed:cannot be found in the log file, check logs/plugin.err for detail why the integration is unable to subscrsibe to the channel defined.
- Clone the repo
- Build
./gradlew clean build
Sample empcon-config.yml
integration_name: com.newrelic.empcon
insights_url: https://insights-collector.newrelic.com/v1/accounts/<New Relic account ID>/events
insights_insert_key: <New Relic Insight insert key>
proxy_host: abc123.compute.amazonaws.com
proxy_port: 3128
proxy_user: squid
proxy_password: abc123
instances:
- name: empcon-salesforce-hh1
eventtype: empevent1
connectioninfo:
url: https://myabc123-dev-ed.my.salesforce.com
username: [email protected]
password: <password><security token>
channel: /topic/InvoiceStatementUpdates
replayfrom: -1
labels:
env: production1
role: empRole1
- name: empcon-salesforce-hh2
eventtype: empevent2
connectioninfo:
url: https://myxyz123-dev-ed.my.salesforce.com
username: [email protected]
password: <password><security token>
channel: <your topic channel>
replayfrom: -1
labels:
env: production2
role: stock2Sample empcon-config.yml with password obfucation
integration_name: com.newrelic.empcon
insights_url: https://insights-collector.newrelic.com/v1/accounts/<New Relic account ID>/events
insights_insert_key: <New Relic Insight insert key>
proxy_host: abc123.compute.amazonaws.com
proxy_port: 3128
proxy_user: squid
proxy_password_obfuscated: <obfuscated password>
instances:
- name: empcon-salesforce-hh1
eventtype: empevent1
connectioninfo:
url: https://myabc123-dev-ed.my.salesforce.com
username: [email protected]
password_obfuscated: <obfuscated password>
channel: /topic/InvoiceStatementUpdates
replayfrom: -1
labels:
env: production1
role: empRole1Sample SalesForce event
{
"event": {
"createdDate": "2021-01-22T01:40:40.736Z",
"replayId": 196,
"type": "updated"
},
"sobject": {
"Description__c": "new lead",
"Id": "a005g000001WGfMAAW",
"Status__c": "Open",
"Name": "INV-0002"
}
}Sample New Relic Insight Event
{
"event": {
"channel": "/topic/InvoiceStatementUpdates",
"env": "production1",
"event_createdDate": "2021-01-22T01:40:40.736Z",
"event_replayId": "196",
"event_type": "updated",
"replayfrom": -1,
"role": "empRole1",
"sobject_Description__c": "new lead",
"sobject_Id": "a005g000001WGfMAAW",
"sobject_Name": "INV-0002",
"sobject_Status__c": "Open",
"timestamp": 1611279642248,
"url": "https://myabc123-dev-ed.my.salesforce.com",
"username": "[email protected]"
}
}We encourage your contributions to improve [Project Name]! Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project. If you have any questions, or to execute our corporate CLA, required if your contribution is on behalf of a company, please drop us an email at [email protected].
A note about vulnerabilities
As noted in our security policy, New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.
If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through HackerOne.
nr-salesforce-event-streaming is licensed under the Apache 2.0 License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent