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

[8.14](backport #39028) x-pack/filebeat/module/salesforce: Remove dashboards #39607

Merged
merged 2 commits into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion CHANGELOG.next.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ https://github.com/elastic/beats/compare/v8.8.1\...main[Check the HEAD diff]
- Introduce input/netmetrics and refactor netflow input metrics {pull}38055[38055]
- Update Salesforce module to use new Salesforce input. {pull}37509[37509]


*Heartbeat*

- Fix monitor state loader to not wait extra seconds for the last attempt {pull}39621[39621]
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
23 changes: 1 addition & 22 deletions filebeat/docs/modules/salesforce.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ This file is generated! See scripts/docs_collector.py
[role="xpack"]

:modulename: salesforce
:has-dashboards: true

== Salesforce module

Expand Down Expand Up @@ -54,7 +53,7 @@ The Salesforce module contains the following filesets for collecting different t
The default interval for collecting logs (`var.real_time_interval` or `var.elf_interval`) is 5m/1h. Exercise caution when reducing this interval, as it directly impacts the Salesforce API rate limit of ~1000 calls per hour. Exceeding the limit will result in errors from the Salesforce API. Refer to 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] documentation for more details.
====

== Set up the OAuth App in the Salesforce
=== Set up the OAuth App in the Salesforce

In order to use this integration, users need to create a new Salesforce Application using OAuth. Follow the steps below to create a connected application in Salesforce:

Expand Down Expand Up @@ -545,24 +544,6 @@ Interval for collecting EventLogFile logs, e.g. 1h or 5m.

Either "Hourly" or "Daily". The time interval of each log file from EventLogFile.

[float]
=== Example dashboards

The Salesforce module includes several predefined dashboards:

- Login Dashboard: Visualizes login activity and trends.
- Logout Dashboard: Visualizes logout activity and trends.
- Apex Dashboard: Visualizes Apex executions and errors.
- Setup Audit Trail Dashboard: Shows changes made in the Setup area.

image::./images/filebeat-salesforce-login-dashboard.png[]

image::./images/filebeat-salesforce-logout-dashboard.png[]

image::./images/filebeat-salesforce-setupaudittrail-dashboard.png[]

Access these dashboards in Kibana by going to Management -> Kibana -> Dashboards and searching for "Salesforce".

[float]
=== Troubleshooting

Expand All @@ -577,8 +558,6 @@ Verify the `var.url` is correct. Check that the user credentials are valid and h
*Not seeing any data*::
Check the Elastic Agent logs for errors. Verify the module configuration is correct, the filesets are enabled, and the intervals are reasonable. Confirm there is log activity in Salesforce for the log types being collected.

:has-dashboards!:

:fileset_ex!:

:modulename!:
Expand Down
23 changes: 1 addition & 22 deletions x-pack/filebeat/module/salesforce/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
[role="xpack"]

:modulename: salesforce
:has-dashboards: true

== Salesforce module

Expand Down Expand Up @@ -47,7 +46,7 @@ The Salesforce module contains the following filesets for collecting different t
The default interval for collecting logs (`var.real_time_interval` or `var.elf_interval`) is 5m/1h. Exercise caution when reducing this interval, as it directly impacts the Salesforce API rate limit of ~1000 calls per hour. Exceeding the limit will result in errors from the Salesforce API. Refer to 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] documentation for more details.
====

== Set up the OAuth App in the Salesforce
=== Set up the OAuth App in the Salesforce

In order to use this integration, users need to create a new Salesforce Application using OAuth. Follow the steps below to create a connected application in Salesforce:

Expand Down Expand Up @@ -538,24 +537,6 @@ Interval for collecting EventLogFile logs, e.g. 1h or 5m.

Either "Hourly" or "Daily". The time interval of each log file from EventLogFile.

[float]
=== Example dashboards

The Salesforce module includes several predefined dashboards:

- Login Dashboard: Visualizes login activity and trends.
- Logout Dashboard: Visualizes logout activity and trends.
- Apex Dashboard: Visualizes Apex executions and errors.
- Setup Audit Trail Dashboard: Shows changes made in the Setup area.

image::./images/filebeat-salesforce-login-dashboard.png[]

image::./images/filebeat-salesforce-logout-dashboard.png[]

image::./images/filebeat-salesforce-setupaudittrail-dashboard.png[]

Access these dashboards in Kibana by going to Management -> Kibana -> Dashboards and searching for "Salesforce".

[float]
=== Troubleshooting

Expand All @@ -570,8 +551,6 @@ Verify the `var.url` is correct. Check that the user credentials are valid and h
*Not seeing any data*::
Check the Elastic Agent logs for errors. Verify the module configuration is correct, the filesets are enabled, and the intervals are reasonable. Confirm there is log activity in Salesforce for the log types being collected.

:has-dashboards!:

:fileset_ex!:

:modulename!:
Loading
Loading