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

Rename google-pubsub Filebeat input to gcp-pubsub #22213

Merged
merged 6 commits into from
Nov 9, 2020
Merged

Rename google-pubsub Filebeat input to gcp-pubsub #22213

merged 6 commits into from
Nov 9, 2020

Conversation

kaiyan-sheng
Copy link
Contributor

@kaiyan-sheng kaiyan-sheng commented Oct 27, 2020

What does this PR do?

This PR is to rename google-pubsub input to gcp-pubsub input. This is a part of the renaming process to change googlecloud to gcp in both Metricbeat and Filebeat.

Warning log message is also added when user is using the old input name:

2020-10-28T13:54:08.841-0600    WARN    [gcp.pubsub]    gcppubsub/input.go:79   google-pubsub input name is deprecated, please use gcp-pubsub instead   {"pubsub_project": "elastic-observability", "pubsub_topic": "my-gcp-pubsub-topic-name", "pubsub_subscription": {"Name":"my-gcp-pubsub-subscription-name","NumGoroutines":1,"MaxOutstandingMessages":1000,"Create":true}}

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

How to test this PR locally

This should not be a breaking change so both google-pubsub and gcp-pubsub input names should work.

  1. Test google-pubsub name:
filebeat.inputs:
- type: google-pubsub
  enabled: true
  project_id: elastic-observability
  topic: my-gcp-pubsub-topic-name
  subscription.name: my-gcp-pubsub-subscription-name
  credentials_file: "/Users/kaiyansheng/Desktop/elastic-observability-5537b831234a.json"
  1. Test gcp-pubsub name:
filebeat.inputs:
- type: gcp-pubsub
  enabled: true
  project_id: elastic-observability
  topic: my-gcp-pubsub-topic-name
  subscription.name: my-gcp-pubsub-subscription-name
  credentials_file: "/Users/kaiyansheng/Desktop/elastic-observability-5537b831234a.json"

Related issues

@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Oct 27, 2020
@kaiyan-sheng kaiyan-sheng self-assigned this Oct 27, 2020
@kaiyan-sheng kaiyan-sheng added the Team:Platforms Label for the Integrations - Platforms team label Oct 27, 2020
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Oct 27, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/integrations-platforms (Team:Platforms)

@elasticmachine
Copy link
Collaborator

elasticmachine commented Oct 27, 2020

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview

Expand to view the summary

Build stats

  • Build Cause: [Pull request #22213 updated]

  • Start Time: 2020-11-03T23:13:59.861+0000

  • Duration: 47 min 8 sec

Test stats 🧪

Test Results
Failed 0
Passed 5859
Skipped 567
Total 6426

Copy link
Member

@andrewkroh andrewkroh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When will the old input name be removed? If 8.0 then after this is backported into 7.x we could remove the old name from master.

In the release note we could say something like "the previous name will continue working until the next major release. Please update your configs".

x-pack/filebeat/input/gcppubsub/input.go Show resolved Hide resolved
@elasticmachine
Copy link
Collaborator

Pinging @elastic/ingest-management (Team:Ingest Management)

@kaiyan-sheng kaiyan-sheng added the in progress Pull request is currently in progress. label Oct 28, 2020
@elasticmachine
Copy link
Collaborator

elasticmachine commented Oct 28, 2020

💚 Flaky test report

Tests succeeded.

Expand to view the summary

Test stats 🧪

Test Results
Failed 0
Passed 5859
Skipped 567
Total 6426

@ph
Copy link
Contributor

ph commented Oct 29, 2020

@kaiyan-sheng Is there any integration using this input? if so they would need to be changed as well.

@kaiyan-sheng
Copy link
Contributor Author

@ph Thanks for reminding me. I don't think so. We only migrated AWS package with s3 input, not GCP.

Copy link
Member

@andrewkroh andrewkroh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kaiyan-sheng kaiyan-sheng merged commit 42428a8 into elastic:master Nov 9, 2020
@kaiyan-sheng kaiyan-sheng deleted the rename_googlecloud branch November 9, 2020 17:28
kaiyan-sheng added a commit that referenced this pull request Nov 10, 2020
* Rename google-pubsub Filebeat input to gcp-pubsub

* change to gcp-pubsub input name in elastic-agent

* add warning log message for deprecated old input name

(cherry picked from commit 42428a8)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in progress Pull request is currently in progress. Team:Platforms Label for the Integrations - Platforms team v7.11.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants