docs: add log signal release note and update docs #10126

jgongd · 2024-10-25T01:47:43Z

Ticket

MD-531

Description

Log signal release note
Update log signal doc

Test Plan

Checklist

Changes have been manually QA'd
New features have been approved by the corresponding PM
User-facing API changes have the "User-facing API Change" label
Release notes have been added as a separate file under docs/release-notes/
See Release Note for details.
Licenses have been included for new code which was copied and/or modified from any external code

netlify · 2024-10-25T01:48:00Z

✅ Deploy Preview for determined-ui canceled.

Name	Link
🔨 Latest commit	`72b9281`
🔍 Latest deploy log	https://app.netlify.com/sites/determined-ui/deploys/671bd6b9be35d800088b97e5

rb-determined-ai · 2024-10-25T15:25:04Z

docs/release-notes/log-signal.rst

+   It has a new format. ``name`` is required. ``pattern`` and ``action`` are optional. To make
+   things simpler, user no longer needs to specify the ``type`` field to set an action. For example:


It has a new format. name is required, and action should be a plain string. See for more details.

Then skip the rest of the text.

The release note should be a brief note and interested users should go to the main docs.

rb-determined-ai · 2024-10-25T15:25:43Z

docs/reference/experiment-config-reference.rst


-  ``pattern``: Required. The regex pattern to match in the logs.
+-  ``pattern``: Optional. The regex pattern to match in the logs.


It's worth explaining why pattern would ever not be provided.

jgongd · 2024-10-25T15:49:51Z

docs/tutorials/log-management.rst

@@ -40,10 +40,9 @@ Example configuration:
 .. code:: yaml

   log_policies:


I think the log signal feature is a visual cue to the original fault tolerant project(exclude_node or cancel_retires when there are serious errors). The main goal is to make it easier for users to know whether a log policy has executed without reading the log.

log_policies is good at:

log_policies: - name: "Encountered Serious Error" pattern: ".*serious error.*" action: cancel_retires

We might not want to steer users toward doing something like below, since the backend and WebUI weren't really designed for this use case:

log_policies: - name: "stringA appears in the log" pattern: ".*stringA.*" - name: "stringB appears in the log" pattern: ".*stringB.*"

tara-hpe · 2024-10-25T16:20:47Z

docs/reference/experiment-config-reference.rst

@@ -308,10 +308,11 @@ Optional. Defines actions and labels in response to trial logs matching specifie
 language syntax). For more information about the syntax, you can visit this `RE2 reference page
 <https://github.com/google/re2/wiki/Syntax>`__. Each log policy can have the following fields:

-  ``name``: Optional. A name for the log policy. If provided, this name will be displayed as a
-   label in the UI when the log policy matches.
+-  ``name``: Required. A name for the log policy. This name will be displayed as a label in the UI


Suggested change

- ``name``: Required. A name for the log policy. This name will be displayed as a label in the UI

- ``name``: Required. The name of the log policy, displayed as a label in the WebUI

tara-hpe · 2024-10-25T16:21:12Z

docs/reference/experiment-config-reference.rst

-  ``name``: Optional. A name for the log policy. If provided, this name will be displayed as a
-   label in the UI when the log policy matches.
+-  ``name``: Required. A name for the log policy. This name will be displayed as a label in the UI
+   when the log policy matches.


Suggested change

when the log policy matches.

when a log match occurs.

tara-hpe · 2024-10-25T16:22:45Z

docs/reference/experiment-config-reference.rst


-  ``pattern``: Required. The regex pattern to match in the logs.
+-  ``pattern``: Optional. It is required to provide a regex pattern to match in the logs unless the


Suggested change

- ``pattern``: Optional. It is required to provide a regex pattern to match in the logs unless the

- ``pattern``: Optional. Defines a regex pattern to match log entries. If not specified, this policy is disabled.

tara-hpe · 2024-10-25T16:22:56Z

docs/reference/experiment-config-reference.rst


-  ``pattern``: Required. The regex pattern to match in the logs.
+-  ``pattern``: Optional. It is required to provide a regex pattern to match in the logs unless the
+   intention is to disable an existing policy.


Suggested change

intention is to disable an existing policy.

tara-hpe · 2024-10-25T16:24:02Z

docs/reference/experiment-config-reference.rst

+       pattern: ".*CUDA out of memory.*"
+       action: cancel_retries
+
+When a log policy matches, its name will be displayed as a label in the WebUI, allowing for easy


Suggested change

When a log policy matches, its name will be displayed as a label in the WebUI, allowing for easy

When a log policy matches, its name appears as a label in the WebUI, making it easy

tara-hpe · 2024-10-25T16:25:40Z

docs/reference/experiment-config-reference.rst

+       action: cancel_retries
+
+When a log policy matches, its name will be displayed as a label in the WebUI, allowing for easy
+identification of specific issues during a run. These labels will appear in both the run table and


Suggested change

identification of specific issues during a run. These labels will appear in both the run table and

to identify specific issues during a run. These labels are shown in both the run table and

tara-hpe · 2024-10-25T16:35:54Z

docs/release-notes/log-signal.rst

+
+**New Features**
+
+-  Experiments: ``log_policies`` now have a ``name`` field. When a log policy matches, its name will


Suggested change

- Experiments: ``log_policies`` now have a ``name`` field. When a log policy matches, its name will

- Experiments: Add a ``name`` field to ``log_policies``. When a log policy matches, its name

tara-hpe · 2024-10-25T16:36:49Z

docs/release-notes/log-signal.rst

+**New Features**
+
+-  Experiments: ``log_policies`` now have a ``name`` field. When a log policy matches, its name will
+   be displayed as a label in the WebUI, allowing for easy identification of specific issues during


Suggested change

be displayed as a label in the WebUI, allowing for easy identification of specific issues during

shows as a label in the WebUI, making it easy to spot specific issues during

tara-hpe · 2024-10-25T16:37:48Z

docs/release-notes/log-signal.rst

+
+-  Experiments: ``log_policies`` now have a ``name`` field. When a log policy matches, its name will
+   be displayed as a label in the WebUI, allowing for easy identification of specific issues during
+   a run. These labels will appear in both the run table and run detail views.


Suggested change

a run. These labels will appear in both the run table and run detail views.

a run. Labels appear in both the run table and run detail views.

tara-hpe · 2024-10-25T16:39:41Z

docs/release-notes/log-signal.rst

+   be displayed as a label in the WebUI, allowing for easy identification of specific issues during
+   a run. These labels will appear in both the run table and run detail views.
+
+   It has a new format. ``name`` is required, and ``action`` should be a plain string. For more


Suggested change

It has a new format. ``name`` is required, and ``action`` should be a plain string. For more

In addition, there is a new format: ``name`` is required, and ``action`` is now a plain string. For more

tara-hpe

suggested edits

cla-bot bot added the cla-signed label Oct 25, 2024

determined-ci requested a review from a team October 25, 2024 01:47

determined-ci added the documentation Improvements or additions to documentation label Oct 25, 2024

jgongd requested review from gt2345 and removed request for a team October 25, 2024 01:47

jgongd requested review from rb-determined-ai and tara-hpe October 25, 2024 01:48

rb-determined-ai reviewed Oct 25, 2024

View reviewed changes

jgongd added 2 commits October 25, 2024 11:30

add log signal release note and update docs

3093f7a

Address comments

79a371f

jgongd force-pushed the jgong/doc/log-signal-release-note branch from 586588f to 79a371f Compare October 25, 2024 15:38

determined-ci requested a review from a team October 25, 2024 15:38

debate between required and optional

8c51b01

jgongd commented Oct 25, 2024

View reviewed changes

tara-hpe reviewed Oct 25, 2024

View reviewed changes

tara-hpe approved these changes Oct 25, 2024

View reviewed changes

Address comment

94a0023

determined-ci requested a review from a team October 25, 2024 17:00

update log management tutorial

0cae196

jgongd added 2 commits October 25, 2024 13:30

fmt

a5244c4

more comments

72b9281

jgongd merged commit c7e0fb5 into main Oct 25, 2024
79 of 91 checks passed

jgongd deleted the jgong/doc/log-signal-release-note branch October 25, 2024 17:58

thiagodallacqua-hpe pushed a commit that referenced this pull request Oct 28, 2024

docs: add log signal release note and update docs (#10126)

63c5e3d

thiagodallacqua-hpe pushed a commit that referenced this pull request Oct 28, 2024

docs: add log signal release note and update docs (#10126)

329450e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add log signal release note and update docs #10126

docs: add log signal release note and update docs #10126

jgongd commented Oct 25, 2024 •

edited by jira bot

Loading

netlify bot commented Oct 25, 2024 •

edited

Loading

rb-determined-ai Oct 25, 2024

rb-determined-ai Oct 25, 2024

jgongd Oct 25, 2024

tara-hpe Oct 25, 2024 •

edited

Loading

tara-hpe Oct 25, 2024

tara-hpe Oct 25, 2024

tara-hpe Oct 25, 2024

tara-hpe Oct 25, 2024

tara-hpe Oct 25, 2024

tara-hpe Oct 25, 2024

tara-hpe Oct 25, 2024

tara-hpe Oct 25, 2024

tara-hpe Oct 25, 2024 •

edited

Loading

tara-hpe left a comment

		It has a new format. ``name`` is required. ``pattern`` and ``action`` are optional. To make
		things simpler, user no longer needs to specify the ``type`` field to set an action. For example:


		- ``pattern``: Required. The regex pattern to match in the logs.
		- ``pattern``: Optional. The regex pattern to match in the logs.

		@@ -40,10 +40,9 @@ Example configuration:
		.. code:: yaml

		log_policies:

	- ``name``: Required. A name for the log policy. This name will be displayed as a label in the UI
	- ``name``: Required. The name of the log policy, displayed as a label in the WebUI


		- ``pattern``: Required. The regex pattern to match in the logs.
		- ``pattern``: Optional. It is required to provide a regex pattern to match in the logs unless the

	- ``pattern``: Optional. It is required to provide a regex pattern to match in the logs unless the
	- ``pattern``: Optional. Defines a regex pattern to match log entries. If not specified, this policy is disabled.

	When a log policy matches, its name will be displayed as a label in the WebUI, allowing for easy
	When a log policy matches, its name appears as a label in the WebUI, making it easy

	identification of specific issues during a run. These labels will appear in both the run table and
	to identify specific issues during a run. These labels are shown in both the run table and


		New Features

		- Experiments: ``log_policies`` now have a ``name`` field. When a log policy matches, its name will

	- Experiments: ``log_policies`` now have a ``name`` field. When a log policy matches, its name will
	- Experiments: Add a ``name`` field to ``log_policies``. When a log policy matches, its name

	be displayed as a label in the WebUI, allowing for easy identification of specific issues during
	shows as a label in the WebUI, making it easy to spot specific issues during

	a run. These labels will appear in both the run table and run detail views.
	a run. Labels appear in both the run table and run detail views.

	It has a new format. ``name`` is required, and ``action`` should be a plain string. For more
	In addition, there is a new format: ``name`` is required, and ``action`` is now a plain string. For more

docs: add log signal release note and update docs #10126

docs: add log signal release note and update docs #10126

Conversation

jgongd commented Oct 25, 2024 • edited by jira bot Loading

Ticket

Description

Test Plan

Checklist

netlify bot commented Oct 25, 2024 • edited Loading

✅ Deploy Preview for determined-ui canceled.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tara-hpe Oct 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tara-hpe Oct 25, 2024 • edited Loading

Choose a reason for hiding this comment

tara-hpe left a comment

Choose a reason for hiding this comment

jgongd commented Oct 25, 2024 •

edited by jira bot

Loading

netlify bot commented Oct 25, 2024 •

edited

Loading

tara-hpe Oct 25, 2024 •

edited

Loading

tara-hpe Oct 25, 2024 •

edited

Loading