rookout / docs Goto Github PK

The setup guide page has a section on Data On-Prem which has a broken link in its "visit this page" which goes to https://docs.rookout.com/docs/setup-guide/dop-intro.md, but that gets a 404, and I couldn't find any page at all that was like this (which is why I am not offering this as a PR).

I suppose I could offer a PR that simply removed it, but instead I'll offer it here as an issue for your consideration, about whether to remove the link or correct it.

I've been searching for the last half-hour for documentation on the "Agile Flame Graphs" feature, mentioned in various places:

The Rookout live-debugger info page: https://www.rookout.com/solutions/live-debugger

Real Time Profiling
Leverage agile flame graphs to measure the execution time of any function or code snippet without worrying about performance hits

An article on Global News Wire: https://www.globenewswire.com/news-release/2021/03/23/2197886/0/en/Rookout-Launches-Agile-Flame-Graphs-to-Dynamically-Profile-Distributed-Applications-in-Production.html

“Until today, developers were blind to the performance of this code in production environments, due to the significant performance overhead of profiling tools,” said Liran Haimovitch, CTO and Co-Founder of Rookout. “Agile Flame Graphs allows software engineers to select a section of code and instantly visualize the latency between functions and individual lines of code, within and across distributed systems.” [...]

“Nobody profiles code anymore because traditional tools have too much overhead to use in production and local environments don’t match the reality of scale,” said Patrick Lightbody, Co-founder of Reclaim.ai, Former SVP of Product at New Relic. “Rookout's Agile Flame Graphs give us the ability to instantly collect ad-hoc performance metrics from any line of code which is critical when dealing with live incidents.”

An article on vmblog.com: https://vmblog.com/archive/2021/03/22/vmblog-expert-interview-shahar-fogel-of-rookout-talks-modern-debugging-understandability-and-agile-flame-graphs.aspx

VMblog: You have a new product that looks great called Agile Flame Graphs. Can you tell the readers a little more about it and how it helps developers better understand their applications?

Fogel: Flame graphs are the type of graph you expect to see when tackling the complex challenge of profiling an application, in an attempt to find performance bottlenecks and identify the areas in your code that cause high latency, or the "hot spots" that get hit so frequently that they just get stuck, and cause a poor user experience and even crashes.

The purpose of the flame graph is to show you a color-coded breakdown of the time spent in different areas of your code. Traditional tools for profiling applications are too resource intensive to use broadly in production without a significant negative impact on application performance. They also come with a lot of noise, and can only really be operated effectively by operations experts. We wanted to simplify the traditional flame graph to just the most necessary information, so that it could be visualized easily and it didn't create a ton of overhead, while giving engineers the most precise information and metrics related to the performance of their application and code-base.

Yet I can't find anything in the Rookout documentation showing how to utilize the feature! (I've searched for "flame" in this repo, and the NodeJS tutorial repo, and got zero results)

I also tried looking for the feature in the NodeJS demo here: https://app.rookout.com/org/Sandbox/debugger

But I couldn't see any way to add profiling points, or to display the Flame Graph interface shown in the screenshot above.

I'm opening the issue here, since the repo for rookout npm module is private.

The behavior for rookout.startSync is problematic. To use it I need deasync installed, but it doesn't appear in the package.json deps - I'm working in an environment that doesn't allow requireing deps that aren't declared.

Could you add deasync to the project deps? Or maybe return a promise from rookout.start that will resolve only after initialization is over? I'm guessing there's a reason you're using deasync, but I just want to make sure you considered this...

Code blocks use Roboto instead of a monospaced font

Rename with prefix (agent-, rook-, node-***)
Add headers (title, id, etc..) of Docusaurus

#376

Originally posted by @noagoldman in #376 (comment)