Package @google-cloud/logging (11.0.0)

Classes

Entry

Create an entry object to define new data to insert into a meta.

Note, Cloud Logging Quotas and limits dictates that the maximum log entry size, including all LogEntry Resource properties, cannot exceed approximately 256 KB.

See LogEntry JSON representation

Log

A log is a named collection of entries, each entry representing a timestamped event. Logs can be produced by Google Cloud Platform services, by third-party services, or by your applications. For example, the log apache-access is produced by the Apache Web Server, but the log compute.googleapis.com/activity_log is produced by Google Compute Engine.

See Introduction to Logs

Logging

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).

See What is Cloud Logging?

See Introduction to the Cloud Logging API

See Logging to Google Cloud from Bunyan

See Logging to Google Cloud from Winston

LogSync

A logSync is a named collection of entries in structured log format. In Cloud Logging, structured logs refer to log entries that use the jsonPayload field to add structure to their payloads. In most GCP environments, like GKE and Cloud Functions, structured logs written to process.stdout are automatically picked up and formatted by logging agents.

Recommended for Serverless environment logging, especially where async log calls made by the Log class can be dropped by the CPU.

See Structured Logging

protos.google.api.ClientLibrarySettings

Represents a ClientLibrarySettings.

protos.google.api.CommonLanguageSettings

Represents a CommonLanguageSettings.

protos.google.api.CppSettings

Represents a CppSettings.

protos.google.api.CustomHttpPattern

Represents a CustomHttpPattern.

protos.google.api.Distribution

Represents a Distribution.

protos.google.api.Distribution.BucketOptions

Represents a BucketOptions.

protos.google.api.Distribution.BucketOptions.Explicit

Represents an Explicit.

protos.google.api.Distribution.BucketOptions.Exponential

Represents an Exponential.

protos.google.api.Distribution.BucketOptions.Linear

Represents a Linear.

protos.google.api.Distribution.Exemplar

Represents an Exemplar.

protos.google.api.Distribution.Range

Represents a Range.

protos.google.api.DotnetSettings

Represents a DotnetSettings.

protos.google.api.GoSettings

Represents a GoSettings.

protos.google.api.Http

Represents a Http.

protos.google.api.HttpRule

Represents a HttpRule.

protos.google.api.JavaSettings

Represents a JavaSettings.

protos.google.api.LabelDescriptor

Represents a LabelDescriptor.

protos.google.api.MethodSettings

Represents a MethodSettings.

protos.google.api.MethodSettings.LongRunning

Represents a LongRunning.

protos.google.api.Metric

Represents a Metric.

protos.google.api.MetricDescriptor

Represents a MetricDescriptor.

protos.google.api.MetricDescriptor.MetricDescriptorMetadata

Represents a MetricDescriptorMetadata.

protos.google.api.MonitoredResource

Represents a MonitoredResource.

protos.google.api.MonitoredResourceDescriptor

Represents a MonitoredResourceDescriptor.

protos.google.api.MonitoredResourceMetadata

Represents a MonitoredResourceMetadata.

protos.google.api.NodeSettings

Represents a NodeSettings.

protos.google.api.PhpSettings

Represents a PhpSettings.

protos.google.api.Publishing

Represents a Publishing.

protos.google.api.PythonSettings

Represents a PythonSettings.

protos.google.api.ResourceDescriptor

Represents a ResourceDescriptor.

protos.google.api.ResourceReference

Represents a ResourceReference.

protos.google.api.RubySettings

Represents a RubySettings.

protos.google.logging.type.HttpRequest

Represents a HttpRequest.

protos.google.logging.v2.BigQueryDataset

Represents a BigQueryDataset.

protos.google.logging.v2.BigQueryOptions

Represents a BigQueryOptions.

protos.google.logging.v2.BucketMetadata

Represents a BucketMetadata.

protos.google.logging.v2.CmekSettings

Represents a CmekSettings.

protos.google.logging.v2.ConfigServiceV2

Represents a ConfigServiceV2

protos.google.logging.v2.CopyLogEntriesMetadata

Represents a CopyLogEntriesMetadata.

protos.google.logging.v2.CopyLogEntriesRequest

Represents a CopyLogEntriesRequest.

protos.google.logging.v2.CopyLogEntriesResponse

Represents a CopyLogEntriesResponse.

protos.google.logging.v2.CreateBucketRequest

Represents a CreateBucketRequest.

protos.google.logging.v2.CreateExclusionRequest

Represents a CreateExclusionRequest.

protos.google.logging.v2.CreateLinkRequest

Represents a CreateLinkRequest.

protos.google.logging.v2.CreateLogMetricRequest

Represents a CreateLogMetricRequest.

protos.google.logging.v2.CreateSinkRequest

Represents a CreateSinkRequest.

protos.google.logging.v2.CreateViewRequest

Represents a CreateViewRequest.

protos.google.logging.v2.DeleteBucketRequest

Represents a DeleteBucketRequest.

protos.google.logging.v2.DeleteExclusionRequest

Represents a DeleteExclusionRequest.

protos.google.logging.v2.DeleteLinkRequest

Represents a DeleteLinkRequest.

protos.google.logging.v2.DeleteLogMetricRequest

Represents a DeleteLogMetricRequest.

protos.google.logging.v2.DeleteLogRequest

Represents a DeleteLogRequest.

protos.google.logging.v2.DeleteSinkRequest

Represents a DeleteSinkRequest.

protos.google.logging.v2.DeleteViewRequest

Represents a DeleteViewRequest.

protos.google.logging.v2.GetBucketRequest

Represents a GetBucketRequest.

protos.google.logging.v2.GetCmekSettingsRequest

Represents a GetCmekSettingsRequest.

protos.google.logging.v2.GetExclusionRequest

Represents a GetExclusionRequest.

protos.google.logging.v2.GetLinkRequest

Represents a GetLinkRequest.

protos.google.logging.v2.GetLogMetricRequest

Represents a GetLogMetricRequest.

protos.google.logging.v2.GetSettingsRequest

Represents a GetSettingsRequest.

protos.google.logging.v2.GetSinkRequest

Represents a GetSinkRequest.

protos.google.logging.v2.GetViewRequest

Represents a GetViewRequest.

protos.google.logging.v2.IndexConfig

Represents an IndexConfig.

Represents a Link.

protos.google.logging.v2.LinkMetadata

Represents a LinkMetadata.

protos.google.logging.v2.ListBucketsRequest

Represents a ListBucketsRequest.

protos.google.logging.v2.ListBucketsResponse

Represents a ListBucketsResponse.

protos.google.logging.v2.ListExclusionsRequest

Represents a ListExclusionsRequest.

protos.google.logging.v2.ListExclusionsResponse

Represents a ListExclusionsResponse.

protos.google.logging.v2.ListLinksRequest

Represents a ListLinksRequest.

protos.google.logging.v2.ListLinksResponse

Represents a ListLinksResponse.

protos.google.logging.v2.ListLogEntriesRequest

Represents a ListLogEntriesRequest.

protos.google.logging.v2.ListLogEntriesResponse

Represents a ListLogEntriesResponse.

protos.google.logging.v2.ListLogMetricsRequest

Represents a ListLogMetricsRequest.

protos.google.logging.v2.ListLogMetricsResponse

Represents a ListLogMetricsResponse.

protos.google.logging.v2.ListLogsRequest

Represents a ListLogsRequest.

protos.google.logging.v2.ListLogsResponse

Represents a ListLogsResponse.

protos.google.logging.v2.ListMonitoredResourceDescriptorsRequest

Represents a ListMonitoredResourceDescriptorsRequest.

protos.google.logging.v2.ListMonitoredResourceDescriptorsResponse

Represents a ListMonitoredResourceDescriptorsResponse.

protos.google.logging.v2.ListSinksRequest

Represents a ListSinksRequest.

protos.google.logging.v2.ListSinksResponse

Represents a ListSinksResponse.

protos.google.logging.v2.ListViewsRequest

Represents a ListViewsRequest.

protos.google.logging.v2.ListViewsResponse

Represents a ListViewsResponse.

protos.google.logging.v2.LocationMetadata

Represents a LocationMetadata.

protos.google.logging.v2.LogBucket

Represents a LogBucket.

protos.google.logging.v2.LogEntry

Represents a LogEntry.

protos.google.logging.v2.LogEntryOperation

Represents a LogEntryOperation.

protos.google.logging.v2.LogEntrySourceLocation

Represents a LogEntrySourceLocation.

protos.google.logging.v2.LogExclusion

Represents a LogExclusion.

protos.google.logging.v2.LoggingServiceV2

Represents a LoggingServiceV2

protos.google.logging.v2.LogMetric

Represents a LogMetric.

protos.google.logging.v2.LogSink

Represents a LogSink.

protos.google.logging.v2.LogSplit

Represents a LogSplit.

protos.google.logging.v2.LogView

Represents a LogView.

protos.google.logging.v2.MetricsServiceV2

Represents a MetricsServiceV2

protos.google.logging.v2.Settings

Represents a Settings.

protos.google.logging.v2.TailLogEntriesRequest

Represents a TailLogEntriesRequest.

protos.google.logging.v2.TailLogEntriesResponse

Represents a TailLogEntriesResponse.

protos.google.logging.v2.TailLogEntriesResponse.SuppressionInfo

Represents a SuppressionInfo.

protos.google.logging.v2.UndeleteBucketRequest

Represents an UndeleteBucketRequest.

protos.google.logging.v2.UpdateBucketRequest

Represents an UpdateBucketRequest.

protos.google.logging.v2.UpdateCmekSettingsRequest

Represents an UpdateCmekSettingsRequest.

protos.google.logging.v2.UpdateExclusionRequest

Represents an UpdateExclusionRequest.

protos.google.logging.v2.UpdateLogMetricRequest

Represents an UpdateLogMetricRequest.

protos.google.logging.v2.UpdateSettingsRequest

Represents an UpdateSettingsRequest.

protos.google.logging.v2.UpdateSinkRequest

Represents an UpdateSinkRequest.

protos.google.logging.v2.UpdateViewRequest

Represents an UpdateViewRequest.

protos.google.logging.v2.WriteLogEntriesPartialErrors

Represents a WriteLogEntriesPartialErrors.

protos.google.logging.v2.WriteLogEntriesRequest

Represents a WriteLogEntriesRequest.

protos.google.logging.v2.WriteLogEntriesResponse

Represents a WriteLogEntriesResponse.

protos.google.longrunning.CancelOperationRequest

Represents a CancelOperationRequest.

protos.google.longrunning.DeleteOperationRequest

Represents a DeleteOperationRequest.

protos.google.longrunning.GetOperationRequest

Represents a GetOperationRequest.

protos.google.longrunning.ListOperationsRequest

Represents a ListOperationsRequest.

protos.google.longrunning.ListOperationsResponse

Represents a ListOperationsResponse.

protos.google.longrunning.Operation

Represents an Operation.

protos.google.longrunning.OperationInfo

Represents an OperationInfo.

protos.google.longrunning.Operations

Represents an Operations

protos.google.longrunning.WaitOperationRequest

Represents a WaitOperationRequest.

protos.google.protobuf.Any

Represents an Any.

protos.google.protobuf.DescriptorProto

Represents a DescriptorProto.

protos.google.protobuf.DescriptorProto.ExtensionRange

Represents an ExtensionRange.

protos.google.protobuf.DescriptorProto.ReservedRange

Represents a ReservedRange.

protos.google.protobuf.Duration

Represents a Duration.

protos.google.protobuf.Empty

Represents an Empty.

protos.google.protobuf.EnumDescriptorProto

Represents an EnumDescriptorProto.

protos.google.protobuf.EnumDescriptorProto.EnumReservedRange

Represents an EnumReservedRange.

protos.google.protobuf.EnumOptions

Represents an EnumOptions.

protos.google.protobuf.EnumValueDescriptorProto

Represents an EnumValueDescriptorProto.

protos.google.protobuf.EnumValueOptions

Represents an EnumValueOptions.

protos.google.protobuf.ExtensionRangeOptions

Represents an ExtensionRangeOptions.

protos.google.protobuf.FieldDescriptorProto

Represents a FieldDescriptorProto.

protos.google.protobuf.FieldMask

Represents a FieldMask.

protos.google.protobuf.FieldOptions

Represents a FieldOptions.

protos.google.protobuf.FileDescriptorProto

Represents a FileDescriptorProto.

protos.google.protobuf.FileDescriptorSet

Represents a FileDescriptorSet.

protos.google.protobuf.FileOptions

Represents a FileOptions.

protos.google.protobuf.GeneratedCodeInfo

Represents a GeneratedCodeInfo.

protos.google.protobuf.GeneratedCodeInfo.Annotation

Represents an Annotation.

protos.google.protobuf.ListValue

Represents a ListValue.

protos.google.protobuf.MessageOptions

Represents a MessageOptions.

protos.google.protobuf.MethodDescriptorProto

Represents a MethodDescriptorProto.

protos.google.protobuf.MethodOptions

Represents a MethodOptions.

protos.google.protobuf.OneofDescriptorProto

Represents an OneofDescriptorProto.

protos.google.protobuf.OneofOptions

Represents an OneofOptions.

protos.google.protobuf.ServiceDescriptorProto

Represents a ServiceDescriptorProto.

protos.google.protobuf.ServiceOptions

Represents a ServiceOptions.

protos.google.protobuf.SourceCodeInfo

Represents a SourceCodeInfo.

protos.google.protobuf.SourceCodeInfo.Location

Represents a Location.

protos.google.protobuf.Struct

Represents a Struct.

protos.google.protobuf.Timestamp

Represents a Timestamp.

protos.google.protobuf.UninterpretedOption

Represents an UninterpretedOption.

protos.google.protobuf.UninterpretedOption.NamePart

Represents a NamePart.

protos.google.protobuf.Value

Represents a Value.

protos.google.rpc.Status

Represents a Status.

Sink

A sink is an object that lets you to specify a set of log entries to export to a particular destination. Cloud Logging lets you export log entries to destinations including Cloud Storage buckets (for long term log storage), Google BigQuery datasets (for log analysis), Google Pub/Sub (for streaming to other applications).

See Introduction to Sinks

Interfaces

AbortableDuplex

CreateSinkCallback

CreateSinkRequest

DeleteCallback

GetEntriesCallback

GetLogsCallback

GetLogsRequest

GetSinksCallback

GetSinksRequest

HttpRequest

LoggingOptions

protos.google.api.Distribution.BucketOptions.IExplicit

Properties of an Explicit.

protos.google.api.Distribution.BucketOptions.IExponential

Properties of an Exponential.

protos.google.api.Distribution.BucketOptions.ILinear

Properties of a Linear.

protos.google.api.Distribution.IBucketOptions

Properties of a BucketOptions.

protos.google.api.Distribution.IExemplar

Properties of an Exemplar.

protos.google.api.Distribution.IRange

Properties of a Range.

protos.google.api.IClientLibrarySettings

Properties of a ClientLibrarySettings.

protos.google.api.ICommonLanguageSettings

Properties of a CommonLanguageSettings.

protos.google.api.ICppSettings

Properties of a CppSettings.

protos.google.api.ICustomHttpPattern

Properties of a CustomHttpPattern.

protos.google.api.IDistribution

Properties of a Distribution.

protos.google.api.IDotnetSettings

Properties of a DotnetSettings.

protos.google.api.IGoSettings

Properties of a GoSettings.

protos.google.api.IHttp

Properties of a Http.

protos.google.api.IHttpRule

Properties of a HttpRule.

protos.google.api.IJavaSettings

Properties of a JavaSettings.

protos.google.api.ILabelDescriptor

Properties of a LabelDescriptor.

protos.google.api.IMethodSettings

Properties of a MethodSettings.

protos.google.api.IMetric

Properties of a Metric.

protos.google.api.IMetricDescriptor

Properties of a MetricDescriptor.

protos.google.api.IMonitoredResource

Properties of a MonitoredResource.

protos.google.api.IMonitoredResourceDescriptor

Properties of a MonitoredResourceDescriptor.

protos.google.api.IMonitoredResourceMetadata

Properties of a MonitoredResourceMetadata.

protos.google.api.INodeSettings

Properties of a NodeSettings.

protos.google.api.IPhpSettings

Properties of a PhpSettings.

protos.google.api.IPublishing

Properties of a Publishing.

protos.google.api.IPythonSettings

Properties of a PythonSettings.

protos.google.api.IResourceDescriptor

Properties of a ResourceDescriptor.

protos.google.api.IResourceReference

Properties of a ResourceReference.

protos.google.api.IRubySettings

Properties of a RubySettings.

protos.google.api.MethodSettings.ILongRunning

Properties of a LongRunning.

protos.google.api.MetricDescriptor.IMetricDescriptorMetadata

Properties of a MetricDescriptorMetadata.

protos.google.logging.type.IHttpRequest

Properties of a HttpRequest.

protos.google.logging.v2.IBigQueryDataset

Properties of a BigQueryDataset.

protos.google.logging.v2.IBigQueryOptions

Properties of a BigQueryOptions.

protos.google.logging.v2.IBucketMetadata

Properties of a BucketMetadata.

protos.google.logging.v2.ICmekSettings

Properties of a CmekSettings.

protos.google.logging.v2.ICopyLogEntriesMetadata

Properties of a CopyLogEntriesMetadata.

protos.google.logging.v2.ICopyLogEntriesRequest

Properties of a CopyLogEntriesRequest.

protos.google.logging.v2.ICopyLogEntriesResponse

Properties of a CopyLogEntriesResponse.

protos.google.logging.v2.ICreateBucketRequest

Properties of a CreateBucketRequest.

protos.google.logging.v2.ICreateExclusionRequest

Properties of a CreateExclusionRequest.

protos.google.logging.v2.ICreateLinkRequest

Properties of a CreateLinkRequest.

protos.google.logging.v2.ICreateLogMetricRequest

Properties of a CreateLogMetricRequest.

protos.google.logging.v2.ICreateSinkRequest

Properties of a CreateSinkRequest.

protos.google.logging.v2.ICreateViewRequest

Properties of a CreateViewRequest.

protos.google.logging.v2.IDeleteBucketRequest

Properties of a DeleteBucketRequest.

protos.google.logging.v2.IDeleteExclusionRequest

Properties of a DeleteExclusionRequest.

protos.google.logging.v2.IDeleteLinkRequest

Properties of a DeleteLinkRequest.

protos.google.logging.v2.IDeleteLogMetricRequest

Properties of a DeleteLogMetricRequest.

protos.google.logging.v2.IDeleteLogRequest

Properties of a DeleteLogRequest.

protos.google.logging.v2.IDeleteSinkRequest

Properties of a DeleteSinkRequest.

protos.google.logging.v2.IDeleteViewRequest

Properties of a DeleteViewRequest.

protos.google.logging.v2.IGetBucketRequest

Properties of a GetBucketRequest.

protos.google.logging.v2.IGetCmekSettingsRequest

Properties of a GetCmekSettingsRequest.

protos.google.logging.v2.IGetExclusionRequest

Properties of a GetExclusionRequest.

protos.google.logging.v2.IGetLinkRequest

Properties of a GetLinkRequest.

protos.google.logging.v2.IGetLogMetricRequest

Properties of a GetLogMetricRequest.

protos.google.logging.v2.IGetSettingsRequest

Properties of a GetSettingsRequest.

protos.google.logging.v2.IGetSinkRequest

Properties of a GetSinkRequest.

protos.google.logging.v2.IGetViewRequest

Properties of a GetViewRequest.

protos.google.logging.v2.IIndexConfig

Properties of an IndexConfig.

Properties of a Link.

protos.google.logging.v2.ILinkMetadata

Properties of a LinkMetadata.

protos.google.logging.v2.IListBucketsRequest

Properties of a ListBucketsRequest.

protos.google.logging.v2.IListBucketsResponse

Properties of a ListBucketsResponse.

protos.google.logging.v2.IListExclusionsRequest

Properties of a ListExclusionsRequest.

protos.google.logging.v2.IListExclusionsResponse

Properties of a ListExclusionsResponse.

protos.google.logging.v2.IListLinksRequest

Properties of a ListLinksRequest.

protos.google.logging.v2.IListLinksResponse

Properties of a ListLinksResponse.

protos.google.logging.v2.IListLogEntriesRequest

Properties of a ListLogEntriesRequest.

protos.google.logging.v2.IListLogEntriesResponse

Properties of a ListLogEntriesResponse.

protos.google.logging.v2.IListLogMetricsRequest

Properties of a ListLogMetricsRequest.

protos.google.logging.v2.IListLogMetricsResponse

Properties of a ListLogMetricsResponse.

protos.google.logging.v2.IListLogsRequest

Properties of a ListLogsRequest.

protos.google.logging.v2.IListLogsResponse

Properties of a ListLogsResponse.

protos.google.logging.v2.IListMonitoredResourceDescriptorsRequest

Properties of a ListMonitoredResourceDescriptorsRequest.

protos.google.logging.v2.IListMonitoredResourceDescriptorsResponse

Properties of a ListMonitoredResourceDescriptorsResponse.

protos.google.logging.v2.IListSinksRequest

Properties of a ListSinksRequest.

protos.google.logging.v2.IListSinksResponse

Properties of a ListSinksResponse.

protos.google.logging.v2.IListViewsRequest

Properties of a ListViewsRequest.

protos.google.logging.v2.IListViewsResponse

Properties of a ListViewsResponse.

protos.google.logging.v2.ILocationMetadata

Properties of a LocationMetadata.

protos.google.logging.v2.ILogBucket

Properties of a LogBucket.

protos.google.logging.v2.ILogEntry

Properties of a LogEntry.

protos.google.logging.v2.ILogEntryOperation

Properties of a LogEntryOperation.

protos.google.logging.v2.ILogEntrySourceLocation

Properties of a LogEntrySourceLocation.

protos.google.logging.v2.ILogExclusion

Properties of a LogExclusion.

protos.google.logging.v2.ILogMetric

Properties of a LogMetric.

protos.google.logging.v2.ILogSink

Properties of a LogSink.

protos.google.logging.v2.ILogSplit

Properties of a LogSplit.

protos.google.logging.v2.ILogView

Properties of a LogView.

protos.google.logging.v2.ISettings

Properties of a Settings.

protos.google.logging.v2.ITailLogEntriesRequest

Properties of a TailLogEntriesRequest.

protos.google.logging.v2.ITailLogEntriesResponse

Properties of a TailLogEntriesResponse.

protos.google.logging.v2.IUndeleteBucketRequest

Properties of an UndeleteBucketRequest.

protos.google.logging.v2.IUpdateBucketRequest

Properties of an UpdateBucketRequest.

protos.google.logging.v2.IUpdateCmekSettingsRequest

Properties of an UpdateCmekSettingsRequest.

protos.google.logging.v2.IUpdateExclusionRequest

Properties of an UpdateExclusionRequest.

protos.google.logging.v2.IUpdateLogMetricRequest

Properties of an UpdateLogMetricRequest.

protos.google.logging.v2.IUpdateSettingsRequest

Properties of an UpdateSettingsRequest.

protos.google.logging.v2.IUpdateSinkRequest

Properties of an UpdateSinkRequest.

protos.google.logging.v2.IUpdateViewRequest

Properties of an UpdateViewRequest.

protos.google.logging.v2.IWriteLogEntriesPartialErrors

Properties of a WriteLogEntriesPartialErrors.

protos.google.logging.v2.IWriteLogEntriesRequest

Properties of a WriteLogEntriesRequest.

protos.google.logging.v2.IWriteLogEntriesResponse

Properties of a WriteLogEntriesResponse.

protos.google.logging.v2.TailLogEntriesResponse.ISuppressionInfo

Properties of a SuppressionInfo.

protos.google.longrunning.ICancelOperationRequest

Properties of a CancelOperationRequest.

protos.google.longrunning.IDeleteOperationRequest

Properties of a DeleteOperationRequest.

protos.google.longrunning.IGetOperationRequest

Properties of a GetOperationRequest.

protos.google.longrunning.IListOperationsRequest

Properties of a ListOperationsRequest.

protos.google.longrunning.IListOperationsResponse

Properties of a ListOperationsResponse.

protos.google.longrunning.IOperation

Properties of an Operation.

protos.google.longrunning.IOperationInfo

Properties of an OperationInfo.

protos.google.longrunning.IWaitOperationRequest

Properties of a WaitOperationRequest.

protos.google.protobuf.DescriptorProto.IExtensionRange

Properties of an ExtensionRange.

protos.google.protobuf.DescriptorProto.IReservedRange

Properties of a ReservedRange.

protos.google.protobuf.EnumDescriptorProto.IEnumReservedRange

Properties of an EnumReservedRange.

protos.google.protobuf.GeneratedCodeInfo.IAnnotation

Properties of an Annotation.

protos.google.protobuf.IAny

Properties of an Any.

protos.google.protobuf.IDescriptorProto

Properties of a DescriptorProto.

protos.google.protobuf.IDuration

Properties of a Duration.

protos.google.protobuf.IEmpty

Properties of an Empty.

protos.google.protobuf.IEnumDescriptorProto

Properties of an EnumDescriptorProto.

protos.google.protobuf.IEnumOptions

Properties of an EnumOptions.

protos.google.protobuf.IEnumValueDescriptorProto

Properties of an EnumValueDescriptorProto.

protos.google.protobuf.IEnumValueOptions

Properties of an EnumValueOptions.

protos.google.protobuf.IExtensionRangeOptions

Properties of an ExtensionRangeOptions.

protos.google.protobuf.IFieldDescriptorProto

Properties of a FieldDescriptorProto.

protos.google.protobuf.IFieldMask

Properties of a FieldMask.

protos.google.protobuf.IFieldOptions

Properties of a FieldOptions.

protos.google.protobuf.IFileDescriptorProto

Properties of a FileDescriptorProto.

protos.google.protobuf.IFileDescriptorSet

Properties of a FileDescriptorSet.

protos.google.protobuf.IFileOptions

Properties of a FileOptions.

protos.google.protobuf.IGeneratedCodeInfo

Properties of a GeneratedCodeInfo.

protos.google.protobuf.IListValue

Properties of a ListValue.

protos.google.protobuf.IMessageOptions

Properties of a MessageOptions.

protos.google.protobuf.IMethodDescriptorProto

Properties of a MethodDescriptorProto.

protos.google.protobuf.IMethodOptions

Properties of a MethodOptions.

protos.google.protobuf.IOneofDescriptorProto

Properties of an OneofDescriptorProto.

protos.google.protobuf.IOneofOptions

Properties of an OneofOptions.

protos.google.protobuf.IServiceDescriptorProto

Properties of a ServiceDescriptorProto.

protos.google.protobuf.IServiceOptions

Properties of a ServiceOptions.

protos.google.protobuf.ISourceCodeInfo

Properties of a SourceCodeInfo.

protos.google.protobuf.IStruct

Properties of a Struct.

protos.google.protobuf.ITimestamp

Properties of a Timestamp.

protos.google.protobuf.IUninterpretedOption

Properties of an UninterpretedOption.

protos.google.protobuf.IValue

Properties of a Value.

protos.google.protobuf.SourceCodeInfo.ILocation

Properties of a Location.

protos.google.protobuf.UninterpretedOption.INamePart

Properties of a NamePart.

protos.google.rpc.IStatus

Properties of a Status.

RequestCallback

RequestConfig

ServiceContext

For logged errors, one can provide a the service context. For more information see [this guide]https://cloud.google.com/error-reporting/docs/formatting-error-messages and the [official documentation]https://cloud.google.com/error-reporting/reference/rest/v1beta1/ServiceContext.

TailEntriesResponse

Enums

protos.google.api.ClientLibraryDestination

ClientLibraryDestination enum.

protos.google.api.ClientLibraryOrganization

ClientLibraryOrganization enum.

protos.google.api.FieldBehavior

FieldBehavior enum.

protos.google.api.LabelDescriptor.ValueType

ValueType enum.

protos.google.api.LaunchStage

LaunchStage enum.

protos.google.api.MetricDescriptor.MetricKind

MetricKind enum.

protos.google.api.MetricDescriptor.ValueType

ValueType enum.

protos.google.api.ResourceDescriptor.History

History enum.

protos.google.api.ResourceDescriptor.Style

Style enum.

protos.google.logging.type.LogSeverity

LogSeverity enum.

protos.google.logging.v2.IndexType

IndexType enum.

protos.google.logging.v2.LifecycleState

LifecycleState enum.

protos.google.logging.v2.LogMetric.ApiVersion

ApiVersion enum.

protos.google.logging.v2.LogSink.VersionFormat

VersionFormat enum.

protos.google.logging.v2.OperationState

OperationState enum.

protos.google.logging.v2.TailLogEntriesResponse.SuppressionInfo.Reason

Reason enum.

protos.google.protobuf.FieldDescriptorProto.Label

Label enum.

protos.google.protobuf.FieldDescriptorProto.Type

Type enum.

protos.google.protobuf.FieldOptions.CType

CType enum.

protos.google.protobuf.FieldOptions.JSType

JSType enum.

protos.google.protobuf.FieldOptions.OptionRetention

OptionRetention enum.

protos.google.protobuf.FieldOptions.OptionTargetType

OptionTargetType enum.

protos.google.protobuf.FileOptions.OptimizeMode

OptimizeMode enum.

protos.google.protobuf.GeneratedCodeInfo.Annotation.Semantic

Semantic enum.

protos.google.protobuf.MethodOptions.IdempotencyLevel

IdempotencyLevel enum.

protos.google.protobuf.NullValue

NullValue enum.

Severity

Variables

v2

v2: any

Functions

assignSeverityToEntries(entries, severity)

export declare function assignSeverityToEntries(entries: Entry | Entry[], severity: string): Entry[];

Return an array of log entries with the desired severity assigned.

Parameters
Name Description
entries Entry | Entry[]

Log entries.
severity string

The desired severity level.
Returns
Type Description
Entry[]

detectServiceContext(auth)

export declare function detectServiceContext(auth: GoogleAuth): Promise

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]https://cloud.google.com/error-reporting/docs/formatting-error-messages and the [official documentation]https://cloud.google.com/error-reporting/reference/rest/v1beta1/ServiceContext.

Parameter
Name Description
auth GoogleAuth
Returns
Type Description
Promise<ServiceContext | null>

formatLogName(projectId, name)

export declare function formatLogName(projectId: string, name: string): string;

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

Parameters
Name Description
projectId string
name string
Returns
Type Description
string

middleware.express.makeMiddleware(projectId, makeChildLogger, emitRequestLog)

export declare function makeMiddleware

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.

Parameters
Name Description
projectId string

Generated traceIds will be associated with this project.
makeChildLogger (trace: string, span?: string, traceSampled?: boolean) => LoggerType

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 (httpRequest: CloudLoggingHttpRequest, trace: string, span?: string, traceSampled?: boolean) => void

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 CloudLoggingHttpRequest which can be emitted as request log.
Returns
Type Description
(req: ServerRequest, res: "\"http\"".ServerResponse, next: Function) => void
Type Parameter
Type Description
LoggerType

Type Aliases

Client

export type Client = string;

DeleteResponse

export type DeleteResponse = google.protobuf.Empty;

GetEntriesResponse

export type GetEntriesResponse = [
    Entry[],
    google.logging.v2.IListLogEntriesRequest,
    google.logging.v2.IListLogEntriesResponse
];

GetLogsResponse

export type GetLogsResponse = [
    Sink[],
    google.logging.v2.IListLogsRequest,
    google.logging.v2.IListLogsResponse
];

GetSinksResponse

export type GetSinksResponse = [
    Sink[],
    google.logging.v2.IListSinksRequest,
    google.logging.v2.IListSinksResponse
];

LogSink

export type LogSink = google.logging.v2.ILogSink;

MonitoredResource

export type MonitoredResource = google.api.IMonitoredResource;

protos.google.logging.v2.ConfigServiceV2.CopyLogEntriesCallback

type CopyLogEntriesCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.CreateBucketAsyncCallback

type CreateBucketAsyncCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.CreateBucketCallback

type CreateBucketCallback = (error: (Error|null), response?: google.logging.v2.LogBucket) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.CreateExclusionCallback

type CreateExclusionCallback = (error: (Error|null), response?: google.logging.v2.LogExclusion) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.CreateLinkCallback

type CreateLinkCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.CreateSinkCallback

type CreateSinkCallback = (error: (Error|null), response?: google.logging.v2.LogSink) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.CreateViewCallback

type CreateViewCallback = (error: (Error|null), response?: google.logging.v2.LogView) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.DeleteBucketCallback

type DeleteBucketCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.DeleteExclusionCallback

type DeleteExclusionCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.DeleteLinkCallback

type DeleteLinkCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.DeleteSinkCallback

type DeleteSinkCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.DeleteViewCallback

type DeleteViewCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.GetBucketCallback

type GetBucketCallback = (error: (Error|null), response?: google.logging.v2.LogBucket) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.GetCmekSettingsCallback

type GetCmekSettingsCallback = (error: (Error|null), response?: google.logging.v2.CmekSettings) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.GetExclusionCallback

type GetExclusionCallback = (error: (Error|null), response?: google.logging.v2.LogExclusion) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.GetLinkCallback

type GetLinkCallback = (error: (Error|null), response?: google.logging.v2.Link) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.GetSettingsCallback

type GetSettingsCallback = (error: (Error|null), response?: google.logging.v2.Settings) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.GetSinkCallback

type GetSinkCallback = (error: (Error|null), response?: google.logging.v2.LogSink) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.GetViewCallback

type GetViewCallback = (error: (Error|null), response?: google.logging.v2.LogView) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.ListBucketsCallback

type ListBucketsCallback = (error: (Error|null), response?: google.logging.v2.ListBucketsResponse) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.ListExclusionsCallback

type ListExclusionsCallback = (error: (Error|null), response?: google.logging.v2.ListExclusionsResponse) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.ListLinksCallback

type ListLinksCallback = (error: (Error|null), response?: google.logging.v2.ListLinksResponse) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.ListSinksCallback

type ListSinksCallback = (error: (Error|null), response?: google.logging.v2.ListSinksResponse) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.ListViewsCallback

type ListViewsCallback = (error: (Error|null), response?: google.logging.v2.ListViewsResponse) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.UndeleteBucketCallback

type UndeleteBucketCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.UpdateBucketAsyncCallback

type UpdateBucketAsyncCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.UpdateBucketCallback

type UpdateBucketCallback = (error: (Error|null), response?: google.logging.v2.LogBucket) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.UpdateCmekSettingsCallback

type UpdateCmekSettingsCallback = (error: (Error|null), response?: google.logging.v2.CmekSettings) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.UpdateExclusionCallback

type UpdateExclusionCallback = (error: (Error|null), response?: google.logging.v2.LogExclusion) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.UpdateSettingsCallback

type UpdateSettingsCallback = (error: (Error|null), response?: google.logging.v2.Settings) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.UpdateSinkCallback

type UpdateSinkCallback = (error: (Error|null), response?: google.logging.v2.LogSink) => void;

Callback as used by .

protos.google.logging.v2.ConfigServiceV2.UpdateViewCallback

type UpdateViewCallback = (error: (Error|null), response?: google.logging.v2.LogView) => void;

Callback as used by .

protos.google.logging.v2.LoggingServiceV2.DeleteLogCallback

type DeleteLogCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.logging.v2.LoggingServiceV2.ListLogEntriesCallback

type ListLogEntriesCallback = (error: (Error|null), response?: google.logging.v2.ListLogEntriesResponse) => void;

Callback as used by .

protos.google.logging.v2.LoggingServiceV2.ListLogsCallback

type ListLogsCallback = (error: (Error|null), response?: google.logging.v2.ListLogsResponse) => void;

Callback as used by .

protos.google.logging.v2.LoggingServiceV2.ListMonitoredResourceDescriptorsCallback

type ListMonitoredResourceDescriptorsCallback = (error: (Error|null), response?: google.logging.v2.ListMonitoredResourceDescriptorsResponse) => void;

Callback as used by .

protos.google.logging.v2.LoggingServiceV2.TailLogEntriesCallback

type TailLogEntriesCallback = (error: (Error|null), response?: google.logging.v2.TailLogEntriesResponse) => void;

Callback as used by .

protos.google.logging.v2.LoggingServiceV2.WriteLogEntriesCallback

type WriteLogEntriesCallback = (error: (Error|null), response?: google.logging.v2.WriteLogEntriesResponse) => void;

Callback as used by .

protos.google.logging.v2.MetricsServiceV2.CreateLogMetricCallback

type CreateLogMetricCallback = (error: (Error|null), response?: google.logging.v2.LogMetric) => void;

Callback as used by .

protos.google.logging.v2.MetricsServiceV2.DeleteLogMetricCallback

type DeleteLogMetricCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.logging.v2.MetricsServiceV2.GetLogMetricCallback

type GetLogMetricCallback = (error: (Error|null), response?: google.logging.v2.LogMetric) => void;

Callback as used by .

protos.google.logging.v2.MetricsServiceV2.ListLogMetricsCallback

type ListLogMetricsCallback = (error: (Error|null), response?: google.logging.v2.ListLogMetricsResponse) => void;

Callback as used by .

protos.google.logging.v2.MetricsServiceV2.UpdateLogMetricCallback

type UpdateLogMetricCallback = (error: (Error|null), response?: google.logging.v2.LogMetric) => void;

Callback as used by .

protos.google.longrunning.Operations.CancelOperationCallback

type CancelOperationCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.longrunning.Operations.DeleteOperationCallback

type DeleteOperationCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.longrunning.Operations.GetOperationCallback

type GetOperationCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.longrunning.Operations.ListOperationsCallback

type ListOperationsCallback = (error: (Error|null), response?: google.longrunning.ListOperationsResponse) => void;

Callback as used by .

protos.google.longrunning.Operations.WaitOperationCallback

type WaitOperationCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

SeverityNames

export type SeverityNames = keyof typeof Severity;