Salesforce input plugin
editSalesforce input plugin
edit- Plugin version: v3.0.7
- Released on: 2021-02-04
- Changelog
For other versions, see the Versioned plugin docs.
Installation
editFor plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-input-salesforce
. See Working with plugins for more details.
Getting Help
editFor questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
Description
editThis Logstash input plugin allows you to query Salesforce using SOQL and puts the results into Logstash, one row per event. You can configure it to pull entire sObjects or only specific fields.
This input plugin will stop after all the results of the query are processed and will need to be re-run to fetch new results. It does not utilize the streaming API.
In order to use this plugin, you will need to create a new SFDC Application using oauth. More details can be found here: https://help.salesforce.com/apex/HTViewHelpDoc?id=connected_app_create.htm
You will also need a username, password, and security token for your salesforce instance. More details for generating a token can be found here: https://help.salesforce.com/apex/HTViewHelpDoc?id=user_security_token.htm
In addition to specifying an sObject, you can also supply a list of API fields that will be used in the SOQL query.
HTTP proxy
editIf your infrastructure uses a HTTP proxy, you can set the SALESFORCE_PROXY_URI
environment variable with the desired URI value (e.g export SALESFORCE_PROXY_URI="http://proxy.example.com:123"
).
Example
editThis example prints all the Salesforce Opportunities to standard out
input { salesforce { client_id => 'OAUTH CLIENT ID FROM YOUR SFDC APP' client_secret => 'OAUTH CLIENT SECRET FROM YOUR SFDC APP' username => 'email@example.com' password => 'super-secret' security_token => 'SECURITY TOKEN FOR THIS USER' sfdc_object_name => 'Opportunity' } } output { stdout { codec => rubydebug } }
Salesforce Input Configuration Options
editThis plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
No |
||
Yes |
||
Yes |
||
Yes |
||
Yes |
||
No |
||
No |
||
Yes |
||
No |
||
No |
||
Yes |
Also see Common Options for a list of options supported by all input plugins.
api_version
edit- Value type is string
- There is no default value for this setting.
By default, this uses the default Restforce API version. To override this, set this to something like "32.0" for example
client_id
edit- This is a required setting.
- Value type is string
- There is no default value for this setting.
Consumer Key for authentication. You must set up a new SFDC connected app with oath to use this output. More information can be found here: https://help.salesforce.com/apex/HTViewHelpDoc?id=connected_app_create.htm
client_secret
edit- This is a required setting.
- Value type is string
- There is no default value for this setting.
Consumer Secret from your oauth enabled connected app
password
edit- This is a required setting.
- Value type is string
- There is no default value for this setting.
The password used to login to sfdc
security_token
edit- This is a required setting.
- Value type is string
- There is no default value for this setting.
The security token for this account. For more information about generting a security token, see: https://help.salesforce.com/apex/HTViewHelpDoc?id=user_security_token.htm
sfdc_fields
edit- Value type is array
-
Default value is
[]
These are the field names to return in the Salesforce query If this is empty, all fields are returned.
sfdc_filters
edit- Value type is string
-
Default value is
""
These options will be added to the WHERE clause in the SOQL statement. Additional fields can be filtered on by adding field1 = value1 AND field2 = value2 AND…
sfdc_object_name
edit- This is a required setting.
- Value type is string
- There is no default value for this setting.
The name of the salesforce object you are creating or updating
to_underscores
edit- Value type is boolean
-
Default value is
false
Setting this to true will convert SFDC’s NamedFieldsc to named_fieldsc
Common Options
editThe following configuration options are supported by all input plugins:
Details
edit
codec
edit- Value type is codec
-
Default value is
"plain"
The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.
enable_metric
edit- Value type is boolean
-
Default value is
true
Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.
id
edit- Value type is string
- There is no default value for this setting.
Add a unique ID
to the plugin configuration. If no ID is specified, Logstash will generate one.
It is strongly recommended to set this ID in your configuration. This is particularly useful
when you have two or more plugins of the same type, for example, if you have 2 salesforce inputs.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
input { salesforce { id => "my_plugin_id" } }
Variable substitution in the id
field only supports environment variables
and does not support the use of values from the secret store.
tags
edit- Value type is array
- There is no default value for this setting.
Add any number of arbitrary tags to your event.
This can help with processing later.
type
edit- Value type is string
- There is no default value for this setting.
Add a type
field to all events handled by this input.
Types are used mainly for filter activation.
The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.
If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.