Agregar telemetría (BETA)

Puedes configurar la telemetría para tu aplicación, que actúa como un colector de registros para canalizar los datos de registro a un proveedor externo de supervisión. Actualmente, solo Honeycomb y Sentry son compatibles como proveedores de terceros.

Crear y configurar archivos de componentes de telemetría

En el directorio app/ de tu proyecto, crea un directorio telemetry/, y agrega en él un archivo de configuración telemetry-hsmeta.json.

└── src/
    └── app/
        └── telemetry/
            └── telemetry-hsmeta.json

Edita el archivo telemetry-hsmeta.json para configurar tu proveedor, los ajustes del nivel de registro y mucho más. Abajo se proporciona un archivo de ejemplo, junto con una tabla que detalla cada uno de los campos disponibles.

Nota: por defecto, todos los tipos y niveles de registro se sincronizarán con tu proveedor a través de los campos logTypes y logLevels, lo que puede provocar que se envíe un volumen muy elevado de datos. Se recomienda encarecidamente que empieces configurando solo los tipos de registro que te interesan y estableciendo los niveles de registro para filtrar solo los errores.

telemetry-hsmeta.json

{
  "uid": "telemetry",
  "type": "telemetry",
  "config": {
    "providerType": "SENTRY",
    "datasetName": "my-app-telemetry",
    "logTypes": ["API_CALL", "EXTENSION_LOG", "EXTENSION_RENDER", "DATA_FETCH"],
    "logLevels": ["ERROR", "WARN", "INFO"]
  }
}

Campo	Tipo	Descripción
`uid`	Cadena	Un identificador único para tu configuración de telemetría. Se puede establecer en cualquier valor, pero aparecerá en la configuración del proyecto en tu cuenta, por lo que debe ser diferente de otros valores de `uid` de otros componentes de la aplicación.
`type`	Cadena	El tipo de componente, que en este caso debe ser `telemetry`.
`config`	Objeto	Un objeto que contiene los detalles de la configuración. Consulta las subpropiedades enumeradas en las filas de abajo.
`providerType`	Cadena	El nombre de tu proveedor de telemetría externo. Actualmente, solo son compatibles `SENTRY` y `HONEYCOMB`.
`datasetName`	Cadena	Una etiqueta que se asociará a tus datos de registro, si tu proveedor admite esa opción.
`logTypes`	Matriz	Lista de tipos de registro enviados a tu proveedor externo. Por defecto, todos los registros se propagan a tu proveedor. Los tipos de registro disponibles son: `["CRM_LEGACY_CARD", "CRM_EXTENSIBILITY_CARD", "WEBHOOKS", "API_CALL", "APP_SETTINGS", "SERVERLESS_EXECUTION", "PROXY_EXECUTION", "EXTENSION_RENDER", "EXTENSION_LOG", "SERVERLESS_GATEWAY_EXECUTION"]`.
`logLevels`	Matriz	Lista de niveles de gravedad por los que filtrar los registros. Los niveles de registro admitidos son: `["ERROR", "WARNING", "INFO"]`

Agregar la autenticación externa como secreto a través de la CLI

Además de crear el archivo de configuración telemetry-hsmeta.json anterior, también tendrás que agregar un secreto que corresponda a la clave de autenticación de tu proveedor:

Si utilizas Sentry, agregarás el DSN (Nombre Fuente de Datos) como secreto.
Si utilizas Honeycomb, agregarás una clave de API como secreto.

Localizar un DSN de Sentry

Si utilizas Sentry, sigue los pasos que se indican a continuación para obtener tu DSN:

Accede a tu cuenta de Sentry.
Navega hasta la configuración de tu proyecto.
En la sección Claves de cliente o DSN, encontrarás un DSN único para tu proyecto. Debe parecerse a lo siguiente:

https://sentry-key@sentry-identifier.ingest.us.sentry.io/project-id

Localizar una clave de API de Honeycomb

Si utilizas Honeycomb como proveedor externo de supervisión, se utiliza una clave de API para autenticar y reenviar los datos. Esta clave de API está asociada a tu cuenta y proyecto de Honeycomb específicos. Para generar una clave de API de Honeycomb:

Accede a tu cuenta de Honeycomb.
Navega hasta la configuración de tu proyecto.
Busca la sección Claves de API y genera una nueva clave.
Copia la clave de API generada.

Agregar un secreto utilizando la CLI de HubSpot

Una vez que hayas obtenido tu DSN de Sentry o tu clave de API de Honeycomb, ejecuta el siguiente comando para agregar el valor como secreto. Cuando se te pida el nombre del secreto, debes utilizar TELEMETRY_SECRET para que los datos de registro se sincronicen correctamente.

hs app secrets add

Crear aplicaciones

Agregar funciones

Publicar en el mercado de HubSpot

Agregar telemetría (BETA)

Crear y configurar archivos de componentes de telemetría

telemetry-hsmeta.json

Agregar la autenticación externa como secreto a través de la CLI

Localizar un DSN de Sentry

Localizar una clave de API de Honeycomb

Agregar un secreto utilizando la CLI de HubSpot

​Crear y configurar archivos de componentes de telemetría

​telemetry-hsmeta.json

​Agregar la autenticación externa como secreto a través de la CLI

​Localizar un DSN de Sentry

​Localizar una clave de API de Honeycomb

​Agregar un secreto utilizando la CLI de HubSpot

Crear y configurar archivos de componentes de telemetría

telemetry-hsmeta.json

Agregar la autenticación externa como secreto a través de la CLI

Localizar un DSN de Sentry

Localizar una clave de API de Honeycomb

Agregar un secreto utilizando la CLI de HubSpot