elastic/kibana

[APM] JSON formatting for database spans

Open

#107,751 opened on Aug 5, 2021

View on GitHub
 (10 comments) (0 reactions) (0 assignees)TypeScript (19,065 stars) (8,021 forks)batch import
Team:obs-ux-infra_services - DEPRECATEDenhancementgood first issuestale

Description

Related https://github.com/elastic/apm-agent-nodejs/issues/2019

We show queries for spans with type db, but if it's not SQL it just renders this text field:

image

Figure out if we can determine if the query language is JSON, and give it pretty formatting and highlighting in these cases.

Contributor guide

Tech stack
typescriptreact
Domain
frontendobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basic frontend knowledgeunderstanding of JSON
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the related issue https://github.com/elastic/apm agent nodejs/issues/2019 for context on how database spans are currently handled. Locate the frontend code in the Kibana repository that renders database span details, likely in the APM plugin. The goal is to detect if the query content is JSON and apply pretty formatting with syntax highlighting. Look for existing components that handle SQL formatting to reuse patterns. Check comments in the issue for any proposed approaches or blockers.