Overview

Details

** This app requires a paid license. Please contact sales@ftsc.com for information. **

Salesforce B2C Commerce includes several different types of log files, including system logs, custom logs, import and export logs, a quota log, security logs, and batch processing logs. The Salesforce Commerce Cloud Add-on for Splunk provides the ability to collect logs from B2C WebDAV locations.

TA-SFCC

Salesforce Commerce Cloud Add-on for Splunk

Description

The Salesforce Commerce Cloud Add-on for Splunk collects various log types from Salesforce Commerce Cloud (formerly Demandware).

Log Types
- Analytics Engine
- API Logs
- Console Logs
- Custom Debug Logs
- Custom Error Logs
- Custom Fatal Logs
- Custom Info Logs
- Custom Logs
- Custom Warn Logs
- Data Replication Logs
- DBInit SQL Logs
- Debug Logs
- Deprecation Logs
- Error Logs
- Fatal Logs
- Import Inventory Logs
- Import Pricebook Logs
- Info Logs
- Jobs Logs
- Migration Logs
- Performance Logs
- Quota Logs
- Security Logs
- Service Logs
- SQL Logs
- Staging Logs
- Sysevent Logs
- Syslog Logs
- Warn Logs

Platform and hardware requirements

This topic discusses the underlying requirements for the Salesforce Commerce Cloud Add-on for Splunk.

Hardware and Operating System requirements

The Salesforce Commerce Cloud Add-on for Splunk has memory, CPU, and disk requirements that meet standard hardware requirements for the core Splunk Enterprise platform. Deploy hardware that meets or exceeds these hardware requirements.

For additional details about Splunk Enterprise system requirements, see "System requirements" in the core Splunk Enterprise documentation.
For information about estimating hardware requirements for a Splunk deployment, see "Introduction to capacity planning for Splunk Enterprise" in the Capacity Planning Manual.

Operating system requirements

You can install the add-on on Splunk Enterprise instances that run a supported operating system. See the list of supported Windows and *nix operating systems.

What versions of Splunk Enterprise does the app support?

Salesforce Commerce Cloud Add-on for Splunk supports Splunk Enterprise versions 8.x (python3)

Distributed Installation

This table provides a quick reference for installing this app onto a distributed deployment of Splunk Enterprise.

Salesforce Commerce Cloud Add-on for Splunk

Splunk Instance Type	Supported	Required
Search Heads	Yes	No
Indexers	No	No
Heavy Forwarders	Yes	Yes
Universal Forwarders	No	No

Setup and Initial Configuration

Configuration -> Add-on Settings
- Ensure that the Local State Directory exists and is writable
Configuration -> Account -> Add
Choose a name for the account and enter the account Username and Password
Click Add
Under Inputs -> Create New Input, select the type of log to collect
- SFCC OOTB Logs
- Select the log type from the list
- Name the input
- Select a collection interval in seconds (i.e. 60)
- Select the index to collect logs
- Select the Account to use for authentication
- Fill in the SFCC B2C Commerce instance name
- Edit the log directory, if necessary
- Edit the provided regular expression, if necessary (the default should work)
- Select SSL certificate verification, if needed
- Select "Set State Only?" to collect the current state information without forwarding or ingesting logs into Splunk
- Click Add
- Custom Logs
  - Choose "Custom Log"
  - Name the input
  - Select a collection interval in seconds (i.e. 60)
  - Select the index to collect logs
  - Select the Account to use for authentication
  - Fill in the SFCC B2C Commerce instance name
  - Edit the log directory, if necessary
  - Using the provided regular expression convention, fill out the log file pattern (i.e. ^custom-logname-.*)
  - Select SSL certificate verification, if needed
  - Select "Set State Only?" to collect the current state information without forwarding or ingesting logs into Splunk
  - Click Add

Inputs and Log Sources

Input Name	Description
Analytics Engine	B2C Commerce analytics
API Logs	API Problems
Console Logs	Internal console log entries
Custom Debug Logs	Debug messages in custom jobs, imports, payment or code
Custom Error Logs	Errors in custom jobs, imports, payment or code
Custom Fatal Logs	Fatal errors in custom jobs, imports, payment or code
Custom Info Logs	Informational logs in in custom jobs, imports, payment or code
Custom Logs	Custom errors
Custom Warn Logs	Warn messages in custom jobs, imports, payment or code
Data Replication Logs	Data Replication Logs
DBInit SQL Logs	SQL used during dbinit.
Debug Logs	Debug information
Deprecation Logs	Deprecated APIs
Error Logs	Errors in B2C Commerce scripts, templates, code and other areas
Fatal Logs	Fatal errors in B2C Commerce scripts, templates, code and other areas
Import Inventory Logs	Inventory Import
Import Pricebook Logs	Price Book Import
Info Logs	Information logs reported on B2C Commerce scripts, templates, code and other areas
Jobs Logs	Shows job status information
Migration Logs	Internal migration data
Performance Logs	Internal performance data
Quota Logs	B2C Commerce quota details
Security Logs	Security logs
Service Logs	Service Logs
SQL Logs	SQL replication issues
Staging Logs	B2C Commerce data and code replication processes
Sysevent Logs	Appserver registration and cartridge-related logs
Syslog Logs	API processing, data staging, and error handling
Warn Logs	Lock status reports, slot warnings and warnings for servlets

Release Notes

Version 3.0.2

June 24, 2023

Updated Splunk Python SDK packages:

certifi-2023.5.7
charset_normalizer-3.1.0
defusedxml-0.7.1
idna-3.4
requests-2.31.0
solnlib-4.11.2
sortedcontainers-2.4.0
splunk_sdk-1.7.3
urllib3-1.26.16

Python2 support removed

Version 2.4.2

May 19, 2023

Updated Splunk Python SDK to 1.7.3

Version 2.4.1

March 5, 2022

Update to conform to AppInspect Cloud requirements

Version 2.3.8

Feb. 24, 2022

More linting
More debugging

Version 2.3.7

Feb. 17, 2022

203

Downloads

Share Subscribe

Version

Built by

Fulcrum Technology Solutions, LLC , an official Splunk Partner

Support

Developer Supported

Contact Developer Questions on Splunk Answers Flag as inappropriate

App Contents: Inputs