@google-cloud/profiler 5.0.0 → 5.0.1

package/build/src/config.d.ts

@@ -0,0 +1,80 @@
+import { GoogleAuthOptions } from '@google-cloud/common';
+export interface Config extends GoogleAuthOptions {
+    /**
+     * The API endpoint of the service used to make requests.
+     * Defaults to `cloudprofiler.googleapis.com`.
+     */
+    apiEndpoint?: string;
+    projectId?: string;
+    logLevel?: number;
+    serviceContext?: {
+        service?: string;
+        version?: string;
+    };
+    instance?: string;
+    zone?: string;
+    disableTime?: boolean;
+    disableHeap?: boolean;
+    timeIntervalMicros?: number;
+    heapIntervalBytes?: number;
+    heapMaxStackDepth?: number;
+    ignoreHeapSamplesPath?: string;
+    backoffMultiplier?: number;
+    initialBackoffMillis?: number;
+    backoffCapMillis?: number;
+    serverBackoffCapMillis?: number;
+    localProfilingPeriodMillis?: number;
+    localLogPeriodMillis?: number;
+    localTimeDurationMillis?: number;
+    sourceMapSearchPath?: string[];
+    disableSourceMaps?: boolean;
+}
+export interface LocalConfig extends GoogleAuthOptions {
+    apiEndpoint: string;
+    projectId?: string;
+    logLevel: number;
+    serviceContext: {
+        service: string;
+        version?: string;
+    };
+    instance?: string;
+    zone?: string;
+    disableTime: boolean;
+    disableHeap: boolean;
+    timeIntervalMicros: number;
+    heapIntervalBytes: number;
+    heapMaxStackDepth: number;
+    ignoreHeapSamplesPath: string;
+    initialBackoffMillis: number;
+    backoffCapMillis: number;
+    backoffMultiplier: number;
+    serverBackoffCapMillis: number;
+    localProfilingPeriodMillis: number;
+    localLogPeriodMillis: number;
+    localTimeDurationMillis: number;
+    sourceMapSearchPath: string[];
+    disableSourceMaps: boolean;
+}
+export interface ProfilerConfig extends LocalConfig {
+    projectId: string;
+}
+export declare const defaultConfig: {
+    logLevel: number;
+    serviceContext: {};
+    disableHeap: boolean;
+    disableTime: boolean;
+    timeIntervalMicros: number;
+    heapIntervalBytes: number;
+    heapMaxStackDepth: number;
+    ignoreHeapSamplesPath: string;
+    initialBackoffMillis: number;
+    backoffCapMillis: number;
+    backoffMultiplier: number;
+    apiEndpoint: string;
+    serverBackoffCapMillis: number;
+    localProfilingPeriodMillis: number;
+    localLogPeriodMillis: number;
+    localTimeDurationMillis: number;
+    sourceMapSearchPath: string[];
+    disableSourceMaps: boolean;
+};

package/build/src/config.js

@@ -0,0 +1,42 @@
+"use strict";
+// Copyright 2017 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultConfig = void 0;
+const parse_duration_1 = require("parse-duration");
+// Default values for configuration for a profiler.
+exports.defaultConfig = {
+    logLevel: 2,
+    serviceContext: {},
+    disableHeap: false,
+    disableTime: false,
+    timeIntervalMicros: 1000,
+    heapIntervalBytes: 512 * 1024,
+    heapMaxStackDepth: 64,
+    ignoreHeapSamplesPath: '@google-cloud/profiler',
+    initialBackoffMillis: 60 * 1000,
+    backoffCapMillis: (0, parse_duration_1.default)('1h'),
+    backoffMultiplier: 1.3,
+    apiEndpoint: 'cloudprofiler.googleapis.com',
+    // This is the largest duration for setTimeout which does not cause it to
+    // run immediately.
+    // https://nodejs.org/dist/latest-v9.x/docs/api/timers.html#timers_settimeout_callback_delay_args.
+    serverBackoffCapMillis: 2147483647,
+    localProfilingPeriodMillis: 1000,
+    localLogPeriodMillis: 10000,
+    localTimeDurationMillis: 1000,
+    sourceMapSearchPath: [process.cwd()],
+    disableSourceMaps: false,
+};
+//# sourceMappingURL=config.js.map

package/build/src/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;AAGjC,mDAA2C;AAiK3C,mDAAmD;AACtC,QAAA,aAAa,GAAG;IAC3B,QAAQ,EAAE,CAAC;IACX,cAAc,EAAE,EAAE;IAClB,WAAW,EAAE,KAAK;IAClB,WAAW,EAAE,KAAK;IAClB,kBAAkB,EAAE,IAAI;IACxB,iBAAiB,EAAE,GAAG,GAAG,IAAI;IAC7B,iBAAiB,EAAE,EAAE;IACrB,qBAAqB,EAAE,wBAAwB;IAC/C,oBAAoB,EAAE,EAAE,GAAG,IAAI;IAC/B,gBAAgB,EAAE,IAAA,wBAAa,EAAC,IAAI,CAAC;IACrC,iBAAiB,EAAE,GAAG;IACtB,WAAW,EAAE,8BAA8B;IAE3C,yEAAyE;IACzE,mBAAmB;IACnB,kGAAkG;IAClG,sBAAsB,EAAE,UAAU;IAElC,0BAA0B,EAAE,IAAI;IAChC,oBAAoB,EAAE,KAAK;IAC3B,uBAAuB,EAAE,IAAI;IAC7B,mBAAmB,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;IACpC,iBAAiB,EAAE,KAAK;CACzB,CAAC"}

package/build/src/index.d.ts

@@ -0,0 +1,36 @@
+import * as semver from 'semver';
+import { Config } from './config';
+import { Profiler } from './profiler';
+/**
+ * Returns true if the version passed in satifised version requirements
+ * specified in the profiler's package.json.
+ *
+ * Exported for testing.
+ */
+export declare function nodeVersionOkay(version: string | semver.SemVer): boolean;
+/**
+ * Initializes the config, and starts heap profiler if the heap profiler is
+ * needed. Returns a profiler if creation is successful. Otherwise, returns
+ * rejected promise.
+ */
+export declare function createProfiler(config?: Config): Promise<Profiler>;
+/**
+ * Starts the profiling agent and returns a promise.
+ * If any error is encountered when configuring the profiler the promise will
+ * be rejected. Resolves when profiling is started.
+ *
+ * config - Config describing configuration for profiling.
+ *
+ * @example
+ * profiler.start();
+ *
+ * @example
+ * profiler.start(config);
+ *
+ */
+export declare function start(config?: Config): Promise<void>;
+/**
+ * For debugging purposes. Collects profiles and discards the collected
+ * profiles.
+ */
+export declare function startLocal(config?: Config): Promise<void>;

package/build/src/index.js

@@ -0,0 +1,248 @@
+"use strict";
+// Copyright 2017 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startLocal = exports.start = exports.createProfiler = exports.nodeVersionOkay = void 0;
+const delay_1 = require("delay");
+const extend = require("extend");
+const fs = require("fs");
+const gcpMetadata = require("gcp-metadata");
+const pprof_1 = require("pprof");
+const semver = require("semver");
+const config_1 = require("./config");
+const logger_1 = require("./logger");
+const profiler_1 = require("./profiler");
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const pjson = require('../../package.json');
+const serviceRegex = /^[a-z0-9]([-a-z0-9_.]{0,253}[a-z0-9])?$/;
+function hasService(config) {
+    return (config.serviceContext !== undefined &&
+        typeof config.serviceContext.service === 'string');
+}
+function hasProjectId(config) {
+    return typeof config.projectId === 'string';
+}
+/**
+ * Sets unset values in the configuration to the value retrieved from
+ * environment variables or specified in defaultConfig.
+ * Throws error if value that must be set cannot be initialized.
+ */
+function initConfigLocal(config) {
+    const envConfig = {
+        projectId: process.env.GCLOUD_PROJECT,
+        serviceContext: {
+            service: process.env.GAE_SERVICE || process.env.K_SERVICE,
+            version: process.env.GAE_VERSION || process.env.K_REVISION,
+        },
+    };
+    if (process.env.GCLOUD_PROFILER_LOGLEVEL !== undefined) {
+        const envLogLevel = Number(process.env.GCLOUD_PROFILER_LOGLEVEL);
+        if (!isNaN(envLogLevel)) {
+            envConfig.logLevel = envLogLevel;
+        }
+    }
+    let envSetConfig = {};
+    const configPath = process.env.GCLOUD_PROFILER_CONFIG;
+    if (configPath) {
+        let envSetConfigBuf;
+        try {
+            envSetConfigBuf = fs.readFileSync(configPath);
+        }
+        catch (e) {
+            throw Error(`Could not read GCLOUD_PROFILER_CONFIG ${configPath}: ${e}`);
+        }
+        try {
+            envSetConfig = JSON.parse(envSetConfigBuf.toString());
+        }
+        catch (e) {
+            throw Error(`Could not parse GCLOUD_PROFILER_CONFIG ${configPath}: ${e}`);
+        }
+    }
+    const mergedUserConfigs = extend(true, {}, envSetConfig, envConfig, config);
+    if (Array.isArray(mergedUserConfigs.sourceMapSearchPath) &&
+        mergedUserConfigs.sourceMapSearchPath.length === 0 &&
+        !mergedUserConfigs.disableSourceMaps) {
+        throw new Error('serviceMapSearchPath is an empty array. Use disableSourceMaps to' +
+            ' disable source map support instead.');
+    }
+    const mergedConfig = extend(true, {}, config_1.defaultConfig, mergedUserConfigs);
+    if (!hasService(mergedConfig)) {
+        throw new Error('Service must be specified in the configuration');
+    }
+    if (!serviceRegex.test(mergedConfig.serviceContext.service)) {
+        throw new Error(`Service ${mergedConfig.serviceContext.service} does not match regular expression "${serviceRegex.toString()}"`);
+    }
+    return mergedConfig;
+}
+/**
+ * Sets unset values in the configuration which can be retrieved from GCP
+ * metadata.
+ */
+async function initConfigMetadata(config) {
+    const logger = (0, logger_1.createLogger)(config.logLevel);
+    const getMetadataProperty = async (f, field) => {
+        try {
+            return await f(field);
+        }
+        catch (e) {
+            logger.debug(`Failed to fetch ${field} from metadata: ${e}`);
+        }
+        return undefined;
+    };
+    if (!config.projectId || !config.zone || !config.instance) {
+        const [projectId, instance, zone] = await Promise.all([
+            getMetadataProperty(gcpMetadata.project, 'project-id'),
+            getMetadataProperty(gcpMetadata.instance, 'name'),
+            getMetadataProperty(gcpMetadata.instance, 'zone'),
+        ]);
+        if (!config.zone && zone) {
+            config.zone = zone.substring(zone.lastIndexOf('/') + 1);
+        }
+        if (!config.instance && instance) {
+            config.instance = instance;
+        }
+        if (!config.projectId && projectId) {
+            config.projectId = projectId;
+        }
+    }
+    if (!hasProjectId(config)) {
+        throw new Error('Project ID must be specified in the configuration');
+    }
+    return config;
+}
+/**
+ * Returns true if the version passed in satifised version requirements
+ * specified in the profiler's package.json.
+ *
+ * Exported for testing.
+ */
+function nodeVersionOkay(version) {
+    // Coerce version if possible, to remove any pre-release, alpha, beta, etc
+    // tags.
+    version = semver.coerce(version) || version;
+    return semver.satisfies(version, pjson.engines.node);
+}
+exports.nodeVersionOkay = nodeVersionOkay;
+/**
+ * Initializes the config, and starts heap profiler if the heap profiler is
+ * needed. Returns a profiler if creation is successful. Otherwise, returns
+ * rejected promise.
+ */
+async function createProfiler(config = {}) {
+    if (!nodeVersionOkay(process.version)) {
+        throw new Error(`Could not start profiler: node version ${process.version}` +
+            ` does not satisfies "${pjson.engines.node}"` +
+            '\nSee https://github.com/googleapis/cloud-profiler-nodejs#prerequisites' +
+            ' for details.');
+    }
+    const localConfig = initConfigLocal(config);
+    // Start the heap profiler if profiler config does not indicate heap profiling
+    // is disabled. This must be done before any asynchronous calls are made so
+    // all memory allocations made after start() is called can be captured.
+    if (!localConfig.disableHeap) {
+        pprof_1.heap.start(localConfig.heapIntervalBytes, localConfig.heapMaxStackDepth);
+    }
+    let profilerConfig;
+    try {
+        profilerConfig = await initConfigMetadata(localConfig);
+    }
+    catch (err) {
+        pprof_1.heap.stop();
+        throw err;
+    }
+    return new profiler_1.Profiler(profilerConfig);
+}
+exports.createProfiler = createProfiler;
+/**
+ * Starts the profiling agent and returns a promise.
+ * If any error is encountered when configuring the profiler the promise will
+ * be rejected. Resolves when profiling is started.
+ *
+ * config - Config describing configuration for profiling.
+ *
+ * @example
+ * profiler.start();
+ *
+ * @example
+ * profiler.start(config);
+ *
+ */
+async function start(config = {}) {
+    const profiler = await createProfiler(config);
+    profiler.start();
+}
+exports.start = start;
+/**
+ * For debugging purposes. Collects profiles and discards the collected
+ * profiles.
+ */
+async function startLocal(config = {}) {
+    const profiler = await createProfiler(config);
+    // Set up periodic logging.
+    const logger = (0, logger_1.createLogger)(config.logLevel);
+    let heapProfileCount = 0;
+    let timeProfileCount = 0;
+    let prevLogTime = Date.now();
+    setInterval(() => {
+        const curTime = Date.now();
+        const { rss, heapTotal, heapUsed } = process.memoryUsage();
+        const debugInfo = [
+            new Date().toISOString(),
+            'rss',
+            (rss / (1024 * 1024)).toFixed(3),
+            'MiB,',
+            'heap total',
+            (heapTotal / (1024 * 1024)).toFixed(3),
+            'MiB,',
+            'heap used',
+            (heapUsed / (1024 * 1024)).toFixed(3),
+            'MiB,',
+            'heap profile collection rate',
+            ((heapProfileCount * 1000) / (curTime - prevLogTime)).toFixed(3),
+            'profiles/s,',
+            'time profile collection rate',
+            ((timeProfileCount * 1000) / (curTime - prevLogTime)).toFixed(3),
+            'profiles/s',
+        ].map(v => v + '');
+        logger.debug(debugInfo.join(' '));
+        heapProfileCount = 0;
+        timeProfileCount = 0;
+        prevLogTime = curTime;
+    }, profiler.config.localLogPeriodMillis);
+    // Periodic profiling
+    setInterval(async () => {
+        if (!config.disableHeap) {
+            await profiler.profile({
+                name: 'Heap-Profile' + new Date(),
+                profileType: 'HEAP',
+            });
+            heapProfileCount++;
+        }
+        await (0, delay_1.default)(profiler.config.localProfilingPeriodMillis / 2);
+        if (!config.disableTime) {
+            await profiler.profile({
+                name: 'Time-Profile' + new Date(),
+                profileType: 'WALL',
+                duration: profiler.config.localTimeDurationMillis.toString() + 'ms',
+            });
+            timeProfileCount++;
+        }
+    }, profiler.config.localProfilingPeriodMillis);
+}
+exports.startLocal = startLocal;
+// If the module was --require'd from the command line, start the agent.
+if (module.parent && module.parent.id === 'internal/preload') {
+    start();
+}
+//# sourceMappingURL=index.js.map

package/build/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;AAEjC,iCAA0B;AAC1B,iCAAiC;AACjC,yBAAyB;AACzB,4CAA4C;AAC5C,iCAA2C;AAC3C,iCAAiC;AAEjC,qCAA4E;AAC5E,qCAAsC;AACtC,yCAAoC;AAEpC,8DAA8D;AAC9D,MAAM,KAAK,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAC5C,MAAM,YAAY,GAAG,yCAAyC,CAAC;AAE/D,SAAS,UAAU,CACjB,MAAc;IAEd,OAAO,CACL,MAAM,CAAC,cAAc,KAAK,SAAS;QACnC,OAAO,MAAM,CAAC,cAAc,CAAC,OAAO,KAAK,QAAQ,CAClD,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,MAAc;IAClC,OAAO,OAAO,MAAM,CAAC,SAAS,KAAK,QAAQ,CAAC;AAC9C,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,MAAc;IACrC,MAAM,SAAS,GAAW;QACxB,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,cAAc;QACrC,cAAc,EAAE;YACd,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS;YACzD,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU;SAC3D;KACF,CAAC;IAEF,IAAI,OAAO,CAAC,GAAG,CAAC,wBAAwB,KAAK,SAAS,EAAE;QACtD,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QACjE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;YACvB,SAAS,CAAC,QAAQ,GAAG,WAAW,CAAC;SAClC;KACF;IAED,IAAI,YAAY,GAAW,EAAE,CAAC;IAC9B,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC;IACtD,IAAI,UAAU,EAAE;QACd,IAAI,eAAe,CAAC;QACpB,IAAI;YACF,eAAe,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;SAC/C;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,KAAK,CAAC,yCAAyC,UAAU,KAAK,CAAC,EAAE,CAAC,CAAC;SAC1E;QACD,IAAI;YACF,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC;SACvD;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,KAAK,CAAC,0CAA0C,UAAU,KAAK,CAAC,EAAE,CAAC,CAAC;SAC3E;KACF;IAED,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,EAAE,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC5E,IACE,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,mBAAmB,CAAC;QACpD,iBAAiB,CAAC,mBAAmB,CAAC,MAAM,KAAK,CAAC;QAClD,CAAC,iBAAiB,CAAC,iBAAiB,EACpC;QACA,MAAM,IAAI,KAAK,CACb,kEAAkE;YAChE,sCAAsC,CACzC,CAAC;KACH;IAED,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,EAAE,EAAE,EAAE,sBAAa,EAAE,iBAAiB,CAAC,CAAC;IAExE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;KACnE;IAED,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE;QAC3D,MAAM,IAAI,KAAK,CACb,WACE,YAAY,CAAC,cAAc,CAAC,OAC9B,uCAAuC,YAAY,CAAC,QAAQ,EAAE,GAAG,CAClE,CAAC;KACH;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,kBAAkB,CAC/B,MAAmB;IAEnB,MAAM,MAAM,GAAG,IAAA,qBAAY,EAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC7C,MAAM,mBAAmB,GAAG,KAAK,EAC/B,CAAiC,EACjC,KAAa,EACb,EAAE;QACF,IAAI;YACF,OAAO,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC;SACvB;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,CAAC,KAAK,CAAC,mBAAmB,KAAK,mBAAmB,CAAC,EAAE,CAAC,CAAC;SAC9D;QACD,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;QACzD,MAAM,CAAC,SAAS,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACpD,mBAAmB,CAAC,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC;YACtD,mBAAmB,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC;YACjD,mBAAmB,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC;SAClD,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,EAAE;YACxB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;SACzD;QACD,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,QAAQ,EAAE;YAChC,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC5B;QACD,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,EAAE;YAClC,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;SAC9B;KACF;IAED,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE;QACzB,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;KACtE;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,OAA+B;IAC7D,0EAA0E;IAC1E,QAAQ;IACR,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC;IAC5C,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AACvD,CAAC;AALD,0CAKC;AAED;;;;GAIG;AACI,KAAK,UAAU,cAAc,CAAC,SAAiB,EAAE;IACtD,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QACrC,MAAM,IAAI,KAAK,CACb,0CAA0C,OAAO,CAAC,OAAO,EAAE;YACzD,wBAAwB,KAAK,CAAC,OAAO,CAAC,IAAI,GAAG;YAC7C,yEAAyE;YACzE,eAAe,CAClB,CAAC;KACH;IAED,MAAM,WAAW,GAAgB,eAAe,CAAC,MAAM,CAAC,CAAC;IAEzD,8EAA8E;IAC9E,2EAA2E;IAC3E,uEAAuE;IACvE,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;QAC5B,YAAY,CAAC,KAAK,CAChB,WAAW,CAAC,iBAAiB,EAC7B,WAAW,CAAC,iBAAiB,CAC9B,CAAC;KACH;IACD,IAAI,cAA8B,CAAC;IACnC,IAAI;QACF,cAAc,GAAG,MAAM,kBAAkB,CAAC,WAAW,CAAC,CAAC;KACxD;IAAC,OAAO,GAAG,EAAE;QACZ,YAAY,CAAC,IAAI,EAAE,CAAC;QACpB,MAAM,GAAG,CAAC;KACX;IACD,OAAO,IAAI,mBAAQ,CAAC,cAAc,CAAC,CAAC;AACtC,CAAC;AA7BD,wCA6BC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,KAAK,CAAC,SAAiB,EAAE;IAC7C,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC;IAC9C,QAAQ,CAAC,KAAK,EAAE,CAAC;AACnB,CAAC;AAHD,sBAGC;AAED;;;GAGG;AACI,KAAK,UAAU,UAAU,CAAC,SAAiB,EAAE;IAClD,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC;IAE9C,2BAA2B;IAC3B,MAAM,MAAM,GAAG,IAAA,qBAAY,EAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAE7C,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,IAAI,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAE7B,WAAW,CAAC,GAAG,EAAE;QACf,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3B,MAAM,EAAC,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAC,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;QACzD,MAAM,SAAS,GAAG;YAChB,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACxB,KAAK;YACL,CAAC,GAAG,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YAChC,MAAM;YACN,YAAY;YACZ,CAAC,SAAS,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YACtC,MAAM;YACN,WAAW;YACX,CAAC,QAAQ,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YACrC,MAAM;YACN,8BAA8B;YAC9B,CAAC,CAAC,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YAChE,aAAa;YACb,8BAA8B;YAC9B,CAAC,CAAC,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YAChE,YAAY;SACb,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;QACnB,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAElC,gBAAgB,GAAG,CAAC,CAAC;QACrB,gBAAgB,GAAG,CAAC,CAAC;QACrB,WAAW,GAAG,OAAO,CAAC;IACxB,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAEzC,qBAAqB;IACrB,WAAW,CAAC,KAAK,IAAI,EAAE;QACrB,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;YACvB,MAAM,QAAQ,CAAC,OAAO,CAAC;gBACrB,IAAI,EAAE,cAAc,GAAG,IAAI,IAAI,EAAE;gBACjC,WAAW,EAAE,MAAM;aACpB,CAAC,CAAC;YACH,gBAAgB,EAAE,CAAC;SACpB;QACD,MAAM,IAAA,eAAK,EAAC,QAAQ,CAAC,MAAM,CAAC,0BAA0B,GAAG,CAAC,CAAC,CAAC;QAC5D,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;YACvB,MAAM,QAAQ,CAAC,OAAO,CAAC;gBACrB,IAAI,EAAE,cAAc,GAAG,IAAI,IAAI,EAAE;gBACjC,WAAW,EAAE,MAAM;gBACnB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,uBAAuB,CAAC,QAAQ,EAAE,GAAG,IAAI;aACpE,CAAC,CAAC;YACH,gBAAgB,EAAE,CAAC;SACpB;IACH,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC;AACjD,CAAC;AAzDD,gCAyDC;AAED,wEAAwE;AACxE,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,kBAAkB,EAAE;IAC5D,KAAK,EAAE,CAAC;CACT"}

package/build/src/logger.d.ts

@@ -0,0 +1,12 @@
+export declare class Logger {
+    readonly level?: number | undefined;
+    private log;
+    private severityThreshold;
+    constructor(level?: number | undefined);
+    debug(msg: string): void;
+    info(msg: string): void;
+    warn(msg: string): void;
+    error(msg: string): void;
+    private toOneLine;
+}
+export declare function createLogger(level?: number): Logger;

package/build/src/logger.js

@@ -0,0 +1,77 @@
+"use strict";
+// Copyright 2017 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLogger = exports.Logger = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const config_1 = require("./config");
+const logging_min_1 = require("@google-cloud/logging-min");
+const logging = new logging_min_1.Logging();
+// migrating from 'console-log-level' package we keep
+// min and max log levels numeric interface used there
+const [MIN_LEVEL, MAX_LEVEL] = [0, 4];
+logging.setProjectId().catch(err => {
+    console.error(`failed to set logging project id ${err}`);
+});
+logging.setDetectedResource().catch(err => {
+    console.error(`failed to discover resource metadata ${err}`);
+});
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const pjson = require('../../package.json');
+class Logger {
+    constructor(level) {
+        this.level = level;
+        if (level === undefined) {
+            level = config_1.defaultConfig.logLevel;
+        }
+        if (level < MIN_LEVEL) {
+            level = MIN_LEVEL;
+        }
+        else if (level > MAX_LEVEL) {
+            level = MAX_LEVEL;
+        }
+        this.severityThreshold = level;
+        this.log = logging.logSync(pjson.name);
+    }
+    debug(msg) {
+        if (this.severityThreshold > 3) {
+            this.log.debug(this.log.entry(this.toOneLine(msg)));
+        }
+    }
+    info(msg) {
+        if (this.severityThreshold > 2) {
+            this.log.info(this.log.entry(this.toOneLine(msg)));
+        }
+    }
+    warn(msg) {
+        if (this.severityThreshold > 1) {
+            this.log.warning(this.log.entry(this.toOneLine(msg)));
+        }
+    }
+    error(msg) {
+        if (this.severityThreshold > 0) {
+            this.log.error(this.log.entry(this.toOneLine(msg)));
+        }
+    }
+    toOneLine(msg) {
+        const temp = msg.replace('\r\n', '\\r\\n');
+        return temp.replace('\n', '\\n');
+    }
+}
+exports.Logger = Logger;
+function createLogger(level) {
+    return new Logger(level);
+}
+exports.createLogger = createLogger;
+//# sourceMappingURL=logger.js.map

package/build/src/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;AAEjC,uDAAuD;AAEvD,qCAAuC;AACvC,2DAA2D;AAE3D,MAAM,OAAO,GAAG,IAAI,qBAAO,EAAE,CAAC;AAE9B,qDAAqD;AACrD,sDAAsD;AACtD,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAEtC,OAAO,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;IACjC,OAAO,CAAC,KAAK,CAAC,oCAAoC,GAAG,EAAE,CAAC,CAAC;AAC3D,CAAC,CAAC,CAAC;AACH,OAAO,CAAC,mBAAmB,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;IACxC,OAAO,CAAC,KAAK,CAAC,wCAAwC,GAAG,EAAE,CAAC,CAAC;AAC/D,CAAC,CAAC,CAAC;AAEH,8DAA8D;AAC9D,MAAM,KAAK,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAE5C,MAAa,MAAM;IAIjB,YAAqB,KAAc;QAAd,UAAK,GAAL,KAAK,CAAS;QACjC,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,KAAK,GAAG,sBAAa,CAAC,QAAQ,CAAC;SAChC;QACD,IAAI,KAAK,GAAG,SAAS,EAAE;YACrB,KAAK,GAAG,SAAS,CAAC;SACnB;aAAM,IAAI,KAAK,GAAG,SAAS,EAAE;YAC5B,KAAK,GAAG,SAAS,CAAC;SACnB;QACD,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;QAC/B,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,GAAW;QACf,IAAI,IAAI,CAAC,iBAAiB,GAAG,CAAC,EAAE;YAC9B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SACrD;IACH,CAAC;IAED,IAAI,CAAC,GAAW;QACd,IAAI,IAAI,CAAC,iBAAiB,GAAG,CAAC,EAAE;YAC9B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SACpD;IACH,CAAC;IAED,IAAI,CAAC,GAAW;QACd,IAAI,IAAI,CAAC,iBAAiB,GAAG,CAAC,EAAE;YAC9B,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SACvD;IACH,CAAC;IAED,KAAK,CAAC,GAAW;QACf,IAAI,IAAI,CAAC,iBAAiB,GAAG,CAAC,EAAE;YAC9B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SACrD;IACH,CAAC;IAEO,SAAS,CAAC,GAAW;QAC3B,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACnC,CAAC;CACF;AA7CD,wBA6CC;AAED,SAAgB,YAAY,CAAC,KAAc;IACzC,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;AAC3B,CAAC;AAFD,oCAEC"}

package/build/src/profiler.d.ts

@@ -0,0 +1,155 @@
+import { ServiceObject } from '@google-cloud/common';
+import { ProfilerConfig } from './config';
+/**
+ * Interface for deployment field of RequestProfile. Profiles with matching
+ * deployments will be grouped together.
+ * Used as body of request when creating profile using the profiler API.
+ *
+ * Public for testing.
+ */
+export interface Deployment {
+    projectId?: string;
+    target?: string;
+    labels?: {
+        zone?: string;
+        version?: string;
+        language: string;
+    };
+}
+/**
+ * Interface for body of response from profiler API when creating
+ * profile and used as body of request to profiler API when
+ * uploading a profile.
+ *
+ * Public for testing.
+ */
+export interface RequestProfile {
+    name: string;
+    profileType?: string;
+    duration?: string;
+    profileBytes?: string;
+    deployment?: Deployment;
+    labels?: {
+        instance?: string;
+    };
+}
+/**
+ * @return if the backoff duration can be parsed, then the backoff duration in
+ * ms, otherwise undefined.
+ *
+ * Public for testing.
+ */
+export declare function parseBackoffDuration(backoffMessage: string): number | undefined;
+/**
+ * Error constructed from HTTP server response which indicates backoff.
+ */
+export declare class BackoffResponseError extends Error {
+    readonly backoffMillis: number;
+    constructor(message: string | undefined, backoffMillis: number);
+}
+/**
+ * Class which tracks how long to wait before the next retry and can be
+ * used to get this backoff.
+ */
+export declare class Retryer {
+    readonly initialBackoffMillis: number;
+    readonly backoffCapMillis: number;
+    readonly backoffMultiplier: number;
+    private nextBackoffMillis;
+    private random;
+    constructor(initialBackoffMillis: number, backoffCapMillis: number, backoffMultiplier: number, random?: () => number);
+    getBackoff(): number;
+    reset(): void;
+}
+/**
+ * Polls profiler server for instructions on behalf of a task and
+ * collects and uploads profiles as requested.
+ *
+ * If heap profiling is enabled, the heap profiler must be enabled before heap
+ * profiles can be collected.
+ */
+export declare class Profiler extends ServiceObject {
+    private logger;
+    private profileLabels;
+    private deployment;
+    private profileTypes;
+    private retryer;
+    private sourceMapper;
+    private baseApiUrl;
+    config: ProfilerConfig;
+    constructor(config: ProfilerConfig);
+    /**
+     * Starts an endless loop to poll profiler server for instructions, and
+     * collects and uploads profiles as requested.
+     * If there is a problem when collecting a profile or uploading a profile to
+     * profiler server, this problem will be logged at the error level and
+     * otherwise ignored.
+     * If there is a problem polling profiler server for instructions
+     * on the type of profile to be collected, this problem will be logged at the
+     * error level and getting profile type will be retried.
+     */
+    start(): Promise<void>;
+    /**
+     * Endlessly polls the profiler server for instructions, and collects and
+     * uploads profiles as requested.
+     */
+    runLoop(): Promise<void>;
+    /**
+     * Waits for profiler server to tell it to collect a profile, then collects
+     * a profile and uploads it.
+     *
+     * @return time, in ms, to wait before asking profiler server again about
+     * collecting another profile.
+     */
+    collectProfile(): Promise<number>;
+    /**
+     * Talks to profiler server, which hangs until server indicates
+     * job should be profiled and then indicates what type of profile should
+     * be collected.
+     *
+     * If any problem is encountered, an error will be thrown.
+     *
+     * @return a RequestProfile specifying which type of profile should be
+     * collected and other information needed to collect and upload a profile of
+     * the specified type.
+     *
+     * TODO (issue #28): right now, this call could hang for up to an hour when
+     * this method is the only thing on the event loop, keeping the program open
+     * even when all work is done. Should expose the ability to cancel the http
+     * request made here, and then determine when to cancel this request.
+     *
+     * Public to allow for testing.
+     */
+    createProfile(): Promise<RequestProfile>;
+    /**
+     * Collects a profile of the type specified by the profileType field of prof.
+     * If any problem is encountered, like a problem collecting or uploading the
+     * profile, a message will be logged, and the error will otherwise be ignored.
+     *
+     * Public to allow for testing.
+     */
+    profileAndUpload(prof: RequestProfile): Promise<void>;
+    /**
+     * Collects a profile of the type specified by profileType field of prof.
+     * If any problem is encountered, for example the profileType is not
+     * recognized or profiling is disabled for the specified profileType, an
+     * error will be thrown.
+     *
+     * Public to allow for testing.
+     */
+    profile(prof: RequestProfile): Promise<RequestProfile>;
+    /**
+     * Collects a time profile, converts profile to compressed, base64 encoded
+     * string, and puts this string in profileBytes field of prof.
+     *
+     * Public to allow for testing.
+     */
+    writeTimeProfile(prof: RequestProfile): Promise<RequestProfile>;
+    /**
+     * Collects a heap profile, converts profile to compressed, base64 encoded
+     * string, and adds profileBytes field to prof with this string.
+     *
+     * Public to allow for testing.
+     */
+    writeHeapProfile(prof: RequestProfile): Promise<RequestProfile>;
+}