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

Surfaces pull step errors as independent log messages #17214

Merged
merged 2 commits into from
Feb 20, 2025

Conversation

chrisguidry
Copy link
Collaborator

@chrisguidry chrisguidry commented Feb 20, 2025

In trying to increase user's visibility into any problems with
dependency installations and code pulls, we want to make sure that the
output is clear and actionable in their logs. Today, when we get a
step excution error, we are showing that as a full traceback, including
the underlying __cause__, which can be quite verbose for the
uninitiated.

Here we get the string representation of that exception message as a
separate ERROR log just before we re-raise it. This comes out in the
flow run logs as a clean error, like:

`run_shell_script` failed with error code 1: Using Python 3.12.2 environment at: /home/chris/.pyenv/versions/orion-312
  × No solution found when resolving dependencies:
  ╰─▶ Because flibbidygibbles was not found in the package registry and you
      require flibbidygibbles>=9000, we can conclude that your requirements
      are unsatisfiable.

image

In trying to increase user's visibility into any problems with
dependency installations and code pulls, we want to make sure that the
output is clear and actionable in their logs.  Today, when we get a
step excution error, we are showing that as a full traceback, including
the underlying `__cause__`, which can be quite verbose for the
uninitiated.

Here we get the string representation of that exception message as a
separate `ERROR` log just before we re-raise it.  This comes out in the
flow run logs as a clean error, like:

```
`run_shell_script` failed with error code 1: Using Python 3.12.2 environment at: /home/chris/.pyenv/versions/orion-312
  × No solution found when resolving dependencies:
  ╰─▶ Because flibbidygibbles was not found in the package registry and you
      require flibbidygibbles>=9000, we can conclude that your requirements
      are unsatisfiable.
```
Copy link
Member

@desertaxle desertaxle left a comment

Choose a reason for hiding this comment

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

flibbidygibbles is a great package name

Copy link

codspeed-hq bot commented Feb 20, 2025

CodSpeed Performance Report

Merging #17214 will not alter performance

Comparing surface-pull-step-errors-as-logs (f5370c2) with main (4d98ad1)

Summary

✅ 2 untouched benchmarks

@chrisguidry chrisguidry merged commit d73a001 into main Feb 20, 2025
46 checks passed
@chrisguidry chrisguidry deleted the surface-pull-step-errors-as-logs branch February 20, 2025 18:19
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.

4 participants