[APM] Improve debug output

[sorenlouv]

• Ensure that ES query can easily be copy/pasted into Dev Tools
• Improve readability with formatting 🎨
• Add debugging to all ES endpoints (not just search!)

Highlight errors

Debugging for non-search requests

[elasticmachine]

Pinging @elastic/apm-ui (Team:apm)

[kibanamachine]

💚 Build Succeeded

• continuous-integration/kibana-ci/pull-request
• Commit: f96cf7b

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

[smith]

This works great and looks very nice.

I think we should be using the built-in logger provided on the server context instead of console.log.

[sorenlouv]

I think we should be using the built-in logger provided on the server context instead of console.log.

I agree. I think we use console.log a bunch of places where we should be using context.logger.info.
In this cause I think we should do an exception though. The built-in logger will append a bunch of information, which will make the output a lot less clean and much harder to copy/paste:

[smith]

In this cause I think we should do an exception though. The built-in logger will append a bunch of information, which will make the output a lot less clean and much harder to copy/paste

I agree that it's easier to copy/paste, but I disagree that we should make an exception, unless there's agreement from the platform team.

Most terminals also support rectangular selection. In VSCode's I can hold option.

[sorenlouv]

Most terminals also support rectangular selection. In VSCode's I can hold option.

How will that help in the above case where it's not a rectangle?

I disagree that we should make an exception, unless there's agreement from the platform team.

I agree it makes sense for actual logging to use the official logger. But in this case we don't care about logging as such - we want to output something to stdout for debugging purposes.

[dgieselaar]

I'll +1 the current approach, given that this is a debugging feature not intended for users, and is explicitly opt-in, I can't quite see the benefit of using the platform logger, and there are clear cons (AFAICT).

[smith]

I agree it makes sense for actual logging to use the official logger. But in this case we don't care about logging as such - we want to output something to stdout for debugging purposes.

I still disagree, but not strongly enough to block merging this.

[sorenlouv]

@dgieselaar and I had a discussion earlier whether we should send the debug info to the client. This would make it much easier for users who don't have access to Kibana logs - but could also pose security threats.

@smith WDYT about that idea?

[smith]

@smith WDYT about that idea?

I like it, since half the time I turn the debug mode on and am confused when there's nothing in my devtools console. As long as it doesn't make the code too complicated. I'd rather have the hassle of having to look in kibana logs than adding unneeded complexity to our code base.

[sorenlouv]

Okay, I'm merging this now, and then we can look into sending it to the client in a follow-up.