Splunk for Enterprise Documentation (Salesforce)

1.      Download and install Splunk for Enterprise from the website depending on your system specifications

2.      On installing and choosing Splunk to run as a localhost, open it in the default browser and login using the default credentials.

3.      Click on the “Plus symbol” under Search and Reporting , which is placed under the Apps Tab

4.      Search for Splunk app for Salesforce, and install it.

5.      Open Splunk App for Salesforce. If it’s the first time it’s being opened, you will be prompted with the connection page for salesforce. Fill in the necessary details and save.

6.      Restart splunk (Under Server Controls - http://localhost:8000/en-US/manager/splunk-app-sfdc/control)

7.      Open the application, and go to settings. Click on Data inputs under the Data tab.

8.      (OPTIONAL : enable only if you want splunk to store event logs) Go to “Salesforce Event Log” and enable EventLog. (http://localhost:8000/en-US/manager/splunk-app-sfdc/data/inputs/sfdc_event_log)

9.      Go to “Salesforce Object” and enable the required objects under it. If a new object is needed to be indexed by splunk, it can be registered by clicking the new button and following the required steps. (http://localhost:8000/en-US/manager/splunk-app-sfdc/data/inputs/sfdc_object).

10.  Go to settings and choose “Access Controls”, and choose Roles. (http://localhost:8000/en-US/manager/splunk-app-sfdc/authorization/roles)

11.  Choose the admin role and goto “Indexes searched by Default”.

12.  Default set of indexes : Splunk Enterprise comes with a number of preconfigured indexes, including:

·         main: This is the default Splunk Enterprise index. All processed data is stored here unless otherwise specified.

·         _internal: Stores Splunk Enterprise internal logs and processing metrics.

·         _audit: Contains events related to the file system change monitor, auditing, and all user search history. If enables audit logs will start showing up under search.

·         Fishbucket: For Splunk engineers trying to decipher file input issues. It contains seek pointers and CRCs for the files you are indexing, so splunkd can tell if it has read them already.

·         _introspection: This is intended to collection information about your systems running Splunk and give you more data to help diagnose Splunk performance issues.

Setting up a new salesforce object in Splunk

1.      Select “Salesforce Object” under data inputs in settings for a new entry.

2.      Provide a name for the input.

3.      Paste the SOQL query you want to index. (without order by clause)

4.      Choose the field you want the data to be ordered by.

5.      Select the time you want to start querying data from. Default is 90 days.

6.      Select the number of records you want Splunk to index in each query.

7.      Select the interval you want Splunk to poll. Ex – Every 60 secs

8.      Let the host name and Source Type be the default values.

9.      Choose the destination index to sfdc.

Setting up Alerts for Events

1.      Alerts for an event can be set in Splunk in 4 different ways. (1) It can be just added to triggered alerts. (2) Can be sent in form of emails (3) Can be triggered in the form of running a script. ( Note : The script needs to be saved in the Splunk bin directory under the Scripts Folder) (4) Lastly can be triggered in the form of a web hook.

2.      To set up alerts for email, the Mail server configuration to send the email needs to be set up with the respective SMTP server along with the port details, username and password.

To set up - http://localhost:8000/en-US/manager/splunk-app-sfdc/admin/alert_actions/email?action=edit

3.      On searching for the required events from Splunk, the search can be saved and can be used to alert in a pre-defined timeline for any new events. To save a search as an alert, Click the “Save As” Button and choose Alert.

4.      Give a suitable title to the alert, and choose whether the alert should run at a scheduled time or should run real-time.

5.      Choose the appropriate Trigger Conditions required for your search.

6.      Choose the appropriate trigger actions. Multiple trigger actions is allowed for a single event.

7.      If the fields in the result needs to be sent in the alert, the field keyword needs to be explicitly used in the search formula containing the fields to be sent in the email alert.

The email alert can call this field using the token $result.<fieldname>$

Other email tokens that can used are - http://docs.splunk.com/Documentation/Splunk/6.5.2/Alert/EmailNotificationTokens