558 palavras

Antes de criar o índice: encontrando consultas lentas no Rails

, em Rails, SQL

Nesta página
  1. Comece pelo log
  2. O N+1
  3. O EXPLAIN
  4. Quando o índice não ajuda
  5. Meça de novo

Quando uma página fica lenta, a primeira sugestão costuma ser “coloca um índice”. Às vezes resolve. Mas sem saber qual consulta está lenta e por quê, o índice é um chute, e ele também tem custo. Antes de mexer no banco, vale descobrir o que ele está fazendo.

Comece pelo log

Em desenvolvimento, o log do Rails já mostra cada consulta, quanto tempo ela levou e de qual linha do seu código ela saiu:

Post Load (1.8ms)  SELECT "posts".* FROM "posts"
  ↳ app/controllers/posts_controller.rb:3:in 'index'
Author Load (0.4ms)  SELECT "authors".* FROM "authors" WHERE "authors"."id" = 1 LIMIT 1
  ↳ app/views/posts/index.html.erb:4
Author Load (0.3ms)  SELECT "authors".* FROM "authors" WHERE "authors"."id" = 2 LIMIT 1
  ↳ app/views/posts/index.html.erb:4
...

Esse ↳ vem do config.active_record.verbose_query_logs, que já vem ligado em desenvolvimento. É o caminho mais curto entre “a página está lenta” e a linha que causa isso.

O N+1

O log acima mostra o problema mais comum de todos: uma consulta para os posts, e depois uma para o autor de cada post. Com 50 posts, são 51 consultas. Vem de um código inocente:

@posts = Post.all
<% @posts.each do |post| %>
  <%= post.author.name %>
<% end %>

O includes carrega os autores de uma vez, e as 51 consultas viram duas:

@posts = Post.includes(:author)

Para não depender de alguém ler o log, há duas ajudas:

  • A gem Bullet avisa em desenvolvimento quando detecta um N+1, e diz qual includes adicionar.
  • O strict_loading do Rails faz o carregamento tardio levantar erro. Com Post.strict_loading.all, o post.author da view levanta ActiveRecord::StrictLoadingViolationError em vez de fazer a consulta escondida.

O EXPLAIN

Quando é uma consulta só que está lenta, o explain mostra como o banco pretende executá-la:

Order.where(order_date: 1.month.ago..).explain

No MySQL, a saída é uma tabela. Duas colunas dizem quase tudo:

| table  | type | possible_keys | key  | rows   | Extra       |
| orders | ALL  | NULL          | NULL | 250000 | Using where |

type: ALL com key: NULL quer dizer que o banco lê a tabela inteira, as 250 mil linhas, para devolver as do último mês. Aqui o índice é a resposta:

add_index :orders, :order_date

E o mesmo explain depois da migração:

| table  | type  | possible_keys              | key                        | rows | Extra                 |
| orders | range | index_orders_on_order_date | index_orders_on_order_date | 8200 | Using index condition |

O banco agora lê só o intervalo de datas. No PostgreSQL a saída é diferente, mas a ideia é a mesma: Seq Scan é a tabela inteira, Index Scan é o índice.

Quando o índice não ajuda

O índice não é de graça: cada INSERT, UPDATE e DELETE também precisa atualizá-lo. E em alguns casos o banco nem usa o índice:

  • Coluna com poucos valores distintos, como um booleano. Se metade das linhas é true, ler a tabela inteira sai mais barato.
  • Função aplicada na coluna, como WHERE DATE(created_at) = '2022-12-20'. Compare com um intervalo: created_at: dia.all_day.
  • LIKE começando com %, como name LIKE '%silva'. O índice ajuda a buscar pelo começo do texto, não pelo meio.

Por isso o explain vem antes e depois. Ele mostra se o índice está sendo usado de fato.

Meça de novo

Depois da mudança, compare o tempo no log, ou na ferramenta de monitoramento que você usa em produção, com o tempo de antes. Se não mudou, o gargalo estava em outro lugar.