Primeiros passos com o ClickStack Open Source

Execute o ClickStack Open Source localmente, envie um evento de teste por meio do OpenTelemetry Collector e confirme se o evento está disponível na interface do ClickStack. Com o ClickStack Open Source, você executa e gerencia o backend do ClickHouse, a interface do ClickStack e o pipeline de ingestão. A imagem all-in-one agrupa esses componentes e o MongoDB em um único contêiner Docker para avaliação e testes locais.

Uma versão gerenciada do ClickStack também está disponível — consulte Managed ClickStack.

As etapas abaixo usam a imagem all-in-one autenticada. Se quiser uma UI local sem criar uma conta, siga o guia do modo local com Docker.

Antes de começar

Instale o Docker e confirme que as seguintes portas estão disponíveis:

8080 para a interface do ClickStack
4317 para OTLP via gRPC
4318 para OTLP via HTTP
8123 para a interface HTTP do ClickHouse

Para workloads contínuos ou de produção, consulte as opções de implantação código aberto e Preparação para produção.

Configure o ClickStack Open Source com a imagem all-in-one

Inicie o ClickStack

Execute a imagem all-in-one:

docker run \
  --name clickstack \
  -p 8123:8123 \
  -p 8080:8080 \
  -p 4317:4317 \
  -p 4318:4318 \
  clickhouse/clickstack-all-in-one:latest

O contêiner é executado em primeiro plano. Mantenha este terminal aberto e use um segundo terminal para executar os comandos restantes deste guia.

Persista dados e configurações

Para manter as configurações do ClickStack, os dados e os logs do ClickHouse após remover o contêiner, execute este comando em vez do anterior:

docker run \
  --name clickstack \
  -p 8123:8123 \
  -p 8080:8080 \
  -p 4317:4317 \
  -p 4318:4318 \
  -v "$(pwd)/.volumes/db:/data/db" \
  -v "$(pwd)/.volumes/ch_data:/var/lib/clickhouse" \
  -v "$(pwd)/.volumes/ch_logs:/var/log/clickhouse-server" \
  clickhouse/clickstack-all-in-one:latest

$(pwd) é resolvido como o diretório atual. Este comando armazena os arquivos persistentes em um diretório .volumes nesse local.

Abra o ClickStack

Após o ClickStack iniciar, abra http://localhost:8080 e crie uma conta.O ClickStack se conecta automaticamente à instância incluída do ClickHouse e cria fontes de dados para logs, traces, métricas e sessões.

Copie a API key de ingestão

Na seção Primeiros passos do menu à esquerda, selecione Adicionar dados e copie a API key de ingestão. A telemetria enviada ao OpenTelemetry Collector incluído deve conter essa chave no header authorization.

Envie dados de teste

No segundo terminal, exporte a API key de ingestão:

export CLICKSTACK_API_KEY=<your_ingestion_api_key>

Envie um log OTLP com o timestamp atual:

NOW_NANO="$(date +%s)000000000"

curl -i "http://localhost:4318/v1/logs" \
  -H "Content-Type: application/json" \
  -H "authorization: ${CLICKSTACK_API_KEY}" \
  --data-binary @- <<EOF
{
  "resourceLogs": [{
    "resource": {
      "attributes": [{
        "key": "service.name",
        "value": {"stringValue": "clickstack-docs-test"}
      }]
    },
    "scopeLogs": [{
      "scope": {"name": "clickstack-docs-test"},
      "logRecords": [{
        "timeUnixNano": "${NOW_NANO}",
        "severityText": "INFO",
        "body": {"stringValue": "ClickStack ingestion test"}
      }]
    }]
  }]
}
EOF

Uma requisição bem-sucedida retorna HTTP/1.1 200 OK.

Confirme a ingestão

Abra a visualização Busca no ClickStack e pesquise por ClickStack ingestion test.O resultado deve incluir o evento de teste com o nome de serviço clickstack-docs-test.

Agora você tem uma instância local do ClickStack, um endpoint de ingestão funcional e um evento de teste que pode inspecionar no ClickStack.

Próximas etapas

Envie dados de aplicações e infraestrutura

Escolha um guia de acordo com os dados que deseja enviar ao ClickStack:

Instrumente uma aplicação

Envie traces e logs da aplicação com um SDK do OpenTelemetry compatível.

Colete logs do host

Encaminhe logs do host de um OpenTelemetry Collector executado no papel de agente.

Monitore o Kubernetes

Colete logs, métricas e traces de um cluster do Kubernetes.

Explore outras integrações

Encontre guias para outras aplicações e fontes de telemetria.

Explore dados de exemplo

Use um conjunto de dados de exemplo para explorar o ClickStack com uma telemetria mais completa:

Logs, traces e métricas de exemplo

Carregue dados da demo pública e diagnostique um problema.

Logs e métricas locais

Colete arquivos locais e métricas do sistema no macOS ou Linux.

Para explorar dados pré-carregados sem instalar o Docker, use a demo hospedada do ClickStack.

Gere dados sintéticos

Use um gerador para testar a ingestão sem precisar de uma aplicação ou conjunto de dados existente:

Gere dados com o otelgen

Envie uma breve sequência de logs, traces e métricas OTLP sintéticos.

Gere dados com o telemetrygen

Gere sinais configuráveis do OpenTelemetry em vários serviços.

Veja todos os dados de exemplo e demos do ClickStack.

Prepare-se para produção

Consulte as orientações sobre implantação e produção antes de usar o ClickStack em workloads contínuos:

Preparação para produção

Consulte as credenciais de ingestão, a segurança, a retenção e as orientações operacionais.

Escolha um modelo de implantação

Compare as opções de implantação de código aberto para seu ambiente.