Skip to content

[O11y] [Couchbase] Make sync-gateway host optional #6404

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.

Sign up for GitHub

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

Jump to bottom
Merged
milan-elastic merged 4 commits into from
Jun 2, 2023
Merged

[O11y] [Couchbase] Make sync-gateway host optional #6404

milan-elastic merged 4 commits into from
Jun 2, 2023

Conversation

@milan-elastic
Copy link
Contributor

@milan-elastic milan-elastic commented May 31, 2023 •
edited
Loading

  • Bug

What does this PR do?

Making the Sync gateway parameter optional, so user won't be forced to configure the Sync gateway host parameter if they are not using it.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.

Author's Checklist

  • Checked for data collection without Syncgateway configuration.
  • Checked for the data collection with Syncgateway configuration.

Related issues

@milan-elastic milan-elastic added Integration:couchbase Couchbase bugfix Pull request that fixes a bug issue labels May 31, 2023
@milan-elastic milan-elastic self-assigned this May 31, 2023
@milan-elastic milan-elastic linked an issue May 31, 2023 that may be closed by this pull request
[Couchbase] - Make sync-gateway host configuration Optional #6248
Closed
@milan-elastic milan-elastic marked this pull request as ready for review May 31, 2023 13:36
@milan-elastic milan-elastic requested a review from a team as a code owner May 31, 2023 13:36
@elasticmachine
Copy link

elasticmachine commented May 31, 2023 •
edited
Loading

💚 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 preview

Expand to view the summary

Build stats

  • Start Time: 2023-06-01T09:42:36.338+0000

  • Duration: 26 min 22 sec

Test stats 🧪

Test Results
Failed 0
Passed 45
Skipped 0
Total 45

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@elasticmachine
Copy link

elasticmachine commented May 31, 2023 •
edited
Loading

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (10/10) 💚
Files 100.0% (10/10) 💚
Classes 100.0% (10/10) 💚
Methods 100.0% (72/72) 💚 3.333
Lines 100.0% (1076/1076) 💚
Conditionals 100.0% (0/0) 💚

muthu-mps
muthu-mps reviewed May 31, 2023
View reviewed changes
packages/couchbase/changelog.yml Outdated
changes:
- description: Make sync-gateway host optional.
type: bugfix
link: https://github.com/elastic/integrations/pull/6404 # FIXME Replace with the real PR link
Copy link
Contributor

@muthu-mps muthu-mps May 31, 2023

Choose a reason for hiding this comment

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

Can we remove the comment added in the link ?

packages/couchbase/manifest.yml Outdated
show_user: false
- name: host_sync_gateway
type: text
title: Hosts for Sync Gateway prometheus exporter
Copy link
Contributor

@muthu-mps muthu-mps May 31, 2023

Choose a reason for hiding this comment

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

When the host-config is optional at base level, then there is a possibility that user may enable the sync-gateway and fail to provide config inputs. To avoid this the config should be moved inside the policy template inputs section as suggested below and the required flag should be turned on. required:true

Suggested change
title: Hosts for Sync Gateway prometheus exporter
policy_templates:
inputs:
- type: prometheus/metrics
title: Hosts for Sync Gateway prometheus exporter

@shmsr
Copy link
Member

shmsr commented May 31, 2023

@milan-elastic

PR title needs a minor change. I've mentioned the reason in 2-3 PRs so I'd just put the link here: #6333 (comment)

The changelog entry is fine. PR title and changelog entry should ideally be consistent so that the commit tree and the changelog make more sense and even looks standardized.

@milan-elastic milan-elastic changed the title Making sync-gateway host optional [O11y] [Couchbase] Make sync-gateway host optional Jun 1, 2023
@milan-elastic milan-elastic requested a review from muthu-mps June 1, 2023 09:31
harnish-crest-data
harnish-crest-data approved these changes Jun 1, 2023
View reviewed changes
Copy link
Contributor

@harnish-crest-data harnish-crest-data left a comment

Choose a reason for hiding this comment

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

LGTM!

muthu-mps
muthu-mps approved these changes Jun 2, 2023
View reviewed changes
Copy link
Contributor

@muthu-mps muthu-mps left a comment

Choose a reason for hiding this comment

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

LGTM!

@milan-elastic milan-elastic merged commit 4566ce5 into elastic:main Jun 2, 2023
@elasticmachine
Copy link

elasticmachine commented Jun 2, 2023

Package couchbase - 0.15.1 containing this change is available at https://epr.elastic.co/search?package=couchbase

sodhikirti07 pushed a commit that referenced this pull request Jun 15, 2023
@milan-elastic @sodhikirti07
[O11y] [Couchbase] Make sync-gateway host optional (#6404)
b78b5b0 
* Making sync-gateway host optional

* Update changelog entry

* address review comments

* Update changelog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@muthu-mps muthu-mps muthu-mps approved these changes

+1 more reviewer

@harnish-crest-data harnish-crest-data harnish-crest-data approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@milan-elastic milan-elastic

Labels

bugfix Pull request that fixes a bug issue Integration:couchbase Couchbase

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Couchbase] - Make sync-gateway host configuration Optional

5 participants

@milan-elastic @elasticmachine @shmsr @muthu-mps @harnish-crest-data