ruby-grape / ruby-grape/grape

Inconsistent instrumentation semantics

Open
#1,496 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug?
Dominant language
Ruby
Stars
10k
Forks
1.2k
Avg merge
14h 38m
Merged PRs (30d)
92

Description

Hi,

I'd like to point out, and ask, what's the expected behavior when an exception is thrown in a Grape endpoint, towards instrumentation (via AS:N).

When I want to instrument Grape, I subscribe to this notification:

https://github.com/ruby-grape/grape/blob/master/lib/grape/endpoint.rb#L238

What I'm experiencing right now is that endpoint.status is always 200 (as opposed to 500 or default_error), even when an exception was raised in that endpoint.

When an exception is raised, I guess this blows up:

https://github.com/ruby-grape/grape/blob/master/lib/grape/endpoint.rb#L264

But then what happens with the instrumentation block?

When explicitly stating an error inside an endpoint, it works (status code is 500).
In a rescue_all block, or while an endpoint throws it doesn't work (status code is either stale, wasn't set, and is just 200)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in lib/grape/endpoint.rb at the instrumentation notification near line 238 and the exception path near line 264. Reproduce explicit errors, rescue_all handling, and uncaught endpoint exceptions, then compare the reported status values; done means the instrumentation semantics are confirmed and status reporting is consistent across these paths.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api, observability
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.