Skip to main content
Un proyecto es el límite de acceso de la telemetría. Cada señal aceptada pertenece a un proyecto, y todos los comandos de lectura pueden filtrar por proyecto. Usa un proyecto aparte cuando la telemetría necesite un límite propio de responsabilidad o de acceso. Para la mayoría de los equipos, eso equivale a una app, un servicio o un área de producto. Un repositorio no tiene por qué corresponder a un proyecto. Un monorepo puede enviar varios servicios a un mismo proyecto. Usa los nombres de servicio para distinguirlos.

Proyecto, servicio y entorno

Configura un proyecto

Instala la CLI. Ejecuta logbrew status --json para leer el acceso de tu cuenta. Si el acceso no es válido, una persona ejecuta logbrew login. Una clave de ingesta del proyecto no sirve para iniciar sesión.
1

Crea o selecciona un proyecto

Primero, lista tus proyectos. Crea un proyecto solo si no existe.
La CLI escribe la clave de ingesta en un archivo nuevo al que solo accede su propietario. Nunca muestra la clave ni la ruta del archivo. Si el resultado no está claro, vuelve a ejecutar exactamente el mismo comando. No cambies el nombre del proyecto ni el archivo de la clave. La CLI reutiliza la identidad de su solicitud pendiente. El Inicio rápido muestra cómo leer el ID del proyecto en el resultado.Para un proyecto existente, registra el estado de configuración:
Para crear otra clave de ingesta para un proyecto existente, usa logbrew projects keys create. Rotar una clave de ingesta muestra el comando.logbrew setup --create-project solo muestra la ayuda. No crea ningún proyecto.
2

Define los nombres de servicio en el SDK

Usa nombres de tu repositorio y tu despliegue, como api, worker, web, ios o checkout-api. Un nombre de servicio es una etiqueta, no un selector de proyecto. La clave de ingesta selecciona el proyecto. Cambiar el nombre de un servicio no mueve los eventos guardados. Si no encuentras un evento, comprueba el proyecto y la clave de ingesta que usa la aplicación antes de crear otro proyecto.
3

Usa entornos estándar

Usa production, staging, preview y local. Si tu despliegue usa otros nombres, úsalos de forma coherente. Un nombre de entorno no puede contener espacios, / ni una barra invertida.
4

Envía un evento de prueba y léelo

Configura el SDK con la clave de ingesta del proyecto, como describe Integración del SDK. Crear un proyecto no instala ningún SDK en tu aplicación. Mantén la clave fuera del control de versiones. Define el servicio, el entorno y el release en la aplicación. Envía un evento seguro y léelo:
Cada señal tiene su propia lista. Una lista de logs vacía no significa que el proyecto no tenga incidencias ni trazas.En el panel, selecciona el mismo proyecto y un intervalo de tiempo que incluya el evento de prueba. Comprueba que los filtros de servicio, entorno y release coinciden con el evento.

Diagnostica la configuración del proyecto

Lee el estado de configuración con el doctor del proyecto. No deduzcas el estado de configuración a partir de archivos locales ni de una consulta de logs vacía.
La CLI devuelve un informe con status, checks y next. El código de salida 0 no demuestra que todas las comprobaciones se superaran. Lee cada elemento de checks. Consulta Lee el informe de doctor de un proyecto.

Respuesta directa de la API

Los clientes de la API llaman a GET /api/projects/{project_id}/doctor con autenticación de cuenta. El endpoint no tiene parámetros de consulta ni cuerpo de solicitud. Nunca uses una clave de ingesta del proyecto para esta lectura. Una respuesta 200 tiene estas claves: project_id, state, setup_status, setup_acknowledged, has_active_ingest_key, first_telemetry_seen_at, last_seen_at, last_signal, next y next_action. Las marcas de tiempo son RFC3339 o null. last_signal es un resumen seguro para mostrar, no una señal sin procesar. El doctor comprueba primero la clave de ingesta. Un proyecto sin una clave de ingesta activa está en needs_ingest_key, sea cual sea su estado de configuración. setup_status es created, setup_started, sdk_seen, first_telemetry_seen o active. setup_acknowledged es true solo con los tres últimos valores. created da needs_setup. setup_started y sdk_seen dan needs_telemetry. first_telemetry_seen y active dan ready. Si la lectura sigue fallando, informa de un problema. No incluyas credenciales, cabeceras, cuerpos de señales, datos de clientes, rutas locales ni código fuente.

Archiva o elimina un proyecto

Archiva un proyecto para quitarlo de la lista de proyectos activos:
El comando necesita --yes. Después de archivarlo, las claves de ingesta del proyecto dejan de aceptar telemetría nueva. La ruta de la API es DELETE /api/projects/{project_id}. Devuelve 204 sin cuerpo. Lista los proyectos archivados con GET /api/projects/archived. Restaura uno con POST /api/projects/{project_id}/restore, que también devuelve 204. Elimina un proyecto de forma permanente solo cuando estés seguro:
Repite el ID exacto del proyecto después de --confirm. Una solicitud aceptada desactiva el proyecto de inmediato y programa su eliminación permanente. Después ya no puedes restaurar el proyecto.

Rota una clave de ingesta

Rotar una clave de ingesta describe el procedimiento de reemplazo, despliegue, prueba y revocación.