[META] Update title and description based on guidelines for Elastic Agent integrations

[alexfrancoeur]

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

Elastic Agent example

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

Current Title	Current Description	New Title	New Description
ActiveMQ	ActiveMQ Integration	ActiveMQ	Collect logs and metrics from ActiveMQ servers with Elastic Agent.
Apache	This Elastic integration collects logs and metrics from Apache servers	Apache	Collect logs and metrics from Apache servers with Elastic Agent.
Auditd	This Elastic integration collects and parses logs from the Audit daemon (auditd)	Auditd	Collect logs from the Linux audit daemon with Elastic Agent.
AWS	This integration collects logs and metrics from Amazon Web Services (AWS)	AWS	Collect logs and metrics from Amazon Web Services with Elastic Agent.
AWS Billing		AWS Billing	Collect logs and metrics from AWS Billing with Elastic Agent.
Azure Logs	This Elastic integration collects logs from Azure	Azure	Collect logs from Microsoft Azure with Elastic Agent.

@akshay-saraswat will follow up with the appropriate folks

[jamiehynds]

@akshay-saraswat are the o11y team updating all integrations, or do you need assistance from my team to update our security integrations?

[akshay-saraswat]

Treating this as a meta issue for the following issues created for apps

• Update title and description based on guidelines for Elastic Agent based Security integrations #1900
• Update title and description based on guidelines for Elastic Agent based Observability integrations #1901
• Update title and description based on guidelines for Elastic Agent based Enterprise Search integrations #1902

[akshay-saraswat]

@akshay-saraswat are the o11y team updating all integrations, or do you need assistance from my team to update our security integrations?

Thanks for offering the help @jamiehynds. I have created GitHub issues for all three teams and assigned Security and Enterprise Search related issues to you and @bhuvanaurora respectively. Please let me know if you need more details or clarification related to the work.

[bhuvanaurora]

Enterprise Search doesn't have any Elastic Agent based integrations so I believe this is not relevant for Enterprise Search. I have linked the titles and descriptions for Workplace Search in the subticket for reference.

[akshay-saraswat]

Enterprise Search doesn't have any Elastic Agent based integrations so I believe this is not relevant for Enterprise Search. I have linked the titles and descriptions for Workplace Search in the subticket for reference.

Thank you @bhuvanaurora !

[andrewkroh]

I wonder if we do want to include the "technology reference" in all cases.

• In particular should we highlight that Filebeat or Metricbeat is the technology behind the integration? Does this couple the integration to the Beat and set expectations that behavior will always be the same as Beats? Does this prevent us from migrating to a unified collector at some point (replacing the Beat)?
• Some integrations use a combination of Metricbeat and Filebeat. Should those mention both in the technology reference (e.g. "Collect logs and metrics from Hashicorp Vault using Filebeat and Metricbeat.")?

[andrewkroh]

I was reading the image rather than the examples. I see in the examples "with Elastic Agent" is used in all cases so that addresses both points I raised above.

[mostlyjason]

@andrewkroh Yes we should include the shipper as the "technology reference". This is included in the guidelines image as the [shipper] part.

Some integrations use a combination of Metricbeat and Filebeat.

Is this a new integration? Our current add data UI page generally has separate cards and tutorial pages for the filebeat and metricbeat parts. I guess if its really combined into a single page you could mention both shippers.

[alexfrancoeur]

fwiw we're tracking beats updates here: #1897

[alexfrancoeur]

@akshay-saraswat I wanted to follow up on this work for 7.16. In your opinion, would you call this done?

[akshay-saraswat]

I believe, yes, this is done. Closing it now.