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

[kush-elastic]

Urgency

• High

Activity Type

• Enhancement

What does this PR do?

• Add support of the interval parameter in Salesforce setupaudittrail-rest fileset.
• Improve documentation for the same to explain more in detail how salesforce data collection frequency works for setupaudittrail-rest fileset.

Checklist

• My code follows the style guidelines of this project
• I have made corresponding changes to the documentation
• I have made corresponding change to the default configuration files
• I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Related issues

• Closes [Filebeat][Salesforce] Add support of interval parameter in Salesforce setupaudittrail-rest fileset #35917

[mergify]

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @kush-elastic? 🙏.
For such, you'll need to label your PR with:

• The upcoming major version of the Elastic Stack
• The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

• backport-v8./d.0 is the label to automatically backport to the 8./d branch. /d is the digit

[elasticmachine]

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

• Start Time: 2023-08-14T06:36:39.011+0000

• Duration: 81 min 46 sec

Test stats 🧪

Test	Results
Failed	0
Passed	8156
Skipped	755
Total	8911

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

• /test : Re-trigger the build.

• /package : Generate the packages and run the E2E tests.

• /beats-tester : Run the installation tests with beats-tester.

• run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

[mergify]

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b salesforce-setupaudittrail-interval upstream/salesforce-setupaudittrail-interval
git merge upstream/main
git push upstream salesforce-setupaudittrail-interval

[agithomas]

LGTM!

[lalit-satapathy]

@kush-elastic,

• Is there any error check in beats code, if user provide a bad value/syntax for the var.interval or salesforce will give error and the module with exit gracefully? Can you provide the exact errors for this scenario.
• the default value of interval is 1h? Can we make that explicit in the document?
• Still concerned, what happens if user gives low value or very high values? Could not find any specific recommendation in this doc for var.limit

[kush-elastic]

@kush-elastic,

• Is there any error check in beats code, if user provide a bad value/syntax for the var.interval or salesforce will give error and the module with exit gracefully? Can you provide the exact errors for this scenario.

Yes, there is an error check in inbuilt beats code. If a user provides a bad value/syntax error for the var.interval. User can see the error.message in the logs.

Error message: Exiting: Failed to start crawler: creating module reloader failed: error checking input configuration: runner factory could not check config: time: invalid duration "1hrs" accessing 'interval'

• the default value of interval is 1h? Can we make that explicit in the document?
• Still concerned, what happens if user gives low value or very high values? Could not find any specific recommendation in this doc for var.limit

We can provide the Note in the document itself. Let me know if the following Note will resolve your concerns so we can update it accordingly.

Note: The default value of `var.interval` is 1h. It is important to exercise caution when reducing the interval, as it directly affects the API rate limit of the Salesforce instance. Salesforce API rate limit is ~1000 API calls per hour. Hence if user goes with lower limit of var.interval, the Salesforce API rate limit will exceed and any additional API requests beyond the limit will result in an error response from the Salesforce API. The error message will typically indicate that the rate limit has been exceeded.. 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].

[lalit-satapathy]

Note: The default value of var.interval is 1h. It is important to exercise caution when reducing the interval, as it directly affects the API rate limit of the Salesforce instance. Salesforce API rate limit is ~1000 API calls per hour. Hence if user goes with lower limit of var.interval, the Salesforce API rate limit will exceed and any additional API requests beyond the limit will result in an error response from the Salesforce API. The error message will typically indicate that the rate limit has been exceeded.. 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].

Yes this is better.

[lalit-satapathy]

LGTM

[lalit-satapathy]

@kush-elastic, Lets raise a seprate PR to update the CODEOWNER for the beats module: /x-pack/filebeat/module/salesforce to @elastic/obs-infraobs-integrations

[mergify]

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b salesforce-setupaudittrail-interval upstream/salesforce-setupaudittrail-interval
git merge upstream/main
git push upstream salesforce-setupaudittrail-interval

[elasticmachine]

Pinging @elastic/elastic-agent (Team:Elastic-Agent)

[pierrehilbert]

Please remove the CHANGELOG.asciidoc entry and I will approve the PR

[pierrehilbert]

LGTM