feat: use synapse-sdk telemetry (#154)

* feat: use synapse-sdk telemetry

* fix: allow filecoin-pin consumers to append to appName

* fix: cleanup telemetry

* chore: fix type errors after merge

Author: SgtPooki

package.json

@@ -97,7 +97,7 @@
   "homepage": "https://github.com/filecoin-project/filecoin-pin#readme",
   "dependencies": {
     "@clack/prompts": "^0.11.0",
-    "@filoz/synapse-sdk": "^0.35.0",
+    "@filoz/synapse-sdk": "^0.35.1",
     "@helia/unixfs": "^6.0.1",
     "@ipld/car": "^5.4.2",
     "commander": "^14.0.1",

src/core/synapse/index.ts

@@ -9,10 +9,12 @@ import {
   type StorageServiceOptions,
   Synapse,
   type SynapseOptions,
+  type TelemetryConfig,
 } from '@filoz/synapse-sdk'
 import { type Provider as EthersProvider, JsonRpcProvider, type Signer, Wallet, WebSocketProvider } from 'ethers'
 import type { Logger } from 'pino'
 import { ADDRESS_ONLY_SIGNER_SYMBOL, AddressOnlySigner } from './address-only-signer.js'
+import { getTelemetryConfig } from './telemetry-config.js'
 
 const WEBSOCKET_REGEX = /^ws(s)?:\/\//i
 
@@ -62,6 +64,20 @@ interface BaseSynapseConfig {
   /** Optional override for WarmStorage contract address */
   warmStorageAddress?: string | undefined
   withCDN?: boolean | undefined
+  /**
+   * Telemetry configuration, merges fields, but appends "appName" to the existing appName
+   * @example
+   * {
+   *   sentryInitOptions: {
+   *     enabled: true,
+   *   },
+   *   sentrySetTags: {
+   *     appName: "${your-app-name}",
+   *   },
+   * }
+   * will result in your appName being "filecoin-pin@v1.0.0-${your-app-name}"
+   */
+  telemetry?: TelemetryConfig
 }
 
 /**
@@ -296,7 +312,11 @@ async function setupSessionKey(synapse: Synapse, sessionWallet: Wallet, logger:
  * @param logger - Logger instance for detailed operation tracking
  * @returns Initialized Synapse instance
  */
-export async function initializeSynapse(config: Partial<SynapseSetupConfig>, logger: Logger): Promise<Synapse> {
+export async function initializeSynapse(
+  config: Partial<SynapseSetupConfig>,
+  logger: Logger,
+  telemetryConfig?: TelemetryConfig
+): Promise<Synapse> {
   try {
     const authMode = validateAuthConfig(config)
 
@@ -320,6 +340,9 @@ export async function initializeSynapse(config: Partial<SynapseSetupConfig>, log
     if (config.warmStorageAddress) {
       synapseOptions.warmStorageAddress = config.warmStorageAddress
     }
+    if (telemetryConfig) {
+      synapseOptions.telemetry = getTelemetryConfig(telemetryConfig)
+    }
 
     let synapse: Synapse
 
@@ -337,7 +360,10 @@ export async function initializeSynapse(config: Partial<SynapseSetupConfig>, log
       const sessionWallet = new Wallet(config.sessionKey, provider)
 
       // Initialize with owner signer, then activate session key
-      synapse = await Synapse.create({ ...synapseOptions, signer: ownerSigner })
+      synapse = await Synapse.create({
+        ...synapseOptions,
+        signer: ownerSigner,
+      })
       await setupSessionKey(synapse, sessionWallet, logger)
     } else if (authMode === 'signer') {
       // Signer mode - type guard ensures signer is defined
@@ -623,6 +649,11 @@ export async function cleanupProvider(provider: any): Promise<void> {
  * and allow the process to terminate
  */
 export async function cleanupSynapseService(): Promise<void> {
+  // Close telemetry to flush pending events and shutdown cleanly
+  if (synapseInstance) {
+    await synapseInstance.telemetry?.sentry?.close()
+  }
+
   if (activeProvider) {
     await cleanupProvider(activeProvider)
   }

src/core/synapse/telemetry-config.ts

@@ -0,0 +1,23 @@
+import type { TelemetryConfig } from '@filoz/synapse-sdk'
+// biome-ignore lint/correctness/useImportExtensions: package.json is bundled for browser and node
+import packageJson from '../../../package.json' with { type: 'json' }
+
+export const getTelemetryConfig = (config?: TelemetryConfig | undefined): TelemetryConfig => {
+  let appName = `${packageJson.name}@v${packageJson.version}`
+  if (config?.sentrySetTags?.appName != null) {
+    appName = `${appName}-${String(config.sentrySetTags.appName)}`
+  }
+
+  return {
+    ...config,
+    sentryInitOptions: {
+      enabled: true,
+      // allow config.enabled to override default
+      ...config?.sentryInitOptions,
+    },
+    sentrySetTags: {
+      ...config?.sentrySetTags,
+      appName, // use constructed appName, always.
+    },
+  }
+}

src/payments/interactive.ts

@@ -22,6 +22,7 @@ import {
   validatePaymentRequirements,
 } from '../core/payments/index.js'
 import { cleanupProvider, cleanupSynapseService } from '../core/synapse/index.js'
+import { getTelemetryConfig } from '../core/synapse/telemetry-config.js'
 import { formatUSDFC } from '../core/utils/format.js'
 import { createSpinner, intro, outro } from '../utils/cli-helpers.js'
 import { isTTY, log } from '../utils/cli-logger.js'
@@ -91,6 +92,7 @@ export async function runInteractiveSetup(options: PaymentSetupOptions): Promise
     const rpcUrl = options.rpcUrl || RPC_URLS.calibration.websocket
 
     const synapse = await Synapse.create({
+      telemetry: getTelemetryConfig(),
       privateKey,
       rpcURL: rpcUrl,
       withIpni: true, // Always filter for IPNI-enabled providers

tsconfig.json

@@ -26,6 +26,6 @@
     "allowUnreachableCode": false,
     "resolveJsonModule": true
   },
-  "include": ["src/**/*"],
+  "include": ["src/**/*", "package.json"],
   "exclude": ["node_modules", "dist"]
 }