Funções de introspecção

Documentação das funções de introspecção

Você pode usar as funções descritas neste capítulo para inspecionar ELF e DWARF no profiling de consultas.

Essas funções são lentas e podem ter implicações de segurança.

Para o funcionamento correto das funções de introspecção:

• Instale o pacote clickhouse-common-static-dbg.

• Defina a configuração allow_introspection_functions como 1.

  Por motivos de segurança, as funções de introspecção ficam desabilitadas por padrão.

O ClickHouse salva relatórios do profiler na tabela de sistema trace_log. Certifique-se de que a tabela e o profiler estejam configurados corretamente.

​

addressToLine

Introduzido em: v20.1.0

Converte um endereço de memória virtual dentro do processo do servidor ClickHouse em um nome de arquivo e um número de linha no código-fonte do ClickHouse.

Esta função é lenta e pode trazer implicações de segurança.

Para habilitar esta função de introspecção:

• Instale o pacote clickhouse-common-static-dbg.
• Defina a configuração allow_introspection_functions como 1.

Sintaxe

addressToLine(address_of_binary_instruction)

Argumentos

• address_of_binary_instruction — Endereço da instrução em um processo em execução. UInt64

Valor retornado

Retorna um nome de arquivo de código-fonte e um número de linha separados por dois-pontos, por exemplo, /build/obj-x86_64-linux-gnu/../src/Common/ThreadPool.cpp:199. Retorna o nome de um binário se nenhuma informação de depuração for encontrada; caso contrário, retorna uma string vazia se o endereço não for válido. String

Exemplos

Selecionando a primeira string da tabela de sistema trace_log

Query

SET allow_introspection_functions=1;
SELECT * FROM system.trace_log LIMIT 1 \G;

Response

-- O campo `trace` contém o stack trace no momento da amostragem.
Row 1:
──────
event_date:              2019-11-19
event_time:              2019-11-19 18:57:23
revision:                54429
timer_type:              Real
thread_number:           48
query_id:                421b6855-1858-45a5-8f37-f383409d6d72
trace:                   [140658411141617,94784174532828,94784076370703,94784076372094,94784076361020,94784175007680,140658411116251,140658403895439]

Como obter o nome do arquivo do código-fonte e o número da linha de um único endereço

Query

SET allow_introspection_functions=1;
SELECT addressToLine(94784076370703) \G;

Response

Linha 1:
──────
addressToLine(94784076370703): /build/obj-x86_64-linux-gnu/../src/Common/ThreadPool.cpp:199

Aplicando a função ao stack trace completo

Query

-- A função arrayMap neste exemplo processa cada elemento individual do array trace pela função addressToLine.
-- O resultado desse processamento é exibido na coluna trace_source_code_lines da saída.

SELECT
    arrayStringConcat(arrayMap(x -> addressToLine(x), trace), '\n') AS trace_source_code_lines
FROM system.trace_log
LIMIT 1
\G

Response

Row 1:
──────
trace_source_code_lines: /lib/x86_64-linux-gnu/libpthread-2.27.so
/usr/lib/debug/usr/bin/clickhouse
/build/obj-x86_64-linux-gnu/../src/Common/ThreadPool.cpp:199
/build/obj-x86_64-linux-gnu/../src/Common/ThreadPool.h:155
/usr/include/c++/9/bits/atomic_base.h:551
/usr/lib/debug/usr/bin/clickhouse
/lib/x86_64-linux-gnu/libpthread-2.27.so
/build/glibc-OTsEL5/glibc-2.27/misc/../sysdeps/unix/sysv/linux/x86_64/clone.S:97

​

addressToLineWithInlines

Introduzido em: v22.2.0

Semelhante a addressToLine, mas retorna um Array com todas as funções embutidas. Por isso, é mais lento que addressToLine.

Para habilitar esta função de introspecção:

• Instale o pacote clickhouse-common-static-dbg.
• Defina a configuração allow_introspection_functions como 1.

Sintaxe

addressToLineWithInlines(address_of_binary_instruction)

Argumentos

• address_of_binary_instruction — O endereço de uma instrução em um processo em execução. UInt64

Valor retornado

Retorna um array cujo primeiro elemento é o nome do arquivo de código-fonte e o número da linha, separados por dois-pontos. O segundo, o terceiro etc. elementos listam os nomes dos arquivos de código-fonte, os números das linhas e os nomes das funções inline. Se nenhuma informação de depuração for encontrada, será retornado um array com um único elemento igual ao nome do binário; caso contrário, será retornado um array vazio se o endereço não for válido. Array(String)

Exemplos

Aplicando a função a um endereço

Query

SET allow_introspection_functions=1;
SELECT addressToLineWithInlines(531055181::UInt64);

Response

┌─addressToLineWithInlines(CAST('531055181', 'UInt64'))────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ ['./src/Functions/addressToLineWithInlines.cpp:98','./build_normal_debug/./src/Functions/addressToLineWithInlines.cpp:176:DB::(anonymous namespace)::FunctionAddressToLineWithInlines::implCached(unsigned long) const'] │
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

Aplicando a função a todo o stack trace

Query

SET allow_introspection_functions=1;

-- A função arrayJoin dividirá o array em linhas

SELECT
    ta, addressToLineWithInlines(arrayJoin(trace) AS ta)
FROM system.trace_log
WHERE
    query_id = '5e173544-2020-45de-b645-5deebe2aae54';

Response

┌────────ta─┬─addressToLineWithInlines(arrayJoin(trace))───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ 365497529 │ ['./build_normal_debug/./contrib/libcxx/include/string_view:252']                                                                                                                                                        │
│ 365593602 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:191']                                                                                                                                                                      │
│ 365593866 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:0']                                                                                                                                                                        │
│ 365592528 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:0']                                                                                                                                                                        │
│ 365591003 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:477']                                                                                                                                                                      │
│ 365590479 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:442']                                                                                                                                                                      │
│ 365590600 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:457']                                                                                                                                                                      │
│ 365598941 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:0']                                                                                                                                                                        │
│ 365607098 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:0']                                                                                                                                                                        │
│ 365590571 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:451']                                                                                                                                                                      │
│ 365598941 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:0']                                                                                                                                                                        │
│ 365607098 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:0']                                                                                                                                                                        │
│ 365590571 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:451']                                                                                                                                                                      │
│ 365598941 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:0']                                                                                                                                                                        │
│ 365607098 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:0']                                                                                                                                                                        │
│ 365590571 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:451']                                                                                                                                                                      │
│ 365598941 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:0']                                                                                                                                                                        │
│ 365597289 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:807']                                                                                                                                                                      │
│ 365599840 │ ['./build_normal_debug/./src/Common/Dwarf.cpp:1118']                                                                                                                                                                     │
│ 531058145 │ ['./build_normal_debug/./src/Functions/addressToLineWithInlines.cpp:152']                                                                                                                                                │
│ 531055181 │ ['./src/Functions/addressToLineWithInlines.cpp:98','./build_normal_debug/./src/Functions/addressToLineWithInlines.cpp:176:DB::(anonymous namespace)::FunctionAddressToLineWithInlines::implCached(unsigned long) const'] │
│ 422333613 │ ['./build_normal_debug/./src/Functions/IFunctionAdaptors.h:21']                                                                                                                                                          │
│ 586866022 │ ['./build_normal_debug/./src/Functions/IFunction.cpp:216']                                                                                                                                                               │
│ 586869053 │ ['./build_normal_debug/./src/Functions/IFunction.cpp:264']                                                                                                                                                               │
│ 586873237 │ ['./build_normal_debug/./src/Functions/IFunction.cpp:334']                                                                                                                                                               │
│ 597901620 │ ['./build_normal_debug/./src/Interpreters/ExpressionActions.cpp:601']                                                                                                                                                    │
│ 597898534 │ ['./build_normal_debug/./src/Interpreters/ExpressionActions.cpp:718']                                                                                                                                                    │
│ 630442912 │ ['./build_normal_debug/./src/Processors/Transforms/ExpressionTransform.cpp:23']                                                                                                                                          │
│ 546354050 │ ['./build_normal_debug/./src/Processors/ISimpleTransform.h:38']                                                                                                                                                          │
│ 626026993 │ ['./build_normal_debug/./src/Processors/ISimpleTransform.cpp:89']                                                                                                                                                        │
│ 626294022 │ ['./build_normal_debug/./src/Processors/Executors/ExecutionThreadContext.cpp:45']                                                                                                                                        │
│ 626293730 │ ['./build_normal_debug/./src/Processors/Executors/ExecutionThreadContext.cpp:63']                                                                                                                                        │
│ 626169525 │ ['./build_normal_debug/./src/Processors/Executors/PipelineExecutor.cpp:213']                                                                                                                                             │
│ 626170308 │ ['./build_normal_debug/./src/Processors/Executors/PipelineExecutor.cpp:178']                                                                                                                                             │
│ 626166348 │ ['./build_normal_debug/./src/Processors/Executors/PipelineExecutor.cpp:329']                                                                                                                                             │
│ 626163461 │ ['./build_normal_debug/./src/Processors/Executors/PipelineExecutor.cpp:84']                                                                                                                                              │
│ 626323536 │ ['./build_normal_debug/./src/Processors/Executors/PullingAsyncPipelineExecutor.cpp:85']                                                                                                                                  │
│ 626323277 │ ['./build_normal_debug/./src/Processors/Executors/PullingAsyncPipelineExecutor.cpp:112']                                                                                                                                 │
│ 626323133 │ ['./build_normal_debug/./contrib/libcxx/include/type_traits:3682']                                                                                                                                                       │
│ 626323041 │ ['./build_normal_debug/./contrib/libcxx/include/tuple:1415']                                                                                                                                                             │
└───────────┴──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

​

addressToSymbol

Introduzido em: v20.1.0

Converte um endereço de memória virtual no processo do servidor ClickHouse em um símbolo dos arquivos-objeto do ClickHouse.

Sintaxe

addressToSymbol(address_of_binary_instruction)

Argumentos

• address_of_binary_instruction — Endereço da instrução em um processo em execução. UInt64

Valor retornado

Retorna o símbolo dos arquivos-objeto do ClickHouse ou uma string vazia, se o endereço não for válido. String

Exemplos

Selecionando a primeira string da tabela de sistema trace_log

Query

SET allow_introspection_functions=1;
SELECT * FROM system.trace_log LIMIT 1 \G;

Response

-- O campo `trace` contém o stack trace no momento da amostragem.
Row 1:
──────
event_date:    2019-11-20
event_time:    2019-11-20 16:57:59
revision:      54429
timer_type:    Real
thread_number: 48
query_id:      724028bf-f550-45aa-910d-2af6212b94ac
trace:         [94138803686098,94138815010911,94138815096522,94138815101224,94138815102091,94138814222988,94138806823642,94138814457211,94138806823642,94138814457211,94138806823642,94138806795179,94138806796144,94138753770094,94138753771646,94138753760572,94138852407232,140399185266395,140399178045583]

Obtendo o símbolo de um único endereço

Query

SET allow_introspection_functions=1;
SELECT addressToSymbol(94138803686098) \G;

Response

Row 1:
──────
addressToSymbol(94138803686098): _ZNK2DB24IAggregateFunctionHelperINS_20AggregateFunctionSumImmNS_24AggregateFunctionSumDataImEEEEE19addBatchSinglePlaceEmPcPPKNS_7IColumnEPNS_5ArenaE

Aplicando a função a todo o stack trace

Query

SET allow_introspection_functions=1;

-- A função arrayMap permite processar cada elemento individual do array trace pela função addressToSymbols.
-- O resultado desse processamento é exibido na coluna trace_symbols da saída.

SELECT
    arrayStringConcat(arrayMap(x -> addressToSymbol(x), trace), '\n') AS trace_symbols
FROM system.trace_log
LIMIT 1
\G

Response

Row 1:
──────
trace_symbols: _ZNK2DB24IAggregateFunctionHelperINS_20AggregateFunctionSumImmNS_24AggregateFunctionSumDataImEEEEE19addBatchSinglePlaceEmPcPPKNS_7IColumnEPNS_5ArenaE
_ZNK2DB10Aggregator21executeWithoutKeyImplERPcmPNS0_28AggregateFunctionInstructionEPNS_5ArenaE
_ZN2DB10Aggregator14executeOnBlockESt6vectorIN3COWINS_7IColumnEE13immutable_ptrIS3_EESaIS6_EEmRNS_22AggregatedDataVariantsERS1_IPKS3_SaISC_EERS1_ISE_SaISE_EERb
_ZN2DB10Aggregator14executeOnBlockERKNS_5BlockERNS_22AggregatedDataVariantsERSt6vectorIPKNS_7IColumnESaIS9_EERS6_ISB_SaISB_EERb
_ZN2DB10Aggregator7executeERKSt10shared_ptrINS_17IBlockInputStreamEERNS_22AggregatedDataVariantsE
_ZN2DB27AggregatingBlockInputStream8readImplEv
_ZN2DB17IBlockInputStream4readEv
_ZN2DB26ExpressionBlockInputStream8readImplEv
_ZN2DB17IBlockInputStream4readEv
_ZN2DB26ExpressionBlockInputStream8readImplEv
_ZN2DB17IBlockInputStream4readEv
_ZN2DB28AsynchronousBlockInputStream9calculateEv
_ZNSt17_Function_handlerIFvvEZN2DB28AsynchronousBlockInputStream4nextEvEUlvE_E9_M_invokeERKSt9_Any_data
_ZN14ThreadPoolImplI20ThreadFromGlobalPoolE6workerESt14_List_iteratorIS0_E
_ZZN20ThreadFromGlobalPoolC4IZN14ThreadPoolImplIS_E12scheduleImplIvEET_St8functionIFvvEEiSt8optionalImEEUlvE1_JEEEOS4_DpOT0_ENKUlvE_clEv
_ZN14ThreadPoolImplISt6threadE6workerESt14_List_iteratorIS0_E
execute_native_thread_routine
start_thread
clone

​

demangle

Introduzido em: v20.1.0

Converte um símbolo em um nome de função em C++. O símbolo geralmente é retornado pela função addressToSymbol.

Sintaxe

demangle(symbol)

Argumentos

• symbol — Símbolo de um arquivo-objeto. String

Valor retornado

Retorna o nome da função C++, ou uma string vazia se o símbolo não for válido. String

Exemplos

Selecionando a primeira string da tabela do sistema trace_log

Query

SELECT * FROM system.trace_log LIMIT 1 \G;

Response

-- The `trace` field contains the stack trace at the moment of sampling.
Linha 1:
──────
event_date:    2019-11-20
event_time:    2019-11-20 16:57:59
revision:      54429
timer_type:    Real
thread_number: 48
query_id:      724028bf-f550-45aa-910d-2af6212b94ac
trace:         [94138803686098,94138815010911,94138815096522,94138815101224,94138815102091,94138814222988,94138806823642,94138814457211,94138806823642,94138814457211,94138806823642,94138806795179,94138806796144,94138753770094,94138753771646,94138753760572,94138852407232,140399185266395,140399178045583]

Obtendo o nome da função a partir de um único endereço

Query

SET allow_introspection_functions=1;
SELECT demangle(addressToSymbol(94138803686098)) \G;

Response

Linha 1:
──────
demangle(addressToSymbol(94138803686098)): DB::IAggregateFunctionHelper<DB::AggregateFunctionSum<unsigned long, unsigned long, DB::AggregateFunctionSumData<unsigned long> > >::addBatchSinglePlace(unsigned long, char*, DB::IColumn const**, DB::Arena*) const

Aplicando a função ao stack trace inteiro

Query

SET allow_introspection_functions=1;

-- The arrayMap function allows to process each individual element of the trace array by the demangle function.
-- The result of this processing is shown in the trace_functions column of output.

SELECT
    arrayStringConcat(arrayMap(x -> demangle(addressToSymbol(x)), trace), '\n') AS trace_functions
FROM system.trace_log
LIMIT 1
\G

Response

Linha 1:
──────
trace_functions: DB::IAggregateFunctionHelper<DB::AggregateFunctionSum<unsigned long, unsigned long, DB::AggregateFunctionSumData<unsigned long> > >::addBatchSinglePlace(unsigned long, char*, DB::IColumn const**, DB::Arena*) const
DB::Aggregator::executeWithoutKeyImpl(char*&, unsigned long, DB::Aggregator::AggregateFunctionInstruction*, DB::Arena*) const
DB::Aggregator::executeOnBlock(...)
DB::Aggregator::executeOnBlock(DB::Block const&, ...)
DB::Aggregator::execute(std::shared_ptr<DB::IBlockInputStream> const&, DB::AggregatedDataVariants&)
DB::AggregatingBlockInputStream::readImpl()
DB::IBlockInputStream::read()
DB::ExpressionBlockInputStream::readImpl()
DB::IBlockInputStream::read()
DB::ExpressionBlockInputStream::readImpl()
DB::IBlockInputStream::read()
DB::AsynchronousBlockInputStream::calculate()
std::_Function_handler<void (), DB::AsynchronousBlockInputStream::next()::{lambda()#1}>::_M_invoke(std::_Any_data const&)
ThreadPoolImpl<ThreadFromGlobalPool>::worker(std::_List_iterator<ThreadFromGlobalPool>)
ThreadFromGlobalPool::ThreadFromGlobalPool<ThreadPoolImpl<ThreadFromGlobalPool>::scheduleImpl<void>(std::function<void ()>, int, std::optional<unsigned long>)::{lambda()#3}>(ThreadPoolImpl<ThreadFromGlobalPool>::scheduleImpl<void>(std::function<void ()>, int, std::optional<unsigned long>)::{lambda()#3}&&)::{lambda()#1}::operator()() const
ThreadPoolImpl<std::thread>::worker(std::_List_iterator<std::thread>)
execute_native_thread_routine
start_thread
clone

​

isMergeTreePartCoveredBy

Introduzido em: v25.6.0

Função que verifica se a parte do primeiro argumento está coberta pela parte do segundo argumento.

Sintaxe

isMergeTreePartCoveredBy(nested_part, covering_part)

Argumentos

• nested_part — Nome da parte aninhada esperada. String
• covering_part — Nome da parte de cobertura esperada. String

Valor retornado

Retorna 1 se houver cobertura, 0 caso contrário. UInt8

Exemplos

Exemplo básico

Query

WITH 'all_12_25_7_4' AS lhs, 'all_7_100_10_20' AS rhs
SELECT isMergeTreePartCoveredBy(rhs, lhs), isMergeTreePartCoveredBy(lhs, rhs);

Response

┌─isMergeTreePartCoveredBy(rhs, lhs)─┬─isMergeTreePartCoveredBy(lhs, rhs)─┐
│                                  0 │                                  1 │
└────────────────────────────────────┴────────────────────────────────────┘

​

logTrace

Introduzido em: v20.12.0

Emite uma mensagem de log no nível trace no log do servidor para cada Block.

Sintaxe

logTrace(message)

Argumentos

• message — Mensagem que é emitida no log do servidor. const String

Valor retornado

Sempre retorna 0. UInt8

Exemplos

Exemplo básico

Query

SELECT logTrace('logTrace message');

Response

┌─logTrace('logTrace message')─┐
│                            0 │
└──────────────────────────────┘

​

mergeTreePartInfo

Introduzido em: v25.6.0

Função que ajuda a extrair os valores úteis do nome da parte do MergeTree.

Sintaxe

mergeTreePartInfo(part_name)

Argumentos

• part_name — Nome da parte a ser desempacotada. String

Valor retornado

Retorna um Tuple com subcolunas: partition_id, min_block, max_block, level, mutation. Tuple

Exemplos

Exemplo básico

Query

WITH mergeTreePartInfo('all_12_25_7_4') AS info
SELECT info.partition_id, info.min_block, info.max_block, info.level, info.mutation;

Response

┌─info.partition_id─┬─info.min_block─┬─info.max_block─┬─info.level─┬─info.mutation─┐
│ all               │             12 │             25 │          7 │             4 │
└───────────────────┴────────────────┴────────────────┴────────────┴───────────────┘

​

tid

Introduzido em: v20.12.0

Retorna o ID da thread em que o Block atual é processado.

Sintaxe

tid()

Argumentos

• Nenhum.

Valor retornado

Retorna o ID da thread atual. UInt64

Exemplos

Exemplo de uso

Query

SELECT tid();

Response

┌─tid()─┐
│  3878 │
└───────┘