IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« redis snmptrap »

› › ›

salesforce

edit

salesforce

edit

This is a community-maintained plugin! It does not ship with Logstash by default, but it is easy to install by running bin/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.

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.

Example

edit

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

Synopsis

edit

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:

Setting	Input type	Required	Default value
`add_field`	hash	No	`{}`
`api_version`	string	No
`client_id`	string	Yes
`client_secret`	string	Yes
`codec`	codec	No	`"plain"`
`password`	string	Yes
`security_token`	string	Yes
`sfdc_fields`	array	No	`[]`
`sfdc_filters`	string	No	`""`
`sfdc_object_name`	string	Yes
`tags`	array	No
`to_underscores`	boolean	No	`false`
`type`	string	No
`use_test_sandbox`	boolean	No	`false`
`username`	string	Yes

Details

edit

`add_field`

edit

Value type is hash
Default value is {}

Add a field to an event

`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

`charset` (DEPRECATED)

edit

DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions. <li> Value type is string
There is no default value for this setting.

The character encoding used in this input. Examples include UTF-8 and cp1252

This setting is useful if your log files are in Latin-1 (aka cp1252) or in another character set other than UTF-8.

This only affects plain format logs since json is UTF-8 already.

`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

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

`debug` (DEPRECATED)

edit

DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
Value type is boolean
Default value is false

`format` (DEPRECATED)

edit

DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
Value can be any of: plain, json, json_event, msgpack_event
There is no default value for this setting.

The format of input data (plain, json, json_event)

`message_format` (DEPRECATED)

edit

DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
Value type is string
There is no default value for this setting.

If format is json, an event sprintf string to build what the display @message should be given (defaults to the raw JSON). sprintf format strings look like %{fieldname}

If format is json_event, ALL fields except for @type are expected to be present. Not receiving all fields will cause unexpected results.

`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

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

`to_underscores`

edit

Value type is boolean
Default value is false

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

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

`use_test_sandbox`

edit

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

`username`

edit

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

« redis snmptrap »

salesforce

salesforce

Example

Synopsis

Details

add_field

api_version

charset (DEPRECATED)

client_id

client_secret

codec

debug (DEPRECATED)

format (DEPRECATED)

message_format (DEPRECATED)

password

security_token

sfdc_fields

sfdc_filters

sfdc_object_name

tags

to_underscores

type

use_test_sandbox

username

`add_field`

`api_version`

`charset` (DEPRECATED)

`client_id`

`client_secret`

`codec`

`debug` (DEPRECATED)

`format` (DEPRECATED)

`message_format` (DEPRECATED)

`password`

`security_token`

`sfdc_fields`

`sfdc_filters`

`sfdc_object_name`

`tags`

`to_underscores`

`type`

`use_test_sandbox`

`username`