Skip to content
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.

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

[O11y][Salesforce] Add support of the interval parameter in Salesforce setupaudittrail-rest fileset. #35938

Merged
Merged
1 change: 1 addition & 0 deletions CHANGELOG.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,7 @@ automatic splitting at root level, if root level element is an array. {pull}3415
- Improve CEL input documentation {pull}34831[34831]
- Add metrics documentation for CEL and AWS CloudWatch inputs. {issue}34887[34887] {pull}34889[34889]
- Metrics hosted by the HTTP monitoring endpoint for the `aws-cloudwatch`, `aws-s3`, `cel`, and `lumberjack` inputs are now available under `/inputs/` instead of `/dataset`.
- Add support of the interval parameter in Salesforce setupaudittrail-rest fileset. {issue}35917[35917] {pull}35938[35938]
kush-elastic marked this conversation as resolved.
Show resolved Hide resolved

*Heartbeat*

Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.next.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,7 @@ automatic splitting at root level, if root level element is an array. {pull}3415
- Add Okta input package for entity analytics. {pull}35611[35611]
- Expose harvester metrics from filestream input {pull}35835[35835] {issue}33771[33771]
- Add device support for Azure AD entity analytics. {pull}35807[35807]
- Add support of the interval parameter in Salesforce setupaudittrail-rest fileset. {issue}35917[35917] {pull}35938[35938]

*Auditbeat*
- Migration of system/package module storage from gob encoding to flatbuffer encoding in bolt db. {pull}34817[34817]
Expand Down
7 changes: 7 additions & 0 deletions filebeat/docs/modules/salesforce.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,7 @@ Example config:
var.user: "my.email@here.com"
var.password: "password"
var.url: "https://instance-url.salesforce.com"
var.interval: 1h
----

include::../include/var-paths.asciidoc[]
Expand Down Expand Up @@ -253,6 +254,12 @@ The password used as part of the authentication flow. It is required for authent

The URL of the Saleforce instance.

*`var.interval`*::

Period of fetching logs, i.e. 1s/1m/1h.
kush-elastic marked this conversation as resolved.
Show resolved Hide resolved

Note: It is important to exercise caution when reducing the interval, as it directly affects the API rate limit of the Salesforce instance. Please refer to the following link for the https://developer.salesforce.com/docs/atlas.en-us.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/salesforce_app_limits_platform_api.htm[Salesforce API Rate Limit].

[float]
==== `apex-rest` fileset settings

Expand Down
4 changes: 3 additions & 1 deletion x-pack/filebeat/filebeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1999,7 +1999,9 @@ filebeat.modules:

# URL, should include the instance_url
#var.url: "https://instance_id.my.salesforce.com"


# Interval, should include the time interval
#var.interval: 1h
#----------------------------- Google Santa Module -----------------------------
- module: santa
log:
Expand Down
3 changes: 3 additions & 0 deletions x-pack/filebeat/module/salesforce/_meta/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -125,3 +125,6 @@

# URL, should include the instance_url
#var.url: "https://instance_id.my.salesforce.com"

# Interval, should include the time interval
#var.interval: 1h
7 changes: 7 additions & 0 deletions x-pack/filebeat/module/salesforce/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,7 @@ Example config:
var.user: "my.email@here.com"
var.password: "password"
var.url: "https://instance-url.salesforce.com"
var.interval: 1h
----

include::../include/var-paths.asciidoc[]
Expand Down Expand Up @@ -246,6 +247,12 @@ The password used as part of the authentication flow. It is required for authent

The URL of the Saleforce instance.

*`var.interval`*::

Period of fetching logs, i.e. 1s/1m/1h.

Note: It is important to exercise caution when reducing the interval, as it directly affects the API rate limit of the Salesforce instance. Please refer to the following link for the https://developer.salesforce.com/docs/atlas.en-us.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/salesforce_app_limits_platform_api.htm[Salesforce API Rate Limit].

[float]
==== `apex-rest` fileset settings

Expand Down
3 changes: 3 additions & 0 deletions x-pack/filebeat/modules.d/salesforce.yml.disabled
Original file line number Diff line number Diff line change
Expand Up @@ -128,3 +128,6 @@

# URL, should include the instance_url
#var.url: "https://instance_id.my.salesforce.com"

# Interval, should include the time interval
#var.interval: 1h