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

Update title and description based on guidelines for Beats based Security integrations #1897

Closed
akshay-saraswat opened this issue Oct 11, 2021 · 7 comments
Assignees

Comments

@akshay-saraswat
Copy link
Contributor

akshay-saraswat commented Oct 11, 2021

In 7.16, we are planning to introduce the unified integrations view. The primary goal of this view is to improve the discoverability for all data ingest options at Elastic. As part of this initiative, we'd like to improve the titles and descriptions of each integration card and do so in a uniform way.

Guidelines

These are the general guidelines we plan to use for the integration cards

image

Beats example

Here's an example for how beats can leverage these guidelines, but please follow the guidelines as you see fit.

Current Title Current Description New Title New Description
ActiveMQ logs Collect ActiveMQ logs with Filebeat ActiveMQ Logs Collect logs from ActiveMQ servers with Filebeat.
ActiveMQ metrics Fetch monitoring metrics from ActiveMQ instances. ActiveMQ Metrics Collect metrics from ActiveMQ servers with Metricbeat.
Aerospike metrics Fetch internal metrics from the Aerospike server. Aeropspike Metrics Collect metrics from Aerospike databases with Metricbeat.
Apache logs Collect and parse access and error logs created by the Apache HTTP server. Apache Logs Collect logs from Apache servers with Filebeat.
Apache metrics Fetch internal metrics from the Apache 2 HTTP server. Apache Metrics Collect metrics from Apache servers with Metricbeat.
Auditbeat Collect audit data from your hosts. Auditbeat Events Collect events from your servers with Auditbeat.
Auditd logs Collect logs from the Linux auditd daemon. Auditd Logs Collect logs from the Linux audit daemon with Filebeat.
@elasticmachine
Copy link

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

@jamiehynds
Copy link

jamiehynds commented Oct 12, 2021

@alexfrancoeur for the Beats based integrations, can you confirm where we should be updating the titles and descriptions? Tiles for Beats modules currently exist under 'Add Data' (which lives in Kibana). If we make the necessary changes here, will they be reflected in the unified view?

Screenshot 2021-10-12 at 13 58 13

@alexfrancoeur
Copy link

For the add data tutorials, at a minimum we'll need to update the title and descriptions on the details page to match the cards a user sees. The cards / overview page for the current add data screen will go away. I believe we'll need to register new cards for beats in the integrations view, but I'll need @thomasneirynck, @clintandrewhall or @joshdover to confirm. Could one of y'all help @jamiehynds with the details?

@joshdover
Copy link
Contributor

joshdover commented Oct 12, 2021

We can update the existing descriptions inside the home plugin and they will get consumed by both the Home and Integrations apps. For example, here is where you could update the apache logs beats module description:
https://github.com/elastic/kibana/blob/afe81bb1a2a8da526a1f42f19e442c32e2ab0fd0/src/plugins/home/server/tutorials/apache_logs/index.ts#L32

@jamiehynds
Copy link

Thanks for confirming @joshdover. That ok with you @andrewkroh?

@andrewkroh
Copy link
Member

As per #1883 (comment) all of the Beats integrations (Security + Observability) will be updated together.

I think we should close this issue and just focus on #1883.

@alexfrancoeur
Copy link

alexfrancoeur commented Oct 21, 2021

wwooo! Thank you @andrewkroh and team

Edit: I see now we moved back to the meta issue, but still, thank you 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants