Set get frames public #41

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

Jump to bottom

Open

ldreux wants to merge 1 commit into joomcode:master

from ldreux:master

Open

Set get frames public #41

ldreux wants to merge 1 commit into joomcode:master from ldreux:master

+20 −6

Conversation

@ldreux

Copy link

@ldreux ldreux commented Jan 21, 2023 •

edited

Loading

In our applications, we catch all errors in our webservices and our batches and create sentry issues with the errorx stacktrace.

errxFrames := errx.GetFrames()
framesLen := len(errxFrames)
sentryFrames := make([]sentry.Frame, framesLen)
for i, errxFrame := range errxFrames {
	sentryFrames[framesLen-i-1] = convertFrame(errxFrame)
}
func convertFrame(frame errorx.Frame) sentry.Frame {
	return sentry.Frame{
		Filename: frame.File(),
		Function: frame.Function(),
		Lineno: frame.Line(),
	}
}

PeterIvanov

PeterIvanov requested changes

Jan 23, 2023

View reviewed changes

Copy link

Collaborator

@PeterIvanov PeterIvanov left a comment

Choose a reason for hiding this comment

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

This PR requires a description.
The first thing to know here is a use case. I'm fairly sure that it's better to provide utilities for it, if it's a valid case, rather than exposing some internals from errorx.

stacktrace.go Outdated Show resolved Hide resolved

error.go Outdated Show resolved Hide resolved

@ldreux ldreux force-pushed the master branch from 540884d to 217efed Compare

July 11, 2023 08:06

@ldreux


 Set get frames public

23be470

@ldreux ldreux force-pushed the master branch from 217efed to 23be470 Compare

July 11, 2023 08:07

@ldreux ldreux requested a review from PeterIvanov

July 11, 2023 08:15

@PeterIvanov

Copy link

Collaborator

PeterIvanov commented Jul 11, 2023

Maybe we adopt this exact use case?
Instead of API focused on just exposing stack frames, make an api for conversion. This would highlight that you don't need to extract this information as-is, but if you need to feed it to some system with custom stack frames format, you can.
Such conversion API can also be based on interface for errorx frame, not the actual representation, as an added bonus.
What's your view on such idea?

PeterIvanov

PeterIvanov requested changes

Jul 18, 2023

View reviewed changes

Copy link

Collaborator

@PeterIvanov PeterIvanov left a comment

Choose a reason for hiding this comment

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

Pending an answer to the question above, marking this PR as Request changes for now.

@reaganiwadha

Copy link

reaganiwadha commented Jan 15, 2024

For monitoring tools like github.com/getsentry/sentry-go, it's important to expose the callstack so the error can be traced.

https://github.com/getsentry/sentry-go/blob/824589bd5be49de6242d5f867a94c7df05510a4e/stacktrace.go#L74

This is how Sentry extracts stack trace from other error libraries. While I don't think errorx should necessarily adhere to the way Sentry parses stack trace, an exposed API to get the frames from the Error should be available for custom stack trace parsing.

@reaganiwadha

Copy link

reaganiwadha commented Jan 15, 2024

Instead of API focused on just exposing stack frames, make an api for conversion. This would highlight that you don't need to extract this information as-is, but if you need to feed it to some system with custom stack frames format, you can.

Im not sure how a conversion API for call stack works, can you provide an example?

@PeterIvanov

Copy link

Collaborator

PeterIvanov commented Jan 16, 2024

As far as I can recall, the idea was that we add an API like this:

func (e *Error) ExportStackFrames(originalFrames []FrameInterface) any

This way, we:

Hint that extracting stack frames is not an intended high-level API for dealing with errors
Hide behind the interface to avoid, say, marshalling issues

@PeterIvanov

Copy link

Collaborator

PeterIvanov commented Jan 16, 2024

In this PR, the second point is already addressed, so I'm generally OK with that. Just asked for an opinion on an idea.

Labels

None yet

3 participants

@ldreux @PeterIvanov @reaganiwadha

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Set get frames public #41

Are you sure you want to change the base?

Set get frames public #41

Conversation

@ldreux ldreux commented Jan 21, 2023 •

edited

Loading

Uh oh!

Uh oh!

@PeterIvanov PeterIvanov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

PeterIvanov commented Jul 11, 2023

Uh oh!

@PeterIvanov PeterIvanov left a comment

Choose a reason for hiding this comment

Uh oh!

reaganiwadha commented Jan 15, 2024

Uh oh!

reaganiwadha commented Jan 15, 2024

Uh oh!

PeterIvanov commented Jan 16, 2024

Uh oh!

PeterIvanov commented Jan 16, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Set get frames public #41

Are you sure you want to change the base?

Set get frames public #41

Conversation

@ldreux ldreux commented Jan 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

@PeterIvanov PeterIvanov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

PeterIvanov commented Jul 11, 2023

Uh oh!

@PeterIvanov PeterIvanov left a comment

Choose a reason for hiding this comment

Uh oh!

reaganiwadha commented Jan 15, 2024

Uh oh!

reaganiwadha commented Jan 15, 2024

Uh oh!

PeterIvanov commented Jan 16, 2024

Uh oh!

PeterIvanov commented Jan 16, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

@ldreux ldreux commented Jan 21, 2023 •

edited

Loading