Skip to content

Conversation

@devamanv
Copy link
Contributor

@devamanv devamanv commented Jun 6, 2024

Proposed commit message

The PR contains changes to allow users to provide username and password as separate fields and marks the password field as secret.

Important points for the reviewers:

  • The changes will continue to work for the existing users and the old Host string pattern containing username and password
  • Configured username and password take precedence over username/password in the Hosts URI
  • The changes were tested with couchdb v3.1, that is also the supported version.

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 or logs.
  • 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

  • Mark the password field as secret
  • Upgrading the package doesn't break the existing integration and metrics still come through
  • No dashboards are broken

How to test this PR locally

  • Spin up the Elastic stack and point your elastic-package to the running Kibana instance
  • Build the package locally and install the package using elastic-package install --zip couchdb-1.3.0.zip
  • Upgrade the integration to the latest version i.e. 1.3.0, there shouldn't be any errors. If you find any errors while upgrading, please report it by adding a comment to this PR.
  • You should now see separate fields for username and password under advanced options while configuring the Integration for metrics collection
  • Take a look at the dashboards, they shouldn't be broken and metrics should still be coming in just fine

Related issues

Screenshots

image
image
image

@devamanv devamanv added the enhancement New feature or request label Jun 6, 2024
@elasticmachine
Copy link

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@devamanv devamanv marked this pull request as ready for review June 7, 2024 18:52
@devamanv devamanv requested a review from a team as a code owner June 7, 2024 18:52
@elastic-sonarqube
Copy link

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@devamanv devamanv self-assigned this Jun 9, 2024
@devamanv devamanv requested a review from ritalwar July 12, 2024 12:12
@elasticmachine
Copy link

💚 Build Succeeded

History

cc @devamanv

@devamanv devamanv merged commit 377ee69 into elastic:main Jul 12, 2024
@devamanv devamanv deleted the mask-password-couchdb branch July 12, 2024 14:27
@elasticmachine
Copy link

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

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

Labels

enhancement New feature or request Integration:couchdb CouchDB

4 participants