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.

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

[vsphere]: Update README with limitations in Virtual Machine metrics #8331

Merged
merged 13 commits into from
Oct 31, 2023
Merged

[vsphere]: Update README with limitations in Virtual Machine metrics #8331

merged 13 commits into from
Oct 31, 2023

Conversation

ishleenk17
Copy link
Contributor

@ishleenk17 ishleenk17 commented Oct 30, 2023 •
edited
Loading

  • Bug

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.

Related issues

@elasticmachine
Copy link

elasticmachine commented Oct 30, 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-10-30T18:55:02.984+0000

  • Duration: 18 min 7 sec

Test stats 🧪

Test Results
Failed 0
Passed 17
Skipped 0
Total 17

🤖 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 Oct 30, 2023 •
edited
Loading

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (1/1) 💚
Files 100.0% (1/1) 💚
Classes 100.0% (1/1) 💚
Methods 100.0% (18/18) 💚
Lines 89.13% (41/46) ❕
Conditionals 100.0% (0/0) 💚

@ishleenk17 ishleenk17 marked this pull request as ready for review October 30, 2023 17:08
@ishleenk17 ishleenk17 requested a review from a team as a code owner October 30, 2023 17:08
@shmsr shmsr changed the title README update: Vsphere limitations of virtual machine [vsphere]: Update README with limitations in Virtual Machine metrics Oct 30, 2023
shmsr
shmsr requested changes Oct 30, 2023
View reviewed changes
packages/vsphere/docs/README.md Outdated
@@ -13,6 +13,8 @@ To access the metrices, the url https://host:port(8989)/sdk needs to be passed t

The virtual machine consists of a set of specification and configuration files and is backed by the physical resources of a host. Every virtual machine has virtual devices that provide the same functionality as physical hardware but are more portable, secure and easier to manage.

Note: vSphere Integration currently supports network names of VM's conecected only to vSS (Virtual Standard Switch) and not vDS (virtual Dustributed Switches).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Note: vSphere Integration currently supports network names of VM's conecected only to vSS (Virtual Standard Switch) and not vDS (virtual Dustributed Switches).
> Note: vSphere Integration currently supports network names of VMs connected only to vSS (Virtual Standard Switch) and not vDS (virtual Distributed Switches).

Notes are usually in blockquote. Also spelling mistakes ^

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is not an explicit mention that blockquote is required. Would prefer having it as continuation of the documentation of virtualmachine metricset.

packages/vsphere/_dev/build/docs/README.md Outdated Show resolved Hide resolved
packages/vsphere/changelog.yml Outdated Show resolved Hide resolved
ishleenk17 and others added 2 commits October 30, 2023 23:47
@ishleenk17
Update README.md
36f63a6
@ishleenk17 @shmsr
Update packages/vsphere/changelog.yml
2e8f016 
Co-authored-by: subham sarkar <sarkar.subhams2@gmail.com>
devamanv
devamanv reviewed Oct 30, 2023
View reviewed changes
packages/vsphere/changelog.yml
- version: 1.9.1
changes:
- description: Update the README with limitations in Virtual Machine metrics.
type: bugfix
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it make sense to treat it an enhancement? Or is it related to a bugfix, that's why we are calling it a bugfix?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Its an addition of a missing documentation, so bugfix should be good

@ishleenk17 @shmsr
Update packages/vsphere/_dev/build/docs/README.md
f71e78a 
Co-authored-by: subham sarkar <sarkar.subhams2@gmail.com>
devamanv
devamanv approved these changes Oct 30, 2023
View reviewed changes
Copy link
Contributor

@devamanv devamanv left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Just one small comment about the update being an enhancement, rest looks good to me.

@ishleenk17 ishleenk17 merged commit d06a60e into elastic:main Oct 31, 2023
4 checks passed
@elasticmachine
Copy link

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

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

@devamanv devamanv devamanv approved these changes

@shmsr shmsr shmsr approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@ishleenk17 @elasticmachine @devamanv @shmsr