@dxos/observability 0.8.4-main.84f28bd → 0.8.4-main.8baae0fced

package/dist/types/src/observability.d.ts

@@ -1,112 +1,34 @@
-import { type Client, type Config } from '@dxos/client';
-import { type ClientServices } from '@dxos/client-protocol';
-import { type IPData } from './helpers';
-import { type TrackOptions, type PageOptions } from './segment';
-import { type InitOptions } from './sentry';
-export type ObservabilitySecrets = {
-    DX_ENVIRONMENT: string | null;
-    DX_RELEASE: string | null;
-    SENTRY_DESTINATION: string | null;
-    TELEMETRY_API_KEY: string | null;
-    IPDATA_API_KEY: string | null;
-    OTEL_ENDPOINT: string | null;
-    OTEL_AUTHORIZATION: string | null;
-};
-export type TagScope = 'errors' | 'telemetry' | 'metrics' | 'all';
-/** Gathering mode. */
-export type Mode = 'basic' | 'full' | 'disabled';
-export type ObservabilityOptions = {
-    mode: Mode;
-    /** Environment. */
-    environment?: string;
-    /** Application namespace. */
-    namespace: string;
-    /** Application release. */
-    release?: string;
-    /** User group. */
-    group?: string;
-    config?: Config;
-    secrets?: Record<string, string>;
-    telemetry?: {
-        batchSize?: number;
-    };
-    errorLog?: {
-        sentryInitOptions?: InitOptions;
-    };
-};
-export declare class Observability {
-    private _mode;
-    private readonly _namespace;
-    private readonly _config?;
-    private readonly _group?;
-    private readonly _secrets;
-    private readonly _tags;
-    private _otelMetrics?;
-    private _otelTraces?;
-    private _telemetryBatchSize;
-    private _telemetry?;
-    private _sentryLogProcessor?;
-    private _otelLogs?;
-    private _errorReportingOptions?;
-    private _captureException?;
-    private _captureUserFeedback?;
-    private _lastNetworkStatus?;
-    private _ctx;
-    constructor({ mode, namespace, environment, release, config, group, secrets, telemetry, errorLog, }: ObservabilityOptions);
-    get mode(): Mode;
-    get group(): string | undefined;
-    get enabled(): boolean;
-    private _loadSecrets;
-    initialize(): Promise<void>;
-    close(): Promise<void>;
-    setMode(mode: Mode): void;
-    /** Callback (e.g., to share tags with Sentry.) */
-    private _setTag?;
-    /**
-     * camelCase keys are converted to snake_case in Segment.
-     */
-    setTag(key: string, value: string | undefined, scope?: TagScope): void;
-    getTag(key: string): {
-        value: string;
-        scope: TagScope;
-    } | undefined;
-    setIdentityTags(clientServices: Partial<ClientServices>): Promise<void>;
-    setIPDataTelemetryTags: (ipData: IPData) => void;
-    private _initLogs;
-    private _initMetrics;
-    /**
-     * Gauge metric.
-     *
-     * The default implementation uses OpenTelemetry
-     */
-    gauge(name: string, value: number | any, extraTags?: any): void;
-    startNetworkMetrics(clientServices: Partial<ClientServices>): void;
-    startSpacesMetrics(client: Client, namespace: string): void;
-    startRuntimeMetrics(client: Client, frequency?: number): Promise<void>;
-    private _initTelemetry;
-    /**
-     * Submit telemetry page view.
-     * The default implementation uses Segment.
-     */
-    page(options: PageOptions): void;
-    /**
-     * Submit telemetry user action.
-     * The default implementation uses Segment.
-     */
-    track(options: TrackOptions): void;
-    private _initErrorLogs;
-    startErrorLogs(): void;
-    startTraces(): void;
-    private _initTraces;
-    /**
-     * Manually capture an exception.
-     * The default implementation uses Sentry.
-     */
-    captureException(err: any): void;
-    /**
-     * Manually capture user feedback.
-     * The default implementation uses Sentry.
-     */
-    captureUserFeedback(message: string): void;
+import * as Effect from 'effect/Effect';
+import { type CleanupFn } from '@dxos/async';
+import { type Attributes, type Errors, type Events, type Extension, type Feedback, type Kind, type Metrics } from './observability-extension';
+export * from './storage';
+/**
+ * Provider of observability data.
+ */
+export type DataProvider = (observability: Observability) => Effect.Effect<CleanupFn | void, Error>;
+/**
+ * Extensible observability provider.
+ */
+export interface Observability {
+    initialize(): Effect.Effect<void>;
+    close(): Effect.Effect<void>;
+    enable(): Effect.Effect<void>;
+    disable(): Effect.Effect<void>;
+    flush(): Effect.Effect<void>;
+    addDataProvider(dataProvider: DataProvider): Effect.Effect<void, Error>;
+    identify(distinctId: string, attributes?: Attributes, setOnceAttributes?: Attributes): void;
+    alias(distinctId: string, previousId?: string): void;
+    setTags(tags: Attributes, kind?: Kind): void;
+    enabled: boolean;
+    errors: Errors;
+    events: Events;
+    feedback: Feedback;
+    /** True if at least one extension of the given kind reports as available. */
+    isAvailable(kind: Kind): Effect.Effect<boolean>;
+    metrics: Metrics;
 }
+export declare const make: () => Effect.Effect<Observability>;
+export declare const addExtension: (_extension: Effect.Effect<Extension>) => (_observability: Effect.Effect<Observability, never, never>) => Effect.Effect<Observability & Record<"_addExtension", unknown>, never, never>;
+export declare const addDataProvider: (dataProvider: DataProvider) => (_observability: Effect.Effect<Observability, never, never>) => Effect.Effect<Observability & Record<"_addDataProvider", unknown>, never, never>;
+export declare const initialize: (_observability: Effect.Effect<Observability, never, never>) => Effect.Effect<Observability, never, never>;
 //# sourceMappingURL=observability.d.ts.map

package/dist/types/src/observability.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"observability.d.ts","sourceRoot":"","sources":["../../../src/observability.ts"],"names":[],"mappings":"AAKA,OAAO,EAAa,KAAK,MAAM,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AACnE,OAAO,EAAE,KAAK,cAAc,EAAc,MAAM,uBAAuB,CAAC;AASxE,OAAO,EAAwB,KAAK,MAAM,EAAa,MAAM,WAAW,CAAC;AAEzE,OAAO,EAAyB,KAAK,YAAY,EAAE,KAAK,WAAW,EAAkB,MAAM,WAAW,CAAC;AACvG,OAAO,EAAE,KAAK,WAAW,EAAmD,MAAM,UAAU,CAAC;AAS7F,MAAM,MAAM,oBAAoB,GAAG;IACjC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,GAAG,KAAK,CAAC;AAElE,sBAAsB;AACtB,MAAM,MAAM,IAAI,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,CAAC;AAEjD,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,IAAI,CAAC;IAEX,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAC;IAElB,2BAA2B;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,kBAAkB;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC,SAAS,CAAC,EAAE;QACV,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IAEF,QAAQ,CAAC,EAAE;QACT,iBAAiB,CAAC,EAAE,WAAW,CAAC;KACjC,CAAC;CACH,CAAC;AAyBF,qBAAa,aAAa;IACxB,OAAO,CAAC,KAAK,CAAO;IACpB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAuB;IAChD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAyD;IAG/E,OAAO,CAAC,YAAY,CAAC,CAAc;IACnC,OAAO,CAAC,WAAW,CAAC,CAAa;IAEjC,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,UAAU,CAAC,CAAmB;IAEtC,OAAO,CAAC,mBAAmB,CAAC,CAAqB;IACjD,OAAO,CAAC,SAAS,CAAC,CAAW;IAC7B,OAAO,CAAC,sBAAsB,CAAC,CAAc;IAC7C,OAAO,CAAC,iBAAiB,CAAC,CAAgC;IAC1D,OAAO,CAAC,oBAAoB,CAAC,CAAqC;IAClE,OAAO,CAAC,kBAAkB,CAAC,CAAgB;IAE3C,OAAO,CAAC,IAAI,CAAiB;gBAGjB,EACV,IAAI,EACJ,SAAS,EACT,WAAW,EACX,OAAO,EACP,MAAM,EACN,KAAK,EACL,OAAO,EACP,SAAS,EACT,QAAQ,GACT,EAAE,oBAAoB;IAmBvB,IAAI,IAAI,SAEP;IAED,IAAI,KAAK,uBAER;IAED,IAAI,OAAO,YAEV;IAED,OAAO,CAAC,YAAY;IA+Bd,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAS3B,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAW5B,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAQzB,kDAAkD;IAClD,OAAO,CAAC,OAAO,CAAC,CAAuC;IAEvD;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,CAAC,EAAE,QAAQ,GAAG,IAAI;IActE,MAAM,CAAC,GAAG,EAAE,MAAM;eA3IgC,MAAM;eAAS,QAAQ;;IAgJnE,eAAe,CAAC,cAAc,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAmC7E,sBAAsB,GAAI,QAAQ,MAAM,UAMtC;YAMY,SAAS;YA8BT,YAAY;IAuB1B;;;;OAIG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,GAAG,EAAE,SAAS,CAAC,EAAE,GAAG,GAAG,IAAI;IAM/D,mBAAmB,CAAC,cAAc,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,IAAI;IAoDlE,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAuDrD,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,GAAE,MAAqC,GAAG,OAAO,CAAC,IAAI,CAAC;YA8C5F,cAAc;IAoB5B;;;OAGG;IACH,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAIhC;;;OAGG;IACH,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;YAQpB,cAAc;IAiC5B,cAAc,IAAI,IAAI;IAItB,WAAW,IAAI,IAAI;YAKL,WAAW;IAoBzB;;;OAGG;IACH,gBAAgB,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAMhC;;;OAGG;IACH,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;CAW3C"}
+{"version":3,"file":"observability.d.ts","sourceRoot":"","sources":["../../../src/observability.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAGxC,OAAO,EAAE,KAAK,SAAS,EAAoB,MAAM,aAAa,CAAC;AAI/D,OAAO,EACL,KAAK,UAAU,EACf,KAAK,MAAM,EACX,KAAK,MAAM,EACX,KAAK,SAAS,EAEd,KAAK,QAAQ,EACb,KAAK,IAAI,EACT,KAAK,OAAO,EACb,MAAM,2BAA2B,CAAC;AAEnC,cAAc,WAAW,CAAC;AAM1B;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,aAAa,EAAE,aAAa,KAAK,MAAM,CAAC,MAAM,CAAC,SAAS,GAAG,IAAI,EAAE,KAAK,CAAC,CAAC;AAEpG;;GAEG;AAEH,MAAM,WAAW,aAAa;IAC5B,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAClC,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7B,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC9B,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/B,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7B,eAAe,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACxE,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,EAAE,iBAAiB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAC5F,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrD,OAAO,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAC7C,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,6EAA6E;IAC7E,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAChD,OAAO,EAAE,OAAO,CAAC;CAClB;AAwND,eAAO,MAAM,IAAI,QAAO,MAAM,CAAC,MAAM,CAAC,aAAa,CAA4C,CAAC;AAEhG,eAAO,MAAM,YAAY,eAAgB,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,kJAO7D,CAAC;AAEL,eAAO,MAAM,eAAe,iBAAkB,YAAY,qJAMtD,CAAC;AAEL,eAAO,MAAM,UAAU,4GAIrB,CAAC"}