Skip to content

[Salesforce] Add request timeout parameter in configuration #7891

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
milan-elastic merged 4 commits into from
Sep 21, 2023
Merged

[Salesforce] Add request timeout parameter in configuration #7891

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1e41990
add request timeout parameter in configuration
milan-elastic Sep 20, 2023
051d326
update changelog.yml
milan-elastic Sep 20, 2023
a2b5280
address review comments
milan-elastic Sep 21, 2023
ed063da
resolve review comments
milan-elastic Sep 21, 2023
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
8 changes: 8 additions & 0 deletions packages/salesforce/_dev/build/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,14 @@ After the integration is successfully configured, clicking on the Assets tab of

## Troubleshooting

### Request timeout

In `Apex`, `Login Rest`, `Logout Rest`, or `SetupAuditTrail` datastreams, if the response is getting delayed from the Salesforce server side due to any reason then the following error might occur.
Comment thread
milan-elastic marked this conversation as resolved.
Outdated
```
Error while processing http request: failed to execute rf.collectResponse: failed to execute http client.Do: failed to execute http client.Do: failed to read http.response.body
```
In this case, consider increasing `Request Timeout` configuration from `Advanced options` section of that data stream.
Comment thread
milan-elastic marked this conversation as resolved.
Outdated

### Data ingestion error

In case of data ingestion if the user finds the following type of error logs:
Expand Down
5 changes: 5 additions & 0 deletions packages/salesforce/changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "0.10.1"
changes:
- description: Add 'Request Timeout' configuration.
type: enhancement
link: https://github.com/elastic/integrations/pull/7891
- version: "0.10.0"
changes:
- description: Rename ownership from obs-service-integrations to obs-infraobs-integrations
Expand Down
3 changes: 3 additions & 0 deletions packages/salesforce/data_stream/apex/agent/stream/httpjson.yml.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ auth.oauth2:
token_url: {{token_url}}
user: {{username}}
password: {{password}}
{{#if request_timeout}}
request.timeout: {{request_timeout}}
{{/if}}
request.url: {{instance_url}}/services/data/v54.0/query?q=apex
request.transforms:
- set:
Expand Down
8 changes: 8 additions & 0 deletions packages/salesforce/data_stream/apex/manifest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ streams:
type: bool
multi: false
default: false
- name: request_timeout
type: text
title: Request Timeout
Comment thread
milan-elastic marked this conversation as resolved.
Outdated
description: Duration before declaring that the HTTP client connection has timed out. Valid time units are s and m. Default is 30s.
Comment thread
milan-elastic marked this conversation as resolved.
Outdated
show_user: false
multi: false
required: false
default: 5m
- name: processors
type: yaml
title: Processors
Expand Down
3 changes: 3 additions & 0 deletions packages/salesforce/data_stream/login_rest/agent/stream/httpjson.yml.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ auth.oauth2:
token_url: {{token_url}}
user: {{username}}
password: {{password}}
{{#if request_timeout}}
request.timeout: {{request_timeout}}
{{/if}}
request.url: {{instance_url}}/services/data/v54.0/query?q=login+rest
request.transforms:
- set:
Expand Down
8 changes: 8 additions & 0 deletions packages/salesforce/data_stream/login_rest/manifest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ streams:
type: bool
multi: false
default: false
- name: request_timeout
type: text
title: Request Timeout
description: Duration before declaring that the HTTP client connection has timed out. Valid time units are s and m. Default is 30s.
Comment thread
milan-elastic marked this conversation as resolved.
Outdated
Comment thread
milan-elastic marked this conversation as resolved.
Outdated
show_user: false
multi: false
required: false
default: 5m
- name: processors
type: yaml
title: Processors
Expand Down
3 changes: 3 additions & 0 deletions packages/salesforce/data_stream/logout_rest/agent/stream/httpjson.yml.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ auth.oauth2:
token_url: {{token_url}}
user: {{username}}
password: {{password}}
{{#if request_timeout}}
request.timeout: {{request_timeout}}
{{/if}}
request.url: {{instance_url}}/services/data/v54.0/query?q=logout+rest
request.transforms:
- set:
Expand Down
8 changes: 8 additions & 0 deletions packages/salesforce/data_stream/logout_rest/manifest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ streams:
type: bool
multi: false
default: false
- name: request_timeout
type: text
title: Request Timeout
description: Duration before declaring that the HTTP client connection has timed out. Valid time units are s and m. Default is 30s.
show_user: false
multi: false
required: false
default: 5m
- name: processors
type: yaml
title: Processors
Expand Down
3 changes: 3 additions & 0 deletions packages/salesforce/data_stream/setupaudittrail/agent/stream/httpjson.yml.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ auth.oauth2:
token_url: {{token_url}}
user: {{username}}
password: {{password}}
{{#if request_timeout}}
request.timeout: {{request_timeout}}
{{/if}}
request.url: {{instance_url}}/services/data/v54.0/query?q=setupaudittrail+rest
request.transforms:
- set:
Expand Down
8 changes: 8 additions & 0 deletions packages/salesforce/data_stream/setupaudittrail/manifest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ streams:
type: bool
multi: false
default: false
- name: request_timeout
type: text
title: Request Timeout
description: Duration before declaring that the HTTP client connection has timed out. Valid time units are s and m. Default is 30s.
show_user: false
multi: false
required: false
default: 5m
- name: processors
type: yaml
title: Processors
Expand Down
8 changes: 8 additions & 0 deletions packages/salesforce/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,14 @@ After the integration is successfully configured, clicking on the Assets tab of

## Troubleshooting

### Request timeout

In `Apex`, `Login Rest`, `Logout Rest`, or `SetupAuditTrail` datastreams, if the response is getting delayed from the Salesforce server side due to any reason then the following error might occur.
```
Error while processing http request: failed to execute rf.collectResponse: failed to execute http client.Do: failed to execute http client.Do: failed to read http.response.body
```
In this case, consider increasing `Request Timeout` configuration from `Advanced options` section of that data stream.
Comment thread
milan-elastic marked this conversation as resolved.
Outdated

### Data ingestion error

In case of data ingestion if the user finds the following type of error logs:
Expand Down
2 changes: 1 addition & 1 deletion packages/salesforce/manifest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
format_version: 1.0.0
name: salesforce
title: Salesforce
version: "0.10.0"
version: "0.10.1"
license: basic
description: Collect logs from Salesforce with Elastic Agent.
type: integration
Expand Down