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

[docs][observability] O11y refactor 2 #35279

Merged
merged 33 commits into from
May 22, 2023
Merged

[docs][observability] O11y refactor 2 #35279

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
aab97f1
moving log persistence content to clusters
angelinalg May 12, 2023
3e11e1e
move redirect stdout and stderr; add and rename some files
angelinalg May 12, 2023
414a314
fix notes and code blocks from rst to md syntax, fix heading hierarch…
angelinalg May 12, 2023
50f9291
rename overview content to key concepts
angelinalg May 12, 2023
59a0ed8
new page for getting started on observability with programmatic inter…
angelinalg May 16, 2023
c035142
Merge branch 'master' into o11y-refactor-2
angelinalg May 16, 2023
8ea2d44
move content to new page for config and manage dashboard
angelinalg May 16, 2023
529187f
populating configure dashboard doc and moving to clusters section
angelinalg May 16, 2023
f18b2b8
forgot to save changes
angelinalg May 16, 2023
cacd619
change title name on side nav
angelinalg May 16, 2023
794130f
change title name on side nav
angelinalg May 16, 2023
ce42aba
changing headers and titles to gerunds for consistency
angelinalg May 16, 2023
32618ab
remove overview, rename dashboard page to getting started
angelinalg May 16, 2023
1448b4d
fixed file location to move up a level
angelinalg May 16, 2023
f19deaf
fixed titles
angelinalg May 16, 2023
408bc0f
another iteration of titles to fit side nav better
angelinalg May 17, 2023
0af82b9
Merge branch 'master' into o11y-refactor-2
angelinalg May 17, 2023
e78de8d
create reference subdirectory; moved content for cli GS and metrics
angelinalg May 17, 2023
6827e25
add youtube links for overview and jobs videos
angelinalg May 17, 2023
0819a37
add five youtube links; fix anchors for api and cli refs
angelinalg May 17, 2023
d5f5558
add two youtube links
angelinalg May 17, 2023
399e9b8
moving some misplaced logging content; fixed extra blank spaces after…
angelinalg May 17, 2023
4d64a1e
removed unnecessary file hierarchy
angelinalg May 17, 2023
c2cc47d
list guides in index of user guides, fixed anchors
angelinalg May 17, 2023
c29d4c2
move gotchas content to troubleshooting apps
angelinalg May 18, 2023
7929f38
revert inadvertent deletion of section
angelinalg May 18, 2023
4ae150f
change title
angelinalg May 18, 2023
fc16269
fixed indentation
angelinalg May 18, 2023
bf9c611
Merge branch 'master' into o11y-refactor-2
angelinalg May 18, 2023
3122f7e
fixing links
angelinalg May 22, 2023
b32a6b8
fixing links
angelinalg May 22, 2023
181b0cf
fixing merge conflicts
angelinalg May 22, 2023
68019c1
fixing broken test and broken note
angelinalg May 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
removed unnecessary file hierarchy 
Signed-off-by: angelinalg <[email protected]>
  • Loading branch information
@angelinalg
angelinalg committed May 17, 2023
commit 4d64a1ef4cc3284ac0733413897b0c2980bdf339
7 changes: 4 additions & 3 deletions doc/source/_toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,14 +386,15 @@ parts:
- file: cluster/faq
- file: cluster/package-overview

- file: ray-observability/monitoring-debugging/monitoring-debugging
- file: ray-observability/index
title: "Monitoring and Debugging"
sections:
- file: ray-observability/getting-started-dashboard
- file: ray-observability/getting-started
- file: ray-observability/key-concepts
- file: ray-observability/user-guides/index
title: User Guides
sections:
- file: ray-observability/user-guides/general-troubleshoot
Copy link
Contributor

Choose a reason for hiding this comment

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

What is this for?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That is the old "Gotchas" page. I think we said we would remove it, but it looked like it might be useful, so I found a place an title for it. I can easily remove it if it's not useful.

Copy link
Contributor

@scottsun94 scottsun94 May 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Got it. The content itself is useful! However, it can belong to "Troubleshoot applications" or maybe they should live in ray core or other sections...

They are more like common mistakes people are likely to make..

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let's not put it in Ray Core because users of the libraries will not know to look there. I can put it in Troubleshoot applications for now.

Copy link
Contributor

Choose a reason for hiding this comment

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

I can put it in Troubleshoot applications for now.

SG.

Let's not put it in Ray Core because users of the libraries will not know to look there.

However, we mostly use core in those examples. Not sure how useful it is for library users. We probably need to improve them and make it more relatable to library users.

- file: ray-observability/user-guides/troubleshoot-apps/index
title: Troubleshooting Applications
sections:
Expand All @@ -409,9 +410,9 @@ parts:
- file: ray-observability/reference/index
title: Reference
sections:
- file: ray-observability/reference/system-metrics
- file: ray-observability/reference/api
- file: ray-observability/reference/cli
- file: ray-observability/reference/system-metrics

- file: ray-references/api
title: References
Expand Down
7 changes: 4 additions & 3 deletions ...servability/getting-started-dashboard.rst → ...rce/ray-observability/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
.. _observability-getting-started-dashboard:
.. _observability-getting-started:

Getting Started
===============

Getting Started (Dashboard)
===========================
Ray provides a web-based dashboard for monitoring and debugging Ray applications.
The dashboard provides a visual representation of the system state, allowing users to track the performance
of their applications and troubleshoot issues.
Expand Down
8 changes: 8 additions & 0 deletions doc/source/ray-observability/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _observability:

Monitoring and Debugging
========================

This section covers how to **monitor and debug Ray applications and clusters**.


60 changes: 0 additions & 60 deletions doc/source/ray-observability/monitoring-debugging/getting-help.rst
View file
Open in desktop

This file was deleted.

17 changes: 0 additions & 17 deletions doc/source/ray-observability/monitoring-debugging/monitoring-debugging.rst
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions doc/source/ray-observability/reference/cli.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _state-api-cli-ref:

Ray State CLI
=============
State CLI
=========

State
-----
Expand Down
3 changes: 2 additions & 1 deletion doc/source/ray-observability/reference/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ Monitor and debug your Ray applications and clusters using the API and CLI docum

The guides include:
* {ref}`state-api-ref`
* {ref}`state-api-cli-ref`
* {ref}`state-api-cli-ref`
* {ref}`system-metrics`
6 changes: 3 additions & 3 deletions ...vability/monitoring-debugging/gotchas.rst → ...lity/user-guides/general-troubleshoot.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _gotchas:
.. _observability-troubleshoot-general:

Ray Gotchas
===========
General Troubleshooting
=======================

Ray sometimes has some aspects of its behavior that might catch
users off guard. There may be sound arguments for these design choices.
Expand Down
Loading