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

Observability docs for Launch #550

Merged
merged 7 commits into from
Jan 10, 2024
Merged

Observability docs for Launch #550

merged 7 commits into from
Jan 10, 2024

Conversation

tristan-spaulding2
Copy link
Contributor

Description

What does the pull request do? If it fixes a bug or resolves a feature request, be sure to link to that issue.

Ticket

Does this PR fix an existing issue? If yes, provide a link to the ticket here:

Checklist

Check if your PR fulfills the following requirements. Put an X in the boxes that apply.

  • Files I edited were previewed on my local development server with yarn start. My changes did not break the local preview.
  • Build (yarn docusaurus build) was run locally and successfully without errors or warnings.
  • I merged the latest changes from main into my feature branch before submitting this PR.

:::info
To turn on this capability, toggle on the `Launch observability` feature flag in your user settings.

This feature requires W&B Weave, which is not available on some Customer-managed and Dedicated Cloud. Contact your W&B representative to learn more.
Copy link
Member

Choose a reason for hiding this comment

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

The dashboard requires Weave 1 in particular, not sure if thats relevant. And must be turned on in user settings in SaS


## Dashboard and plots

Each queue now has a `Monitor` tab. When you click on the tab, W&B will gather data over the last 7 days of activity for this queue. Time ranges, grouping and filters can be controlled from the left panel.
Copy link
Member

Choose a reason for hiding this comment

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

Data gathering is technically independent, maybe "gather" -> "display"

docs/guides/launch/launch-queue-observability.md Outdated Show resolved Hide resolved

![](/images/launch/launch_obs_queuedtime.png)

This plot shows, for every time period, the amount of time in minutes that jobs were queued. For example, if there were 10 jobs queued in that period, waiting for an average of 30 minutes each, the plot would show 300 minutes.
Copy link
Member

Choose a reason for hiding this comment

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

this is currently in seconds, but we can change that if you think jobs are going to sit in queued for a long time...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I would actually update it to minutes in the product... things will be queued for a while...I will doc it as seconds here though.

Copy link
Contributor

Choose a reason for hiding this comment

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

QQ: In my revision, I mentioned seconds. Is this still correct.

PS It'd be nice to have the units on plots...


This plot shows the start and end of every job executed in a time period, with distinct colors for each run. This makes it easy to see at a glance what workloads the queue was processing at a given time.

Use the Select tool in the bottom right of the panel to brush over jobs to see more details in the table below.
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
Use the Select tool in the bottom right of the panel to brush over jobs to see more details in the table below.
Use the Select tool in the bottom right of the panel to brush over jobs to populate the table below.

Copy link
Contributor

@ngrayluna ngrayluna left a comment

Choose a reason for hiding this comment

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

Did some word smithing. Will do a follow up in the future to mention how to access this feature (post Beta).

@ngrayluna ngrayluna merged commit 8a634ed into main Jan 10, 2024
6 of 7 checks passed
@johndmulhausen johndmulhausen deleted the observability branch September 5, 2024 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants