> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> Introdução ao uso do ClickHouse com o Grafana

# Plugin de fonte de dados do ClickHouse para o Grafana

export const ClickHouseSupportedBadge = () => {
  return <div className="ClickHouseSupportedBadge">
            <div className="ClickHouseSupportedIcon">
                <svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
                    <path d="M1.30762 1.39073C1.30762 1.3103 1.37465 1.22986 1.46849 1.22986H2.64824C2.72868 1.22986 2.80912 1.29689 2.80912 1.39073V14.4886C2.80912 14.5691 2.74209 14.6495 2.64824 14.6495H1.46849C1.38805 14.6495 1.30762 14.5825 1.30762 14.4886V1.39073Z" fill="currentColor" />
                    <path d="M4.2832 1.39073C4.2832 1.3103 4.35023 1.22986 4.44408 1.22986H5.62383C5.70427 1.22986 5.7847 1.29689 5.7847 1.39073V14.4886C5.7847 14.5691 5.71767 14.6495 5.62383 14.6495H4.44408C4.36364 14.6495 4.2832 14.5825 4.2832 14.4886V1.39073Z" fill="currentColor" />
                    <path d="M7.25977 1.39073C7.25977 1.3103 7.3268 1.22986 7.42064 1.22986H8.60039C8.68083 1.22986 8.76127 1.29689 8.76127 1.39073V14.4886C8.76127 14.5691 8.69423 14.6495 8.60039 14.6495H7.42064C7.3402 14.6495 7.25977 14.5825 7.25977 14.4886V1.39073Z" fill="currentColor" />
                    <path d="M10.2354 1.39073C10.2354 1.3103 10.3024 1.22986 10.3962 1.22986H11.576C11.6564 1.22986 11.7369 1.29689 11.7369 1.39073V14.4886C11.7369 14.5691 11.6698 14.6495 11.576 14.6495H10.3962C10.3158 14.6495 10.2354 14.5825 10.2354 14.4886V1.39073Z" fill="currentColor" />
                    <path d="M13.2256 6.6057C13.2256 6.52526 13.2926 6.44482 13.3865 6.44482H14.5662C14.6466 6.44482 14.7271 6.51186 14.7271 6.6057V9.27354C14.7271 9.35398 14.6601 9.43442 14.5662 9.43442H13.3865C13.306 9.43442 13.2256 9.36739 13.2256 9.27354V6.6057Z" fill="currentColor" />
                </svg>
            </div>
            Suportado pelo ClickHouse
        </div>;
};

export const Image = ({img, alt, size = "lg"}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} />
      </Frame>
    </div>;
};

<ClickHouseSupportedBadge />

Com o Grafana, você pode explorar e compartilhar todos os seus dados por meio de dashboards.
O Grafana requer um plugin para se conectar ao ClickHouse, que pode ser instalado facilmente pela UI.

<div class="vimeo-container">
  <Frame>
    <iframe
      src="//www.youtube.com/embed/bRce9xWiqQM"
      frameborder="0"
      allow="autoplay;
fullscreen;
picture-in-picture"
      allowfullscreen
    />
  </Frame>
</div>

<Steps>
  <Step title="Reúna os detalhes da sua conexão" id="1-gather-your-connection-details">
    Para se conectar ao ClickHouse com TCP nativo, você precisa destas informações:

    | Parâmetros              | Descrição                                                                                                       |
    | ----------------------- | --------------------------------------------------------------------------------------------------------------- |
    | `HOST` e `PORT`         | Normalmente, a porta é 9440 ao usar TLS, ou 9000 quando não se usa TLS.                                         |
    | `DATABASE NAME`         | Por padrão, há um banco de dados chamado `default`; use o nome do banco de dados ao qual você quer se conectar. |
    | `USERNAME` e `PASSWORD` | Por padrão, o nome de usuário é `default`. Use o nome de usuário apropriado para o seu caso de uso.             |

    Os detalhes do seu serviço do ClickHouse Cloud estão disponíveis no console do ClickHouse Cloud.
    Selecione o serviço ao qual você vai se conectar e clique em **Connect**:

    <div className="ch-image-md">
      <Frame>
        <img src="https://mintcdn.com/private-7c7dfe99/CFFsa2agBPbviR4r/images/_snippets/cloud-connect-button.webp?fit=max&auto=format&n=CFFsa2agBPbviR4r&q=85&s=ec0a298a33ca841e947fa5e8bae47362" alt="Botão Connect do serviço do ClickHouse Cloud" width="998" height="932" data-path="images/_snippets/cloud-connect-button.webp" />
      </Frame>
    </div>

    Escolha **Native**; os detalhes estarão disponíveis em um comando `clickhouse-client` de exemplo.

    <div className="ch-image-md">
      <Frame>
        <img src="https://mintcdn.com/private-7c7dfe99/CFFsa2agBPbviR4r/images/_snippets/connection-details-native.webp?fit=max&auto=format&n=CFFsa2agBPbviR4r&q=85&s=91bf501b52dd0ed0fddf84f56d290fc8" alt="Detalhes da conexão TCP nativa do ClickHouse Cloud" width="1290" height="1176" data-path="images/_snippets/connection-details-native.webp" />
      </Frame>
    </div>

    Se você estiver usando ClickHouse autogerenciado, os detalhes da conexão serão definidos pelo administrador do ClickHouse.
  </Step>

  <Step title="Criando um usuário somente leitura" id="2-making-a-read-only-user">
    Ao conectar o ClickHouse a uma ferramenta de visualização de dados como o Grafana, recomenda-se criar um usuário somente leitura para proteger seus dados contra modificações indesejadas.

    O Grafana não valida se as consultas são seguras. As consultas podem conter qualquer instrução SQL, incluindo `DELETE` e `INSERT`.

    Para configurar um usuário somente leitura, siga estas etapas:

    1. Crie um perfil de usuário `readonly` seguindo o guia [Creating Users and Roles in ClickHouse](/docs/pt-BR/concepts/features/security/access-rights).
    2. Certifique-se de que o usuário `readonly` tenha permissão suficiente para modificar a configuração `max_execution_time` exigida pelo [cliente clickhouse-go](https://github.com/ClickHouse/clickhouse-go).
    3. Se você estiver usando uma instância pública do ClickHouse, não é recomendável definir `readonly=2` no perfil `readonly`. Em vez disso, mantenha `readonly=1` e defina o tipo de constraint de `max_execution_time` como [changeable\_in\_readonly](/docs/pt-BR/concepts/features/configuration/settings/constraints-on-settings) para permitir a modificação dessa configuração.
  </Step>

  <Step title="Instale o plugin ClickHouse para Grafana" id="3--install-the-clickhouse-plugin-for-grafana">
    Antes que o Grafana possa se conectar ao ClickHouse, você precisa instalar o plugin apropriado do Grafana. Supondo que você esteja conectado ao Grafana, siga estas etapas:

    1. Na página **Connections** na barra lateral, selecione a aba **Add new connection**.

    2. Procure por **ClickHouse** e clique no plugin assinado pela Grafana Labs:

           <Image size="md" img="https://mintcdn.com/private-7c7dfe99/PWQnWTwcu17exYX2/images/integrations/data-visualization/grafana/search.webp?fit=max&auto=format&n=PWQnWTwcu17exYX2&q=85&s=76a37e6a6b3ebc5e59f92bc8f38e51c4" alt="Selecione o plugin ClickHouse na página de conexões" border width="784" height="365" data-path="images/integrations/data-visualization/grafana/search.webp" />

    3. Na próxima tela, clique no botão **Install**:

           <Image size="md" img="https://mintcdn.com/private-7c7dfe99/PWQnWTwcu17exYX2/images/integrations/data-visualization/grafana/install.webp?fit=max&auto=format&n=PWQnWTwcu17exYX2&q=85&s=c6138c1f11134634244841c7f57d7aa4" alt="Instale o plugin ClickHouse" border width="865" height="364" data-path="images/integrations/data-visualization/grafana/install.webp" />
  </Step>

  <Step title="Defina uma fonte de dados do ClickHouse" id="4-define-a-clickhouse-data-source">
    1. Quando a instalação for concluída, clique no botão **Add new data source**. (Você também pode adicionar uma fonte de dados pela aba **Data sources** na página **Connections**.)

           <Image size="md" img="https://mintcdn.com/private-7c7dfe99/PWQnWTwcu17exYX2/images/integrations/data-visualization/grafana/add_new_ds.webp?fit=max&auto=format&n=PWQnWTwcu17exYX2&q=85&s=16c835e49f7166091a673374f60a30a2" alt="Criar uma fonte de dados do ClickHouse" border width="886" height="383" data-path="images/integrations/data-visualization/grafana/add_new_ds.webp" />

    2. Role a página para baixo e localize o tipo de fonte de dados **ClickHouse** ou pesquise por ele na barra de busca da página **Add data source**. Selecione a fonte de dados **ClickHouse** e a página a seguir será exibida:

    <Image size="md" img="https://mintcdn.com/private-7c7dfe99/PWQnWTwcu17exYX2/images/integrations/data-visualization/grafana/quick_config.webp?fit=max&auto=format&n=PWQnWTwcu17exYX2&q=85&s=c61e6ef612d243a1a56f8fa45484cac7" alt="Página de configuração da conexão" border width="976" height="1050" data-path="images/integrations/data-visualization/grafana/quick_config.webp" />

    3. Insira as configurações do servidor e as credenciais. As principais configurações são:

    * **Server host address:** o hostname do seu serviço ClickHouse.
    * **Server port:** a porta do seu serviço ClickHouse. Ela varia conforme a configuração do servidor e o protocolo.
    * **Protocol** o protocolo usado para se conectar ao seu serviço ClickHouse.
    * **Secure connection** habilite esta opção se o seu servidor exigir uma conexão segura.
    * **Username** e **Password**: insira as credenciais do seu usuário do ClickHouse. Se você não tiver configurado nenhum usuário, tente `default` como nome de usuário. Recomendamos [configurar um usuário somente leitura](#2-making-a-read-only-user).

    Para ver mais configurações, consulte a documentação de [configuração do plugin](/docs/pt-BR/integrations/connectors/data-visualization/grafana/config).

    4. Clique no botão **Save & test** para verificar se o Grafana consegue se conectar ao seu serviço ClickHouse. Se a conexão for bem-sucedida, você verá a mensagem **Data source is working**:

           <Image size="md" img="https://mintcdn.com/private-7c7dfe99/PWQnWTwcu17exYX2/images/integrations/data-visualization/grafana/valid_ds.webp?fit=max&auto=format&n=PWQnWTwcu17exYX2&q=85&s=25d294cee7c24a3c3aa37d34af1ae4b3" alt="Selecione Save & test" border width="975" height="213" data-path="images/integrations/data-visualization/grafana/valid_ds.webp" />
  </Step>

  <Step title="Próximos passos" id="5-next-steps">
    Sua fonte de dados agora está pronta para uso! Saiba mais sobre como criar consultas com o [query builder](/docs/pt-BR/integrations/connectors/data-visualization/grafana/query-builder).

    Para mais detalhes sobre configuração, consulte a documentação de [configuração do plugin](/docs/pt-BR/integrations/connectors/data-visualization/grafana/config).

    Se você estiver procurando mais informações que não estão incluídas nesta documentação, consulte o [repositório do plugin no GitHub](https://github.com/grafana/clickhouse-datasource).
  </Step>
</Steps>

<div id="upgrading-plugin-versions">
  ## Atualizando versões do plugin
</div>

A partir da v4, configurações e consultas podem ser atualizadas à medida que novas versões são lançadas.

Configurações e consultas da v3 são migradas para a v4 conforme são abertas. Embora as configurações e dashboards antigos sejam carregados na v4, a migração não é salva até que sejam salvos novamente na nova versão. Se você notar algum problema ao abrir uma configuração/consulta antiga, descarte suas alterações e [relate o problema no GitHub](https://github.com/grafana/clickhouse-datasource/issues).

O plugin não pode voltar para versões anteriores se a configuração/consulta tiver sido criada com uma versão mais recente.
