salesforceedit

Note

This is a community-maintained plugin! It does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-input-salesforce.

This 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.

Note

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.

Exampleedit

This 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
  }
}

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

salesforce {
    client_id => ...
    client_secret => ...
    password => ...
    security_token => ...
    sfdc_object_name => ...
    username => ...
}

Available configuration options:

Detailsedit

 

add_fieldedit

  • Value type is hash
  • Default value is {}

Add a field to an event

api_versionedit

  • 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_idedit

  • 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_secretedit

  • 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

codecedit

  • 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.

passwordedit

  • 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_tokenedit

  • 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_fieldsedit

  • 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_filtersedit

  • 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_nameedit

  • 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

tagsedit

  • 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.

to_underscoresedit

  • Value type is boolean
  • Default value is false

Setting this to true will convert SFDC’s NamedFieldsc to named_fieldsc

typeedit

  • 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.

use_test_sandboxedit

  • Value type is boolean
  • Default value is false

Set this to true to connect to a sandbox sfdc instance logging in through test.salesforce.com

usernameedit

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

A valid salesforce user name, usually your email address. Used for authentication and will be the user all objects are created or modified by