diff --git a/.eslintignore b/.eslintignore index 971b2565..c4a0963e 100644 --- a/.eslintignore +++ b/.eslintignore @@ -4,4 +4,5 @@ test/fixtures build/ docs/ protos/ -**/env-tests-logging +samples/generated/ +system-test/**/fixtures diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 80520bba..089c91ec 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -6,7 +6,7 @@ # The yoshi-nodejs team is the default owner for nodejs repositories. -* @googleapis/yoshi-nodejs +* @googleapis/yoshi-nodejs @googleapis/yoshi-nodejs # The github automation team is the default owner for the auto-approve file. .github/auto-approve.yml @googleapis/github-automation diff --git a/.github/auto-label.yaml b/.github/auto-label.yaml index ccad49b4..09c8d735 100644 --- a/.github/auto-label.yaml +++ b/.github/auto-label.yaml @@ -1,19 +1,2 @@ -# Copyright 2022 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. requestsize: enabled: true -staleness: - pullrequest: true - old: 30 - extraold: 60 diff --git a/.github/release-please.yml b/.github/release-please.yml index e38b6169..a1b41da3 100644 --- a/.github/release-please.yml +++ b/.github/release-please.yml @@ -1,3 +1,2 @@ handleGHRelease: true releaseType: node -extraFiles: ["src/utils/instrumentation.ts"] diff --git a/.github/sync-repo-settings.yaml b/.github/sync-repo-settings.yaml index 5edb586a..b46e4c4d 100644 --- a/.github/sync-repo-settings.yaml +++ b/.github/sync-repo-settings.yaml @@ -7,12 +7,10 @@ branchProtectionRules: requiredStatusCheckContexts: - "ci/kokoro: Samples test" - "ci/kokoro: System test" - - docs - lint - test (14) - test (16) - test (18) - - test (20) - cla/google - windows - OwlBot Post Processor @@ -23,4 +21,3 @@ permissionRules: permission: admin - team: jsteam permission: push - diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 1e75783e..4892eb2c 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -46,20 +46,15 @@ jobs: node-version: 14 - run: npm install - run: npm run lint - # TODO(https://github.com/googleapis/nodejs-logging/issues/1609) docs: runs-on: ubuntu-latest steps: - - run: echo "Docs are disabled for now" - # docs: - # runs-on: ubuntu-latest - # steps: - # - uses: actions/checkout@v3 - # - uses: actions/setup-node@v3 - # with: - # node-version: 14 - # - run: npm install - # - run: npm run docs - # - uses: JustinBeckwith/linkinator-action@v1 - # with: - # paths: docs/ + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: 14 + - run: npm install + - run: npm run docs + - uses: JustinBeckwith/linkinator-action@v1 + with: + paths: docs/ diff --git a/.kokoro/common.cfg b/.kokoro/common.cfg index 593a07b2..f55932f1 100644 --- a/.kokoro/common.cfg +++ b/.kokoro/common.cfg @@ -22,23 +22,3 @@ env_vars: { key: "TRAMPOLINE_BUILD_FILE" value: "github/nodejs-logging/.kokoro/test.sh" } - - -############################################# -# this section merged from .kokoro/common_env_vars.cfg using owlbot.py - -env_vars: { - key: "PRODUCT_AREA_LABEL" - value: "observability" -} -env_vars: { - key: "PRODUCT_LABEL" - value: "logging" -} -env_vars: { - key: "LANGUAGE_LABEL" - value: "nodejs" -} - -################################################### - diff --git a/.kokoro/continuous/node14/common.cfg b/.kokoro/continuous/node14/common.cfg index 593a07b2..f55932f1 100644 --- a/.kokoro/continuous/node14/common.cfg +++ b/.kokoro/continuous/node14/common.cfg @@ -22,23 +22,3 @@ env_vars: { key: "TRAMPOLINE_BUILD_FILE" value: "github/nodejs-logging/.kokoro/test.sh" } - - -############################################# -# this section merged from .kokoro/common_env_vars.cfg using owlbot.py - -env_vars: { - key: "PRODUCT_AREA_LABEL" - value: "observability" -} -env_vars: { - key: "PRODUCT_LABEL" - value: "logging" -} -env_vars: { - key: "LANGUAGE_LABEL" - value: "nodejs" -} - -################################################### - diff --git a/.prettierignore b/.prettierignore index 971b2565..9340ad9b 100644 --- a/.prettierignore +++ b/.prettierignore @@ -4,4 +4,3 @@ test/fixtures build/ docs/ protos/ -**/env-tests-logging diff --git a/.trampolinerc b/.trampolinerc index e7bdc633..5fc22531 100644 --- a/.trampolinerc +++ b/.trampolinerc @@ -15,12 +15,11 @@ # Template for .trampolinerc # Add required env vars here. -required_envvars+=() +required_envvars+=( +) # Add env vars which are passed down into the container here. pass_down_envvars+=( - "ENVIRONMENT" - "RUNTIME" "AUTORELEASE_PR" "VERSION" ) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fd50e66e..b6f4bfd8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,22 +68,8 @@ accept your pull requests. npm run fix -## Running the tests in GCP services - -It is possible to end-to-end test this library within specific Google Cloud -Platform environments. The [env-tests-logging](https://github.com/googleapis/env-tests-logging) -submodule contains common tests to ensure correct logging behavior across Google -Cloud Platforms. - -Currently, the following environments are supported: - -| Platform | Runtime | Try it | -| --------------- | -------------- | ------------------------------ | -| Cloud Functions | Nodejs12 | `nox --session "tests(language='nodejs', platform='functions')"` | -| Cloud Run | COMING SOON | `nox --session "tests(language='nodejs', platform='cloudrun')"` | - [setup]: https://cloud.google.com/nodejs/docs/setup [projects]: https://console.cloud.google.com/project [billing]: https://support.google.com/cloud/answer/6293499#enable-billing [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=logging.googleapis.com -[auth]: https://cloud.google.com/docs/authentication/getting-started +[auth]: https://cloud.google.com/docs/authentication/getting-started \ No newline at end of file diff --git a/README.md b/README.md index a2f913a7..6405bea2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +**_THIS REPOSITORY IS DEPRECATED. ALL OF ITS CONTENT AND HISTORY HAS BEEN MOVED TO [GOOGLE-CLOUD-NODE](https://github.com/googleapis/google-cloud-node/tree/main/packages/handwritten)_** + [//]: # "This README.md file is auto-generated, all changes to this file will be lost." [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo diff --git a/owlbot.py b/owlbot.py index 58d77a55..49fce7a6 100644 --- a/owlbot.py +++ b/owlbot.py @@ -1,69 +1,17 @@ -# Copyright 2018 Google LLC +# Copyright 2022 Google LLC # -# Licensed under the Apache License, Version 2.0 (the "License"); +# 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 +# https://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. - -"""This script is used to synthesize generated parts of this library.""" - -import os -import synthtool as s import synthtool.languages.node as node - -node.owlbot_main( - staging_excludes=[ - ".eslintignore", ".prettierignore", "src/index.ts", "README.md", "package.json", - "system-test/fixtures/sample/src/index.js", - "system-test/fixtures/sample/src/index.ts"], - templates_excludes=[ - "src/index.ts", - ".eslintignore", - ".prettierignore", - "CONTRIBUTING.md", - ".github/auto-label.yaml", - ".github/release-please.yml", - ".github/CODEOWNERS", - ".github/sync-repo-settings.yaml" - ] -) - -# adjust .trampolinerc for environment tests -s.replace( - ".trampolinerc", - "required_envvars[^\)]*\)", - "required_envvars+=()" -) -s.replace( - ".trampolinerc", - "pass_down_envvars\+\=\(", - 'pass_down_envvars+=(\n "ENVIRONMENT"\n "RUNTIME"' -) - -# -------------------------------------------------------------------------- -# Modify test configs -# -------------------------------------------------------------------------- - -# add shared environment variables to test configs -s.move( - ".kokoro/common_env_vars.cfg", - ".kokoro/common.cfg", - merge=lambda src, dst, _, : f"{dst}\n{src}", -) - -for path, subdirs, files in os.walk(f".kokoro/continuous"): - for name in files: - if name == "common.cfg": - file_path = os.path.join(path, name) - s.move( - ".kokoro/common_env_vars.cfg", - file_path, - merge=lambda src, dst, _, : f"{dst}\n{src}", - ) +node.owlbot_main(templates_excludes=[ +'README.md' +]) diff --git a/protos/protos.d.ts b/protos/protos.d.ts index 8b3a9888..c8d28f80 100644 --- a/protos/protos.d.ts +++ b/protos/protos.d.ts @@ -1,4 +1,4 @@ -// Copyright 2025 Google LLC +// Copyright 2026 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/protos/protos.js b/protos/protos.js index a78662d6..efbfabc9 100644 --- a/protos/protos.js +++ b/protos/protos.js @@ -1,4 +1,4 @@ -// Copyright 2025 Google LLC +// Copyright 2026 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/src/index.ts b/src/index.ts index 1bfc0c3b..aff9ff12 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,1608 +1,47 @@ -/*! - * Copyright 2015 Google Inc. All Rights Reserved. - * - * 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. - */ +// Copyright 2020 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 +// +// https://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. +// +// ** This file is automatically generated by synthtool. ** +// ** https://github.com/googleapis/synthtool ** +// ** All changes to this file may be overwritten. ** -import {util} from '@google-cloud/common'; -import {paginator} from '@google-cloud/paginator'; -import {replaceProjectIdToken} from '@google-cloud/projectify'; -import {callbackifyAll} from '@google-cloud/promisify'; -import arrify = require('arrify'); -import * as extend from 'extend'; -import * as gax from 'google-gax'; -// eslint-disable-next-line n/no-extraneous-import -import {ClientReadableStream, ClientDuplexStream} from '@grpc/grpc-js'; -// eslint-disable-next-line @typescript-eslint/no-var-requires -const pumpify = require('pumpify'); -import * as streamEvents from 'stream-events'; import * as middleware from './middleware'; -import {detectServiceContext, getDefaultResource} from './utils/metadata'; -import {CloudLoggingHttpRequest as HttpRequest} from './utils/http-request'; - -import {GoogleAuth} from 'google-auth-library'; - -export {middleware}; -export {HttpRequest}; -export {detectServiceContext}; - -const version = require('../../package.json').version; -// eslint-disable-next-line @typescript-eslint/no-var-requires -const v2 = require('./v2'); - -import {Entry, LogEntry} from './entry'; -import { - MonitoredResource, - Severity, - SeverityNames, - formatLogName, - assignSeverityToEntries, -} from './utils/log-common'; -import {Log, GetEntriesRequest, TailEntriesRequest, LogOptions} from './log'; -import {LogSync, LogSyncOptions} from './log-sync'; -import {Sink} from './sink'; -import {Duplex, PassThrough, Transform, Writable} from 'stream'; -import {google} from '../protos/protos'; - -import {Bucket} from '@google-cloud/storage'; // types only -import {Dataset, BigQuery} from '@google-cloud/bigquery'; // types only -import {Topic} from '@google-cloud/pubsub'; // types only - -export interface LoggingOptions extends gax.GrpcClientOptions { - autoRetry?: boolean; - maxRetries?: number; - apiEndpoint?: string; -} - -export interface DeleteCallback { - (error?: Error | null, response?: google.protobuf.Empty): void; -} - -export type DeleteResponse = google.protobuf.Empty; - -export type LogSink = google.logging.v2.ILogSink; - -export interface AbortableDuplex extends Duplex { - abort(): void; -} - -export interface CreateSinkRequest { - // destination: Bucket|Dataset|Topic|string; - // eslint-disable-next-line @typescript-eslint/no-explicit-any - destination: any; - filter?: string; - includeChildren?: boolean; - name?: string; - outputVersionFormat?: google.logging.v2.LogSink.VersionFormat; - uniqueWriterIdentity?: string | boolean; - gaxOptions?: gax.CallOptions; -} - -export interface CreateSinkCallback { - (err: Error | null, sink?: Sink | null, resp?: LogSink): void; -} - -export type GetEntriesResponse = [ - Entry[], - google.logging.v2.IListLogEntriesRequest, - google.logging.v2.IListLogEntriesResponse, -]; - -export interface GetEntriesCallback { - ( - err: Error | null, - entries?: Entry[], - request?: google.logging.v2.IListLogEntriesRequest, - apiResponse?: google.logging.v2.IListLogEntriesResponse - ): void; -} - -export interface TailEntriesResponse { - entries: Entry[]; - suppressionInfo: google.logging.v2.TailLogEntriesResponse.SuppressionInfo; -} - -export interface GetLogsRequest { - autoPaginate?: boolean; - gaxOptions?: gax.CallOptions; - maxApiCalls?: number; - maxResults?: number; - pageSize?: number; - pageToken?: string; -} - -export type GetLogsResponse = [ - Sink[], - google.logging.v2.IListLogsRequest, - google.logging.v2.IListLogsResponse, -]; - -export interface GetLogsCallback { - ( - err: Error | null, - entries?: Sink[], - request?: google.logging.v2.IListLogsRequest, - apiResponse?: google.logging.v2.IListLogsResponse - ): void; -} - -export interface GetSinksRequest { - autoPaginate?: boolean; - gaxOptions?: gax.CallOptions; - maxApiCalls?: number; - maxResults?: number; - pageSize?: number; - pageToken?: string; -} - -export type GetSinksResponse = [ - Sink[], - google.logging.v2.IListSinksRequest, - google.logging.v2.IListSinksResponse, -]; - -export interface GetSinksCallback { - ( - err: Error | null, - entries?: Sink[], - request?: google.logging.v2.IListSinksRequest, - apiResponse?: google.logging.v2.IListSinksResponse - ): void; -} -export type Client = string; - -export interface RequestConfig { - client: Client; - method: string; - reqOpts?: object; - gaxOpts?: gax.CallOptions; -} - -export interface RequestCallback { - (err: Error | null, res?: TResponse): void; -} - -interface GaxRequestCallback { - (err: Error | null, requestFn?: Function): void; -} -/** - * For logged errors, one can provide a the service context. For more - * information see [this guide]{@link - * https://cloud.google.com/error-reporting/docs/formatting-error-messages} - * and the [official documentation]{@link - * https://cloud.google.com/error-reporting/reference/rest/v1beta1/ServiceContext}. - */ -export interface ServiceContext { - /** - * An identifier of the service, such as the name of the executable, job, or - * Google App Engine service name. - */ - service?: string; - /** - * Represents the version of the service. - */ - version?: string; -} - -/** - * @typedef {object} ClientConfig - * @property {string} [projectId] The project ID from the Google Developer's - * Console, e.g. 'grape-spaceship-123'. We will also check the environment - * variable `GCLOUD_PROJECT` for your project ID. If your app is running in - * an environment which supports {@link - * https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application - * Application Default Credentials}, your project ID will be detected - * automatically. - * @property {string} [keyFilename] Full path to the a .json, .pem, or .p12 key - * downloaded from the Google Developers Console. If you provide a path to a - * JSON file, the `projectId` option above is not necessary. NOTE: .pem and - * .p12 require you to specify the `email` option as well. - * @property {string} [email] Account email address. Required when using a .pem - * or .p12 keyFilename. - * @property {object} [credentials] Credentials object. - * @property {string} [credentials.client_email] - * @property {string} [credentials.private_key] - * @property {boolean} [autoRetry=true] Automatically retry requests if the - * response is related to rate limits or certain intermittent server errors. - * We will exponentially backoff subsequent requests by default. - * @property {number} [maxRetries=3] Maximum number of automatic retries - * attempted before returning the error. - * @property {Constructor} [promise] Custom promise module to use instead of - * native Promises. - */ -/** - * {@link https://cloud.google.com/logging/docs| Cloud Logging} allows you to - * store, search, analyze, monitor, and alert on log data and events from Google - * Cloud Platform and Amazon Web Services (AWS). - * - * @class - * - * See {@link https://cloud.google.com/logging/docs| What is Cloud Logging?} - * - * See {@link https://cloud.google.com/logging/docs/api| Introduction to the Cloud Logging API} - * - * See {@link https://www.npmjs.com/package/@google-cloud/logging-bunyan| Logging to Google Cloud from Bunyan} - * - * See {@link https://www.npmjs.com/package/@google-cloud/logging-winston| Logging to Google Cloud from Winston} - * - * @param {ClientConfig} [options] Configuration options. - * - * @example Import the client library - * ``` - * const {Logging} = require('@google-cloud/logging'); - * - * ``` - * @example Create a client that uses Application Default Credentials (ADC): - * ``` - * const logging = new Logging(); - * - * ``` - * @example Create a client with explicitcredentials: - * ``` - * const logging = new Logging({ projectId: - * 'your-project-id', keyFilename: '/path/to/keyfile.json' - * }); - * - * ``` - * @example include:samples/quickstart.js - * region_tag:logging_quickstart - * Full quickstart example: - */ -class Logging { - api: {[key: string]: gax.ClientStub}; - auth: gax.GoogleAuth; - options: LoggingOptions; - projectId: string; - detectedResource?: object; - configService?: typeof v2.ConfigServiceV2Client; - loggingService?: typeof v2.LoggingServiceV2Client; - - constructor(options?: LoggingOptions, gaxInstance?: typeof gax) { - // Determine what scopes are needed. - // It is the union of the scopes on all three clients. - const scopes: Array<{}> = []; - const clientClasses = [ - v2.ConfigServiceV2Client, - v2.LoggingServiceV2Client, - v2.MetricsServiceV2Client, - ]; - for (const clientClass of clientClasses) { - for (const scope of clientClass.scopes) { - if (scopes.indexOf(scope) === -1) { - scopes.push(scope); - } - } - } - const options_ = extend( - { - libName: 'gccl', - libVersion: version, - scopes, - }, - options - ); - this.api = {}; - this.auth = new (gaxInstance ?? gax).GoogleAuth(options_); - this.options = options_; - this.projectId = this.options.projectId || '{{projectId}}'; - this.configService = new v2.ConfigServiceV2Client( - this.options, - gaxInstance - ); - this.loggingService = new v2.LoggingServiceV2Client( - this.options, - gaxInstance - ); - } - - /** - * Config to set for the sink. Not all available options are listed here, see - * the [Sink - * resource](https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks#LogSink) - * definition for full details. - * - * @typedef {object} CreateSinkRequest - * @property {object} [gaxOptions] Request configuration options, outlined - * here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions. - * @property {Bucket|Dataset|Topic} [destination] The destination. The proper ACL - * scopes will be granted to the provided destination. Can be one of: - * {@link https://googleapis.dev/nodejs/storage/latest/ Bucket}, - * {@link https://googleapis.dev/nodejs/bigquery/latest/ Dataset}, or - * {@link https://googleapis.dev/nodejs/pubsub/latest/ Topic} - * @property {string} [filter] An advanced logs filter. Only log entries - * matching the filter are written. - * @property {string|boolean} [uniqueWriterIdentity] Determines the kind of IAM - * identity returned as `writerIdentity` in the new sink. See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/create#query-parameters}. - */ - /** - * @typedef {array} CreateSinkResponse - * @property {Sink} 0 The new {@link Sink}. - * @property {object} 1 The full API response. - */ - /** - * @callback CreateSinkCallback - * @param {?Error} err Request error, if any. - * @param {Sink} sink The new {@link Sink}. - * @param {object} apiResponse The full API response. - */ - createSink(name: string, config: CreateSinkRequest): Promise<[Sink, LogSink]>; - createSink( - name: string, - config: CreateSinkRequest, - callback: CreateSinkCallback - ): void; - // jscs:disable maximumLineLength - /** - * Create a sink. - * - * See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks|Sink Overview} - * See {@link https://cloud.google.com/logging/docs/view/advanced_filters|Advanced Logs Filters} - * See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/create|projects.sinks.create API Documentation} - * - * @param {string} name Name of the sink. - * @param {CreateSinkRequest} config Config to set for the sink. - * @param {CreateSinkCallback} [callback] Callback function. - * @returns {Promise} - * @throws {Error} If a name is not provided. - * @throws {Error} if a config object is not provided. - * @see Sink#create - * - * @example - * ``` - * const {Storage} = require('@google-cloud/storage'); - * const storage = new Storage({ - * projectId: 'grape-spaceship-123' - * }); - * const {Logging} = require('@google-cloud/logging'); - * const logging = new Logging(); - * - * const config = { - * destination: storage.bucket('logging-bucket'), - * filter: 'severity = ALERT' - * }; - * - * function callback(err, sink, apiResponse) { - * // `sink` is a Sink object. - * } - * - * logging.createSink('new-sink-name', config, callback); - * - * //- - * // If the callback is omitted, we'll return a Promise. - * //- - * logging.createSink('new-sink-name', config).then(data => { - * const sink = data[0]; - * const apiResponse = data[1]; - * }); - * - * ``` - * @example include:samples/sinks.js - * region_tag:logging_create_sink - * Another example: - */ - async createSink( - name: string, - config: CreateSinkRequest - ): Promise<[Sink, LogSink]> { - if (typeof name !== 'string') { - throw new Error('A sink name must be provided.'); - } - if (typeof config !== 'object') { - throw new Error('A sink configuration object must be provided.'); - } - if (util.isCustomType(config.destination, 'bigquery/dataset')) { - await this.setAclForDataset_(config); - } - if (util.isCustomType(config.destination, 'pubsub/topic')) { - await this.setAclForTopic_(config); - } - if (util.isCustomType(config.destination, 'storage/bucket')) { - await this.setAclForBucket_(config); - } - const reqOpts = { - parent: 'projects/' + this.projectId, - sink: extend({}, config, {name}), - uniqueWriterIdentity: config.uniqueWriterIdentity, - }; - delete reqOpts.sink.gaxOptions; - delete reqOpts.sink.uniqueWriterIdentity; - await this.setProjectId(reqOpts); - const [resp] = await this.configService.createSink( - reqOpts, - config.gaxOptions - ); - const sink = this.sink(resp.name); - sink.metadata = resp; - return [sink, resp]; - } - - /** - * Create an entry object. - * - * Using this method will not itself make any API requests. You will use - * the object returned in other API calls, such as - * {@link Log#write}. - * - * Note, {@link https://cloud.google.com/logging/quotas|Cloud Logging Quotas and limits} - * dictates that the maximum log entry size, including all - * [LogEntry Resource properties]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry}, - * cannot exceed _approximately_ 256 KB. - * - * See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry|LogEntry JSON representation} - * - * @param {?object|?string} [resource] See a - * [Monitored - * Resource](https://cloud.google.com/logging/docs/reference/v2/rest/v2/MonitoredResource). - * @param {object|string} data The data to use as the value for this log - * entry. - * @returns {Entry} - * - * @example - * ``` - * const {Logging} = require('@google-cloud/logging'); - * const logging = new Logging(); - * - * const resource = { - * type: 'gce_instance', - * labels: { - * zone: 'global', - * instance_id: '3' - * } - * }; - * - * const entry = logging.entry(resource, { - * delegate: 'my_username' - * }); - * - * entry.toJSON(); - * // { - * // resource: { - * // type: 'gce_instance', - * // labels: { - * // zone: 'global', - * // instance_id: '3' - * // } - * // }, - * // jsonPayload: { - * // delegate: 'my_username' - * // } - * // } - * ``` - */ - entry(resource?: LogEntry, data?: {} | string) { - return new Entry(resource, data); - } - - /** - * Query object for listing entries. - * - * @typedef {object} GetEntriesRequest - * @property {boolean} [autoPaginate=true] Have pagination handled - * automatically. - * @property {string} [filter] An - * [advanced logs - * filter](https://cloud.google.com/logging/docs/view/advanced_filters). An - * empty filter matches all log entries. - * @property {object} [gaxOptions] Request configuration options, outlined - * here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions. - * @property {string} [log] A name of the log specifying to pnly return - * entries from this log. - * @property {number} [maxApiCalls] Maximum number of API calls to make. - * @property {number} [maxResults] Maximum number of items plus prefixes to - * return. - * @property {string} [orderBy] How the results should be sorted, - * `timestamp asc` (oldest first) and `timestamp desc` (newest first, - * **default**). - * @property {number} [pageSize] Maximum number of logs to return. - * @property {string} [pageToken] A previously-returned page token - * representing part of the larger set of results to view. - */ - /** - * @typedef {array} GetEntriesResponse - * @property {Entry[]} 0 Array of {@link Entry} instances. - * @property {object} 1 The full API request. - * @property {object} 2 The full API response. - */ - /** - * @callback GetEntriesCallback - * @param {?Error} err Request error, if any. - * @param {Entry[]} entries Array of {@link Entry} instances. - * @param {object} apiResponse The full API response. - */ - /** - * List the entries in your logs. - * - * See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/list|entries.list API Documentation} - * - * @param {GetEntriesRequest} [query] Query object for listing entries. - * @param {GetEntriesCallback} [callback] Callback function. - * @returns {Promise} - * - * @example - * ``` - * const {Logging} = require('@google-cloud/logging'); - * const logging = new Logging(); - * - * logging.getEntries((err, entries) => { - * // `entries` is an array of Cloud Logging entry objects. - * // See the `data` property to read the data from the entry. - * }); - * - * //- - * // To control how many API requests are made and page through the results - * // manually, set `autoPaginate` to `false`. - * //- - * function callback(err, entries, nextQuery, apiResponse) { - * if (nextQuery) { - * // More results exist. - * logging.getEntries(nextQuery, callback); - * } - * } - * - * logging.getEntries({ - * autoPaginate: false - * }, callback); - * - * //- - * // If the callback is omitted, we'll return a Promise. - * //- - * logging.getEntries().then(data => { - * const entries = data[0]; - * }); - * - * ``` - * @example include:samples/logs.js - * region_tag:logging_list_log_entries - * Another example: - * - * @example include:samples/logs.js - * region_tag:logging_list_log_entries_advanced - * Another example: - */ - getEntries(options?: GetEntriesRequest): Promise; - getEntries(callback: GetEntriesCallback): void; - getEntries(options: GetEntriesRequest, callback: GetEntriesCallback): void; - async getEntries( - opts?: GetEntriesRequest | GetEntriesCallback - ): Promise { - const options = opts ? (opts as GetEntriesRequest) : {}; - - // By default, sort entries by descending timestamp - let reqOpts = extend({orderBy: 'timestamp desc'}, options); - - // By default, filter entries to last 24 hours only - const time = new Date(); - time.setDate(time.getDate() - 1); - const timeFilter = `timestamp >= "${time.toISOString()}"`; - if (!options.filter) { - reqOpts = extend({filter: timeFilter}, reqOpts); - } else if (!options.filter.includes('timestamp')) { - reqOpts.filter += ` AND ${timeFilter}`; - } - - this.projectId = await this.auth.getProjectId(); - const resourceName = 'projects/' + this.projectId; - reqOpts.resourceNames = arrify(reqOpts.resourceNames!); - if (reqOpts.resourceNames.length === 0) { - // If no resource names are provided, default to the current project. - reqOpts.resourceNames.push(resourceName); - } - delete reqOpts.autoPaginate; - delete reqOpts.gaxOptions; - let gaxOptions = extend( - { - autoPaginate: options!.autoPaginate, - }, - options!.gaxOptions - ); - if (options?.maxResults) { - gaxOptions = extend( - { - maxResults: options.maxResults, - }, - gaxOptions - ); - } - const resp = await this.loggingService.listLogEntries(reqOpts, gaxOptions); - const [entries] = resp; - if (entries) { - resp[0] = entries.map(Entry.fromApiResponse_); - } - return resp; - } - - /** - * List the {@link Entry} objects in your logs as a readable object - * stream. - * - * @method Logging#getEntriesStream - * @param {GetEntriesRequest} [query] Query object for listing entries. - * @returns {ReadableStream} A readable stream that emits {@link Entry} - * instances. - * - * @example - * ``` - * const {Logging} = require('@google-cloud/logging'); - * const logging = new Logging(); - * - * logging.getEntriesStream() - * .on('error', console.error) - * .on('data', entry => { - * // `entry` is a Cloud Logging entry object. - * // See the `data` property to read the data from the entry. - * }) - * .on('end', function() { - * // All entries retrieved. - * }); - * - * //- - * // If you anticipate many results, you can end a stream early to prevent - * // unnecessary processing and API requests. - * //- - * logging.getEntriesStream() - * .on('data', function(entry) { - * this.end(); - * }); - * ``` - */ - getEntriesStream(options: GetEntriesRequest = {}) { - let requestStream: Duplex; - const userStream = streamEvents(pumpify.obj()); - (userStream as AbortableDuplex).abort = () => { - if (requestStream) { - (requestStream as AbortableDuplex).abort(); - } - }; - const toEntryStream = new Transform({ - objectMode: true, - transform: (chunk, encoding, callback) => { - callback(null, Entry.fromApiResponse_(chunk)); - }, - }); - userStream.once('reading', () => { - this.auth.getProjectId().then(projectId => { - this.projectId = projectId; - if (options.log) { - if (options.filter) { - options.filter = `(${options.filter}) AND logName="${formatLogName( - this.projectId, - options.log - )}"`; - } else { - options.filter = `logName="${formatLogName( - this.projectId, - options.log - )}"`; - } - delete options.log; - } - const reqOpts = extend( - { - orderBy: 'timestamp desc', - }, - options - ); - reqOpts.resourceNames = arrify(reqOpts.resourceNames!); - reqOpts.resourceNames.push(`projects/${this.projectId}`); - delete reqOpts.autoPaginate; - delete reqOpts.gaxOptions; - const gaxOptions = extend( - { - autoPaginate: options.autoPaginate, - }, - options.gaxOptions - ); - - let gaxStream: ClientReadableStream; - requestStream = streamEvents( - new PassThrough({objectMode: true}) - ); - (requestStream as AbortableDuplex).abort = () => { - if (gaxStream && gaxStream.cancel) { - gaxStream.cancel(); - } - }; - // eslint-disable-next-line @typescript-eslint/no-explicit-any - if (!(global as any).GCLOUD_SANDBOX_ENV) { - requestStream.once('reading', () => { - try { - gaxStream = this.loggingService.listLogEntriesStream( - reqOpts, - gaxOptions - ); - } catch (error) { - requestStream.destroy(error as Error); - return; - } - gaxStream - .on('error', err => { - requestStream.destroy(err); - }) - .pipe(requestStream); - return; - }); - } - // eslint-disable-next-line @typescript-eslint/no-explicit-any - (userStream as any).setPipeline(requestStream, toEntryStream); - }); - }); - return userStream; - } - - /** - * Query object for streaming entries. - * - * @typedef {object} TailEntriesRequest - * @property {Array.|string} [resourceNames] Names of project - * resources to stream logs out of. - * @property {string} [filter] An - * [advanced logs - * filter](https://cloud.google.com/logging/docs/view/advanced_filters). An - * empty filter matches all log entries. - * @property {number} [bufferWindow=2] A setting to balance the tradeoff - * between viewing the log entries as they are being written and viewing - * them in ascending order. - * @property {string} [log] A name of the log specifying to only return - * entries from this log. - * @property {object} [gaxOptions] Request configuration options, outlined - * here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions. - */ - /** - * Streaming read of live logs as log entries are ingested. Until the stream - * is terminated, it will continue reading logs. - * - * @method Logging#tailEntries - * @param {TailEntriesRequest} [query] Query object for tailing entries. - * @returns {DuplexStream} A duplex stream that emits TailEntriesResponses - * containing an array of {@link Entry} instances. - * - * @example - * ``` - * const {Logging} = require('@google-cloud/logging'); - * const logging = new Logging(); - * - * logging.tailEntries() - * .on('error', console.error) - * .on('data', resp => { - * console.log(resp.entries); - * console.log(resp.suppressionInfo); - * }) - * .on('end', function() { - * // All entries retrieved. - * }); - * - * //- - * // If you anticipate many results, you can end a stream early to prevent - * // unnecessary processing and API requests. - * //- - * logging.getEntriesStream() - * .on('data', function(entry) { - * this.end(); - * }); - * ``` - */ - tailEntries(options: TailEntriesRequest = {}) { - const userStream = streamEvents(pumpify.obj()); - - // eslint-disable-next-line @typescript-eslint/no-explicit-any - let gaxStream: ClientDuplexStream; - - (userStream as AbortableDuplex).abort = () => { - if (gaxStream && gaxStream.cancel) { - gaxStream.cancel(); - } - }; - - const transformStream = new Transform({ - objectMode: true, - transform: (chunk, encoding, callback) => { - callback( - null, - (() => { - const formattedEntries: Entry[] = []; - chunk.entries.forEach((entry: google.logging.v2.LogEntry) => { - formattedEntries.push(Entry.fromApiResponse_(entry)); - }); - const resp: TailEntriesResponse = { - entries: formattedEntries, - suppressionInfo: chunk.suppressionInfo, - }; - return resp; - })() - ); - }, - }); - - this.auth.getProjectId().then(projectId => { - this.projectId = projectId; - - if (options.log) { - if (options.filter) { - options.filter = `(${options.filter}) AND logName="${formatLogName( - this.projectId, - options.log - )}"`; - } else { - options.filter = `logName="${formatLogName( - this.projectId, - options.log - )}"`; - } - } - options.resourceNames = arrify(options.resourceNames); - options.resourceNames.push(`projects/${this.projectId}`); - const writeOptions = { - resourceNames: options.resourceNames, - ...(options.filter && {filter: options.filter}), - ...(options.bufferWindow && {bufferwindow: options.bufferWindow}), - }; - - // eslint-disable-next-line @typescript-eslint/no-explicit-any - if (!(global as any).GCLOUD_SANDBOX_ENV) { - gaxStream = this.loggingService.tailLogEntries(options.gaxOptions); - // Write can only be called once in a single tail streaming session. - gaxStream.write(writeOptions); - // eslint-disable-next-line @typescript-eslint/no-explicit-any - (userStream as any).setPipeline(gaxStream, transformStream); - } - }); - - return userStream; - } - - /** - * Query object for listing entries. - * - * @typedef {object} GetLogsRequest - * @property {boolean} [autoPaginate=true] Have pagination handled - * automatically. - * @property {object} [gaxOptions] Request configuration options, outlined - * here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions. - * @property {number} [maxApiCalls] Maximum number of API calls to make. - * @property {number} [maxResults] Maximum number of items plus prefixes to - * return. - * @property {number} [pageSize] Maximum number of logs to return. - * @property {string} [pageToken] A previously-returned page token - * representing part of the larger set of results to view. - */ - /** - * @typedef {array} GetLogsResponse - * @property {Log[]} 0 Array of {@link Log} instances. - * @property {object} 1 The full API request. - * @property {object} 2 The full API response. - */ - /** - * @callback GetLogsCallback - * @param {?Error} err Request error, if any. - * @param {Log[]} logs Array of {@link Log} instances. - * @param {object} apiResponse The full API response. - */ - /** - * List the entries in your logs. - * - * See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/logs/list|logs.list API Documentation} - * - * @param {GetLogsRequest} [query] Query object for listing entries. - * @param {GetLogsCallback} [callback] Callback function. - * @returns {Promise} - * - * @example - * ``` - * const {Logging} = require('@google-cloud/logging'); - * const logging = new Logging(); - * - * logging.getLogs((err, logs) => { - * // `logs` is an array of Cloud Logging log objects. - * }); - * - * //- - * // To control how many API requests are made and page through the results - * // manually, set `autoPaginate` to `false`. - * //- - * function callback(err, entries, nextQuery, apiResponse) { - * if (nextQuery) { - * // More results exist. - * logging.getLogs(nextQuery, callback); - * } - * } - * - * logging.getLogs({ - * autoPaginate: false - * }, callback); - * - * //- - * // If the callback is omitted, we'll return a Promise. - * //- - * logging.getLogs().then(data => { - * const entries = data[0]; - * }); - * - * ``` - * @example include:samples/logs.js - * region_tag:logging_list_logs - * Another example: - */ - getLogs(options?: GetLogsRequest): Promise; - getLogs(callback: GetLogsCallback): void; - getLogs(options: GetLogsRequest, callback: GetLogsCallback): void; - async getLogs( - opts?: GetLogsRequest | GetLogsCallback - ): Promise { - const options = opts ? (opts as GetSinksRequest) : {}; - this.projectId = await this.auth.getProjectId(); - const reqOpts = extend({}, options, { - parent: 'projects/' + this.projectId, - }); - delete reqOpts.autoPaginate; - delete reqOpts.gaxOptions; - const gaxOptions = extend( - { - autoPaginate: options.autoPaginate, - }, - options.gaxOptions - ); - const resp = await this.loggingService.listLogs(reqOpts, gaxOptions); - const [logs] = resp; - if (logs) { - resp[0] = logs.map((logName: string) => this.log(logName)); - } - return resp; - } - - /** - * List the {@link Log} objects in your project as a readable object stream. - * - * @method Logging#getLogsStream - * @param {GetLogsRequest} [query] Query object for listing entries. - * @returns {ReadableStream} A readable stream that emits {@link Log} - * instances. - * - * @example - * ``` - * const {Logging} = require('@google-cloud/logging'); - * const logging = new Logging(); - * - * logging.getLogsStream() - * .on('error', console.error) - * .on('data', log => { - * // `log` is a Cloud Logging log object. - * }) - * .on('end', function() { - * // All logs retrieved. - * }); - * - * //- - * // If you anticipate many results, you can end a stream early to prevent - * // unnecessary processing and API requests. - * //- - * logging.getLogsStream() - * .on('data', log => { - * this.end(); - * }); - * ``` - */ - getLogsStream(options: GetLogsRequest = {}) { - options = options || {}; - let requestStream: Duplex; - const userStream = streamEvents(pumpify.obj()); - (userStream as AbortableDuplex).abort = () => { - if (requestStream) { - (requestStream as AbortableDuplex).abort(); - } - }; - const toLogStream = new Transform({ - objectMode: true, - transform: (chunk, encoding, callback) => { - callback(null, this.log(chunk)); - }, - }); - userStream.once('reading', () => { - this.auth.getProjectId().then(projectId => { - this.projectId = projectId; - const reqOpts = extend({}, options, { - parent: 'projects/' + this.projectId, - }); - delete reqOpts.gaxOptions; - const gaxOptions = extend( - { - autoPaginate: options.autoPaginate, - }, - options.gaxOptions - ); - - let gaxStream: ClientReadableStream; - requestStream = streamEvents( - new PassThrough({objectMode: true}) - ); - (requestStream as AbortableDuplex).abort = () => { - if (gaxStream && gaxStream.cancel) { - gaxStream.cancel(); - } - }; - requestStream.once('reading', () => { - try { - gaxStream = this.loggingService.listLogsStream(reqOpts, gaxOptions); - } catch (error) { - requestStream.destroy(error as Error); - return; - } - gaxStream - .on('error', err => { - requestStream.destroy(err); - }) - .pipe(requestStream); - return; - }); - // eslint-disable-next-line @typescript-eslint/no-explicit-any - (userStream as any).setPipeline(requestStream, toLogStream); - }); - }); - return userStream; - } - - /** - * Query object for listing sinks. - * - * @typedef {object} GetSinksRequest - * @property {boolean} [autoPaginate=true] Have pagination handled - * automatically. - * @property {object} [gaxOptions] Request configuration options, outlined - * here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions. - * @property {number} [maxApiCalls] Maximum number of API calls to make. - * @property {number} [maxResults] Maximum number of items plus prefixes to - * return. - * @property {number} [pageSize] Maximum number of logs to return. - * @property {string} [pageToken] A previously-returned page token - * representing part of the larger set of results to view. - */ - /** - * @typedef {array} GetSinksResponse - * @property {Sink[]} 0 Array of {@link Sink} instances. - * @property {object} 1 The full API response. - */ - /** - * @callback GetSinksCallback - * @param {?Error} err Request error, if any. - * @param {Sink[]} sinks Array of {@link Sink} instances. - * @param {object} apiResponse The full API response. - */ - /** - * Get the sinks associated with this project. - * - * See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/list|projects.sinks.list API Documentation} - * - * @param {GetSinksRequest} [query] Query object for listing sinks. - * @param {GetSinksCallback} [callback] Callback function. - * @returns {Promise} - * - * @example - * ``` - * const {Logging} = require('@google-cloud/logging'); - * const logging = new Logging(); - * - * logging.getSinks((err, sinks) => { - * // sinks is an array of Sink objects. - * }); - * - * //- - * // If the callback is omitted, we'll return a Promise. - * //- - * logging.getSinks().then(data => { - * const sinks = data[0]; - * }); - * - * ``` - * @example include:samples/sinks.js - * region_tag:logging_list_sinks - * Another example: - */ - getSinks(options?: GetSinksRequest): Promise; - getSinks(callback: GetSinksCallback): void; - getSinks(options: GetSinksRequest, callback: GetSinksCallback): void; - async getSinks( - opts?: GetSinksRequest | GetSinksCallback - ): Promise { - const options = opts ? (opts as GetSinksRequest) : {}; - this.projectId = await this.auth.getProjectId(); - const reqOpts = extend({}, options, { - parent: 'projects/' + this.projectId, - }); - delete reqOpts.autoPaginate; - delete reqOpts.gaxOptions; - const gaxOptions = extend( - { - autoPaginate: options.autoPaginate, - }, - options.gaxOptions - ); - const resp = await this.configService.listSinks(reqOpts, gaxOptions); - const [sinks] = resp; - if (sinks) { - resp[0] = sinks.map((sink: LogSink) => { - const sinkInstance = this.sink(sink.name!); - sinkInstance.metadata = sink; - return sinkInstance; - }); - } - return resp; - } - - /** - * Get the {@link Sink} objects associated with this project as a - * readable object stream. - * - * @method Logging#getSinksStream - * @param {GetSinksRequest} [query] Query object for listing sinks. - * @returns {ReadableStream} A readable stream that emits {@link Sink} - * instances. - * - * @example - * ``` - * const {Logging} = require('@google-cloud/logging'); - * const logging = new Logging(); - * - * logging.getSinksStream() - * .on('error', console.error) - * .on('data', sink => { - * // `sink` is a Sink object. - * }) - * .on('end', function() { - * // All sinks retrieved. - * }); - * - * //- - * // If you anticipate many results, you can end a stream early to prevent - * // unnecessary processing and API requests. - * //- - * logging.getSinksStream() - * .on('data', function(sink) { - * this.end(); - * }); - * ``` - */ - getSinksStream(options: GetSinksRequest) { - // eslint-disable-next-line @typescript-eslint/no-this-alias - const self = this; - options = options || {}; - let requestStream: Duplex; - const userStream = streamEvents(pumpify.obj()); - (userStream as AbortableDuplex).abort = () => { - if (requestStream) { - (requestStream as AbortableDuplex).abort(); - } - }; - const toSinkStream = new Transform({ - objectMode: true, - transform: (chunk, encoding, callback) => { - const sinkInstance = self.sink(chunk.name); - sinkInstance.metadata = chunk; - callback(null, sinkInstance); - }, - }); - userStream.once('reading', () => { - this.auth.getProjectId().then(projectId => { - this.projectId = projectId; - const reqOpts = extend({}, options, { - parent: 'projects/' + self.projectId, - }); - delete reqOpts.gaxOptions; - const gaxOptions = extend( - { - autoPaginate: options.autoPaginate, - }, - options.gaxOptions - ); - - let gaxStream: ClientReadableStream; - requestStream = streamEvents( - new PassThrough({objectMode: true}) - ); - (requestStream as AbortableDuplex).abort = () => { - if (gaxStream && gaxStream.cancel) { - gaxStream.cancel(); - } - }; - // eslint-disable-next-line @typescript-eslint/no-explicit-any - if (!(global as any).GCLOUD_SANDBOX_ENV) { - requestStream.once('reading', () => { - try { - gaxStream = this.configService.listSinksStream( - reqOpts, - gaxOptions - ); - } catch (error) { - requestStream.destroy(error as Error); - return; - } - gaxStream - .on('error', err => { - requestStream.destroy(err); - }) - .pipe(requestStream); - return; - }); - } - // eslint-disable-next-line @typescript-eslint/no-explicit-any - (userStream as any).setPipeline(requestStream, toSinkStream); - }); - }); - return userStream; - } - - /** - * Get a reference to a Cloud Logging log. - * - * See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs|Log Overview} - * - * @param {string} name Name of the existing log. - * @param {object} [options] Configuration object. - * @param {boolean} [options.removeCircular] Replace circular references in - * logged objects with a string value, `[Circular]`. (Default: false) - * @returns {Log} - * - * @example - * ``` - * const {Logging} = require('@google-cloud/logging'); - * const logging = new Logging(); - * const log = logging.log('my-log'); - * ``` - */ - log(name: string, options?: LogOptions) { - return new Log(this, name, options); - } - - /** - * Get a reference to a Cloud Logging logSync. - * - * @param {string} name Name of the existing log. - * @param {object} transport An optional write stream. - * @param {LogSyncOptions} options An optional configuration object. - * @returns {LogSync} - * - * @example - * ``` - * const {Logging} = require('@google-cloud/logging'); - * const logging = new Logging(); - * - * // Optional: enrich logs with additional context - * await logging.setProjectId(); - * await logging.setDetectedResource(); - * - * // Default transport writes to process.stdout - * const log = logging.logSync('my-log'); - * ``` - */ - logSync(name: string, transport?: Writable, options?: LogSyncOptions) { - return new LogSync(this, name, transport, options); - } - - /** - * Get a reference to a Cloud Logging sink. - * - * See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks|Sink Overview} - * - * @param {string} name Name of the existing sink. - * @returns {Sink} - * - * @example - * ``` - * const {Logging} = require('@google-cloud/logging'); - * const logging = new Logging(); - * const sink = logging.sink('my-sink'); - * ``` - */ - sink(name: string) { - return new Sink(this, name); - } - - /** - * Funnel all API requests through this method, to be sure we have a project - * ID. - * - * @param {object} config Configuration object. - * @param {object} config.gaxOpts GAX options. - * @param {function} config.method The gax method to call. - * @param {object} config.reqOpts Request options. - * @param {function} [callback] Callback function. - */ - // eslint-disable-next-line @typescript-eslint/no-explicit-any - request( - config: RequestConfig, - callback?: RequestCallback - ) { - // eslint-disable-next-line @typescript-eslint/no-this-alias - const self = this; - const isStreamMode = !callback; - let gaxStream: ClientReadableStream; - let stream: Duplex; - if (isStreamMode) { - stream = streamEvents(new PassThrough({objectMode: true})); - (stream as AbortableDuplex).abort = () => { - if (gaxStream && gaxStream.cancel) { - gaxStream.cancel(); - } - }; - stream.once('reading', makeRequestStream); - } else { - makeRequestCallback(); - } - function prepareGaxRequest(callback: GaxRequestCallback): void { - self.auth.getProjectId((err, projectId) => { - if (err) { - callback(err); - return; - } - self.projectId = projectId!; - let gaxClient = self.api[config.client]; - if (!gaxClient) { - // Lazily instantiate client. - gaxClient = new v2[config.client](self.options); - self.api[config.client] = gaxClient; - } - let reqOpts = extend(true, {}, config.reqOpts); - reqOpts = replaceProjectIdToken(reqOpts, projectId!); - const requestFn = gaxClient[config.method].bind( - gaxClient, - reqOpts, - config.gaxOpts - ); - callback(null, requestFn); - }); - } - function makeRequestCallback() { - // eslint-disable-next-line @typescript-eslint/no-explicit-any - if ((global as any).GCLOUD_SANDBOX_ENV) { - return; - } - prepareGaxRequest((err, requestFn) => { - if (err) { - callback!(err); - return; - } - requestFn!(callback); - }); - } - function makeRequestStream() { - // eslint-disable-next-line @typescript-eslint/no-explicit-any - if ((global as any).GCLOUD_SANDBOX_ENV) { - return new PassThrough({objectMode: true}); - } - prepareGaxRequest((err, requestFn) => { - if (err) { - stream.destroy(err); - return; - } - gaxStream = requestFn!(); - gaxStream - .on('error', err => { - stream.destroy(err); - }) - .pipe(stream); - }); - return; - } - return stream!; - } - - /** - * This method is called when creating a sink with a Bucket destination. The - * bucket must first grant proper ACL access to the Cloud Logging - * account. - * - * The parameters are the same as what {@link Logging#createSink} accepts. - * - * @private - */ - async setAclForBucket_(config: CreateSinkRequest) { - const bucket = config.destination as Bucket; - // eslint-disable-next-line @typescript-eslint/no-explicit-any - await (bucket.acl.owners as any).addGroup('cloud-logs@google.com'); - config.destination = 'storage.googleapis.com/' + bucket.name; - } - - /** - * This method is called when creating a sink with a Dataset destination. The - * dataset must first grant proper ACL access to the Cloud Logging - * account. - * - * The parameters are the same as what {@link Logging#createSink} accepts. - * - * @private - */ - async setAclForDataset_(config: CreateSinkRequest) { - const dataset = config.destination as Dataset; - const [metadata] = await dataset.getMetadata(); - // eslint-disable-next-line @typescript-eslint/no-explicit-any - const access = ([] as any[]).slice.call(arrify(metadata.access)); - access.push({ - role: 'WRITER', - groupByEmail: 'cloud-logs@google.com', - }); - await dataset.setMetadata({ - access, - }); - const baseUrl = 'bigquery.googleapis.com'; - const pId = (dataset.parent as BigQuery).projectId; - const dId = dataset.id; - config.destination = `${baseUrl}/projects/${pId}/datasets/${dId}`; - } - - /** - * This method is called when creating a sink with a Topic destination. The - * topic must first grant proper ACL access to the Cloud Logging - * account. - * - * The parameters are the same as what {@link Logging#createSink} accepts. - * - * @private - */ - async setAclForTopic_(config: CreateSinkRequest) { - const topic = config.destination as Topic; - const [policy] = await topic.iam.getPolicy(); - policy.bindings = arrify(policy.bindings!); - policy!.bindings.push({ - role: 'roles/pubsub.publisher', - members: ['serviceAccount:cloud-logs@system.gserviceaccount.com'], - }); - await topic.iam.setPolicy(policy); - const baseUrl = 'pubsub.googleapis.com'; - const topicName = topic.name; - config.destination = `${baseUrl}/${topicName}`; - } - - /** - * setProjectId detects and sets a projectId string on the Logging instance. - * It can be invoked once to ensure ensuing LogSync entries have a projectID. - * @param reqOpts - */ - // eslint-disable-next-line @typescript-eslint/no-unused-vars - async setProjectId(reqOpts?: {}) { - if (this.projectId === '{{projectId}}') - this.projectId = await this.auth.getProjectId(); - if (reqOpts) reqOpts = replaceProjectIdToken(reqOpts, this.projectId); - } - - /** - * setResource detects and sets a detectedresource object on the Logging - * instance. It can be invoked once to ensure ensuing LogSync entries contain - * resource context. - */ - async setDetectedResource() { - if (!this.detectedResource) { - this.detectedResource = await getDefaultResource( - this.auth as unknown as GoogleAuth - ); - } - } -} - -/*! Developer Documentation - * All async methods (except for streams) will execute a callback in the event - * that a callback is provided. - */ -callbackifyAll(Logging, { - exclude: ['request'], -}); - -/*! Developer Documentation - * - * These methods can be auto-paginated. - */ -paginator.extend(Logging, ['getEntries', 'getLogs', 'getSinks']); - -/** - * {@link Entry} class. - * - * @name Logging.Entry - * @see Entry - * @type {Constructor} - */ -export {Entry}; - -/** - * {@link Log} class. - * - * @name Logging.Log - * @see Log - * @type {Constructor} - */ -export {Log}; - -/** - * {@link Severity} enum. - */ -export {Severity}; -export {SeverityNames}; - -export {assignSeverityToEntries}; -export {formatLogName}; - -/** - * {@link MonitoredResource} class. - * - * @name Logging.MonitoredResource - * @see MonitoredResource - * @type {Interface} - */ -export {MonitoredResource}; - -/** - * {@link LogSync} class. - * - * @name Logging.LogSync - * @see LogSync - * @type {Constructor} - */ -export {LogSync}; - -/** - * {@link Sink} class. - * - * @name Logging.Sink - * @see Sink - * @type {Constructor} - */ -export {Sink}; - -/** - * The default export of the `@google-cloud/logging` package is the - * {@link Logging} class. - * - * See {@link Logging} and {@link ClientConfig} for client methods and - * configuration options. - * - * @module {Constructor} @google-cloud/logging - * @alias nodejs-logging - * - * @example Install the client library with npm: - * ``` - * npm install --save @google-cloud/logging - * - * ``` - * @example Import the client library - * ``` - * const {Logging} = require('@google-cloud/logging'); - * - * ``` - * @example Create a client that uses Application Default Credentials (ADC): - * ``` - * const logging = new Logging(); - * - * ``` - * @example Create a client with explicit credentials: - * ``` - * const logging = new Logging({ projectId: 'your-project-id', keyFilename: '/path/to/keyfile.json'}); - * - * ``` - * @example include:samples/quickstart.js - * region_tag:logging_quickstart - * Full quickstart example: - */ -export {Logging}; - -/** - * Reference to the low-level auto-generated clients for the V2 Logging service. - * - * @type {object} - * @property {constructor} LoggingServiceV2Client - * Reference to {@link v2.LoggingServiceV2Client} - * @property {constructor} ConfigServiceV2Client - * Reference to {@link v2.ConfigServiceV2Client} - * @property {constructor} MetricsServiceV2Client - * Reference to {@link v2.MetricsServiceV2Client} - */ -module.exports.v2 = v2; +import * as utils from './utils'; +import * as v2 from './v2'; + +const ConfigServiceV2Client = v2.ConfigServiceV2Client; +type ConfigServiceV2Client = v2.ConfigServiceV2Client; +const LoggingServiceV2Client = v2.LoggingServiceV2Client; +type LoggingServiceV2Client = v2.LoggingServiceV2Client; +const MetricsServiceV2Client = v2.MetricsServiceV2Client; +type MetricsServiceV2Client = v2.MetricsServiceV2Client; + +export { + middleware, + utils, + v2, + ConfigServiceV2Client, + LoggingServiceV2Client, + MetricsServiceV2Client, +}; +export default { + middleware, + utils, + v2, + ConfigServiceV2Client, + LoggingServiceV2Client, + MetricsServiceV2Client, +}; import * as protos from '../protos/protos'; export {protos}; -export {v2}; -export * from '@opentelemetry/api';