Add resource ID to 404 response body

[colings86]

It would be very useful to be able to easily extract the id of the resource thats not found from the body of a 404 request. I believe this would involve adding the ID to ResourceNotFoundException.

[elasticmachine]

Pinging @elastic/es-core-infra (Team:Core/Infra)

[rjernst]

We discussed this a few weeks weeks back, and do not object to adding a separate resource id member to ResourceNotFoundException. However, there are over 100 places in the Elasticsearch codebase that construct this exception. A meta issue would need to be created to work through each of these. It's not difficult work, but can be time consuming. At this time, we don't see this work as a priority, so I've marked this issue with help wanted.

[sanjeev0210]

Hello @rjernst can you let me know what do you mean by creating a meta issue. I'm interested in picking this up so I would like to know about it.

[grcevski]

Hi @sanjeev0210,

Meta issue means opening an issue to track the work that needs to be completed, broken down into multiple separate steps based on the discovery work that has been done. We probably don't need 100 different steps, they should be logically grouped around the code they are modifying.

Here are some examples:

#81820
#78744
#89183

[sanjeev0210]

Thank you for your help @grcevski , I'll look into this and will let you know once I'm ready to pick this ticket

[sanjeev0210]

Hello @grcevski @rjernst, Can you please point me to the right direction to prepare for this issue. It would be helpful if you can provide me appropriate docs to start looking into

[rjernst]

@sanjeev0210 You won't find any docs on this issue. Instead, you would need start being looking at all places in the Elasticsearch codebase which construct ResourceNotFoundException. A list of these locations (say by package or module) would then need to be made and written into a meta issue. Once that is complete, an alternate constructor could be created which takes the resource id, and deprecates the existing constructor. Then all devs could work through each deprecated constructor call to find the appropriate resource id and call the new constructor.

[chrisssCurry]

Hello @colings86 @rjernst - is this still needed? I would like to help if so.

an alternate constructor could be created which takes the resource id

In some places, I've seen this error being thrown when there's multiple resources (thus multiple ids) that could not be found. In this case should the 'id' member be a List/Set of multiple ids instead?

[barry800414]

Hi @rjernst ,
I would like to clarify a little bit more. There are at least 195 places constructing ResourceNotFoundException instance in codebase. I am think probably we don't need to update all of them for adding resource id. Maybe we only need to add resource id for client facing part (e.g. REST API), since the original request is for debugging purpose and is to ask to attach it in response. Is my direction acceptable ?

Besides, I have the same question as @chrisssCurry . In many errors, there are multiple resource ids involving in.
I am thinking better not to return all of them in response, because it could potentially cause too large response body.
How about let us focus on the error with only one resource id involved ?

If both direction is acceptable, @chrisssCurry are you willing to do this issue together ?