Customization

const otis = initOtis({
  apiKey: "sk-otis-xxx",         // Required (or OTIS_API_KEY env var on server)
  serviceName: "my-app",         // Required
  surface: "support-copilot",    // Named origin of flows (multi-surface services — optional)
  disabled: false,               // Silently drop all spans (default: false)
  endpoint: "https://...",       // Default: https://ingest.runotis.com
  serverless: true,              // Flush immediately (Lambda, Vercel, Workers)
  beforeSend: (span) => span,    // Pre-send hook for filtering / enrichment
  identifierHashing: true,       // HMAC-SHA256 hashing for all identifiers (default: true)
  setOnceKeys: ["signup_channel"], // User property keys that keep their first value
  browser: {                     // Browser identity via cookies
    autoAnonymousUserId: true,
    autoSessionId: true,
  },
  debug: true,                   // Debug logging
  piiRedaction: {                // PII redaction (enabled by default)
    enabled: true,
    disabledPatterns: ["ipv4"],
  },
});

// 1. Instance default — every span from this Otis instance
initOtis({ serviceName: "my-app", surface: "support-copilot" });

// 2. Per wrap / withContext — overrides the instance default for these spans
otis.wrap(ai, { context: { surface: "onboarding-copilot" } });
otis.withContext({ surface: "onboarding-copilot" }, async () => { /* ... */ });

// 3. Per integration
instrumentMcpServer(server, { zod: z, surface: "docs-mcp" });   // see MCP options
runInstrumentedCli(fn, { name: "my-cli" });                     // CLI defaults surface to `name`

const otis = initOtis({
  apiKey: "sk-otis-xxx",
  serviceName: "my-app",
  beforeSend: (span) => {
    // Drop noisy spans
    if (span.name.startsWith("internal.healthcheck")) return null;

    // Add required attributes to every span
    span.attributes = {
      ...span.attributes,
      "deploy.env": "production",
      "app.version": "1.2.3",
    };

    return span;
  },
});

import { initOtis, isAISpan } from "@runotis/sdk";

const otis = initOtis({
  serviceName: "my-app",
  beforeSend: (span) => isAISpan(span) ? span : null,
});

initOtis({ serviceName: "my-app", debug: true });             // all activity
initOtis({ serviceName: "my-app", debug: "traced,wrap" });    // specific types
initOtis({ serviceName: "my-app", debug: "verbose" });        // full payloads
initOtis({ serviceName: "my-app", debug: "verbose:filter" }); // verbose for specific types

[otis:filter] { span: 'ai.generateText', kept: true, reason: 'beforeSend' }
[otis:filter] { span: 'http.request', kept: false, reason: 'beforeSend_drop' }
[otis:filter] { span: 'otis_identifyUser', kept: true, reason: 'otis_event' }

otis.on("error", (err) => {
  myErrorReporter.captureException(err);
});

import {
  // Initialization
  initOtis,
  getOtisInstance,
  shutdownOtis,

  // Core class
  Otis,

  // Wrapping
  type WrapContext,
  type WrapOptions,
  type OtisOptions,
  extractUserTextContent,

  // Chat request helpers
  contextFromChatRequest,
  type ChatRequestContextOptions,
  OTIS_SESSION_COOKIE,    // "__otis_session"
  OTIS_SESSION_HEADER,    // "x-otis-session-id"

  // Span
  OtisSpan,
  getSpanId,

  // Event helpers
  identifyUser,
  setUserProperties,
  setGroupProperties,
  sendEvent,
  sendFeedbackSignal,

  // Context inspection
  currentSpan,
  withCurrent,

  // Application errors
  sendException,

  // Per-call metadata
  eventMetadata,

  // Browser identity
  CookieIdentityManager,
  type BrowserIdentityConfig,

  // Hashing
  isHashedUserId,
  isHashedSessionId,
  isHashedGroupId,

  // Filtering
  isAISpan,

  // PII redaction defaults
  DEFAULT_SCAN_ATTRIBUTES,
  DEFAULT_SCAN_ATTRIBUTE_PREFIXES,

  // Escape hatch
  OtisSpanProcessor,
  OtisExporter,
} from "@runotis/sdk";

// Next.js client
import {
  OtisProvider,
  useOtis,
  OtisPageView,
  withOtisConfig,
} from "@runotis/sdk/next";

// Next.js server
import {
  createOtisInstrumentation,
  getServerOtis,
} from "@runotis/sdk/next/server";