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

Add debug documentation and configuration #9435

Merged
merged 5 commits into from
Feb 27, 2025

Conversation

d-buckner
Copy link
Member

@d-buckner d-buckner commented Feb 21, 2025

Description

This PR is to introduce basic debugging documentation and configuration for the OpenSearch Dashboards server.

Issues this resolves

Changelog

  • doc: add documentation and configuration for server debugging

Check List

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

Signed-off-by: Daniel Rowe <rowdane@amazon.com>
Copy link

codecov bot commented Feb 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.74%. Comparing base (946c6bb) to head (d0562a9).
Report is 7 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #9435   +/-   ##
=======================================
  Coverage   61.74%   61.74%           
=======================================
  Files        3816     3816           
  Lines       91890    91890           
  Branches    14563    14563           
=======================================
+ Hits        56733    56735    +2     
+ Misses      31497    31496    -1     
+ Partials     3660     3659    -1     
Flag Coverage Δ
Linux_1 28.99% <ø> (ø)
Linux_2 56.41% <ø> (ø)
Linux_3 39.26% <ø> (+<0.01%) ⬆️
Linux_4 28.87% <ø> (ø)
Windows_1 29.00% <ø> (ø)
Windows_2 56.37% <ø> (ø)
Windows_3 39.26% <ø> (ø)
Windows_4 28.87% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

angle943
angle943 previously approved these changes Feb 21, 2025
Signed-off-by: daniel <51932404+d-buckner@users.noreply.github.com>
Signed-off-by: daniel <51932404+d-buckner@users.noreply.github.com>
@d-buckner d-buckner requested review from ananzh and angle943 February 21, 2025 22:14
@@ -230,6 +230,11 @@ $ wsl -d docker-desktop
$ sysctl -w vm.max_map_count=262144
```

#### Debugging
You can debug the OpenSearch Dashboards server by
1. Attaching your debugger client to the debug port on port `9229`. If you're using VSCode, you can use the `attach-to-server` debug configuration provided.
Copy link
Collaborator

Choose a reason for hiding this comment

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

No love for webstorm? :(

Copy link
Member Author

Choose a reason for hiding this comment

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

I'd love this for webstorm too! Do you know if webstorm has a similar debugging file? We can include as followup.

@kavilla
Copy link
Member

kavilla commented Feb 27, 2025

should we close this issue? #723

@d-buckner
Copy link
Member Author

should we close this issue? #723

Yup, we can close once this is merged. Any blockers preventing approval/merge here?

@ananzh ananzh merged commit 85547a2 into opensearch-project:main Feb 27, 2025
74 checks passed
@d-buckner d-buckner deleted the debugger-configuration branch February 27, 2025 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants