Telemetriedaten hinzufügen (BETA)

Sie können für Ihre App eine Telemetriefunktion einrichten, die zur Ablage von Protokolldaten dient, um diese an einen externen Observability-Anbieter weiterzuleiten. Derzeit werden nur Honeycomb und Sentry als Drittanbieter unterstützt.

Erstellen und Einrichten von Telemetriekomponentendateien

Erstellen Sie im app/-Verzeichnis Ihres Projekts ein telemetry/-Verzeichnis und fügen Sie dort eine telemetry-hsmeta.json-Konfigurationsdatei hinzu.

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

Bearbeiten Sie die telemetry-hsmeta.json-Datei, um Ihren Anbieter, die Einstellungen auf Protokollebene usw. zu konfigurieren. Nachstehend finden Sie eine Beispieldatei sowie eine Tabelle, in der die einzelnen verfügbaren Felder aufgeführt sind.

Hinweis: Standardmäßig werden alle Protokolltypen und -ebenen über die logTypes- und logLevels-Felder mit Ihrem Anbieter synchronisiert, was zu einem sehr hohen Datenvolumen führen kann. Deshalb wird dringend empfohlen, zunächst nur die Protokolltypen zu konfigurieren, an denen Sie interessiert sind, und die Protokollebenen so festzulegen, dass nur nach Fehlern gefiltert wird.

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"]
  }
}

Feld	Typ	Beschreibung
`uid`	Zeichenfolge	Eine eindeutige ID für Ihre Telemetriekonfiguration. Dieser Wert kann auf einen beliebigen Wert festgelegt werden, wird jedoch in den Projekteinstellungen in Ihrem Account angezeigt und sollte sich daher von den `uid`-Werten anderer App-Komponenten unterscheiden.
`type`	Zeichenfolge	Der Typ der Komponente, der in diesem Fall `telemetry` lauten sollte.
`config`	Objekt	Dies ist ein Objekt, das die Konfigurationsdetails enthält; s. die Untereigenschaften in den folgenden Zeilen.
`providerType`	Zeichenfolge	Der Name Ihres Drittanbieters für Telemetriedaten. Derzeit werden nur `SENTRY` und `HONEYCOMB` unterstützt.
`datasetName`	Zeichenfolge	Ein Label, das Ihren Protokolldaten zugeordnet wird, wenn Ihr Anbieter diese Option unterstützt.
`logTypes`	Array	Eine Liste von Protokolltypen, die an Ihren externen Anbieter gesendet werden. Standardmäßig werden alle Protokolle an Ihren Anbieter weitergegeben. Die verfügbaren Protokolltypen umfassen: `["CRM_LEGACY_CARD", "CRM_EXTENSIBILITY_CARD", "WEBHOOKS", "API_CALL", "APP_SETTINGS", "SERVERLESS_EXECUTION", "PROXY_EXECUTION", "EXTENSION_RENDER", "EXTENSION_LOG", "SERVERLESS_GATEWAY_EXECUTION"]`.
`logLevels`	Array	Eine Liste von Schweregraden, nach denen Protokolle gefiltert werden sollen. Unterstützte Protokollebenen sind: `["ERROR", "WARNING", "INFO"]`

Externe Authentifizierung als Geheimnis per CLI hinzufügen

Zusätzlich zum Erstellen der zuvor genannten telemetry-hsmeta.json-Konfigurationsdatei müssen Sie auch ein Geheimnis hinzufügen, das dem Authentifizierungsschlüssel Ihres Anbieters entspricht:

Wenn Sie Sentry verwenden, fügen Sie den DSN (Namen der Datenquelle) als Geheimnis hinzu.
Wenn Sie Honeycomb verwenden, fügen Sie einen API-Schlüssel als Geheimnis hinzu.

Einen Sentry-DSN finden

Wenn Sie Sentry verwenden, führen Sie die folgenden Schritte zum DSN-Erhalt aus:

Melden Sie sich bei Ihrem Sentry-Konto an.
Gehen Sie zu den Einstellungen Ihres Projekts.
Im Abschnitt Clientschlüssel oder im Bereich DSN finden Sie einen eindeutigen DSN-Eintrag für Ihr Projekt. Dieser sollte wie folgt aussehen:

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

Einen Honeycomb-API-Schlüssel finden

Wenn Sie Honeycomb als externen Observability-Anbieter verwenden, wird ein API-Schlüssel zur Authentifizierung und Weiterleitung von Daten verwendet. Dieser API-Schlüssel ist mit Ihrem spezifischen Honeycomb-Account und -Projekt verknüpft. So generieren Sie einen Honeycomb-API-Schlüssel:

Melden Sie sich bei Ihrem Honeycomb-Konto an.
Gehen Sie zu den Einstellungen Ihres Projekts,
dann zum Abschnitt API-Schlüssel und generieren Sie einen neuen Schlüssel.
Kopieren Sie den generierten API-Schlüssel.

Ein Geheimnis mithilfe des HubSpot CLI hinzufügen

Nachdem Sie entweder Ihren Sentry DSN- oder Honeycomb-API-Schlüssel erhalten haben, führen Sie den folgenden Befehl aus, um den Wert als Geheimnis hinzuzufügen. Wenn Sie zur Eingabe des Namens des Geheimnisses aufgefordert werden, müssen Sie TELEMETRY_SECRET für die korrekte Synchronisierung der Protokolldaten verwenden.

hs app secrets add

Integrationen erstellen

Funktionen hinzufügen

Im HubSpot Marketplace veröffentlichen

Telemetriedaten hinzufügen (BETA)

Erstellen und Einrichten von Telemetriekomponentendateien

telemetry-hsmeta.json

Externe Authentifizierung als Geheimnis per CLI hinzufügen

Einen Sentry-DSN finden

Einen Honeycomb-API-Schlüssel finden

Ein Geheimnis mithilfe des HubSpot CLI hinzufügen

​Erstellen und Einrichten von Telemetriekomponentendateien

​telemetry-hsmeta.json

​Externe Authentifizierung als Geheimnis per CLI hinzufügen

​Einen Sentry-DSN finden

​Einen Honeycomb-API-Schlüssel finden

​Ein Geheimnis mithilfe des HubSpot CLI hinzufügen

Erstellen und Einrichten von Telemetriekomponentendateien

telemetry-hsmeta.json

Externe Authentifizierung als Geheimnis per CLI hinzufügen

Einen Sentry-DSN finden

Einen Honeycomb-API-Schlüssel finden

Ein Geheimnis mithilfe des HubSpot CLI hinzufügen