Ajuda?!

Se algo não está funcionando, há duas possibilidades:

  • Há um bug, que podemos ajudar a corrigir, ou
  • Você pode estar fazendo algo incorreto. Quem nunca?

Seja o que for, podemos ajudar a consertar e fazer você voltar a ser feliz.

Há uma comunidade forte e prestativa de usuários no nosso fórum de discussão e na instância do Slack. Eles terão o maior prazer em ajudar a resolver qualquer problema. Para você fazer isso, sugerimos algumas diretrizes.

Se você está executando seu serviço com o Elastic Cloud, fique à vontade para entrar em contato com a equipe de suporte.

Compreensível e reproduzível

Uma descrição clara do problema ajuda a comunidade a ajudar você. Aqui estão algumas dicas:

  • Se você espera uma coisa, mas recebe outra, dizer o que você esperava realmente nos ajuda a entender o que você está tentando alcançar.
  • Se você seguiu as instruções, independentemente de quem as escreveu, envie-nos um link para o URL para que possamos validar sua abordagem.
  • Inclua informações como a versão dos produtos do Elastic Stack que você está usando, junto com seu sistema operacional e/ou navegador.

A melhor maneira de começar é criar um roteiro de recriação simples, mas completo, do problema. Se você está usando Dev Tools no Kibana, copie as solicitações de API que está fazendo, bem como qualquer saída. A mesma abordagem se aplica se você está usando cURL ou uma CLI, ou tem arquivos de configuração json ou yaml.

Os fóruns têm um limite para o tamanho do post. Você pode dividir a saída acima em vários posts ou usar gist/pastebin/etc. e colocar um link no post para que possamos ver os detalhes.

Não publique imagens de saídas de texto, como solicitações e respostas de API ou arquivos de configuração. Elas podem ser difíceis de ler e replicar e impossíveis de buscar, e podem não aparecer para todos os usuários.

Quanto mais completa for a sua reprodução, mais clara será a pergunta que você está fazendo e mais fácil será para os outros ajudarem e encontrarem uma resolução mais rápida!

O que é uma recriação?

O Kibana tem uma ferramenta útil chamada Console, disponível no menu Dev Tools. Ela ajuda a enviar solicitações para o Elasticsearch. Por exemplo, você pode exibir as informações de boas-vindas enviando:

GET /

Isso retorna algo como:

{
"name": "instance-0000000003",
"cluster_name": "b72dca58dc9c4814ab9c68aedee87639",
"cluster_uuid": "3oq0ZLnWTYqunndjR07okQ",
"version": {
"number": "8.8.1",
"build_flavor": "default",
"build_type": "docker",
"build_hash": "f8edfccba429b6477927a7c1ce1bc6729521305e",
"build_date": "2023-06-05T21:32:25.188464208Z",
"build_snapshot": false,
"lucene_version": "9.6.0",
"minimum_wire_compatibility_version": "7.17.0",
"minimum_index_compatibility_version": "7.0.0"
},
"tagline": "You Know, for Search"
}

Um script de reprodução completo é algo que qualquer pessoa pode copiar e colar no Console do Kibana e executar para reproduzir seu problema. Ele ajuda os leitores a compreender e reproduzir o seu problema e a obter uma resposta mais rápida.

Como faço para criar um roteiro de recriação?

Abra o Console no menu Dev Tools do Kibana e reproduza o problema que você está vendo com um exemplo bem simples. Não há necessidade de recriar seu caso de uso completo com todos os campos. Concentre-se apenas no problema em si.

Por exemplo, este roteiro é fácil para qualquer membro da comunidade colar e executar no Console das Dev Tools do Kibana:

DELETE index
POST index/_doc
{
"foo": "bar"
}
GET index/_search
{
"query": {
"match": {
"foo": "bar"
}
}
}

Copie/cole seu roteiro na discussão e também a resposta que você está recebendo, e explique o que espera.

Observe que:

  • É sempre útil incluir seu mapeamento no exemplo.
  • Pode ser útil compartilhar configurações específicas do Elasticsearch que você esteja usando ou a lista de plugins necessários, caso tenha instalado algum.
  • Pode ser útil também compartilhar o resultado JSON que você está obtendo e qual seria o resultado esperado. Se estiver usando curl em vez do Console das Dev Tools do Kibana, acrescente ?pretty=true à sua solicitação para ter uma saída JSON bem formatada.

APIs úteis para diagnosticar seu problema

Abra o Console no menu Dev Tools do Kibana e reproduza o problema que você está vendo com um exemplo bem simples. Não há necessidade de recriar seu caso de uso completo com todos os campos. Concentre-se apenas no problema em si.

Por exemplo, este roteiro é fácil para qualquer membro da comunidade colar e executar no Console das Dev Tools do Kibana:

GET /Informações do cluster
GET /_cat/health?vIntegridade do cluster em uma forma sintética
GET /_cat/nodes?vNós de cluster em uma forma sintética
GET /_cat/indices?vÍndices do cluster em uma forma sintética
GET /_cat/shards?vShards do cluster em uma forma sintética
GET /INDEX/_settingsObtenha as configurações do seu INDEX
GET /INDEX/_mappingObtenha o mapeamento do seu INDEX

Dicas

Ao tentar reproduzir seu problema, é sempre melhor usar a versão mais recente da stack, pois seu problema pode ter sido corrigido nesse meio tempo.

Seja paciente.

Seja paciente ao aguardar as respostas à sua pergunta, evite enviar ping várias vezes pedindo uma resposta ou abrir vários tópicos para a mesma pergunta. Como esse é um fórum da comunidade, pode levar algum tempo para alguém responder à sua pergunta. Para obter mais informações, consulte o código de conduta da comunidade (em inglês), especificamente a seção “Be patient”.

Evite enviar ping para qualquer pessoa que ainda não esteja diretamente no seu tópico — esse é um fórum, e qualquer pessoa que participe poderá ajudar você. Além disso, compartilhar a resposta publicamente é de grande valia ara os próximos leitores.

Se você precisa de um serviço com um SLA que cubra os tempos de resposta para perguntas, considere a possibilidade de conversar conosco sobre uma assinatura.

Não há problema em responder em seu próprio tópico após 2 ou 3 dias (não incluindo finais de semana) se você não tem uma resposta.