@squidcloud/client 1.0.281 → 1.0.282

package/dist/typescript-client/src/observability-client.d.ts

@@ -1 +1,39 @@
-export {};
+import { QueryMetricsRequest, QueryMetricsResponse } from '../../internal-common/src/public-types/metric.public-types';
+/** A client for reporting user metrics and querying both application-related Squid and user metrics. */
+export declare class ObservabilityClient {
+    private readonly rpcManager;
+    private pendingPromises;
+    private isReporting;
+    /**
+     * Reports metrics to the metric submission queue.
+     * The metric can be sent immediately or with some (several seconds) delay
+     * due to optimizations applied by Squid client.
+     * If no tags are provided tags are set to an empty record ({}).
+     * If no timestamp is provided the timestamp is set to now().
+     */
+    reportMetric<MetricNameType = string>(metric: MetricReport<MetricNameType>): void;
+    /**
+     * Flushes all pending (unsent) metrics.
+     * Note: Even after flushing, it may take some time for these metrics to become visible via 'queryMetrics' due to the
+     * eventual consistency of the metrics storage.
+     */
+    flush(): Promise<void>;
+    /** Queries a batch of metric values. */
+    queryMetrics<MetricName extends string = string>(metricRequest: QueryMetricsRequest<MetricName>): Promise<QueryMetricsResponse<MetricName>>;
+}
+/** A single metric event. */
+export interface Metric<MetricNameType = string> {
+    /** Name of the metric. */
+    name: MetricNameType;
+    /** Value of the metric. */
+    value: number;
+    /** Time associated with the metric. Milliseconds since UNIX epoch. */
+    timestamp: number;
+    /** Set of tags for the metric. */
+    tags: Record<string, string>;
+}
+/**
+ * MetricReport represents a single metric event with some optional fields.
+ * These optional fields are automatically populated by Squid with default values.
+ */
+export type MetricReport<MetricNameType = string> = Omit<Metric<MetricNameType>, 'tags' | 'timestamp'> & Partial<Pick<Metric, 'tags' | 'timestamp'>>;

package/dist/typescript-client/src/squid.d.ts

@@ -8,6 +8,7 @@ import { QueueManager } from './queue.manager';
 import { SecretClient } from './secret.client';
 import { StorageClient } from './storage-client';
 import { TransactionId } from './types';
+import { ObservabilityClient } from './observability-client';
 import { ExtractionClient } from './extraction-client';
 import { PersonalStorageClient } from './personal-storage-client';
 import { SchedulerClient } from './scheduler-client';
@@ -207,6 +208,7 @@ export declare class Squid {
     personalStorage(integrationId: IntegrationId): PersonalStorageClient;
     extraction(): ExtractionClient;
     get secrets(): SecretClient;
+    get observability(): ObservabilityClient;
     get schedulers(): SchedulerClient;
     /**
      * Returns a distributed lock for the given mutex. The lock can be used to synchronize access to a shared resource.

package/dist/typescript-client/src/version.d.ts

@@ -1 +1 @@
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.281";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.282";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.281",
+  "version": "1.0.282",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "types": "dist/typescript-client/src/index.d.ts",