icon/x Created with Sketch.

Splunk Cookie Policy

We use our own and third-party cookies to provide you with a great online experience. We also use these cookies to improve our products and services, support our marketing campaigns, and advertise to you on our website and other websites. Some cookies may continue to collect information after you have left our website. Learn more (including how to update your settings) here.
Accept Cookie Policy

Accept License Agreements

This app is provided by a third party and your right to use the app is in accordance with the license provided by that third-party licensor. Splunk is not responsible for any third-party apps and does not provide any warranty or support. If you have any questions, complaints or claims with respect to this app, please contact the licensor directly.

Thank You

Downloading Splunk Add-on for SFDC Streaming API
SHA256 checksum (splunk-add-on-for-sfdc-streaming-api_104.tgz) 6c11c4420495c617847a3a684e4d62250ca591ffda1ff738004c4f6d7eea4f60 SHA256 checksum (splunk-add-on-for-sfdc-streaming-api_103.tgz) 60237552fbc58ff98a06ec4e5b36fe4f7fd6ac1fbf54e1f8555ea3ee29ceda91
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate

splunk

Splunk Add-on for SFDC Streaming API

Splunk Cloud
Splunk Labs
This app is NOT supported by Splunk. Please read about what that means for you here.
Overview
Details
The Salesforce Streaming API enables streaming of events using push technology and provides a subscription mechanism for receiving events in near real-time. The Streaming API subscription mechanism supports multiple types of events, including PushTopic events, generic events, platform events, and Change Data Capture events. This add-on helps ingest all the above-mentioned streaming events into Splunk.

Install

Install the add-on on Forwarders and IDM.

(Splunk Cloud Platform deployments on Victoria Experience do not require IDM. If your deployment is on Victoria Experience you can run add-ons that contain scripted and modular inputs directly on the search head. To determine if your deployment has the Classic or Victoria experience, see Determine your Splunk Cloud Platform Experience.

For Splunk Cloud, refer to Install apps in your Splunk Cloud deployment. For customer managed deployments, refer to the standard methods for Splunk Add-on installs as documented for a Single Server Install or a Distributed Environment Install.

Configuration

Salesforce

Setup Connected App and OAuth access

  • Create a connected app and use the consumer key and secret to authenticate the application
    (via SETUP -> Platform Tools → Apps → App Manager -> New Connected App)
  • Enable OAuth access for the application.
  • Setup Callback URL -> https://<sfdc-instance>/services/oauth2/callback
  • Get OAuth Credentials (Consumer Key and Consumer Secret)
  • Add Full Access to Selected OAuth scopes under OAuth Settings for the connected app
  • Enable Real-time streaming objects
  • Splunk add-on for SFDC Streaming API will require SFDC username, password, consumer key and consumer password to create a connection.

NOTE: Security Token
When you access Salesforce from an IP address that isn’t trusted for your company, and you use a desktop client or the API, you need a security token to log in.
What’s a security token? It’s a case-sensitive alphanumeric code that’s tied to your password. Whenever your password is reset, your security token is also reset.

password : \<password> + <security_token>

Another alternative to avoid using the security token, is to relax IP restrictions.

Splunk

  • Install Splunk add-on for SFDC Streaming API
  • Create a connection in the Conntection tab with SFDC username, password, consumer key and consumer password to create a connection. Check the sandbox option if you're connecting to a SFDC sandbox instance (http://test.salesforce.com/services/oauth2/token)
  • Create a data input in the Inputs tab to subscribe to any of the channels Real-time streaming objects. (For instance: To subscribe to the LoginEventStream set channel topic to /event/LoginEventStream)

TroubleShooting

Authorization Failure

ERROR('Authentication failed', {'error': 'invalid_grant', 'error_description': 'authentication failure'})

Check if your creds are correct. You can curl your SFDC instance to validate your credentials.
curl -d 'grant_type=password&client_id=<client_id>&client_secret=<client_secret>&username=<username>&password=<password>' "https://login.salesforce.com/services/oauth2/token"

Additional permissions may be required: Additional setting in the App: Apps -> [select your "Connected App"] -> Edit -> Oauth Policies -> Permitted Users -> All users may self-authorize.

Channel Subscription Failure

ERROR pid=28219 tid=MainThread file=base.py:_send_payload_with_auth:321 | server error response for Channel (/meta/subscribe): '403:denied_by_security_policy:create_denied'

Enable access monitoring for real-time event monitoring - Enable Access to the Real-Time Event Monitoring

Release Notes

Version 1.0.4
Sept. 23, 2021

Adding Sourcetypes and CIM compatibility.

Sourcetypes and CIM Compatibility

sfdc-streaming-api-events: Default sourcetype for all streaming API events

sfdc-streaming-api-events:login: Use this sourcetype for login related events (EG: LoginEventStream, LoginAsEventStream, LogoutEventStream).
This sourcetype maps to the authentication data model

sfdc-streaming-api-events:report: Use this sourcetype for report related events (EG: ReportEventStream).
This sourcetype maps to the data and access data model

sfdc-streaming-api-events:security: Use this sourcetype for security related events (EG: ApiAnomalyEvent, CredentialStuffingEvent, SessionHijackingEvent, ReportAnomalyEvent).
This sourcetype maps to the IDS and attack data model

Version 1.0.3
Sept. 2, 2021
9
Installs
26
Downloads
Share Subscribe LOGIN TO DOWNLOAD

Subscribe Share

Are you a developer?

As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps and add-ons from Splunk, our partners and our community. Find an app or add-on for most any data source and user need, or simply create your own with help from our developer portal.

Follow Us:
Splunk, Splunk>,Turn Data Into Doing, Data-to-Everything, and D2E are trademarks or registered trademarks of Splunk Inc. in the United States and other countries. All other brand names,product names,or trademarks belong to their respective owners.