> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-8c05c8a2.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> Агрегатная функция, строящая флеймграф по списку трассировок стека.

# flameGraph

<div id="flameGraph">
  ## flameGraph
</div>

Добавленный в: v23.8.0

Создает [флеймграф](https://www.brendangregg.com/flamegraphs.html) на основе списка трассировок стека.
Возвращает массив строк, который можно использовать в утилите [flamegraph.pl](https://github.com/brendangregg/FlameGraph) для отрисовки SVG-флеймграфа.

<Note>
  Если `ptr != 0`, flameGraph сопоставляет выделения памяти (size > 0) и освобождения памяти (size \< 0) с одинаковыми значениями size и ptr.
  Отображаются только те выделения памяти, которые не были освобождены.
  Несопоставленные освобождения памяти игнорируются.
</Note>

**Синтаксис**

```sql theme={null}
flameGraph(traces[, size[, ptr]])
```

**Аргументы**

* `traces` — Трассировка стека в виде необработанных адресов или строк с уже разрешёнными символами (например, `arrayMap(addressToSymbol, trace)`). [`Array(UInt64)`](/ru/reference/data-types/array) или [`Array(String)`](/ru/reference/data-types/array)
* `size` — Необязательно. Размер выделения памяти для профилирования памяти (по умолчанию 1). [`UInt64`](/ru/reference/data-types/int-uint)
* `ptr` — Необязательно. Адрес выделения памяти (по умолчанию 0). [`UInt64`](/ru/reference/data-types/int-uint)

**Возвращаемое значение**

Возвращает массив строк для использования с утилитой flamegraph.pl. [`Array(String)`](/ru/reference/data-types/array)

**Примеры**

**Построение флеймграфа на основе CPU-профилировщика запросов**

```sql title=Query theme={null}
SET query_profiler_cpu_time_period_ns=10000000;
SELECT SearchPhrase, COUNT(DISTINCT UserID) AS u FROM hits WHERE SearchPhrase <> '' GROUP BY SearchPhrase ORDER BY u DESC LIMIT 10;
```

```response title=Response theme={null}
clickhouse client --allow_introspection_functions=1 -q "select arrayJoin(flameGraph(arrayReverse(trace))) from system.trace_log where trace_type = 'CPU' and query_id = 'xxx'" | ~/dev/FlameGraph/flamegraph.pl  > flame_cpu.svg
```

**Построение флеймграфа на основе профилировщика запросов по памяти, отображающего все выделения памяти**

```sql title=Query theme={null}
SET memory_profiler_sample_probability=1, max_untracked_memory=1;
SELECT SearchPhrase, COUNT(DISTINCT UserID) AS u FROM hits WHERE SearchPhrase <> '' GROUP BY SearchPhrase ORDER BY u DESC LIMIT 10;
```

```response title=Response theme={null}
clickhouse client --allow_introspection_functions=1 -q "select arrayJoin(flameGraph(trace, size)) from system.trace_log where trace_type = 'MemorySample' and query_id = 'xxx'" | ~/dev/FlameGraph/flamegraph.pl --countname=bytes --color=mem > flame_mem.svg
```

**Построение флеймграфа на основе профилировщика запросов по памяти, показывающего неосвобождённые выделения**

```sql title=Query theme={null}
SET memory_profiler_sample_probability=1, max_untracked_memory=1, use_uncompressed_cache=1, merge_tree_max_rows_to_use_cache=100000000000, merge_tree_max_bytes_to_use_cache=1000000000000;
SELECT SearchPhrase, COUNT(DISTINCT UserID) AS u FROM hits WHERE SearchPhrase <> '' GROUP BY SearchPhrase ORDER BY u DESC LIMIT 10;
```

```response title=Response theme={null}
clickhouse client --allow_introspection_functions=1 -q "SELECT arrayJoin(flameGraph(trace, size, ptr)) FROM system.trace_log WHERE trace_type = 'MemorySample' AND query_id = 'xxx'" | ~/dev/FlameGraph/flamegraph.pl --countname=bytes --color=mem > flame_mem_untracked.svg
```

**Постройте флеймграф на основе профилировщика запросов по памяти, показывающий активные выделения в фиксированный момент времени**

```sql title=Query theme={null}
SET memory_profiler_sample_probability=1, max_untracked_memory=1;
SELECT SearchPhrase, COUNT(DISTINCT UserID) AS u FROM hits WHERE SearchPhrase <> '' GROUP BY SearchPhrase ORDER BY u DESC LIMIT 10;

-- 1. Использование памяти в секунду
SELECT event_time, m, formatReadableSize(max(s) AS m) FROM (SELECT event_time, sum(size) OVER (ORDER BY event_time) AS s FROM system.trace_log WHERE query_id = 'xxx' AND trace_type = 'MemorySample') GROUP BY event_time ORDER BY event_time;

-- 2. Найти момент времени с максимальным использованием памяти
SELECT argMax(event_time, s), max(s) FROM (SELECT event_time, sum(size) OVER (ORDER BY event_time) AS s FROM system.trace_log WHERE query_id = 'xxx' AND trace_type = 'MemorySample');
```

```response title=Response theme={null}
-- 3. Зафиксировать активные выделения памяти в заданный момент времени
clickhouse client --allow_introspection_functions=1 -q "SELECT arrayJoin(flameGraph(trace, size, ptr)) FROM (SELECT * FROM system.trace_log WHERE trace_type = 'MemorySample' AND query_id = 'xxx' AND event_time <= 'yyy' ORDER BY event_time\)\" | ~/dev/FlameGraph/flamegraph.pl --countname=bytes --color=mem > flame_mem_time_point_pos.svg

-- 4. Найти освобождения памяти в заданный момент времени
clickhouse client --allow_introspection_functions=1 -q "SELECT arrayJoin(flameGraph(trace, -size, ptr)) FROM (SELECT * FROM system.trace_log WHERE trace_type = 'MemorySample' AND query_id = 'xxx' AND event_time > 'yyy' ORDER BY event_time desc\)\" | ~/dev/FlameGraph/flamegraph.pl --countname=bytes --color=mem > flame_mem_time_point_neg.svg
```