Acesso antecipadoSó por convite, e os SDKs ainda não foram publicados.Pedir um convite
Ir para o conteúdo
Docs

Início rápido

Crie um projeto, copie a chave de ingestão dele, envie um primeiro evento e encontre-o no painel.

O Lyrelog é um serviço hospedado, em acesso antecipado por convite. Peça acesso em lyrelog.com; o link do convite permite criar a sua conta. O painel fica em app.lyrelog.com, e os apps enviam os eventos para https://ingest.lyrelog.com.

Dê um nome ao seu primeiro projeto

Depois que você cria a conta, o painel abre em Welcome. Dê um nome ao projeto e diga o que envia os eventos dele: um app iOS ou macOS, um site, um serviço Node, Python ou Go, ou qualquer outra coisa via HTTP. Essa escolha define o snippet que você vê a seguir e a plataforma do projeto.

Crie um projeto por app. Se o app também tiver um site e um backend, todos podem enviar para o mesmo projeto (veja Plataformas). Os próximos projetos são criados em Projects e New project. Só um proprietário da organização pode criar projetos.

Copie a chave de ingestão

Logo depois que você cria o projeto, o Lyrelog mostra a chave de ingestão dele, lyr_ing_..., e as linhas para colar no seu app. Copie a chave agora: só um hash dela fica armazenado, então ela não pode ser mostrada de novo. Se você a perder, crie uma nova na página API keys do projeto.

A chave de ingestão só consegue enviar eventos, nunca lê-los, então é seguro distribuí-la dentro de um app. Veja Chaves. Um backend deve enviar com uma chave de servidor (Send events from a server, na página API keys), cujos eventos são verificados.

Envie um primeiro evento

Os SDKs ainda não foram publicados

Os SDKs para Swift, Android, React Native, Flutter, JavaScript, Python, Go e a JVM ainda não podem ser instalados. Por enquanto, envie o seu primeiro evento com curl, ou de qualquer linguagem pela API HTTP.

Num terminal do macOS ou do Linux (o comando usa uuidgen e date), troque lyr_ing_... pela sua chave e execute:

curl -X POST https://ingest.lyrelog.com/v1/events:batch \
  -H "Authorization: Bearer lyr_ing_..." \
  -H "Content-Type: application/x-ndjson" \
  --data-binary "{\"event_id\":\"$(uuidgen | tr A-Z a-z)\",\"ts\":\"$(date -u +%Y-%m-%dT%H:%M:%SZ)\",\"message\":\"hello_lyrelog\",\"resource\":{\"environment\":\"production\"}}"

Todo evento precisa de um UUID novo como event_id e do horário atual como ts. Um evento cujo ts seja mais antigo que a retenção do projeto, ou esteja mais de um dia no futuro, não se perde: ele é armazenado com o horário em que chegou, e o horário enviado vai para o atributo _lyrelog_ts_clamped. A resposta diz quantas linhas foram armazenadas:

{"accepted":1,"rejected":[]}

Recebeu outra coisa? Veja Nenhum evento chega.

Veja o evento chegar

A página Welcome fica esperando o primeiro evento e avisa quando ele chega. Abra o projeto a partir dali: a página Events lista hello_lyrelog. Clique nele para ver o evento completo.

Não apareceu?

O painel mostra um ambiente de cada vez e abre no padrão do projeto, production. Os SDKs enviam development de um build que você roda no Xcode, do simulador, de uma página em localhost e do Node, a menos que NODE_ENV=production esteja definido. Por isso, os seus primeiros eventos de um SDK ficam em development: escolha esse ambiente, ou All environments, na barra superior. O curl acima define "environment":"production"; um evento enviado sem resource.environment também é armazenado como production. Veja Ambientes.

Leia o evento a partir de um script (opcional)

Na página API keys do projeto, escolha New key, defina What it can do como Read events e copie a chave lyr_read_.... Criar uma chave de leitura pede que você entre de novo se o seu último login foi há mais de 10 minutos. Mantenha essa chave num servidor: ela lê todos os eventos do projeto.

export LYRELOG_READ_KEY=lyr_read_...
curl -s -G https://app.lyrelog.com/v1/events \
  -H "Authorization: Bearer $LYRELOG_READ_KEY" \
  --data-urlencode "message=hello_lyrelog"

Veja a API de leitura.

Próximos passos