googleapis
Version:
Google APIs Client Library for Node.js
844 lines (843 loc) • 258 kB
TypeScript
/**
* Copyright 2019 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.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace logging_v2 {
interface Options extends GlobalOptions {
version: 'v2';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Stackdriver Logging API
*
* Writes log entries and manages your Stackdriver Logging configuration. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the Stackdriver Logging documentation.
*
* @example
* const {google} = require('googleapis');
* const logging = google.logging('v2');
*
* @namespace logging
* @type {Function}
* @version v2
* @variation v2
* @param {object=} options Options for Logging
*/
class Logging {
context: APIRequestContext;
billingAccounts: Resource$Billingaccounts;
entries: Resource$Entries;
exclusions: Resource$Exclusions;
folders: Resource$Folders;
logs: Resource$Logs;
monitoredResourceDescriptors: Resource$Monitoredresourcedescriptors;
organizations: Resource$Organizations;
projects: Resource$Projects;
sinks: Resource$Sinks;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.
*/
interface Schema$BucketOptions {
/**
* The explicit buckets.
*/
explicitBuckets?: Schema$Explicit;
/**
* The exponential buckets.
*/
exponentialBuckets?: Schema$Exponential;
/**
* The linear bucket.
*/
linearBuckets?: Schema$Linear;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
*/
interface Schema$Empty {
}
/**
* Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.
*/
interface Schema$Explicit {
/**
* The values must be monotonically increasing.
*/
bounds?: number[];
}
/**
* Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
*/
interface Schema$Exponential {
/**
* Must be greater than 1.
*/
growthFactor?: number;
/**
* Must be greater than 0.
*/
numFiniteBuckets?: number;
/**
* Must be greater than 0.
*/
scale?: number;
}
/**
* A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.
*/
interface Schema$HttpRequest {
/**
* The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
*/
cacheFillBytes?: string;
/**
* Whether or not an entity was served from cache (with or without validation).
*/
cacheHit?: boolean;
/**
* Whether or not a cache lookup was attempted.
*/
cacheLookup?: boolean;
/**
* Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.
*/
cacheValidatedWithOriginServer?: boolean;
/**
* The request processing latency on the server, from the time the request was received until the response was sent.
*/
latency?: string;
/**
* Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
*/
protocol?: string;
/**
* The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
*/
referer?: string;
/**
* The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: "192.168.1.1", "FE80::0202:B3FF:FE1E:8329".
*/
remoteIp?: string;
/**
* The request method. Examples: "GET", "HEAD", "PUT", "POST".
*/
requestMethod?: string;
/**
* The size of the HTTP request message in bytes, including the request headers and the request body.
*/
requestSize?: string;
/**
* The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: "http://example.com/some/info?color=red".
*/
requestUrl?: string;
/**
* The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
*/
responseSize?: string;
/**
* The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
*/
serverIp?: string;
/**
* The response code indicating the status of response. Examples: 200, 404.
*/
status?: number;
/**
* The user agent sent by the client. Example: "Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)".
*/
userAgent?: string;
}
/**
* A description of a label.
*/
interface Schema$LabelDescriptor {
/**
* A human-readable description for the label.
*/
description?: string;
/**
* The label key.
*/
key?: string;
/**
* The type of data that can be assigned to the label.
*/
valueType?: string;
}
/**
* Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)).
*/
interface Schema$Linear {
/**
* Must be greater than 0.
*/
numFiniteBuckets?: number;
/**
* Lower bound of the first bucket.
*/
offset?: number;
/**
* Must be greater than 0.
*/
width?: number;
}
/**
* Result returned from ListExclusions.
*/
interface Schema$ListExclusionsResponse {
/**
* A list of exclusions.
*/
exclusions?: Schema$LogExclusion[];
/**
* If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.
*/
nextPageToken?: string;
}
/**
* The parameters to ListLogEntries.
*/
interface Schema$ListLogEntriesRequest {
/**
* Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters.
*/
filter?: string;
/**
* Optional. How the results should be sorted. Presently, the only permitted values are "timestamp asc" (default) and "timestamp desc". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values.
*/
orderBy?: string;
/**
* Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.
*/
pageSize?: number;
/**
* Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.
*/
pageToken?: string;
/**
* Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: "my-project-1A".
*/
projectIds?: string[];
/**
* Required. Names of one or more parent resources from which to retrieve log entries: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Projects listed in the project_ids field are added to this list.
*/
resourceNames?: string[];
}
/**
* Result returned from ListLogEntries.
*/
interface Schema$ListLogEntriesResponse {
/**
* A list of log entries. If entries is empty, nextPageToken may still be returned, indicating that more entries may exist. See nextPageToken for more information.
*/
entries?: Schema$LogEntry[];
/**
* If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.
*/
nextPageToken?: string;
}
/**
* Result returned from ListLogMetrics.
*/
interface Schema$ListLogMetricsResponse {
/**
* A list of logs-based metrics.
*/
metrics?: Schema$LogMetric[];
/**
* If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
*/
nextPageToken?: string;
}
/**
* Result returned from ListLogs.
*/
interface Schema$ListLogsResponse {
/**
* A list of log names. For example, "projects/my-project/syslog" or "organizations/123/cloudresourcemanager.googleapis.com%2Factivity".
*/
logNames?: string[];
/**
* If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
*/
nextPageToken?: string;
}
/**
* Result returned from ListMonitoredResourceDescriptors.
*/
interface Schema$ListMonitoredResourceDescriptorsResponse {
/**
* If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
*/
nextPageToken?: string;
/**
* A list of resource descriptors.
*/
resourceDescriptors?: Schema$MonitoredResourceDescriptor[];
}
/**
* Result returned from ListSinks.
*/
interface Schema$ListSinksResponse {
/**
* If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.
*/
nextPageToken?: string;
/**
* A list of sinks.
*/
sinks?: Schema$LogSink[];
}
/**
* An individual entry in a log.
*/
interface Schema$LogEntry {
/**
* Optional. Information about the HTTP request associated with this log entry, if applicable.
*/
httpRequest?: Schema$HttpRequest;
/**
* Optional. A unique identifier for the log entry. If you provide a value, then Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Logging assigns its own unique identifier. The insert_id is also used to order log entries that have the same timestamp value.
*/
insertId?: string;
/**
* The log entry payload, represented as a structure that is expressed as a JSON object.
*/
jsonPayload?: {
[key: string]: any;
};
/**
* Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
*/
labels?: {
[key: string]: string;
};
/**
* Required. The resource name of the log to which this log entry belongs: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" A project number may optionally be used in place of PROJECT_ID. The project number is translated to its corresponding PROJECT_ID internally and the log_name field will contain PROJECT_ID in queries and exports.[LOG_ID] must be URL-encoded within log_name. Example: "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.
*/
logName?: string;
/**
* Deprecated. Output only. Additional metadata about the monitored resource.Only k8s_container, k8s_pod, and k8s_node MonitoredResources have this field populated for GKE versions older than 1.12.6. For GKE versions 1.12.6 and above, the metadata field has been deprecated. The Kubernetes pod labels that used to be in metadata.userLabels will now be present in the labels field with a key prefix of k8s-pod/. The Stackdriver system labels that were present in the metadata.systemLabels field will no longer be available in the LogEntry.
*/
metadata?: Schema$MonitoredResourceMetadata;
/**
* Optional. Information about an operation associated with the log entry, if applicable.
*/
operation?: Schema$LogEntryOperation;
/**
* The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.The following protocol buffer types are supported; user-defined types are not supported:"type.googleapis.com/google.cloud.audit.AuditLog" "type.googleapis.com/google.appengine.logging.v1.RequestLog"
*/
protoPayload?: {
[key: string]: any;
};
/**
* Output only. The time the log entry was received by Logging.
*/
receiveTimestamp?: string;
/**
* Required. The monitored resource that produced this log entry.Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.
*/
resource?: Schema$MonitoredResource;
/**
* Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.
*/
severity?: string;
/**
* Optional. Source code location information associated with the log entry, if any.
*/
sourceLocation?: Schema$LogEntrySourceLocation;
/**
* Optional. The span ID within the trace associated with the log entry.For Trace spans, this is the same format that the Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as <code>"000000000000004a"</code>.
*/
spanId?: string;
/**
* The log entry payload, represented as a Unicode string (UTF-8).
*/
textPayload?: string;
/**
* Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed.Incoming log entries should have timestamps that are no more than the logs retention period in the past, and no more than 24 hours in the future. Log entries outside those time boundaries will not be available when calling entries.list, but those log entries can still be exported with LogSinks.
*/
timestamp?: string;
/**
* Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824
*/
trace?: string;
/**
* Optional. The sampling decision of the trace associated with the log entry.True means that the trace resource name in the trace field was sampled for storage in a trace backend. False means that the trace was not sampled for storage when this log entry was written, or the sampling decision was unknown at the time. A non-sampled trace value is still useful as a request correlation identifier. The default is False.
*/
traceSampled?: boolean;
}
/**
* Additional information about a potentially long-running operation with which a log entry is associated.
*/
interface Schema$LogEntryOperation {
/**
* Optional. Set this to True if this is the first log entry in the operation.
*/
first?: boolean;
/**
* Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.
*/
id?: string;
/**
* Optional. Set this to True if this is the last log entry in the operation.
*/
last?: boolean;
/**
* Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: "MyDivision.MyBigCompany.com", "github.com/MyProject/MyApplication".
*/
producer?: string;
}
/**
* Additional information about the source code location that produced the log entry.
*/
interface Schema$LogEntrySourceLocation {
/**
* Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.
*/
file?: string;
/**
* Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).
*/
function?: string;
/**
* Optional. Line within the source file. 1-based; 0 indicates no line number available.
*/
line?: string;
}
/**
* Specifies a set of log entries that are not to be stored in Logging. If your project receives a large volume of logs, you might be able to use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded. Audit log entries and log entries from Amazon Web Services are never excluded.
*/
interface Schema$LogExclusion {
/**
* Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions.
*/
createTime?: string;
/**
* Optional. A description of this exclusion.
*/
description?: string;
/**
* Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can update an exclusion to change the value of this field.
*/
disabled?: boolean;
/**
* Required. An advanced logs filter that matches the log entries to be excluded. By using the sample function, you can exclude less than 100% of the matching log entries. For example, the following filter matches 99% of low-severity log entries from load balancers:"resource.type=http_load_balancer severity<ERROR sample(insertId, 0.99)"
*/
filter?: string;
/**
* Required. A client-assigned identifier, such as "load-balancer-exclusion". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.
*/
name?: string;
/**
* Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions.
*/
updateTime?: string;
}
/**
* Application log line emitted while processing a request.
*/
interface Schema$LogLine {
/**
* App-provided log message.
*/
logMessage?: string;
/**
* Severity of this log entry.
*/
severity?: string;
/**
* Where in the source code this log message was written.
*/
sourceLocation?: Schema$SourceLocation;
/**
* Approximate time when this log entry was made.
*/
time?: string;
}
/**
* Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.Logs-based metric can also be used to extract values from logs and create a a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options.
*/
interface Schema$LogMetric {
/**
* Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values.
*/
bucketOptions?: Schema$BucketOptions;
/**
* Output only. The creation timestamp of the metric.This field may not be present for older metrics.
*/
createTime?: string;
/**
* Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.
*/
description?: string;
/**
* Required. An advanced logs filter which is used to match log entries. Example: "resource.type=gae_app AND severity>=ERROR" The maximum length of the filter is 20000 characters.
*/
filter?: string;
/**
* Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If the either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project.
*/
labelExtractors?: {
[key: string]: string;
};
/**
* Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of "1". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description.
*/
metricDescriptor?: Schema$MetricDescriptor;
/**
* Required. The client-assigned metric identifier. Examples: "error_count", "nginx/requests".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.The metric identifier in this field must not be URL-encoded (https://en.wikipedia.org/wiki/Percent-encoding). However, when the metric identifier appears as the [METRIC_ID] part of a metric_name API parameter, then the metric identifier must be URL-encoded. Example: "projects/my-project/metrics/nginx%2Frequests".
*/
name?: string;
/**
* Output only. The last update timestamp of the metric.This field may not be present for older metrics.
*/
updateTime?: string;
/**
* Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The argument are: 1. field: The name of the log entry field from which the value is to be extracted. 2. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, ".*quantity=(\d+).*")
*/
valueExtractor?: string;
/**
* Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.
*/
version?: string;
}
/**
* Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
*/
interface Schema$LogSink {
/**
* Output only. The creation timestamp of the sink.This field may not be present for older sinks.
*/
createTime?: string;
/**
* Required. The export destination: "storage.googleapis.com/[GCS_BUCKET]" "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks.
*/
destination?: string;
/**
* Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example: logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
*/
filter?: string;
/**
* Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name: logName:("projects/test-project1/" OR "projects/test-project2/") AND resource.type=gce_instance
*/
includeChildren?: boolean;
/**
* Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
*/
name?: string;
/**
* Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.
*/
outputVersionFormat?: string;
/**
* Output only. The last update timestamp of the sink.This field may not be present for older sinks.
*/
updateTime?: string;
/**
* Output only. An IAM identity&mdash;a service account or group&mdash;under which Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
*/
writerIdentity?: string;
}
/**
* Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
*/
interface Schema$MetricDescriptor {
/**
* A detailed description of the metric, which can be used in documentation.
*/
description?: string;
/**
* A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
*/
displayName?: string;
/**
* The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
*/
labels?: Schema$LabelDescriptor[];
/**
* Optional. The launch stage of the metric definition.
*/
launchStage?: string;
/**
* Optional. Metadata which can be used to guide usage of the metric.
*/
metadata?: Schema$MetricDescriptorMetadata;
/**
* Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
*/
metricKind?: string;
/**
* The resource name of the metric descriptor.
*/
name?: string;
/**
* The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"
*/
type?: string;
/**
* The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d dayPrefixes (PREFIX) k kilo (10**3) M mega (10**6) G giga (10**9) T tera (10**12) P peta (10**15) E exa (10**18) Z zetta (10**21) Y yotta (10**24) m milli (10**-3) u micro (10**-6) n nano (10**-9) p pico (10**-12) f femto (10**-15) a atto (10**-18) z zepto (10**-21) y yocto (10**-24) Ki kibi (2**10) Mi mebi (2**20) Gi gibi (2**30) Ti tebi (2**40)GrammarThe grammar also includes these connectors: / division (as an infix operator, e.g. 1/s). . multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'. 1 represents dimensionless value 1, such as in 1/s. % represents dimensionless value 1/100, and annotates values giving a percentage.
*/
unit?: string;
/**
* Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
*/
valueType?: string;
}
/**
* Additional annotations that can be used to guide the usage of a metric.
*/
interface Schema$MetricDescriptorMetadata {
/**
* The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
*/
ingestDelay?: string;
/**
* Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition.
*/
launchStage?: string;
/**
* The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
*/
samplePeriod?: string;
}
/**
* An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone": { "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }}
*/
interface Schema$MonitoredResource {
/**
* Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone".
*/
labels?: {
[key: string]: string;
};
/**
* Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance.
*/
type?: string;
}
/**
* An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.
*/
interface Schema$MonitoredResourceDescriptor {
/**
* Optional. A detailed description of the monitored resource type that might be used in documentation.
*/
description?: string;
/**
* Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".
*/
displayName?: string;
/**
* Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".
*/
labels?: Schema$LabelDescriptor[];
/**
* Optional. The launch stage of the monitored resource definition.
*/
launchStage?: string;
/**
* Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".
*/
name?: string;
/**
* Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.
*/
type?: string;
}
/**
* Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message.
*/
interface Schema$MonitoredResourceMetadata {
/**
* Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false }
*/
systemLabels?: {
[key: string]: any;
};
/**
* Output only. A map of user-defined metadata labels.
*/
userLabels?: {
[key: string]: string;
};
}
/**
* Complete log information about a single HTTP request to an App Engine application.
*/
interface Schema$RequestLog {
/**
* App Engine release version.
*/
appEngineRelease?: string;
/**
* Application that handled this request.
*/
appId?: string;
/**
* An indication of the relative cost of serving this request.
*/
cost?: number;
/**
* Time when the request finished.
*/
endTime?: string;
/**
* Whether this request is finished or active.
*/
finished?: boolean;
/**
* Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.
*/
first?: boolean;
/**
* Internet host and port number of the resource being requested.
*/
host?: string;
/**
* HTTP version of request. Example: "HTTP/1.1".
*/
httpVersion?: string;
/**
* An identifier for the instance that handled the request.
*/
instanceId?: string;
/**
* If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1.
*/
instanceIndex?: number;
/**
* Origin IP address.
*/
ip?: string;
/**
* Latency of the request.
*/
latency?: string;
/**
* A list of log lines emitted by the application while serving this request.
*/
line?: Schema$LogLine[];
/**
* Number of CPU megacycles used to process request.
*/
megaCycles?: string;
/**
* Request method. Example: "GET", "HEAD", "PUT", "POST", "DELETE".
*/
method?: string;
/**
* Module of the application that handled this request.
*/
moduleId?: string;
/**
* The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21.
*/
nickname?: string;
/**
* Time this request spent in the pending request queue.
*/
pendingTime?: string;
/**
* Referrer URL of request.
*/
referrer?: string;
/**
* Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier.
*/
requestId?: string;
/**
* Contains the path and query portion of the URL that was requested. For example, if the URL was "http://example.com/app?name=val", the resource would be "/app?name=val". The fragment identifier, which is identified by the # character, is not included.
*/
resource?: string;
/**
* Size in bytes sent back to client by request.
*/
responseSize?: string;
/**
* Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.
*/
sourceReference?: Schema$SourceReference[];
/**
* Time when the request started.
*/
startTime?: string;
/**
* HTTP response status code. Example: 200, 404.
*/
status?: number;
/**
* Task name of the request, in the case of an offline request.
*/
taskName?: string;
/**
* Queue name of the request, in the case of an offline request.
*/
taskQueueName?: string;
/**
* Stackdriver Trace identifier for this request.
*/
traceId?: string;
/**
* If true, the value in the 'trace_id' field was sampled for storage in a trace backend.
*/