A few final logging touch-ups #4388

jtcohen6 · 2021-12-02T11:34:30Z

Pick up from things I noticed in #4293. These are tiny non-functional / cosmetic changes only:

Remove two unused events (they were removed in Parser no longer takes greedy. Accepts indirect selection, a bool. #4104)
More structured ConcurrencyLine
Instead of starting or ending messages with \n, precede/follow them with EmptyLine() events. Note: The legacy logger used to wrap these in with TextOnly(), in order to avoid writing them to JSON-formatted logs. I don't care too much about the legacy logger, but I bet we could do something very simple to achieve the same behavior with the new event logger, that is, avoid firing EmptyLine() events when JSON formatting is enabled.

Checklist

I have signed the CLA
I have run this code in development and it appears to resolve the stated issue
~~This PR includes tests, or tests are not required/relevant for this PR~~
~~I have updated the CHANGELOG.md and added information about my change~~ — centralizing in Changelog entries for rc3 -> final #4389

emmyoop

Just a couple more cleanup spots.

emmyoop · 2021-12-02T15:23:48Z

core/dbt/task/runnable.py

-            warn_or_error("\nWARNING: Nothing to do. Try checking your model "
+            with TextOnly():
+                fire_event(EmptyLine())
+            warn_or_error("WARNING: Nothing to do. Try checking your model "


Take out the "WARNING" text too since we want to remove that duplication.

We're no longer including the log level in the CLI output (since #4379), so it's not as duplicative as it used to be. But I can sub this out to use ui.warning_tag, so at least the logic is consistent/centralized

I realize I changed warning_tag to do nothing! Let me change it to do something again

I'm thinking we could use these for deprecation warnings too, just to give them a little colorful pop like the others:

@emmyoop let me know if you hate it!

emmyoop · 2021-12-02T15:27:49Z

core/dbt/events/types.py

@@ -863,7 +829,7 @@ class InvalidVarsYAML(ErrorLevel, Cli, File):
    code: str = "A008"

    def message(self) -> str:
-        return "The YAML provided in the --vars argument is not valid.\n"
+        return "The YAML provided in the --vars argument is not valid."


 # TODO: Remove? (appears to be uncalled)


Can we remove these too?

This highlighted wrong. I'm referring to HandleInternalException, CatchRunException, DetailsHandleGenericException

yep can do!

also removing MessageHandleGenericException, since it doesn't have a code and appears to be uncalled

nathaniel-may · 2021-12-02T16:01:25Z

... avoid firing EmptyLine() events when JSON formatting is enabled.

yup. we really should do this.

jtcohen6 · 2021-12-02T17:31:04Z

... avoid firing EmptyLine() events when JSON formatting is enabled.

yup. we really should do this.

@nathaniel-may I did a very simple, very janky version of this in ~~a8ecaf5~~ a9cbdc8. Let me know if you hate it and I'll happily revert it.

I imagine the better approach would be to implement JSON + Text base types. FWIW I checked through all instances of TextOnly(), and EmptyLine is the only event that ever applies, so I don't feel too bad about making it a special case for now.

emmyoop · 2021-12-02T20:23:20Z

core/dbt/deprecations.py

@@ -62,7 +62,7 @@ class PackageInstallPathDeprecation(DBTDeprecation):

 class ConfigPathDeprecation(DBTDeprecation):
    _description = '''\
-    The `{deprecated_path}` config has been deprecated in favor of `{exp_path}`.
+    The `{deprecated_path}` config has been renamed to `{exp_path}`.


Love the wording updates.

* Rm unused events, per #4104 * More structured ConcurrencyLine * Replace \n prefixes with EmptyLine * Reimplement ui.warning_tag to centralize logic * Use warning_tag for deprecations too * Rm more unused event types * Exclude EmptyLine from json logs * loglines are not always created by events (#4406) Co-authored-by: Nathaniel May <nathaniel.may@fishtownanalytics.com>

* A few final logging touch-ups (#4388) * Rm unused events, per #4104 * More structured ConcurrencyLine * Replace \n prefixes with EmptyLine * Reimplement ui.warning_tag to centralize logic * Use warning_tag for deprecations too * Rm more unused event types * Exclude EmptyLine from json logs * loglines are not always created by events (#4406) Co-authored-by: Nathaniel May <nathaniel.may@fishtownanalytics.com> * Rollover + backup for dbt.log (#4405) Co-authored-by: Nathaniel May <nathaniel.may@fishtownanalytics.com>

* Rm unused events, per #4104 * More structured ConcurrencyLine * Replace \n prefixes with EmptyLine * Reimplement ui.warning_tag to centralize logic * Use warning_tag for deprecations too * Rm more unused event types * Exclude EmptyLine from json logs * loglines are not always created by events (#4406) Co-authored-by: Nathaniel May <nathaniel.may@fishtownanalytics.com> automatic commit by git-black, original commits: 8bdaa69 b90ab74

* Rm unused events, per #4104 * More structured ConcurrencyLine * Replace \n prefixes with EmptyLine * Reimplement ui.warning_tag to centralize logic * Use warning_tag for deprecations too * Rm more unused event types * Exclude EmptyLine from json logs * loglines are not always created by events (#4406) Co-authored-by: Nathaniel May <nathaniel.may@fishtownanalytics.com> automatic commit by git-black, original commits: b90ab74

cla-bot bot added the cla:yes label Dec 2, 2021

jtcohen6 mentioned this pull request Dec 2, 2021

Misc logging cleanup + commentary #4293

Closed

4 tasks

jtcohen6 force-pushed the jerco/final-logging-touchups branch 2 times, most recently from e7c11a2 to 137ba88 Compare December 2, 2021 11:53

jtcohen6 requested review from emmyoop and nathaniel-may and removed request for emmyoop December 2, 2021 12:13

emmyoop requested changes Dec 2, 2021

View reviewed changes

jtcohen6 force-pushed the jerco/final-logging-touchups branch from 137ba88 to a8ecaf5 Compare December 2, 2021 17:28

jtcohen6 force-pushed the jerco/final-logging-touchups branch from a8ecaf5 to d9ae93b Compare December 2, 2021 17:53

jtcohen6 added 7 commits December 2, 2021 21:07

Rm unused events, per #4104

494aa0f

More structured ConcurrencyLine

744748f

Replace \n prefixes with EmptyLine

f477cd9

Reimplement ui.warning_tag to centralize logic

50cda90

Use warning_tag for deprecations too

c9a267e

Rm more unused event types

6e14d05

Exclude EmptyLine from json logs

a9cbdc8

jtcohen6 force-pushed the jerco/final-logging-touchups branch from d9ae93b to a9cbdc8 Compare December 2, 2021 20:13

jtcohen6 requested a review from emmyoop December 2, 2021 20:13

jtcohen6 mentioned this pull request Dec 2, 2021

Structured Logging Phase 2 #4260

Closed

26 tasks

emmyoop approved these changes Dec 2, 2021

View reviewed changes

loglines are not always created by events (#4406)

ba1dd7b

jtcohen6 merged commit b90ab74 into main Dec 2, 2021

jtcohen6 deleted the jerco/final-logging-touchups branch December 2, 2021 21:09

jtcohen6 mentioned this pull request Dec 2, 2021

[Backport] #4388 + #4405 #4408

Merged

aranke mentioned this pull request May 20, 2024

[Backport 1.0.latest] Fix #9907: Add retry to tox to reduce flaky tests due to network failures #10178

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

A few final logging touch-ups #4388

A few final logging touch-ups #4388

jtcohen6 commented Dec 2, 2021 •

edited

Loading

emmyoop left a comment

emmyoop Dec 2, 2021

jtcohen6 Dec 2, 2021 •

edited

Loading

jtcohen6 Dec 2, 2021

jtcohen6 Dec 2, 2021

jtcohen6 Dec 2, 2021

emmyoop Dec 2, 2021

emmyoop Dec 2, 2021

jtcohen6 Dec 2, 2021

jtcohen6 Dec 2, 2021

nathaniel-may commented Dec 2, 2021 •

edited

Loading

jtcohen6 commented Dec 2, 2021 •

edited

Loading

emmyoop Dec 2, 2021

A few final logging touch-ups #4388

A few final logging touch-ups #4388

Conversation

jtcohen6 commented Dec 2, 2021 • edited Loading

Checklist

emmyoop left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jtcohen6 Dec 2, 2021 • 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

nathaniel-may commented Dec 2, 2021 • edited Loading

jtcohen6 commented Dec 2, 2021 • edited Loading

Choose a reason for hiding this comment

jtcohen6 commented Dec 2, 2021 •

edited

Loading

jtcohen6 Dec 2, 2021 •

edited

Loading

nathaniel-may commented Dec 2, 2021 •

edited

Loading

jtcohen6 commented Dec 2, 2021 •

edited

Loading