search

SigNoz / signoz

SigNoz is an open-source observability platform native to OpenTelemetry with logs, traces and metrics in a single application. An open-source alternative to DataDog, NewRelic, etc. 🔥 🖥. 👉 Open source Application Performance Monitoring (APM) & Observability tool
https://signoz.io
Other
18.04k stars 1.14k forks source link

Correct documentation referencing "flame graphs" to say "flame charts" #5476

Open sihil opened 1 month ago

sihil commented 1 month ago

Bug description

The documentation talks at length about flame graphs, but these are not actually implemented in SigNoz, which instead has flame charts. Whilst flame charts are still useful, claiming they are flame graphs is very confusing for users trying to figure out why their data is not being displayed as expected.

Expected behavior

The documentation should refer to 'flame charts' rather than 'flame graphs'.

How to reproduce

The distinction is that the x-axis on a flame chart is chronological, but the x-axis on a flame graph is sorted alphabetically such that repeated, but chronologically disparate, calls to functions or system components are sorted (and merged) together. Flame graphs make it very easy to understand how much time repeated but fast calls take overall.

This distinction is noted on the flame graph page at https://www.brendangregg.com/flamegraphs.html#Variations. SigNoz links to this page when talking about flame graphs but then goes on to wrongly describe what has been implemented as flame graphs.

Version information

welcome[bot] commented 1 month ago

Thanks for opening this issue. A team member should give feedback soon. In the meantime, feel free to check out the contributing guidelines.