Add telemetry - HubSpot docs

You can set up telemetry for your app, which acts as a log sink to pipe out log data to an external observability provider. Honeycomb and Sentry are supported as third-party providers. You can also specify a custom backend with an endpoint URL pointed at a specific backend provider of your choice. Note that using a custom backend provider for app telemetry is currently in beta, and is subject to HubSpot’s Developer Terms and Developer Beta Terms.

Create and set up telemetry component files

In your project’s src/app/ directory, create a telemetry/ directory, then add a telemetry-hsmeta.json configuration file within it.

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

Edit the telemetry-hsmeta.json file to configure your provider, log level settings, and more. An example file is provided below, along with a table that details each of the available fields.

Please note: by default, all log types and levels will be synced with your provider via the logTypes and logLevels fields, which may result in a very high volume of data being sent. It’s strongly recommended you start with configuring only the log types you’re interested in, and setting the log levels to filter for errors only.

telemetry-hsmeta.json

The code block below demonstrates an example telemetry-hsmeta.json file configured for Sentry:

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

Field	Type	Description
`uid`	String	A unique identifier for your telemetry configuration. This can be set to any value, but it will appear in your project settings in your account, so it should be different from other `uid` values of other app components.
`type`	String	The type of component, which should be `telemetry` in this case.
`config`	Object	An object containing the configuration details. See the sub-properties listed in the rows below.
`providerType`	String	The name of your third-party telemetry provider, which can be `SENTRY`, `HONEYCOMB`, or you can set this value to `CUSTOM_BACKEND` to propagate data to a specific backend provider of your choice. If you opt for a custom backend provider, you should also set the `endpointUrl` field detailed below.
`datasetName`	String	A label that will be associated with your log data, if your provider supports that option.
`logTypes`	Array	A list of log types sent to your external provider. By default, all logs are propagated to your provider. The available log types include: `API_CALL` `EXTENSION_LOG` `EXTENSION_RENDER` `DATA_FETCH` `ENDPOINT_FUNCTION` `APP_FUNCTION` `WEBHOOKS` `APP_SETTINGS` `CRM_LEGACY_CARD` .
`logLevels`	Array	A list of severity levels to filter logs by. Supported log levels are: `"ERROR"`, `"WARN"`, `"INFO"`, `"TRACE"`, and `"DEBUG"`
`endpointUrl`	String	If you specified a custom backend via the `CUSTOM_BACKEND` value as your `providerType`, use this field to provide the URL to your custom backend provider, following your provider’s documentation to get the URL that’s specific to your account. Omit this field if you’re using Sentry or Honeycomb as your telemetry provider.

Add external authentication as a secret via the CLI

In addition to creating the telemetry-hsmeta.json configuration file above, you’ll also need to add a secret that corresponds to the authentication key for your provider:

If you’re using Sentry, you’ll add the DSN (Data Source Name) as a secret.
If you’re using Honeycomb, you’ll add an API key as a secret.

Locate a Sentry DSN

If you’re using Sentry, follow the steps below to get your DSN:

Log into your Sentry account.
Navigate to your project’s settings.
Under the Client Keys or DSN section, you’ll find a unique DSN for your project. It should resemble the following:

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

Locate a Honeycomb API key

If you’re using Honeycomb as your external observability provider, an API key is used to authenticate and forward data. This API key is associated with your specific Honeycomb account and project. To generate a Honeycomb API key:

Log into your Honeycomb account.
Navigate to your project settings.
Find the API Keys section and generate a new key.
Copy the generated API key.

Add a secret using the HubSpot CLI

Once you’ve obtained either your Sentry DSN or Honeycomb API key, run the following command to add the value as a secret. When prompted for the name of the secret, you must use TELEMETRY_SECRET for log data to be synced correctly.

hs app secrets add

​Create and set up telemetry component files

​telemetry-hsmeta.json

​Add external authentication as a secret via the CLI

​Locate a Sentry DSN

​Locate a Honeycomb API key

​Add a secret using the HubSpot CLI

Create and set up telemetry component files

telemetry-hsmeta.json

Add external authentication as a secret via the CLI

Locate a Sentry DSN

Locate a Honeycomb API key

Add a secret using the HubSpot CLI