@google-cloud/logging 4.2.0 » Globals

Globals

Property

v2

object

Reference to the low-level auto-generated clients for the V2 Logging service.

Properties

Parameter
LoggingServiceV2Client	constructor Reference to v2.LoggingServiceV2Client
ConfigServiceV2Client	constructor Reference to v2.ConfigServiceV2Client
MetricsServiceV2Client	constructor Reference to v2.MetricsServiceV2Client

Methods

getCloudFunctionDescriptor

getCloudFunctionDescriptor() returns object

Create a descriptor for Cloud Functions.

Returns

object 

getDefaultResource

getDefaultResource()

Attempt to contact the metadata service and determine, based on request success and environment variables, what type of resource the library is operating on.

getGAEDescriptor

getGAEDescriptor() returns object

Create a descriptor for Google App Engine.

Returns

object 

getGCEDescriptor

getGCEDescriptor() returns object

Create a descriptor for Google Compute Engine.

Returns

object 

getGKEDescriptor

getGKEDescriptor() returns object

Create a descriptor for Google Container Engine.

Returns

object 

getGlobalDescriptor

getGlobalDescriptor() returns object

Create a global descriptor.

Returns

object 

makeMiddleware

makeMiddleware(projectId, makeChildLogger, emitRequestLog)

Generates an express middleware that installs a request-specific logger on the request object. It optionally can do HttpRequest timing that can be used for generating request logs. This can be used to integrate with logging libraries such as winston and bunyan.

Parameter
projectId	Generated traceIds will be associated with this project.
makeChildLogger	A function that generates logger instances that will be installed onto req as req.log. The logger should include the trace in each log entry's metadata (associated with the LOGGING_TRACE_KEY property.
emitRequestLog	Optional. A function that will emit a parent request log. While some environments like GAE and GCF emit parent request logs automatically, other environments do not. When provided this function will be called with a populated StackdriverHttpRequest which can be emitted as request log.

Abstract types

ClientConfig

object

Properties

Parameter
projectId	Optional string 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 Application Default Credentials, your project ID will be detected automatically.
keyFilename	Optional string 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.
email	Optional string Account email address. Required when using a .pem or .p12 keyFilename.
credentials	Optional object Credentials object. Values in credentials have the following properties: Parameter client_email Optional string private_key Optional string
autoRetry	Optional boolean Automatically retry requests if the response is related to rate limits or certain intermittent server errors. We will exponentially backoff subsequent requests by default.
maxRetries	Optional number Maximum number of automatic retries attempted before returning the error.
promise	Optional Constructor Custom promise module to use instead of native Promises.

CreateSinkCallback

CreateSinkCallback(err, sink, apiResponse)

Parameter
err	Error Request error, if any. Value may be null.
sink	Sink The new Sink.
apiResponse	object The full API response.

CreateSinkRequest

object

Config to set for the sink. Not all available options are listed here, see the Sink resource definition for full details.

Properties

Parameter
gaxOptions	Optional object Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions.
destination	Optional (Bucket, Dataset, or Topic) The destination. The proper ACL scopes will be granted to the provided destination. Can be one of: Bucket, Dataset, or Topic
filter	Optional string An advanced logs filter. Only log entries matching the filter are written.

CreateSinkResponse

array

Properties

Parameter
0	Sink The new Sink.
1	object The full API response.

DeleteSinkCallback

DeleteSinkCallback(err, apiResponse)

Parameter
err	Error Request error, if any. Value may be null.
apiResponse	object The full API response.

DeleteSinkResponse

array

Property

Parameter
0	object The full API response.

GetEntriesCallback

GetEntriesCallback(err, entries, apiResponse)

Parameter
err	Error Request error, if any. Value may be null.
entries	Array of Entry Array of Entry instances.
apiResponse	object The full API response.

GetEntriesRequest

object

Query object for listing entries.

Properties

Parameter
autoPaginate	Optional boolean Have pagination handled automatically.
filter	Optional string An advanced logs filter. An empty filter matches all log entries.
gaxOptions	Optional object Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions.
maxApiCalls	Optional number Maximum number of API calls to make.
maxResults	Optional number Maximum number of items plus prefixes to return.
orderBy	Optional string How the results should be sorted, timestamp (oldest first) and timestamp desc (newest first, default).
pageSize	Optional number Maximum number of logs to return.
pageToken	Optional string A previously-returned page token representing part of the larger set of results to view.

GetEntriesResponse

array

Properties

Parameter
0	Array of Entry Array of Entry instances.
1	object The full API response.

GetSinksCallback

GetSinksCallback(err, sinks, apiResponse)

Parameter
err	Error Request error, if any. Value may be null.
sinks	Array of Sink Array of Sink instances.
apiResponse	object The full API response.

GetSinksRequest

object

Query object for listing sinks.

Properties

Parameter
autoPaginate	Optional boolean Have pagination handled automatically.
gaxOptions	Optional object Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions.
maxApiCalls	Optional number Maximum number of API calls to make.
maxResults	Optional number Maximum number of items plus prefixes to return.
pageSize	Optional number Maximum number of logs to return.
pageToken	Optional string A previously-returned page token representing part of the larger set of results to view.

GetSinksResponse

array

Properties

Parameter
0	Array of Sink Array of Sink instances.
1	object The full API response.

SetSinkFilterCallback

SetSinkFilterCallback(err, apiResponse)

Parameter
err	Error Request error, if any. Value may be null.
apiResponse	object The full API response.

SetSinkFilterResponse

array

Property

Parameter
0	object The full API response.

SetSinkMetadataCallback

SetSinkMetadataCallback(err, apiResponse)

Parameter
err	Error Request error, if any. Value may be null.
apiResponse	object The full API response.

SetSinkMetadataResponse

array

Property

Parameter
0	object The full API response.