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

Fix inconsistency of GCP Filebeat/Metricbeat names #19467

Closed
kaiyan-sheng opened this issue Jun 26, 2020 · 12 comments
Closed

Fix inconsistency of GCP Filebeat/Metricbeat names #19467

kaiyan-sheng opened this issue Jun 26, 2020 · 12 comments
Assignees
Labels
discuss Issue needs further discussion. Team:Integrations Label for the Integrations team

Comments

@kaiyan-sheng
Copy link
Contributor

kaiyan-sheng commented Jun 26, 2020

Currently we have several Filebeat inputs with inconsistent naming, such as azureeventhub, googlepubsub and s3. With the migration work to elastic-agent, this is a good opportunity for us to make changes on these names.

This issue is to start the discussion on if we should rename s3 to awss3, or should we remove the public cloud names completely.

TODO list:

Description Current Name Proposed New Name PR
Google Cloud Metricbeat module googlecloud gcp #22246
Google Cloud Filebeat module googlecloud gcp #22214
Google Cloud Filebeat Pub/Sub input google-pubsub gcp-pubsub #22213
AWS S3 s3 aws-s3 Will be tracked with issue https://github.com/elastic/beats/issues/22799
AWS CloudWatch Filebeat input awscloudwatch aws-cloudwatch #22228
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Jun 26, 2020
@kaiyan-sheng kaiyan-sheng added the Team:Integrations Label for the Integrations team label Jun 26, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/integrations (Team:Integrations)

@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Jun 26, 2020
@kaiyan-sheng kaiyan-sheng added the discuss Issue needs further discussion. label Jun 26, 2020
@ycombinator
Copy link
Contributor

Ah, naming :)

My vote would be to include the cloud provider names (or abbreviations) in the input names, since the input implementations are specific to cloud providers. So I prefer awss3. But perhaps we could shorten/abbreviate the cloud provider names so maybe google becomes gcp.

@kaiyan-sheng
Copy link
Contributor Author

Agree on changing googlecloud to gcp and also agree on changing s3 to awss3 😄 @ycombinator Thank you for the input!!

@kaiyan-sheng kaiyan-sheng self-assigned this Jul 8, 2020
@kaiyan-sheng
Copy link
Contributor Author

We would like to rename googlecloud to gcp for both Metricbeat and Filebeat. @andrewkroh WDYT? I see in cloud ECS field, we are using gcp for cloud provider name instead of googlecloud.

@andrewkroh
Copy link
Member

In Filebeat the input name for collecting data from Google Cloud's Pub/Sub service is called google-pubsub. The Filebeat module for Google Cloud is called googlecloud.

So is the proposal to change the input name, module, or both?

@andrewkroh
Copy link
Member

I like the hyphenated input names for readability. If we want to shorten google to gcp then how about

Description Name Proposal
Azure Event Hub azure-eventhub NO CHANGE
AWS S3 s3 aws-s3
Google Cloud Pub/Sub google-pubsub gcp-pubsub

We should look across all the other input names too (this was just a quick look for me).

@kaiyan-sheng
Copy link
Contributor Author

kaiyan-sheng commented Oct 20, 2020

@andrewkroh Thank you! We are proposing to change both the Filebeat input name and Filebeat/Metricbeat module name. Do you know if google pubsub Filebeat input is GA or Beta?

@kaiyan-sheng
Copy link
Contributor Author

kaiyan-sheng commented Oct 20, 2020

Here is the proposal for both input names and module names.

Filebeat input name:

Description Name Proposal
Azure Event Hub azure-eventhub NO CHANGE
AWS S3 s3 aws-s3
Google Cloud Pub/Sub google-pubsub gcp-pubsub

Filebeat module name:

Description Name Proposal
AWS aws NO CHANGE
Azure azure NO CHANGE
Google Cloud Filebeat module googlecloud gcp

Metricbeat module name:

Description Name Proposal
AWS aws NO CHANGE
Azure azure NO CHANGE
Google Cloud Metricbeat module googlecloud gcp

@kaiyan-sheng kaiyan-sheng changed the title Fix inconsistency of Filebeat input names Fix inconsistency of GCP Filebeat/Metricbeat names Oct 20, 2020
@andrewkroh
Copy link
Member

The above list SGTM.

When Filebeat modules are renamed aliases can be installed so that existing users are not broken by the change. See the apache module for an example.

@andrewkroh
Copy link
Member

andrewkroh commented Oct 20, 2020

Do you know if google pubsub Filebeat input is GA or Beta?

It must be GA since there are not beta labels at. https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-google-pubsub.html

So if we rename inputs then we should probably figure out how to register them with their old name too so we don't break anything in 7.x.

@kaiyan-sheng
Copy link
Contributor Author

It must be GA since there are not beta labels at. https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-google-pubsub.html

Yeah good to know, thank you! I also didn't see release: ga under filebeat input 😬 That's why I want to confirm.

@kaiyan-sheng
Copy link
Contributor Author

GCP part of the renaming is done, will close this issue.

@zube zube bot added the [zube]: Done label Nov 30, 2020
@zube zube bot removed the [zube]: Done label Mar 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Issue needs further discussion. Team:Integrations Label for the Integrations team
Projects
None yet
Development

No branches or pull requests

5 participants