Página de Estado Orbit

A status page is a public, no-login URL that shows whether your project is up, how it has performed recently, and what you have deployed. Turning it on also starts an uptime check that pings your…

Uma página de estado é um URL público, sem necessidade de início de sessão, que mostra se o seu projeto está operacional, como tem funcionado recentemente e o que implementou. Ativar a página também inicia uma verificação de tempo de atividade que envia um ping ao seu projeto a cada minuto, portanto obtém monitorização como efeito secundário da publicação.

Onde as Definições da Página de Estado se Encontram

Abra o Orbit, clique no projeto e escolha Status page sob o grupo Observability na fita de separadores do projeto. A página tem o título Public status page.

Status page settings for an Orbit project

Ativar a Página

Ative Enable public status page.
Escolha um Public slug. Isto torna-se parte do URL público, portanto escolha algo reconhecível, tal como o nome do seu produto.
Opcionalmente defina um Ping path. Por predefinição é /.
Preencha o Page title e Tagline mostrados no topo da página pública.
Decida se quer Show recent deploys e Show recent incidents.
Clique em Save settings.

Uma vez guardado, a página mostra um crachá Live e confirma que a sua página de estado foi publicada e está a enviar um ping a cada minuto. Uma ligação leva-o à página pública para que possa ver o que os visitantes veem.

Regras de Slug

O slug deve ter letras minúsculas, dígitos e hífenes, até 80 caracteres, e não pode começar nem terminar com um hífen. Os slugs são únicos em todo o Orbit, não apenas na sua conta, portanto uma palavra comum pode já estar ocupada. Se estiver, guardar devolve uma mensagem dizendo que o slug já está ocupado e escolhe outro.

Escolha o slug com cuidado: é o endereço público que colocará na sua documentação e nas suas respostas de suporte, e alterá-lo posteriormente quebra todas as ligações para ele.

O Que os Visitantes Veem

A página pública é construída a partir dos mesmos dados que os separadores do seu próprio projeto:

Current status, da implementação mais recente: Operational, Building, Deploying, Queued, Awaiting Approval, Build Failed, Cancelled ou Rolled Back.
Uptime, calculado em janelas contínuas de 24 horas, 7 dias e 30 dias a partir das verificações minuto a minuto.
Recent deployments com uma taxa de sucesso, se ativou essa secção.
30-day statistics: taxa de sucesso, tempo médio de construção e total de implementações.
Core Web Vitals, como p75 nos últimos 30 dias, se os está a recolher.
Incidents, extraídos de anotações que marcou na linha cronológica do projeto.

A página atualiza-se automaticamente, portanto um cliente que a deixa aberta durante um incidente vê-a atualizar-se sem recarregar.

Tudo na página é dados operacionais: estado de implementação, tempos de resposta, tempo de atividade e vitals. Mensagens de commit, nomes de ramo, variáveis de ambiente e os detalhes do seu repositório não são publicados.

Incidentes Vêm da Linha Cronológica

A secção de incidentes não é um editor separado. Mostra anotações do tipo Incident da Timeline do projeto, portanto o fluxo de trabalho durante uma falha é: marcar uma anotação de incidente, e aparece publicamente.

Isto é intencional. Significa que a sua linha cronológica interna e a sua comunicação pública mantêm-se sincronizadas sem que ninguém mantenha dois registos. Consulte Orbit Timeline Annotations para saber como escrever uma.

Escreva anotações de incidentes como se um cliente as fosse ler, porque vai. Diga o que é afetado, o que sabe e quando fará a próxima atualização. Depois publique uma anotação de atualização quando for resolvido, em vez de deixar a última palavra pública como "investigando".

A Verificação de Tempo de Atividade

Ativar a página de estado inicia uma verificação que obtém o URL de produção do seu projeto, no caminho de ping que definiu, uma vez por minuto. Cada resultado é armazenado e as percentagens de tempo de atividade na página pública são calculadas a partir desses registos.

As verificações são mantidas por 90 dias e as mais antigas são removidas automaticamente.

Escolher um Bom Caminho de Ping

O padrão / funciona para a maioria dos projetos. Duas razões para escolher algo diferente:

A sua página inicial é pesada. Um caminho leve é algo mais justo e económico para sondagem uma vez por minuto.
A sua página inicial pode estar operacional enquanto a aplicação está quebrada. Um shell estático em cache devolverá felizmente 200 enquanto a sua API está inativa. Um caminho tal como /api/health que realmente exercita a aplicação diz a verdade.

Se já tem uma verificação de integridade configurada para reversão automática, usar o mesmo caminho aqui mantém ambos os sinais consistentes. Consulte Deploying Your Project para as definições de verificação de integridade.

Não aponte o caminho de ping para algo dispendioso, e não o aponte para um caminho atrás de autenticação. Um caminho que devolve 401 ou 302 para uma página de início de sessão registará uma falha a cada minuto e o seu tempo de atividade será lido como zero.

Remover a Página de Estado

Clique em Remove page e confirme. A confirmação é explícita: todo o histórico de tempo de atividade será eliminado.

Vale a pena fazer uma pausa nisso. Remover a página não é um botão de pausa. A verificação para, o URL público deixa de funcionar e o registo de tempo de atividade acumulado desaparece com ele. Se apenas quer que a página seja temporariamente invisível, não há modo oculto: considere se desativar o comutador de ativação e deixar a configuração no lugar se adequa melhor para si do que removê-la.

O slug é libertado quando a página é removida, portanto outra pessoa pode reclamá-lo posteriormente.

Conselhos Práticos

Publique antes de precisar. Uma página de estado criada durante uma falha é uma página de estado que ninguém marcou. Coloque a ligação no seu rodapé, na sua documentação e na sua assinatura de suporte enquanto tudo está bem.

Não prometa em excesso. A figura de tempo de atividade na página vem de uma verificação de um minuto contra um caminho. É monitorização honesta, não um SLA contratual, e não deve ser apresentada como tal.

Mantenha o tagline curto. Fica sob o título numa página que as pessoas abrem quando já estão frustradas. Uma linha dizendo o que é o serviço, e nada mais.

Resolução de Problemas

Tempo de atividade mostra 0% ou é muito menor do que a realidade. O caminho de ping está a devolver uma resposta não-2xx. Abra-o numa janela de navegação privada: um redirecionamento para uma página de início de sessão, um 404 de um caminho que já não existe, ou um bloqueio geográfico são as causas usuais.

O URL público mostra 404. A página é guardada mas o comutador de ativação está desativado, ou o slug na sua ligação não corresponde ao guardado. Copie a ligação da página de definições.

O slug é rejeitado. Está ocupado, contém um carácter inválido, ou começa ou termina com um hífen.

Não aparecem vitals na página pública. Os vitals vêm do script do coletor no seu site. Consulte Orbit Web Vitals.

Não aparecem incidentes apesar de termos tido um. A anotação tem de ser do tipo Incident, e o comutador Show recent incidents tem de estar ativado.

Para Onde Ir a Seguir

Orbit Timeline Annotations para publicar atualizações de incidentes.
Orbit Webhooks para ser notificado antes dos seus clientes.
Orbit Web Vitals para as figuras de desempenho mostradas publicamente.