@frengki0707/google-cloud-clone 1.33.0

package/lib/types.d.mts

@@ -0,0 +1,121 @@
+import { InstrumentationConfigMap } from '@opentelemetry/auto-instrumentations-node';
+import { Instrumentation } from '@opentelemetry/instrumentation';
+import { Sampler } from '@opentelemetry/sdk-trace-base';
+import { JWTInput } from 'google-auth-library';
+
+/**
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** Configuration options for the Google Cloud plugin. */
+interface GcpTelemetryConfigOptions {
+    /**
+     * Google Cloud Project ID. If provided, will take precedence over the
+     * projectId inferred from the application credential and/or environment.
+     * Required when providing an external credential (e.g. Workload Identity
+     * Federation.)
+     */
+    projectId?: string;
+    /**
+     * Credentials for authenticating with Google Cloud. Primarily intended for
+     * use in environments outside of GCP. On GCP credentials will typically be
+     * inferred from the environment via Application Default Credentials (ADC).
+     */
+    credentials?: JWTInput;
+    /**
+     * OpenTelemetry sampler; controls the number of traces collected and exported
+     * to Google Cloud. Defaults to AlwaysOnSampler, which will collect and export
+     * all traces.
+     *
+     * There are four built-in samplers to choose from:
+     *
+     * - {@link https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-sdk-trace-base/src/sampler/AlwaysOnSampler.ts | AlwaysOnSampler} - samples all traces
+     * - {@link https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-sdk-trace-base/src/sampler/AlwaysOffSampler.ts | AlwaysOffSampler} - samples no traces
+     * - {@link https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-sdk-trace-base/src/sampler/ParentBasedSampler.ts | ParentBasedSampler} - samples based on parent span
+     * - {@link https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-sdk-trace-base/src/sampler/TraceIdRatioBasedSampler.ts | TraceIdRatioBasedSampler} - samples a configurable percentage of traces
+     */
+    sampler?: Sampler;
+    /**
+     * Enabled by default, OpenTelemetry will automatically collect telemetry for
+     * popular libraries via auto instrumentations without any additional code
+     * or configuration. All available instrumentations will be collected, unless
+     * otherwise specified via {@link autoInstrumentationConfig}.
+     *
+     * @see https://opentelemetry.io/docs/zero-code/js/
+     */
+    autoInstrumentation?: boolean;
+    /**
+     * Map of auto instrumentations and their configuration options. Available
+     * options will vary by instrumentation.
+     *
+     * @see https://opentelemetry.io/docs/zero-code/js/
+     */
+    autoInstrumentationConfig?: InstrumentationConfigMap;
+    /**
+     * Additional OpenTelemetry instrumentations to include, beyond those
+     * provided by auto instrumentations.
+     */
+    instrumentations?: Instrumentation[];
+    /**
+     * Metrics export interval in milliseconds; Google Cloud requires a minimum
+     * value of 5000ms.
+     */
+    metricExportIntervalMillis?: number;
+    /**
+     * Timeout for the metrics export in milliseconds.
+     */
+    metricExportTimeoutMillis?: number;
+    /**
+     * If set to true, metrics will not be exported to Google Cloud. Traces and
+     * logs may still be exported.
+     */
+    disableMetrics?: boolean;
+    /**
+     * If set to true, traces will not be exported to Google Cloud. Metrics and
+     * logs may still be exported.
+     */
+    disableTraces?: boolean;
+    /**
+     * If set to true, input and output logs will not be collected.
+     */
+    disableLoggingInputAndOutput?: boolean;
+    /**
+     * If set to true, telemetry data will be exported in the Genkit `dev`
+     * environment. Useful for local testing and troubleshooting; default is
+     * false.
+     */
+    forceDevExport?: boolean;
+}
+/** Internal telemetry configuration. */
+interface GcpTelemetryConfig {
+    projectId?: string;
+    credentials?: JWTInput;
+    sampler: Sampler;
+    autoInstrumentation: boolean;
+    autoInstrumentationConfig: InstrumentationConfigMap;
+    metricExportIntervalMillis: number;
+    metricExportTimeoutMillis: number;
+    instrumentations: Instrumentation[];
+    disableMetrics: boolean;
+    disableTraces: boolean;
+    exportInputAndOutput: boolean;
+    export: boolean;
+}
+interface GcpPrincipal {
+    projectId?: string;
+    serviceAccountEmail?: string;
+}
+
+export type { GcpPrincipal, GcpTelemetryConfig, GcpTelemetryConfigOptions };

package/lib/types.d.ts

@@ -0,0 +1,121 @@
+import { InstrumentationConfigMap } from '@opentelemetry/auto-instrumentations-node';
+import { Instrumentation } from '@opentelemetry/instrumentation';
+import { Sampler } from '@opentelemetry/sdk-trace-base';
+import { JWTInput } from 'google-auth-library';
+
+/**
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** Configuration options for the Google Cloud plugin. */
+interface GcpTelemetryConfigOptions {
+    /**
+     * Google Cloud Project ID. If provided, will take precedence over the
+     * projectId inferred from the application credential and/or environment.
+     * Required when providing an external credential (e.g. Workload Identity
+     * Federation.)
+     */
+    projectId?: string;
+    /**
+     * Credentials for authenticating with Google Cloud. Primarily intended for
+     * use in environments outside of GCP. On GCP credentials will typically be
+     * inferred from the environment via Application Default Credentials (ADC).
+     */
+    credentials?: JWTInput;
+    /**
+     * OpenTelemetry sampler; controls the number of traces collected and exported
+     * to Google Cloud. Defaults to AlwaysOnSampler, which will collect and export
+     * all traces.
+     *
+     * There are four built-in samplers to choose from:
+     *
+     * - {@link https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-sdk-trace-base/src/sampler/AlwaysOnSampler.ts | AlwaysOnSampler} - samples all traces
+     * - {@link https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-sdk-trace-base/src/sampler/AlwaysOffSampler.ts | AlwaysOffSampler} - samples no traces
+     * - {@link https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-sdk-trace-base/src/sampler/ParentBasedSampler.ts | ParentBasedSampler} - samples based on parent span
+     * - {@link https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-sdk-trace-base/src/sampler/TraceIdRatioBasedSampler.ts | TraceIdRatioBasedSampler} - samples a configurable percentage of traces
+     */
+    sampler?: Sampler;
+    /**
+     * Enabled by default, OpenTelemetry will automatically collect telemetry for
+     * popular libraries via auto instrumentations without any additional code
+     * or configuration. All available instrumentations will be collected, unless
+     * otherwise specified via {@link autoInstrumentationConfig}.
+     *
+     * @see https://opentelemetry.io/docs/zero-code/js/
+     */
+    autoInstrumentation?: boolean;
+    /**
+     * Map of auto instrumentations and their configuration options. Available
+     * options will vary by instrumentation.
+     *
+     * @see https://opentelemetry.io/docs/zero-code/js/
+     */
+    autoInstrumentationConfig?: InstrumentationConfigMap;
+    /**
+     * Additional OpenTelemetry instrumentations to include, beyond those
+     * provided by auto instrumentations.
+     */
+    instrumentations?: Instrumentation[];
+    /**
+     * Metrics export interval in milliseconds; Google Cloud requires a minimum
+     * value of 5000ms.
+     */
+    metricExportIntervalMillis?: number;
+    /**
+     * Timeout for the metrics export in milliseconds.
+     */
+    metricExportTimeoutMillis?: number;
+    /**
+     * If set to true, metrics will not be exported to Google Cloud. Traces and
+     * logs may still be exported.
+     */
+    disableMetrics?: boolean;
+    /**
+     * If set to true, traces will not be exported to Google Cloud. Metrics and
+     * logs may still be exported.
+     */
+    disableTraces?: boolean;
+    /**
+     * If set to true, input and output logs will not be collected.
+     */
+    disableLoggingInputAndOutput?: boolean;
+    /**
+     * If set to true, telemetry data will be exported in the Genkit `dev`
+     * environment. Useful for local testing and troubleshooting; default is
+     * false.
+     */
+    forceDevExport?: boolean;
+}
+/** Internal telemetry configuration. */
+interface GcpTelemetryConfig {
+    projectId?: string;
+    credentials?: JWTInput;
+    sampler: Sampler;
+    autoInstrumentation: boolean;
+    autoInstrumentationConfig: InstrumentationConfigMap;
+    metricExportIntervalMillis: number;
+    metricExportTimeoutMillis: number;
+    instrumentations: Instrumentation[];
+    disableMetrics: boolean;
+    disableTraces: boolean;
+    exportInputAndOutput: boolean;
+    export: boolean;
+}
+interface GcpPrincipal {
+    projectId?: string;
+    serviceAccountEmail?: string;
+}
+
+export type { GcpPrincipal, GcpTelemetryConfig, GcpTelemetryConfigOptions };

package/lib/types.js

@@ -0,0 +1,17 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["/**\n * Copyright 2024 Google LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { InstrumentationConfigMap } from '@opentelemetry/auto-instrumentations-node';\nimport type { Instrumentation } from '@opentelemetry/instrumentation';\nimport type { Sampler } from '@opentelemetry/sdk-trace-base';\nimport type { JWTInput } from 'google-auth-library';\n\n/** Configuration options for the Google Cloud plugin. */\nexport interface GcpTelemetryConfigOptions {\n  /**\n   * Google Cloud Project ID. If provided, will take precedence over the\n   * projectId inferred from the application credential and/or environment.\n   * Required when providing an external credential (e.g. Workload Identity\n   * Federation.)\n   */\n  projectId?: string;\n\n  /**\n   * Credentials for authenticating with Google Cloud. Primarily intended for\n   * use in environments outside of GCP. On GCP credentials will typically be\n   * inferred from the environment via Application Default Credentials (ADC).\n   */\n  credentials?: JWTInput;\n\n  /**\n   * OpenTelemetry sampler; controls the number of traces collected and exported\n   * to Google Cloud. Defaults to AlwaysOnSampler, which will collect and export\n   * all traces.\n   *\n   * There are four built-in samplers to choose from:\n   *\n   * - {@link https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-sdk-trace-base/src/sampler/AlwaysOnSampler.ts | AlwaysOnSampler} - samples all traces\n   * - {@link https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-sdk-trace-base/src/sampler/AlwaysOffSampler.ts | AlwaysOffSampler} - samples no traces\n   * - {@link https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-sdk-trace-base/src/sampler/ParentBasedSampler.ts | ParentBasedSampler} - samples based on parent span\n   * - {@link https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-sdk-trace-base/src/sampler/TraceIdRatioBasedSampler.ts | TraceIdRatioBasedSampler} - samples a configurable percentage of traces\n   */\n  sampler?: Sampler;\n\n  /**\n   * Enabled by default, OpenTelemetry will automatically collect telemetry for\n   * popular libraries via auto instrumentations without any additional code\n   * or configuration. All available instrumentations will be collected, unless\n   * otherwise specified via {@link autoInstrumentationConfig}.\n   *\n   * @see https://opentelemetry.io/docs/zero-code/js/\n   */\n  autoInstrumentation?: boolean;\n\n  /**\n   * Map of auto instrumentations and their configuration options. Available\n   * options will vary by instrumentation.\n   *\n   * @see https://opentelemetry.io/docs/zero-code/js/\n   */\n  autoInstrumentationConfig?: InstrumentationConfigMap;\n\n  /**\n   * Additional OpenTelemetry instrumentations to include, beyond those\n   * provided by auto instrumentations.\n   */\n  instrumentations?: Instrumentation[];\n\n  /**\n   * Metrics export interval in milliseconds; Google Cloud requires a minimum\n   * value of 5000ms.\n   */\n  metricExportIntervalMillis?: number;\n\n  /**\n   * Timeout for the metrics export in milliseconds.\n   */\n  metricExportTimeoutMillis?: number;\n\n  /**\n   * If set to true, metrics will not be exported to Google Cloud. Traces and\n   * logs may still be exported.\n   */\n  disableMetrics?: boolean;\n\n  /**\n   * If set to true, traces will not be exported to Google Cloud. Metrics and\n   * logs may still be exported.\n   */\n  disableTraces?: boolean;\n\n  /**\n   * If set to true, input and output logs will not be collected.\n   */\n  disableLoggingInputAndOutput?: boolean;\n\n  /**\n   * If set to true, telemetry data will be exported in the Genkit `dev`\n   * environment. Useful for local testing and troubleshooting; default is\n   * false.\n   */\n  forceDevExport?: boolean;\n}\n\n/** Internal telemetry configuration. */\nexport interface GcpTelemetryConfig {\n  projectId?: string;\n  credentials?: JWTInput;\n\n  sampler: Sampler;\n  autoInstrumentation: boolean;\n  autoInstrumentationConfig: InstrumentationConfigMap;\n  metricExportIntervalMillis: number;\n  metricExportTimeoutMillis: number;\n  instrumentations: Instrumentation[];\n  disableMetrics: boolean;\n  disableTraces: boolean;\n  exportInputAndOutput: boolean;\n  export: boolean;\n}\n\nexport interface GcpPrincipal {\n  projectId?: string;\n  serviceAccountEmail?: string;\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/lib/types.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=types.mjs.map

package/lib/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/lib/utils.d.mts

@@ -0,0 +1,57 @@
+import { ReadableSpan, TimedEvent } from '@opentelemetry/sdk-trace-base';
+
+/**
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare function extractOuterFlowNameFromPath(path: string): string;
+declare function truncate(text: string, limit?: number): string;
+declare function truncatePath(path: string): string;
+/**
+ * Extract first feature name from a path
+ * e.g. for /{myFlow,t:flow}/{myStep,t:flowStep}/{googleai/gemini-pro,t:action,s:model}
+ * returns "myFlow"
+ */
+declare function extractOuterFeatureNameFromPath(path: string): string;
+declare function extractErrorName(events: TimedEvent[]): string | undefined;
+declare function extractErrorMessage(events: TimedEvent[]): string | undefined;
+declare function extractErrorStack(events: TimedEvent[]): string | undefined;
+declare function createCommonLogAttributes(span: ReadableSpan, projectId?: string): {
+    'logging.googleapis.com/spanId': string;
+    'logging.googleapis.com/trace': string;
+    'logging.googleapis.com/trace_sampled': string;
+};
+declare function requestDenied(err: Error & {
+    code?: number;
+    statusDetails?: Record<string, any>[];
+}): boolean;
+declare function loggingDenied(err: Error & {
+    code?: number;
+    statusDetails?: Record<string, any>[];
+}): boolean | undefined;
+declare function tracingDenied(err: Error & {
+    code?: number;
+    statusDetails?: Record<string, any>[];
+}): boolean;
+declare function metricsDenied(err: Error & {
+    code?: number;
+    statusDetails?: Record<string, any>[];
+}): boolean;
+declare function permissionDeniedHelpText(role: string): Promise<string>;
+declare function loggingDeniedHelpText(): Promise<string>;
+declare function tracingDeniedHelpText(): Promise<string>;
+declare function metricsDeniedHelpText(): Promise<string>;
+
+export { createCommonLogAttributes, extractErrorMessage, extractErrorName, extractErrorStack, extractOuterFeatureNameFromPath, extractOuterFlowNameFromPath, loggingDenied, loggingDeniedHelpText, metricsDenied, metricsDeniedHelpText, permissionDeniedHelpText, requestDenied, tracingDenied, tracingDeniedHelpText, truncate, truncatePath };

package/lib/utils.d.ts

@@ -0,0 +1,57 @@
+import { ReadableSpan, TimedEvent } from '@opentelemetry/sdk-trace-base';
+
+/**
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare function extractOuterFlowNameFromPath(path: string): string;
+declare function truncate(text: string, limit?: number): string;
+declare function truncatePath(path: string): string;
+/**
+ * Extract first feature name from a path
+ * e.g. for /{myFlow,t:flow}/{myStep,t:flowStep}/{googleai/gemini-pro,t:action,s:model}
+ * returns "myFlow"
+ */
+declare function extractOuterFeatureNameFromPath(path: string): string;
+declare function extractErrorName(events: TimedEvent[]): string | undefined;
+declare function extractErrorMessage(events: TimedEvent[]): string | undefined;
+declare function extractErrorStack(events: TimedEvent[]): string | undefined;
+declare function createCommonLogAttributes(span: ReadableSpan, projectId?: string): {
+    'logging.googleapis.com/spanId': string;
+    'logging.googleapis.com/trace': string;
+    'logging.googleapis.com/trace_sampled': string;
+};
+declare function requestDenied(err: Error & {
+    code?: number;
+    statusDetails?: Record<string, any>[];
+}): boolean;
+declare function loggingDenied(err: Error & {
+    code?: number;
+    statusDetails?: Record<string, any>[];
+}): boolean | undefined;
+declare function tracingDenied(err: Error & {
+    code?: number;
+    statusDetails?: Record<string, any>[];
+}): boolean;
+declare function metricsDenied(err: Error & {
+    code?: number;
+    statusDetails?: Record<string, any>[];
+}): boolean;
+declare function permissionDeniedHelpText(role: string): Promise<string>;
+declare function loggingDeniedHelpText(): Promise<string>;
+declare function tracingDeniedHelpText(): Promise<string>;
+declare function metricsDeniedHelpText(): Promise<string>;
+
+export { createCommonLogAttributes, extractErrorMessage, extractErrorName, extractErrorStack, extractOuterFeatureNameFromPath, extractOuterFlowNameFromPath, loggingDenied, loggingDeniedHelpText, metricsDenied, metricsDeniedHelpText, permissionDeniedHelpText, requestDenied, tracingDenied, tracingDeniedHelpText, truncate, truncatePath };

package/lib/utils.js

@@ -0,0 +1,143 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var utils_exports = {};
+__export(utils_exports, {
+  createCommonLogAttributes: () => createCommonLogAttributes,
+  extractErrorMessage: () => extractErrorMessage,
+  extractErrorName: () => extractErrorName,
+  extractErrorStack: () => extractErrorStack,
+  extractOuterFeatureNameFromPath: () => extractOuterFeatureNameFromPath,
+  extractOuterFlowNameFromPath: () => extractOuterFlowNameFromPath,
+  loggingDenied: () => loggingDenied,
+  loggingDeniedHelpText: () => loggingDeniedHelpText,
+  metricsDenied: () => metricsDenied,
+  metricsDeniedHelpText: () => metricsDeniedHelpText,
+  permissionDeniedHelpText: () => permissionDeniedHelpText,
+  requestDenied: () => requestDenied,
+  tracingDenied: () => tracingDenied,
+  tracingDeniedHelpText: () => tracingDeniedHelpText,
+  truncate: () => truncate,
+  truncatePath: () => truncatePath
+});
+module.exports = __toCommonJS(utils_exports);
+var import_api = require("@opentelemetry/api");
+var import_auth = require("./auth.js");
+const MAX_LOG_CONTENT_CHARS = 128e3;
+const MAX_PATH_CHARS = 4096;
+function extractOuterFlowNameFromPath(path) {
+  if (!path || path === "<unknown>") {
+    return "<unknown>";
+  }
+  const flowName = path.match("/{(.+),t:flow}+");
+  return flowName ? flowName[1] : "<unknown>";
+}
+function truncate(text, limit = MAX_LOG_CONTENT_CHARS) {
+  return text ? text.substring(0, limit) : text;
+}
+function truncatePath(path) {
+  return truncate(path, MAX_PATH_CHARS);
+}
+function extractOuterFeatureNameFromPath(path) {
+  if (!path || path === "<unknown>") {
+    return "<unknown>";
+  }
+  const first = path.split("/")[1];
+  const featureName = first?.match(
+    "{(.+),t:(flow|action|prompt|dotprompt|helper)"
+  );
+  return featureName ? featureName[1] : "<unknown>";
+}
+function extractErrorName(events) {
+  return events.filter((event) => event.name === "exception").map((event) => {
+    const attributes = event.attributes;
+    return attributes ? truncate(attributes["exception.type"], 1024) : "<unknown>";
+  }).at(0);
+}
+function extractErrorMessage(events) {
+  return events.filter((event) => event.name === "exception").map((event) => {
+    const attributes = event.attributes;
+    return attributes ? truncate(attributes["exception.message"], 4096) : "<unknown>";
+  }).at(0);
+}
+function extractErrorStack(events) {
+  return events.filter((event) => event.name === "exception").map((event) => {
+    const attributes = event.attributes;
+    return attributes ? truncate(attributes["exception.stacktrace"], 32768) : "<unknown>";
+  }).at(0);
+}
+function createCommonLogAttributes(span, projectId) {
+  const spanContext = span.spanContext();
+  const isSampled = !!(spanContext.traceFlags & import_api.TraceFlags.SAMPLED);
+  return {
+    "logging.googleapis.com/spanId": spanContext.spanId,
+    "logging.googleapis.com/trace": `projects/${projectId}/traces/${spanContext.traceId}`,
+    "logging.googleapis.com/trace_sampled": isSampled ? "1" : "0"
+  };
+}
+function requestDenied(err) {
+  return err.code === 7;
+}
+function loggingDenied(err) {
+  return requestDenied(err) && err.statusDetails?.some((details) => {
+    return details?.metadata?.permission === "logging.logEntries.create";
+  });
+}
+function tracingDenied(err) {
+  return requestDenied(err);
+}
+function metricsDenied(err) {
+  return requestDenied(err);
+}
+async function permissionDeniedHelpText(role) {
+  const principal = await (0, import_auth.resolveCurrentPrincipal)();
+  return `Add the role '${role}' to your Service Account in the IAM & Admin page on the Google Cloud console, or use the following command:
+
+gcloud projects add-iam-policy-binding ${principal.projectId ?? "${PROJECT_ID}"} \\
+    --member=serviceAccount:${principal.serviceAccountEmail || "${SERVICE_ACCT}"} \\
+    --role=${role}`;
+}
+async function loggingDeniedHelpText() {
+  return permissionDeniedHelpText("roles/logging.logWriter");
+}
+async function tracingDeniedHelpText() {
+  return permissionDeniedHelpText("roles/cloudtrace.agent");
+}
+async function metricsDeniedHelpText() {
+  return permissionDeniedHelpText("roles/monitoring.metricWriter");
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createCommonLogAttributes,
+  extractErrorMessage,
+  extractErrorName,
+  extractErrorStack,
+  extractOuterFeatureNameFromPath,
+  extractOuterFlowNameFromPath,
+  loggingDenied,
+  loggingDeniedHelpText,
+  metricsDenied,
+  metricsDeniedHelpText,
+  permissionDeniedHelpText,
+  requestDenied,
+  tracingDenied,
+  tracingDeniedHelpText,
+  truncate,
+  truncatePath
+});
+//# sourceMappingURL=utils.js.map

package/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils.ts"],"sourcesContent":["/**\n * Copyright 2024 Google LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { TraceFlags } from '@opentelemetry/api';\nimport type { ReadableSpan, TimedEvent } from '@opentelemetry/sdk-trace-base';\nimport { resolveCurrentPrincipal } from './auth.js';\n\n/**\n * The maximum length (in characters) of a logged input or output.\n * This limit exists to align the logs with GCP logging size limits.\n * */\nconst MAX_LOG_CONTENT_CHARS = 128_000;\n\n/**\n * The maximum length (in characters) of a flow path.\n */\nconst MAX_PATH_CHARS = 4096;\n\nexport function extractOuterFlowNameFromPath(path: string) {\n  if (!path || path === '<unknown>') {\n    return '<unknown>';\n  }\n\n  const flowName = path.match('/{(.+),t:flow}+');\n  return flowName ? flowName[1] : '<unknown>';\n}\n\nexport function truncate(\n  text: string,\n  limit: number = MAX_LOG_CONTENT_CHARS\n): string {\n  return text ? text.substring(0, limit) : text;\n}\n\nexport function truncatePath(path: string) {\n  return truncate(path, MAX_PATH_CHARS);\n}\n\n/**\n * Extract first feature name from a path\n * e.g. for /{myFlow,t:flow}/{myStep,t:flowStep}/{googleai/gemini-pro,t:action,s:model}\n * returns \"myFlow\"\n */\nexport function extractOuterFeatureNameFromPath(path: string) {\n  if (!path || path === '<unknown>') {\n    return '<unknown>';\n  }\n  const first = path.split('/')[1];\n  const featureName = first?.match(\n    '{(.+),t:(flow|action|prompt|dotprompt|helper)'\n  );\n  return featureName ? featureName[1] : '<unknown>';\n}\n\nexport function extractErrorName(events: TimedEvent[]): string | undefined {\n  return events\n    .filter((event) => event.name === 'exception')\n    .map((event) => {\n      const attributes = event.attributes;\n      return attributes\n        ? truncate(attributes['exception.type'] as string, 1024)\n        : '<unknown>';\n    })\n    .at(0);\n}\n\nexport function extractErrorMessage(events: TimedEvent[]): string | undefined {\n  return events\n    .filter((event) => event.name === 'exception')\n    .map((event) => {\n      const attributes = event.attributes;\n      return attributes\n        ? truncate(attributes['exception.message'] as string, 4096)\n        : '<unknown>';\n    })\n    .at(0);\n}\n\nexport function extractErrorStack(events: TimedEvent[]): string | undefined {\n  return events\n    .filter((event) => event.name === 'exception')\n    .map((event) => {\n      const attributes = event.attributes;\n      return attributes\n        ? truncate(attributes['exception.stacktrace'] as string, 32_768)\n        : '<unknown>';\n    })\n    .at(0);\n}\n\nexport function createCommonLogAttributes(\n  span: ReadableSpan,\n  projectId?: string\n) {\n  const spanContext = span.spanContext();\n  const isSampled = !!(spanContext.traceFlags & TraceFlags.SAMPLED);\n  return {\n    'logging.googleapis.com/spanId': spanContext.spanId,\n    'logging.googleapis.com/trace': `projects/${projectId}/traces/${spanContext.traceId}`,\n    'logging.googleapis.com/trace_sampled': isSampled ? '1' : '0',\n  };\n}\n\nexport function requestDenied(\n  err: Error & {\n    code?: number;\n    statusDetails?: Record<string, any>[];\n  }\n) {\n  return err.code === 7;\n}\n\nexport function loggingDenied(\n  err: Error & {\n    code?: number;\n    statusDetails?: Record<string, any>[];\n  }\n) {\n  return (\n    requestDenied(err) &&\n    err.statusDetails?.some((details) => {\n      return details?.metadata?.permission === 'logging.logEntries.create';\n    })\n  );\n}\n\nexport function tracingDenied(\n  err: Error & {\n    code?: number;\n    statusDetails?: Record<string, any>[];\n  }\n) {\n  // Looks like we don't get status details like we do with logging\n  return requestDenied(err);\n}\n\nexport function metricsDenied(\n  err: Error & {\n    code?: number;\n    statusDetails?: Record<string, any>[];\n  }\n) {\n  // Looks like we don't get status details like we do with logging\n  return requestDenied(err);\n}\n\nexport async function permissionDeniedHelpText(role: string) {\n  const principal = await resolveCurrentPrincipal();\n  return `Add the role '${role}' to your Service Account in the IAM & Admin page on the Google Cloud console, or use the following command:\\n\\ngcloud projects add-iam-policy-binding ${principal.projectId ?? '${PROJECT_ID}'} \\\\\\n    --member=serviceAccount:${principal.serviceAccountEmail || '${SERVICE_ACCT}'} \\\\\\n    --role=${role}`;\n}\n\nexport async function loggingDeniedHelpText() {\n  return permissionDeniedHelpText('roles/logging.logWriter');\n}\n\nexport async function tracingDeniedHelpText() {\n  return permissionDeniedHelpText('roles/cloudtrace.agent');\n}\n\nexport async function metricsDeniedHelpText() {\n  return permissionDeniedHelpText('roles/monitoring.metricWriter');\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAgBA,iBAA2B;AAE3B,kBAAwC;AAMxC,MAAM,wBAAwB;AAK9B,MAAM,iBAAiB;AAEhB,SAAS,6BAA6B,MAAc;AACzD,MAAI,CAAC,QAAQ,SAAS,aAAa;AACjC,WAAO;AAAA,EACT;AAEA,QAAM,WAAW,KAAK,MAAM,iBAAiB;AAC7C,SAAO,WAAW,SAAS,CAAC,IAAI;AAClC;AAEO,SAAS,SACd,MACA,QAAgB,uBACR;AACR,SAAO,OAAO,KAAK,UAAU,GAAG,KAAK,IAAI;AAC3C;AAEO,SAAS,aAAa,MAAc;AACzC,SAAO,SAAS,MAAM,cAAc;AACtC;AAOO,SAAS,gCAAgC,MAAc;AAC5D,MAAI,CAAC,QAAQ,SAAS,aAAa;AACjC,WAAO;AAAA,EACT;AACA,QAAM,QAAQ,KAAK,MAAM,GAAG,EAAE,CAAC;AAC/B,QAAM,cAAc,OAAO;AAAA,IACzB;AAAA,EACF;AACA,SAAO,cAAc,YAAY,CAAC,IAAI;AACxC;AAEO,SAAS,iBAAiB,QAA0C;AACzE,SAAO,OACJ,OAAO,CAAC,UAAU,MAAM,SAAS,WAAW,EAC5C,IAAI,CAAC,UAAU;AACd,UAAM,aAAa,MAAM;AACzB,WAAO,aACH,SAAS,WAAW,gBAAgB,GAAa,IAAI,IACrD;AAAA,EACN,CAAC,EACA,GAAG,CAAC;AACT;AAEO,SAAS,oBAAoB,QAA0C;AAC5E,SAAO,OACJ,OAAO,CAAC,UAAU,MAAM,SAAS,WAAW,EAC5C,IAAI,CAAC,UAAU;AACd,UAAM,aAAa,MAAM;AACzB,WAAO,aACH,SAAS,WAAW,mBAAmB,GAAa,IAAI,IACxD;AAAA,EACN,CAAC,EACA,GAAG,CAAC;AACT;AAEO,SAAS,kBAAkB,QAA0C;AAC1E,SAAO,OACJ,OAAO,CAAC,UAAU,MAAM,SAAS,WAAW,EAC5C,IAAI,CAAC,UAAU;AACd,UAAM,aAAa,MAAM;AACzB,WAAO,aACH,SAAS,WAAW,sBAAsB,GAAa,KAAM,IAC7D;AAAA,EACN,CAAC,EACA,GAAG,CAAC;AACT;AAEO,SAAS,0BACd,MACA,WACA;AACA,QAAM,cAAc,KAAK,YAAY;AACrC,QAAM,YAAY,CAAC,EAAE,YAAY,aAAa,sBAAW;AACzD,SAAO;AAAA,IACL,iCAAiC,YAAY;AAAA,IAC7C,gCAAgC,YAAY,SAAS,WAAW,YAAY,OAAO;AAAA,IACnF,wCAAwC,YAAY,MAAM;AAAA,EAC5D;AACF;AAEO,SAAS,cACd,KAIA;AACA,SAAO,IAAI,SAAS;AACtB;AAEO,SAAS,cACd,KAIA;AACA,SACE,cAAc,GAAG,KACjB,IAAI,eAAe,KAAK,CAAC,YAAY;AACnC,WAAO,SAAS,UAAU,eAAe;AAAA,EAC3C,CAAC;AAEL;AAEO,SAAS,cACd,KAIA;AAEA,SAAO,cAAc,GAAG;AAC1B;AAEO,SAAS,cACd,KAIA;AAEA,SAAO,cAAc,GAAG;AAC1B;AAEA,eAAsB,yBAAyB,MAAc;AAC3D,QAAM,YAAY,UAAM,qCAAwB;AAChD,SAAO,iBAAiB,IAAI;AAAA;AAAA,yCAA0J,UAAU,aAAa,eAAe;AAAA,8BAAoC,UAAU,uBAAuB,iBAAiB;AAAA,aAAmB,IAAI;AAC3U;AAEA,eAAsB,wBAAwB;AAC5C,SAAO,yBAAyB,yBAAyB;AAC3D;AAEA,eAAsB,wBAAwB;AAC5C,SAAO,yBAAyB,wBAAwB;AAC1D;AAEA,eAAsB,wBAAwB;AAC5C,SAAO,yBAAyB,+BAA+B;AACjE;","names":[]}

package/lib/utils.mjs

@@ -0,0 +1,104 @@
+import { TraceFlags } from "@opentelemetry/api";
+import { resolveCurrentPrincipal } from "./auth.js";
+const MAX_LOG_CONTENT_CHARS = 128e3;
+const MAX_PATH_CHARS = 4096;
+function extractOuterFlowNameFromPath(path) {
+  if (!path || path === "<unknown>") {
+    return "<unknown>";
+  }
+  const flowName = path.match("/{(.+),t:flow}+");
+  return flowName ? flowName[1] : "<unknown>";
+}
+function truncate(text, limit = MAX_LOG_CONTENT_CHARS) {
+  return text ? text.substring(0, limit) : text;
+}
+function truncatePath(path) {
+  return truncate(path, MAX_PATH_CHARS);
+}
+function extractOuterFeatureNameFromPath(path) {
+  if (!path || path === "<unknown>") {
+    return "<unknown>";
+  }
+  const first = path.split("/")[1];
+  const featureName = first?.match(
+    "{(.+),t:(flow|action|prompt|dotprompt|helper)"
+  );
+  return featureName ? featureName[1] : "<unknown>";
+}
+function extractErrorName(events) {
+  return events.filter((event) => event.name === "exception").map((event) => {
+    const attributes = event.attributes;
+    return attributes ? truncate(attributes["exception.type"], 1024) : "<unknown>";
+  }).at(0);
+}
+function extractErrorMessage(events) {
+  return events.filter((event) => event.name === "exception").map((event) => {
+    const attributes = event.attributes;
+    return attributes ? truncate(attributes["exception.message"], 4096) : "<unknown>";
+  }).at(0);
+}
+function extractErrorStack(events) {
+  return events.filter((event) => event.name === "exception").map((event) => {
+    const attributes = event.attributes;
+    return attributes ? truncate(attributes["exception.stacktrace"], 32768) : "<unknown>";
+  }).at(0);
+}
+function createCommonLogAttributes(span, projectId) {
+  const spanContext = span.spanContext();
+  const isSampled = !!(spanContext.traceFlags & TraceFlags.SAMPLED);
+  return {
+    "logging.googleapis.com/spanId": spanContext.spanId,
+    "logging.googleapis.com/trace": `projects/${projectId}/traces/${spanContext.traceId}`,
+    "logging.googleapis.com/trace_sampled": isSampled ? "1" : "0"
+  };
+}
+function requestDenied(err) {
+  return err.code === 7;
+}
+function loggingDenied(err) {
+  return requestDenied(err) && err.statusDetails?.some((details) => {
+    return details?.metadata?.permission === "logging.logEntries.create";
+  });
+}
+function tracingDenied(err) {
+  return requestDenied(err);
+}
+function metricsDenied(err) {
+  return requestDenied(err);
+}
+async function permissionDeniedHelpText(role) {
+  const principal = await resolveCurrentPrincipal();
+  return `Add the role '${role}' to your Service Account in the IAM & Admin page on the Google Cloud console, or use the following command:
+
+gcloud projects add-iam-policy-binding ${principal.projectId ?? "${PROJECT_ID}"} \\
+    --member=serviceAccount:${principal.serviceAccountEmail || "${SERVICE_ACCT}"} \\
+    --role=${role}`;
+}
+async function loggingDeniedHelpText() {
+  return permissionDeniedHelpText("roles/logging.logWriter");
+}
+async function tracingDeniedHelpText() {
+  return permissionDeniedHelpText("roles/cloudtrace.agent");
+}
+async function metricsDeniedHelpText() {
+  return permissionDeniedHelpText("roles/monitoring.metricWriter");
+}
+export {
+  createCommonLogAttributes,
+  extractErrorMessage,
+  extractErrorName,
+  extractErrorStack,
+  extractOuterFeatureNameFromPath,
+  extractOuterFlowNameFromPath,
+  loggingDenied,
+  loggingDeniedHelpText,
+  metricsDenied,
+  metricsDeniedHelpText,
+  permissionDeniedHelpText,
+  requestDenied,
+  tracingDenied,
+  tracingDeniedHelpText,
+  truncate,
+  truncatePath
+};
+//# sourceMappingURL=utils.mjs.map