Skip to content

feat: timeout configuration #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fransflippo merged 2 commits into from
May 14, 2025
Merged

feat: timeout configuration #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c748204
feat: timeout configuration
Asafkbalink Aug 11, 2022
0e1fa72
doc: documented timeout configuration option
fransflippo May 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
| <<plugins-{type}s-{plugin}-sfdc_filters>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sfdc_instance_url>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sfdc_object_name>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-timeout>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-to_underscores>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-use_test_sandbox>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-use_tooling_api>> |<<boolean,boolean>>|No
Expand Down Expand Up @@ -203,6 +204,17 @@ but not both to configure the url to which the plugin connects to.

The name of the salesforce object you are creating or updating

[id="plugins-{type}s-{plugin}-timeout"]
===== `timeout`

* Value type is <<number,number>>
* Default value is `60`

The timeout to apply to REST API calls to Salesforce, in seconds. If
a connection to Salesforce cannot be made in this time, an error occurs.
If it takes longer than the timeout for a block of data (e.g. query results) to be
read, an error occurs.

[id="plugins-{type}s-{plugin}-to_underscores"]
===== `to_underscores`

Expand Down
6 changes: 5 additions & 1 deletion lib/logstash/inputs/salesforce.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,9 @@ class LogStash::Inputs::Salesforce < LogStash::Inputs::Base
# adding field1 = value1 AND field2 = value2 AND...
config :sfdc_filters, :validate => :string, :default => ""

# RESTForce request timeout in seconds.
config :timeout, :validate => :number, :default => 60, :required => false

# Setting this to true will convert SFDC's NamedFields__c to named_fields__c
config :to_underscores, :validate => :boolean, :default => false

Expand Down Expand Up @@ -179,7 +182,8 @@ def client_options
:password => @password.value,
:security_token => @security_token.value,
:client_id => @client_id,
:client_secret => @client_secret.value
:client_secret => @client_secret.value,
:timeout => @timeout
}
# configure the endpoint to which restforce connects to for authentication
if @sfdc_instance_url && @use_test_sandbox
Expand Down