Salesforce (im_salesforce)
This module can be used to collect event monitoring data from Salesforce applications. It uses Salesforce Lightning Platform SOAP API and REST API v54 with username-password authorization to retrieve log data.
For the module to connect to the API and access Salesforce logs, you must first set up a Connected App and retrieve its Consumer Key and Consumer Secret.
Configuration
The im_salesforce module accepts the following directives in addition to the common module directives.
Required directives
The following directives are required to authenticate with the REST API.
This mandatory directive specifies the consumer key of your Salesforce Connected App. |
|
This mandatory directive specifies the consumer secret of your Salesforce Connected App. |
|
This mandatory directive specifies the domain of your Salesforce org, e.g., |
|
An optional directive to specify a different domain for OAuth application authorization.
By default, |
|
This mandatory directive specifies the username of your Salesforce org account, e.g., |
|
This mandatory directive specifies the password of your Salesforce org account. |
HTTP(S) directives
The following directives are for configuring HTTP(S) connection settings.
This optional directive can be specified multiple times to add custom headers to each HTTP request. |
|
This optional directive can be used to enable HTTP compression for outgoing HTTP messages.
The possible values are |
|
HTTP basic authorization username. You must also set the HTTPBasicAuthPassword directive to use HTTP authorization. |
|
HTTP basic authorization password. You must also set the HTTPBasicAuthUser directive to use HTTP authorization. |
|
This boolean directive specifies whether the connection should be allowed with an expired certificate.
If set to |
|
This boolean directive specifies that the connection should be allowed without certificate verification.
If set to |
|
This directive specifies a path to a directory containing certificate authority (CA) certificates. These certificates will be used to verify the certificate presented by the remote host. The certificate files must be named using the OpenSSL hashed format, i.e. the hash of the certificate followed by .0, .1 etc. To find the hash of a certificate using OpenSSL:
For example, if the certificate hash is A remote host’s self-signed certificate (which is not signed by a CA) can also be trusted by including a copy of the certificate in this directory. The default operating system root certificate store will be used if this directive is not specified.
Unix-like operating systems commonly store root certificates in |
|
This specifies the path of the certificate authority (CA) certificate that will be used to verify the certificate presented by the remote host. A remote host’s self-signed certificate (which is not signed by a CA) can be trusted by specifying the remote host certificate itself. In the case of certificates signed by an intermediate CA, the certificate specified must contain the complete certificate chain (certificate bundle). |
|
This specifies the path of the certificate file that will be presented to the remote host during the HTTPS handshake. |
|
This specifies the path of the private key file that was used to generate the certificate specified by the HTTPSCertFile directive. This is used for the HTTPS handshake. |
|
This optional directive is used to specify the protocol, IP address (or hostname) and port number of the HTTP or SOCKS proxy server to be used.
The format is |
|
This optional directive sets the reconnect interval in seconds. If it is set, the module attempts to reconnect in every defined second. If it is not set, the reconnect interval will start at 1 second and doubles on every attempt. If the duration of the successful connection is greater than the current reconnect interval, then the reconnect interval will be reset to 1 sec. |
Optional directives
This optional directive specifies the used Salesforce REST API version.
It can be in |
|||||||||||||||||||||||||||||||||||||
This is an optional group directive to include or exclude event types from being collected. If this directive is not specified, the module will collect all events. It has the following sub-directives that can be defined multiple times:
|
|||||||||||||||||||||||||||||||||||||
This optional directive specifies how frequently the module will check for new events in seconds. If this directive is not specified, it defaults to 60 seconds. |
|||||||||||||||||||||||||||||||||||||
This optional boolean directive instructs the module to only read logs that arrive after NXLog Agent is started.
This directive comes into effect if a saved position is not found, for example on the first start, or when the SavePos directive is The following matrix shows the outcome of this directive in conjunction with the SavePos directive:
|
|||||||||||||||||||||||||||||||||||||
If this boolean directive is set to |
|||||||||||||||||||||||||||||||||||||
This optional directive specifies the time in RFC 3339 format of the first event to pull. If this directive is not set, the module reads events according to the ReadFromLast directive. |
Sandbox environment
If a sandbox environment is used, the following configuration changes should be applied:
-
LoginDomain should be
test.salesforce.com
. -
Domain should be changed to
MyDomainName—SandboxName.sandbox.my.salesforce.com
. -
Login should be appended with
.sandbox_name
: for example,user1@acme.com
becomesuser1@acme.com.test
.
Examples
This configuration collects event monitoring logs from a Salesforce organization. im_salesforce receives records from the Salesforce API in CSV format, which it then parses into structured data and writes each record as a list of key-value pairs.
<Input salesforce>
Module im_salesforce
Domain MYACCOUNT.my.salesforce.com
LoginDomain login.salesforce.com
Login USER@email.com
Password USERPASSWORD
ConsumerKey APP_KEY
ConsumerSecret APP_SECRET
<EventFilter>
Accept Login,Logout (1)
Accept OneCommerceUsage
# Exclude Search,SearchClick (2)
# Exclude Sandbox
</EventFilter>
StartFrom 2022-07-19T16:39:57-08:00 (3)
PollInterval 120 (4)
</Input>
1 | The event filter specifies the list of event types to collect in the Accept sub-directives. |
2 | The filter can also be configured to collect all log types except those specified by the Exclude sub-directives. |
3 | The StartFrom directive specifies to start collecting events from the specified date onward. |
4 | The PollInterval directive specifies to check for new events every 120 seconds. The default is 60 seconds. |
The following is a Salesforce event monitoring record after it was processed by NXLog Agent.
2022-07-15 12:03:11 nxlog-server INFO EVENT_TYPE="OneCommerceUsage" TIMESTAMP="20220602110049.842" REQUEST_ID="4jHvZvFIY-2Rl-l1cKNLKV" ORGANIZATION_ID="00D5f000003Hhp1" USER_ID="0055f0000030qMF" RUN_TIME="14443623" CPU_TIME="6876485" SERVICE_NAME="CommerceLicenseUsageMetrics" OPERATION="B2BMetricsCombinationJob" OPERATION_STAGE="combineNumberOfStores" COUNT="0" OPERATION_STATUS="Success" CONTEXT_MAP="{\"cc\":0,\"lb2b\":0}" B2B_EDITION="LB2B" TIMESTAMP_DERIVED="2022-06-02T11:00:49.842Z" USER_ID_DERIVED="0055f0000030qMFAAY"