Global

Default library version to be used Using release-please annotations to update DEFAULT_INSTRUMENTATION_VERSION with latest version. See https://github.com/googleapis/release-please/blob/main/docs/customizing.md#updating-arbitrary-files

Header that carries span context across W3C compliant infrastructure.

Header that carries span context across Google infrastructure.

Common construct and functions used by both Log and LogSync

Client JSON configuration object, loaded from src/v2/config_service_v2_client_config.json. This file defines retry strategy and timeouts for all API methods in this library.

Client JSON configuration object, loaded from src/v2/logging_service_v2_client_config.json. This file defines retry strategy and timeouts for all API methods in this library.

Client JSON configuration object, loaded from src/v2/metrics_service_v2_client_config.json. This file defines retry strategy and timeouts for all API methods in this library.

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

The helper method to generate a log entry with diagnostic instrumentation data.

Decode a protobuf Struct's value.

For logged errors, users can provide a service context. This enables errors to be picked up Cloud Error Reporting. For more information see this guide and the official documentation.

Format the name of a log. A log's full name is in the format of 'projects/{projectId}/logs/{logName}'.

Create a descriptor for Cloud Functions.

Create a descriptor for Cloud Run.

getContextFromOtelContext looks for the active open telemetry span context per Open Telemetry specifications for tracing contexts.

getOrInjectTraceParent looks for the HTTP header 'traceparent' per W3C specifications for OpenTelemetry and OpenCensus Read more about W3C protocol: https://www.w3.org/TR/trace-context/

getContextFromXCloudTrace looks for the HTTP header 'x-cloud-trace-context' per Google Cloud specifications for Cloud Tracing.

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

Create a descriptor for Google App Engine.

Create a descriptor for Google Compute Engine.

Create a descriptor for Google Container Engine.

Create a global descriptor.

The helper function to retrieve current library version from annotated NODEJS_DEFAULT_LIBRARY_VERSION

getOrInjectContext returns a CloudTraceContext with as many available trace and span properties as possible. It examines HTTP headers for trace context. Optionally, it can inject a Google compliant trace context when no context is available from headers.

isRawHttpRequest detects whether a request object extends the http.IncomingMessage class. It should return true on HTTP compliant requests and all requests created by an http.Server.

The helper function which checks if given InstrumentationInfo is valid.

makeCloudTraceHeader generates valid X-Cloud-Trace-Context trace and spanId.

makeHeaderWrapper returns a wrapper with set and get header functionality, returning null if the incoming request object doesn't contain the 'header' propery.

makeHttpRequestData turns raw incoming HTTPRequests into structured HTTPRequest objects interpreted by Cloud Logging.

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.

parseTraceParentHeader is a custom implementation of the parseTraceParent function in @opentelemetry-core/trace. For more information see https://www.w3.org/TR/trace-context/

parseXCloudTraceHeader looks for trace context in X-Cloud-Trace-Context header

This method helps to populate entries with instrumentation data

The helper method used to set a status of a flag which indicates if instrumentation info already written or not.

snakecaseKeys turns label keys from camel case to snake case.

toCloudTraceContext converts any context format to cloudTraceContext format.

Converts Date to nanoseconds format suported by Logging. See https://cloud.google.com/logging/docs/agent/logging/configuration#timestamp-processing for more details

A helper function to truncate a value (library name or version for example). The value is truncated when it is longer than {maxLen} chars and '*' is added instead of truncated suffix.

This method validates that provided instrumentation info list is valid and also adds current library info to a list.

zuluToDateObj RFC3339 "Zulu" timestamp into a format that can be parsed to a JS Date Object.

Query object for streaming entries.