Firebase Update

This commit is contained in:
Lukas Nowy
2018-12-22 23:30:39 +01:00
parent befb44764d
commit acffe619b3
11523 changed files with 1614327 additions and 930246 deletions

View File

@ -0,0 +1,93 @@
// Copyright 2018 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.
//
syntax = "proto3";
package google.logging.type;
import "google/api/annotations.proto";
import "google/protobuf/duration.proto";
option csharp_namespace = "Google.Cloud.Logging.Type";
option go_package = "google.golang.org/genproto/googleapis/logging/type;ltype";
option java_multiple_files = true;
option java_outer_classname = "HttpRequestProto";
option java_package = "com.google.logging.type";
option php_namespace = "Google\\Cloud\\Logging\\Type";
// 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.
message HttpRequest {
// The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
string request_method = 1;
// 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"`.
string request_url = 2;
// The size of the HTTP request message in bytes, including the request
// headers and the request body.
int64 request_size = 3;
// The response code indicating the status of response.
// Examples: 200, 404.
int32 status = 4;
// The size of the HTTP response message sent back to the client, in bytes,
// including the response headers and the response body.
int64 response_size = 5;
// The user agent sent by the client. Example:
// `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.
string user_agent = 6;
// The IP address (IPv4 or IPv6) of the client that issued the HTTP
// request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.
string remote_ip = 7;
// The IP address (IPv4 or IPv6) of the origin server that the request was
// sent to.
string server_ip = 13;
// The referer URL of the request, as defined in
// [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
string referer = 8;
// The request processing latency on the server, from the time the request was
// received until the response was sent.
google.protobuf.Duration latency = 14;
// Whether or not a cache lookup was attempted.
bool cache_lookup = 11;
// Whether or not an entity was served from cache
// (with or without validation).
bool cache_hit = 9;
// 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.
bool cache_validated_with_origin_server = 10;
// The number of HTTP response bytes inserted into cache. Set only when a
// cache fill was attempted.
int64 cache_fill_bytes = 12;
// Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
string protocol = 15;
}

View File

@ -0,0 +1,73 @@
// Copyright 2018 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.
//
syntax = "proto3";
package google.logging.type;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.Logging.Type";
option go_package = "google.golang.org/genproto/googleapis/logging/type;ltype";
option java_multiple_files = true;
option java_outer_classname = "LogSeverityProto";
option java_package = "com.google.logging.type";
option php_namespace = "Google\\Cloud\\Logging\\Type";
// The severity of the event described in a log entry, expressed as one of the
// standard severity levels listed below. For your reference, the levels are
// assigned the listed numeric values. The effect of using numeric values other
// than those listed is undefined.
//
// You can filter for log entries by severity. For example, the following
// filter expression will match log entries with severities `INFO`, `NOTICE`,
// and `WARNING`:
//
// severity > DEBUG AND severity <= WARNING
//
// If you are writing log entries, you should map other severity encodings to
// one of these standard levels. For example, you might map all of Java's FINE,
// FINER, and FINEST levels to `LogSeverity.DEBUG`. You can preserve the
// original severity level in the log entry payload if you wish.
enum LogSeverity {
// (0) The log entry has no assigned severity level.
DEFAULT = 0;
// (100) Debug or trace information.
DEBUG = 100;
// (200) Routine information, such as ongoing status or performance.
INFO = 200;
// (300) Normal but significant events, such as start up, shut down, or
// a configuration change.
NOTICE = 300;
// (400) Warning events might cause problems.
WARNING = 400;
// (500) Error events are likely to cause problems.
ERROR = 500;
// (600) Critical events cause more severe problems or outages.
CRITICAL = 600;
// (700) A person must take an action immediately.
ALERT = 700;
// (800) One or more systems are unusable.
EMERGENCY = 800;
}

View File

@ -0,0 +1,193 @@
// Copyright 2018 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.
//
syntax = "proto3";
package google.logging.v2;
import "google/api/annotations.proto";
import "google/api/monitored_resource.proto";
import "google/logging/type/http_request.proto";
import "google/logging/type/log_severity.proto";
import "google/protobuf/any.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Logging.V2";
option go_package = "google.golang.org/genproto/googleapis/logging/v2;logging";
option java_multiple_files = true;
option java_outer_classname = "LogEntryProto";
option java_package = "com.google.logging.v2";
option php_namespace = "Google\\Cloud\\Logging\\V2";
// An individual entry in a log.
message LogEntry {
// 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.
string log_name = 12;
// Required. The primary monitored resource associated with 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.
google.api.MonitoredResource resource = 8;
// Optional. The log entry payload, which can be one of multiple types.
oneof payload {
// The log entry payload, represented as a protocol buffer. Some
// Google Cloud Platform services use this field for their log
// entry payloads.
google.protobuf.Any proto_payload = 2;
// The log entry payload, represented as a Unicode string (UTF-8).
string text_payload = 3;
// The log entry payload, represented as a structure that is
// expressed as a JSON object.
google.protobuf.Struct json_payload = 6;
}
// 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](/logging/quotas) 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](/logging/docs/api/tasks/exporting-logs).
google.protobuf.Timestamp timestamp = 9;
// Output only. The time the log entry was received by Logging.
google.protobuf.Timestamp receive_timestamp = 24;
// Optional. The severity of the log entry. The default value is
// `LogSeverity.DEFAULT`.
google.logging.type.LogSeverity severity = 10;
// 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.
string insert_id = 4;
// Optional. Information about the HTTP request associated with this
// log entry, if applicable.
google.logging.type.HttpRequest http_request = 7;
// Optional. A set of user-defined (key, value) data that provides additional
// information about the log entry.
map<string, string> labels = 11;
// Output only. Additional metadata about the monitored resource.
// Only `k8s_container`, `k8s_pod`, and `k8s_node` MonitoredResources have
// this field populated.
google.api.MonitoredResourceMetadata metadata = 25;
// Optional. Information about an operation associated with the log entry, if
// applicable.
LogEntryOperation operation = 15;
// 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`
string trace = 22;
// 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>.
string span_id = 27;
// 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.
bool trace_sampled = 30;
// Optional. Source code location information associated with the log entry,
// if any.
LogEntrySourceLocation source_location = 23;
}
// Additional information about a potentially long-running operation with which
// a log entry is associated.
message LogEntryOperation {
// Optional. An arbitrary operation identifier. Log entries with the
// same identifier are assumed to be part of the same operation.
string id = 1;
// 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"`.
string producer = 2;
// Optional. Set this to True if this is the first log entry in the operation.
bool first = 3;
// Optional. Set this to True if this is the last log entry in the operation.
bool last = 4;
}
// Additional information about the source code location that produced the log
// entry.
message LogEntrySourceLocation {
// Optional. Source file name. Depending on the runtime environment, this
// might be a simple name or a fully-qualified name.
string file = 1;
// Optional. Line within the source file. 1-based; 0 indicates no line number
// available.
int64 line = 2;
// 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).
string function = 3;
}

View File

@ -0,0 +1,346 @@
// Copyright 2018 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.
//
syntax = "proto3";
package google.logging.v2;
import "google/api/annotations.proto";
import "google/api/monitored_resource.proto";
import "google/logging/v2/log_entry.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Logging.V2";
option go_package = "google.golang.org/genproto/googleapis/logging/v2;logging";
option java_multiple_files = true;
option java_outer_classname = "LoggingProto";
option java_package = "com.google.logging.v2";
option php_namespace = "Google\\Cloud\\Logging\\V2";
// Service for ingesting and querying logs.
service LoggingServiceV2 {
// Deletes all the log entries in a log.
// The log reappears if it receives new entries.
// Log entries written shortly before the delete operation might not be
// deleted.
rpc DeleteLog(DeleteLogRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v2/{log_name=projects/*/logs/*}"
additional_bindings {
delete: "/v2/{log_name=organizations/*/logs/*}"
}
additional_bindings {
delete: "/v2/{log_name=folders/*/logs/*}"
}
additional_bindings {
delete: "/v2/{log_name=billingAccounts/*/logs/*}"
}
};
}
// Writes log entries to Logging. This API method is the
// only way to send log entries to Logging. This method
// is used, directly or indirectly, by the Logging agent
// (fluentd) and all logging libraries configured to use Logging.
// A single request may contain log entries for a maximum of 1000
// different resources (projects, organizations, billing accounts or
// folders)
rpc WriteLogEntries(WriteLogEntriesRequest) returns (WriteLogEntriesResponse) {
option (google.api.http) = {
post: "/v2/entries:write"
body: "*"
};
}
// Lists log entries. Use this method to retrieve log entries from
// Logging. For ways to export log entries, see
// [Exporting Logs](/logging/docs/export).
rpc ListLogEntries(ListLogEntriesRequest) returns (ListLogEntriesResponse) {
option (google.api.http) = {
post: "/v2/entries:list"
body: "*"
};
}
// Lists the descriptors for monitored resource types used by Logging.
rpc ListMonitoredResourceDescriptors(ListMonitoredResourceDescriptorsRequest) returns (ListMonitoredResourceDescriptorsResponse) {
option (google.api.http) = {
get: "/v2/monitoredResourceDescriptors"
};
}
// Lists the logs in projects, organizations, folders, or billing accounts.
// Only logs that have entries are listed.
rpc ListLogs(ListLogsRequest) returns (ListLogsResponse) {
option (google.api.http) = {
get: "/v2/{parent=*/*}/logs"
additional_bindings {
get: "/v2/{parent=projects/*}/logs"
}
additional_bindings {
get: "/v2/{parent=organizations/*}/logs"
}
additional_bindings {
get: "/v2/{parent=folders/*}/logs"
}
additional_bindings {
get: "/v2/{parent=billingAccounts/*}/logs"
}
};
}
}
// The parameters to DeleteLog.
message DeleteLogRequest {
// Required. The resource name of the log to delete:
//
// "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]"
//
// `[LOG_ID]` must be URL-encoded. For example,
// `"projects/my-project-id/logs/syslog"`,
// `"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"`.
// For more information about log names, see
// [LogEntry][google.logging.v2.LogEntry].
string log_name = 1;
}
// The parameters to WriteLogEntries.
message WriteLogEntriesRequest {
// Optional. A default log resource name that is assigned to all log entries
// in `entries` that do not specify a value for `log_name`:
//
// "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]"
//
// `[LOG_ID]` must be URL-encoded. For example:
//
// "projects/my-project-id/logs/syslog"
// "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"
//
// The permission <code>logging.logEntries.create</code> is needed on each
// project, organization, billing account, or folder that is receiving
// new log entries, whether the resource is specified in
// <code>logName</code> or in an individual log entry.
string log_name = 1;
// Optional. A default monitored resource object that is assigned to all log
// entries in `entries` that do not specify a value for `resource`. Example:
//
// { "type": "gce_instance",
// "labels": {
// "zone": "us-central1-a", "instance_id": "00000000000000000000" }}
//
// See [LogEntry][google.logging.v2.LogEntry].
google.api.MonitoredResource resource = 2;
// Optional. Default labels that are added to the `labels` field of all log
// entries in `entries`. If a log entry already has a label with the same key
// as a label in this parameter, then the log entry's label is not changed.
// See [LogEntry][google.logging.v2.LogEntry].
map<string, string> labels = 3;
// Required. The log entries to send to Logging. The order of log
// entries in this list does not matter. Values supplied in this method's
// `log_name`, `resource`, and `labels` fields are copied into those log
// entries in this list that do not include values for their corresponding
// fields. For more information, see the
// [LogEntry][google.logging.v2.LogEntry] type.
//
// If the `timestamp` or `insert_id` fields are missing in log entries, then
// this method supplies the current time or a unique identifier, respectively.
// The supplied values are chosen so that, among the log entries that did not
// supply their own values, the entries earlier in the list will sort before
// the entries later in the list. See the `entries.list` method.
//
// Log entries with timestamps that are more than the
// [logs retention period](/logging/quota-policy) in the past or more than
// 24 hours in the future will not be available when calling `entries.list`.
// However, those log entries can still be exported with
// [LogSinks](/logging/docs/api/tasks/exporting-logs).
//
// To improve throughput and to avoid exceeding the
// [quota limit](/logging/quota-policy) for calls to `entries.write`,
// you should try to include several log entries in this list,
// rather than calling this method for each individual log entry.
repeated LogEntry entries = 4;
// Optional. Whether valid entries should be written even if some other
// entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any
// entry is not written, then the response status is the error associated
// with one of the failed entries and the response includes error details
// keyed by the entries' zero-based index in the `entries.write` method.
bool partial_success = 5;
// Optional. If true, the request should expect normal response, but the
// entries won't be persisted nor exported. Useful for checking whether the
// logging API endpoints are working properly before sending valuable data.
bool dry_run = 6;
}
// Result returned from WriteLogEntries.
// empty
message WriteLogEntriesResponse {
}
// Error details for WriteLogEntries with partial success.
message WriteLogEntriesPartialErrors {
// When `WriteLogEntriesRequest.partial_success` is true, records the error
// status for entries that were not written due to a permanent error, keyed
// by the entry's zero-based index in `WriteLogEntriesRequest.entries`.
//
// Failed requests for which no entries are written will not include
// per-entry errors.
map<int32, google.rpc.Status> log_entry_errors = 1;
}
// The parameters to `ListLogEntries`.
message ListLogEntriesRequest {
// Deprecated. Use `resource_names` instead. One or more project identifiers
// or project numbers from which to retrieve log entries. Example:
// `"my-project-1A"`. If present, these project identifiers are converted to
// resource name format and added to the list of resources in
// `resource_names`.
repeated string project_ids = 1 [deprecated = true];
// 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.
repeated string resource_names = 8;
// Optional. A filter that chooses which log entries to return. See [Advanced
// Logs Filters](/logging/docs/view/advanced_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.
string filter = 2;
// 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.
string order_by = 3;
// 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.
int32 page_size = 4;
// 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.
string page_token = 5;
}
// Result returned from `ListLogEntries`.
message 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.
repeated LogEntry entries = 1;
// 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.
string next_page_token = 2;
}
// The parameters to ListMonitoredResourceDescriptors
message ListMonitoredResourceDescriptorsRequest {
// Optional. The maximum number of results to return from this request.
// Non-positive values are ignored. The presence of `nextPageToken` in the
// response indicates that more results might be available.
int32 page_size = 1;
// Optional. If present, then retrieve the next batch of results from the
// preceding call to this method. `pageToken` must be the value of
// `nextPageToken` from the previous response. The values of other method
// parameters should be identical to those in the previous call.
string page_token = 2;
}
// Result returned from ListMonitoredResourceDescriptors.
message ListMonitoredResourceDescriptorsResponse {
// A list of resource descriptors.
repeated google.api.MonitoredResourceDescriptor resource_descriptors = 1;
// 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`.
string next_page_token = 2;
}
// The parameters to ListLogs.
message ListLogsRequest {
// Required. The resource name that owns the logs:
//
// "projects/[PROJECT_ID]"
// "organizations/[ORGANIZATION_ID]"
// "billingAccounts/[BILLING_ACCOUNT_ID]"
// "folders/[FOLDER_ID]"
string parent = 1;
// Optional. The maximum number of results to return from this request.
// Non-positive values are ignored. The presence of `nextPageToken` in the
// response indicates that more results might be available.
int32 page_size = 2;
// Optional. If present, then retrieve the next batch of results from the
// preceding call to this method. `pageToken` must be the value of
// `nextPageToken` from the previous response. The values of other method
// parameters should be identical to those in the previous call.
string page_token = 3;
}
// Result returned from ListLogs.
message ListLogsResponse {
// A list of log names. For example,
// `"projects/my-project/syslog"` or
// `"organizations/123/cloudresourcemanager.googleapis.com%2Factivity"`.
repeated string log_names = 3;
// 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`.
string next_page_token = 2;
}

View File

@ -0,0 +1,633 @@
// Copyright 2018 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.
//
syntax = "proto3";
package google.logging.v2;
import "google/api/annotations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Logging.V2";
option go_package = "google.golang.org/genproto/googleapis/logging/v2;logging";
option java_multiple_files = true;
option java_outer_classname = "LoggingConfigProto";
option java_package = "com.google.logging.v2";
option php_namespace = "Google\\Cloud\\Logging\\V2";
// Service for configuring sinks used to export log entries out of
// Logging.
service ConfigServiceV2 {
// Lists sinks.
rpc ListSinks(ListSinksRequest) returns (ListSinksResponse) {
option (google.api.http) = {
get: "/v2/{parent=*/*}/sinks"
additional_bindings {
get: "/v2/{parent=projects/*}/sinks"
}
additional_bindings {
get: "/v2/{parent=organizations/*}/sinks"
}
additional_bindings {
get: "/v2/{parent=folders/*}/sinks"
}
additional_bindings {
get: "/v2/{parent=billingAccounts/*}/sinks"
}
};
}
// Gets a sink.
rpc GetSink(GetSinkRequest) returns (LogSink) {
option (google.api.http) = {
get: "/v2/{sink_name=*/*/sinks/*}"
additional_bindings {
get: "/v2/{sink_name=projects/*/sinks/*}"
}
additional_bindings {
get: "/v2/{sink_name=organizations/*/sinks/*}"
}
additional_bindings {
get: "/v2/{sink_name=folders/*/sinks/*}"
}
additional_bindings {
get: "/v2/{sink_name=billingAccounts/*/sinks/*}"
}
};
}
// Creates a sink that exports specified log entries to a destination. The
// export of newly-ingested log entries begins immediately, unless the sink's
// `writer_identity` is not permitted to write to the destination. A sink can
// export log entries only from the resource owning the sink.
rpc CreateSink(CreateSinkRequest) returns (LogSink) {
option (google.api.http) = {
post: "/v2/{parent=*/*}/sinks"
body: "sink"
additional_bindings {
post: "/v2/{parent=projects/*}/sinks"
body: "sink"
}
additional_bindings {
post: "/v2/{parent=organizations/*}/sinks"
body: "sink"
}
additional_bindings {
post: "/v2/{parent=folders/*}/sinks"
body: "sink"
}
additional_bindings {
post: "/v2/{parent=billingAccounts/*}/sinks"
body: "sink"
}
};
}
// Updates a sink. This method replaces the following fields in the existing
// sink with values from the new sink: `destination`, and `filter`.
// The updated sink might also have a new `writer_identity`; see the
// `unique_writer_identity` field.
rpc UpdateSink(UpdateSinkRequest) returns (LogSink) {
option (google.api.http) = {
put: "/v2/{sink_name=*/*/sinks/*}"
body: "sink"
additional_bindings {
put: "/v2/{sink_name=projects/*/sinks/*}"
body: "sink"
}
additional_bindings {
put: "/v2/{sink_name=organizations/*/sinks/*}"
body: "sink"
}
additional_bindings {
put: "/v2/{sink_name=folders/*/sinks/*}"
body: "sink"
}
additional_bindings {
put: "/v2/{sink_name=billingAccounts/*/sinks/*}"
body: "sink"
}
additional_bindings {
patch: "/v2/{sink_name=projects/*/sinks/*}"
body: "sink"
}
additional_bindings {
patch: "/v2/{sink_name=organizations/*/sinks/*}"
body: "sink"
}
additional_bindings {
patch: "/v2/{sink_name=folders/*/sinks/*}"
body: "sink"
}
additional_bindings {
patch: "/v2/{sink_name=billingAccounts/*/sinks/*}"
body: "sink"
}
};
}
// Deletes a sink. If the sink has a unique `writer_identity`, then that
// service account is also deleted.
rpc DeleteSink(DeleteSinkRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v2/{sink_name=*/*/sinks/*}"
additional_bindings {
delete: "/v2/{sink_name=projects/*/sinks/*}"
}
additional_bindings {
delete: "/v2/{sink_name=organizations/*/sinks/*}"
}
additional_bindings {
delete: "/v2/{sink_name=folders/*/sinks/*}"
}
additional_bindings {
delete: "/v2/{sink_name=billingAccounts/*/sinks/*}"
}
};
}
// Lists all the exclusions in a parent resource.
rpc ListExclusions(ListExclusionsRequest) returns (ListExclusionsResponse) {
option (google.api.http) = {
get: "/v2/{parent=*/*}/exclusions"
additional_bindings {
get: "/v2/{parent=projects/*}/exclusions"
}
additional_bindings {
get: "/v2/{parent=organizations/*}/exclusions"
}
additional_bindings {
get: "/v2/{parent=folders/*}/exclusions"
}
additional_bindings {
get: "/v2/{parent=billingAccounts/*}/exclusions"
}
};
}
// Gets the description of an exclusion.
rpc GetExclusion(GetExclusionRequest) returns (LogExclusion) {
option (google.api.http) = {
get: "/v2/{name=*/*/exclusions/*}"
additional_bindings {
get: "/v2/{name=projects/*/exclusions/*}"
}
additional_bindings {
get: "/v2/{name=organizations/*/exclusions/*}"
}
additional_bindings {
get: "/v2/{name=folders/*/exclusions/*}"
}
additional_bindings {
get: "/v2/{name=billingAccounts/*/exclusions/*}"
}
};
}
// Creates a new exclusion in a specified parent resource.
// Only log entries belonging to that resource can be excluded.
// You can have up to 10 exclusions in a resource.
rpc CreateExclusion(CreateExclusionRequest) returns (LogExclusion) {
option (google.api.http) = {
post: "/v2/{parent=*/*}/exclusions"
body: "exclusion"
additional_bindings {
post: "/v2/{parent=projects/*}/exclusions"
body: "exclusion"
}
additional_bindings {
post: "/v2/{parent=organizations/*}/exclusions"
body: "exclusion"
}
additional_bindings {
post: "/v2/{parent=folders/*}/exclusions"
body: "exclusion"
}
additional_bindings {
post: "/v2/{parent=billingAccounts/*}/exclusions"
body: "exclusion"
}
};
}
// Changes one or more properties of an existing exclusion.
rpc UpdateExclusion(UpdateExclusionRequest) returns (LogExclusion) {
option (google.api.http) = {
patch: "/v2/{name=*/*/exclusions/*}"
body: "exclusion"
additional_bindings {
patch: "/v2/{name=projects/*/exclusions/*}"
body: "exclusion"
}
additional_bindings {
patch: "/v2/{name=organizations/*/exclusions/*}"
body: "exclusion"
}
additional_bindings {
patch: "/v2/{name=folders/*/exclusions/*}"
body: "exclusion"
}
additional_bindings {
patch: "/v2/{name=billingAccounts/*/exclusions/*}"
body: "exclusion"
}
};
}
// Deletes an exclusion.
rpc DeleteExclusion(DeleteExclusionRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v2/{name=*/*/exclusions/*}"
additional_bindings {
delete: "/v2/{name=projects/*/exclusions/*}"
}
additional_bindings {
delete: "/v2/{name=organizations/*/exclusions/*}"
}
additional_bindings {
delete: "/v2/{name=folders/*/exclusions/*}"
}
additional_bindings {
delete: "/v2/{name=billingAccounts/*/exclusions/*}"
}
};
}
}
// 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.
message LogSink {
// Available log entry formats. Log entries can be written to
// Logging in either format and can be exported in either format.
// Version 2 is the preferred format.
enum VersionFormat {
// An unspecified format version that will default to V2.
VERSION_FORMAT_UNSPECIFIED = 0;
// `LogEntry` version 2 format.
V2 = 1;
// `LogEntry` version 1 format.
V1 = 2;
}
// 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.
string name = 1;
// 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](/logging/docs/api/tasks/exporting-logs).
string destination = 3;
// Optional.
// An [advanced logs filter](/logging/docs/view/advanced_filters). 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
string filter = 5;
// 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.
VersionFormat output_version_format = 6 [deprecated = true];
// 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](/logging/docs/api/reference/rest/v2/projects.sinks/create)
// and
// [sinks.update](/logging/docs/api/reference/rest/v2/projects.sinks/update),
// based on the setting 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](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource).
// Consult the destination service's documentation to determine the
// appropriate IAM roles to assign to the identity.
string writer_identity = 8;
// 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
bool include_children = 9;
// Deprecated. This field is ignored when creating or updating sinks.
google.protobuf.Timestamp start_time = 10 [deprecated = true];
// Deprecated. This field is ignored when creating or updating sinks.
google.protobuf.Timestamp end_time = 11 [deprecated = true];
}
// The parameters to `ListSinks`.
message ListSinksRequest {
// Required. The parent resource whose sinks are to be listed:
//
// "projects/[PROJECT_ID]"
// "organizations/[ORGANIZATION_ID]"
// "billingAccounts/[BILLING_ACCOUNT_ID]"
// "folders/[FOLDER_ID]"
string parent = 1;
// Optional. If present, then retrieve the next batch of results from the
// preceding call to this method. `pageToken` must be the value of
// `nextPageToken` from the previous response. The values of other method
// parameters should be identical to those in the previous call.
string page_token = 2;
// Optional. The maximum number of results to return from this request.
// Non-positive values are ignored. The presence of `nextPageToken` in the
// response indicates that more results might be available.
int32 page_size = 3;
}
// Result returned from `ListSinks`.
message ListSinksResponse {
// A list of sinks.
repeated LogSink sinks = 1;
// 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`.
string next_page_token = 2;
}
// The parameters to `GetSink`.
message GetSinkRequest {
// Required. The resource name of the sink:
//
// "projects/[PROJECT_ID]/sinks/[SINK_ID]"
// "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
// "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
// "folders/[FOLDER_ID]/sinks/[SINK_ID]"
//
// Example: `"projects/my-project-id/sinks/my-sink-id"`.
string sink_name = 1;
}
// The parameters to `CreateSink`.
message CreateSinkRequest {
// Required. The resource in which to create the sink:
//
// "projects/[PROJECT_ID]"
// "organizations/[ORGANIZATION_ID]"
// "billingAccounts/[BILLING_ACCOUNT_ID]"
// "folders/[FOLDER_ID]"
//
// Examples: `"projects/my-logging-project"`, `"organizations/123456789"`.
string parent = 1;
// Required. The new sink, whose `name` parameter is a sink identifier that
// is not already in use.
LogSink sink = 2;
// Optional. Determines the kind of IAM identity returned as `writer_identity`
// in the new sink. If this value is omitted or set to false, and if the
// sink's parent is a project, then the value returned as `writer_identity` is
// the same group or service account used by Logging before the
// addition of writer identities to this API. The sink's destination must be
// in the same project as the sink itself.
//
// If this field is set to true, or if the sink is owned by a non-project
// resource such as an organization, then the value of `writer_identity` will
// be a unique service account used only for exports from the new sink. For
// more information, see `writer_identity` in [LogSink][google.logging.v2.LogSink].
bool unique_writer_identity = 3;
}
// The parameters to `UpdateSink`.
message UpdateSinkRequest {
// Required. The full resource name of the sink to update, including the
// parent resource and the sink identifier:
//
// "projects/[PROJECT_ID]/sinks/[SINK_ID]"
// "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
// "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
// "folders/[FOLDER_ID]/sinks/[SINK_ID]"
//
// Example: `"projects/my-project-id/sinks/my-sink-id"`.
string sink_name = 1;
// Required. The updated sink, whose name is the same identifier that appears
// as part of `sink_name`.
LogSink sink = 2;
// Optional. See
// [sinks.create](/logging/docs/api/reference/rest/v2/projects.sinks/create)
// for a description of this field. When updating a sink, the effect of this
// field on the value of `writer_identity` in the updated sink depends on both
// the old and new values of this field:
//
// + If the old and new values of this field are both false or both true,
// then there is no change to the sink's `writer_identity`.
// + If the old value is false and the new value is true, then
// `writer_identity` is changed to a unique service account.
// + It is an error if the old value is true and the new value is
// set to false or defaulted to false.
bool unique_writer_identity = 3;
// Optional. Field mask that specifies the fields in `sink` that need
// an update. A sink field will be overwritten if, and only if, it is
// in the update mask. `name` and output only fields cannot be updated.
//
// An empty updateMask is temporarily treated as using the following mask
// for backwards compatibility purposes:
// destination,filter,includeChildren
// At some point in the future, behavior will be removed and specifying an
// empty updateMask will be an error.
//
// For a detailed `FieldMask` definition, see
// https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask
//
// Example: `updateMask=filter`.
google.protobuf.FieldMask update_mask = 4;
}
// The parameters to `DeleteSink`.
message DeleteSinkRequest {
// Required. The full resource name of the sink to delete, including the
// parent resource and the sink identifier:
//
// "projects/[PROJECT_ID]/sinks/[SINK_ID]"
// "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
// "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
// "folders/[FOLDER_ID]/sinks/[SINK_ID]"
//
// Example: `"projects/my-project-id/sinks/my-sink-id"`.
string sink_name = 1;
}
// 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.
message LogExclusion {
// 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.
string name = 1;
// Optional. A description of this exclusion.
string description = 2;
// Required.
// An [advanced logs filter](/logging/docs/view/advanced_filters)
// that matches the log entries to be excluded. By using the
// [sample function](/logging/docs/view/advanced_filters#sample),
// 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)"`
string filter = 3;
// Optional. If set to True, then this exclusion is disabled and it does not
// exclude any log entries. You can use
// [exclusions.patch](/logging/docs/reference/v2/rest/v2/projects.exclusions/patch)
// to change the value of this field.
bool disabled = 4;
}
// The parameters to `ListExclusions`.
message ListExclusionsRequest {
// Required. The parent resource whose exclusions are to be listed.
//
// "projects/[PROJECT_ID]"
// "organizations/[ORGANIZATION_ID]"
// "billingAccounts/[BILLING_ACCOUNT_ID]"
// "folders/[FOLDER_ID]"
string parent = 1;
// Optional. If present, then retrieve the next batch of results from the
// preceding call to this method. `pageToken` must be the value of
// `nextPageToken` from the previous response. The values of other method
// parameters should be identical to those in the previous call.
string page_token = 2;
// Optional. The maximum number of results to return from this request.
// Non-positive values are ignored. The presence of `nextPageToken` in the
// response indicates that more results might be available.
int32 page_size = 3;
}
// Result returned from `ListExclusions`.
message ListExclusionsResponse {
// A list of exclusions.
repeated LogExclusion exclusions = 1;
// 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`.
string next_page_token = 2;
}
// The parameters to `GetExclusion`.
message GetExclusionRequest {
// Required. The resource name of an existing exclusion:
//
// "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
// "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
// "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
// "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
//
// Example: `"projects/my-project-id/exclusions/my-exclusion-id"`.
string name = 1;
}
// The parameters to `CreateExclusion`.
message CreateExclusionRequest {
// Required. The parent resource in which to create the exclusion:
//
// "projects/[PROJECT_ID]"
// "organizations/[ORGANIZATION_ID]"
// "billingAccounts/[BILLING_ACCOUNT_ID]"
// "folders/[FOLDER_ID]"
//
// Examples: `"projects/my-logging-project"`, `"organizations/123456789"`.
string parent = 1;
// Required. The new exclusion, whose `name` parameter is an exclusion name
// that is not already used in the parent resource.
LogExclusion exclusion = 2;
}
// The parameters to `UpdateExclusion`.
message UpdateExclusionRequest {
// Required. The resource name of the exclusion to update:
//
// "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
// "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
// "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
// "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
//
// Example: `"projects/my-project-id/exclusions/my-exclusion-id"`.
string name = 1;
// Required. New values for the existing exclusion. Only the fields specified
// in `update_mask` are relevant.
LogExclusion exclusion = 2;
// Required. A nonempty list of fields to change in the existing exclusion.
// New values for the fields are taken from the corresponding fields in the
// [LogExclusion][google.logging.v2.LogExclusion] included in this request. Fields not mentioned in
// `update_mask` are not changed and are ignored in the request.
//
// For example, to change the filter and description of an exclusion,
// specify an `update_mask` of `"filter,description"`.
google.protobuf.FieldMask update_mask = 3;
}
// The parameters to `DeleteExclusion`.
message DeleteExclusionRequest {
// Required. The resource name of an existing exclusion to delete:
//
// "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
// "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
// "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
// "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
//
// Example: `"projects/my-project-id/exclusions/my-exclusion-id"`.
string name = 1;
}

View File

@ -0,0 +1,265 @@
// Copyright 2018 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.
//
syntax = "proto3";
package google.logging.v2;
import "google/api/annotations.proto";
import "google/api/distribution.proto";
import "google/api/metric.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Logging.V2";
option go_package = "google.golang.org/genproto/googleapis/logging/v2;logging";
option java_multiple_files = true;
option java_outer_classname = "LoggingMetricsProto";
option java_package = "com.google.logging.v2";
option php_namespace = "Google\\Cloud\\Logging\\V2";
// Service for configuring logs-based metrics.
service MetricsServiceV2 {
// Lists logs-based metrics.
rpc ListLogMetrics(ListLogMetricsRequest) returns (ListLogMetricsResponse) {
option (google.api.http) = {
get: "/v2/{parent=projects/*}/metrics"
};
}
// Gets a logs-based metric.
rpc GetLogMetric(GetLogMetricRequest) returns (LogMetric) {
option (google.api.http) = {
get: "/v2/{metric_name=projects/*/metrics/*}"
};
}
// Creates a logs-based metric.
rpc CreateLogMetric(CreateLogMetricRequest) returns (LogMetric) {
option (google.api.http) = {
post: "/v2/{parent=projects/*}/metrics"
body: "metric"
};
}
// Creates or updates a logs-based metric.
rpc UpdateLogMetric(UpdateLogMetricRequest) returns (LogMetric) {
option (google.api.http) = {
put: "/v2/{metric_name=projects/*/metrics/*}"
body: "metric"
};
}
// Deletes a logs-based metric.
rpc DeleteLogMetric(DeleteLogMetricRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v2/{metric_name=projects/*/metrics/*}"
};
}
}
// 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.
message LogMetric {
// Logging API version.
enum ApiVersion {
// Logging API v2.
V2 = 0;
// Logging API v1.
V1 = 1;
}
// 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"`.
string name = 1;
// Optional. A description of this metric, which is used in documentation.
string description = 2;
// Required. An [advanced logs filter](/logging/docs/view/advanced_filters)
// which is used to match log entries.
// Example:
//
// "resource.type=gae_app AND severity>=ERROR"
//
// The maximum length of the filter is 20000 characters.
string filter = 3;
// 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.
google.api.MetricDescriptor metric_descriptor = 5;
// 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+).*")`
string value_extractor = 6;
// 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.
map<string, string> label_extractors = 7;
// 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.
google.api.Distribution.BucketOptions bucket_options = 8;
// Deprecated. The API version that created or updated this metric.
// The v2 format is used by default and cannot be changed.
ApiVersion version = 4 [deprecated = true];
}
// The parameters to ListLogMetrics.
message ListLogMetricsRequest {
// Required. The name of the project containing the metrics:
//
// "projects/[PROJECT_ID]"
string parent = 1;
// Optional. If present, then retrieve the next batch of results from the
// preceding call to this method. `pageToken` must be the value of
// `nextPageToken` from the previous response. The values of other method
// parameters should be identical to those in the previous call.
string page_token = 2;
// Optional. The maximum number of results to return from this request.
// Non-positive values are ignored. The presence of `nextPageToken` in the
// response indicates that more results might be available.
int32 page_size = 3;
}
// Result returned from ListLogMetrics.
message ListLogMetricsResponse {
// A list of logs-based metrics.
repeated LogMetric metrics = 1;
// 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`.
string next_page_token = 2;
}
// The parameters to GetLogMetric.
message GetLogMetricRequest {
// The resource name of the desired metric:
//
// "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
string metric_name = 1;
}
// The parameters to CreateLogMetric.
message CreateLogMetricRequest {
// The resource name of the project in which to create the metric:
//
// "projects/[PROJECT_ID]"
//
// The new metric must be provided in the request.
string parent = 1;
// The new logs-based metric, which must not have an identifier that
// already exists.
LogMetric metric = 2;
}
// The parameters to UpdateLogMetric.
message UpdateLogMetricRequest {
// The resource name of the metric to update:
//
// "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
//
// The updated metric must be provided in the request and it's
// `name` field must be the same as `[METRIC_ID]` If the metric
// does not exist in `[PROJECT_ID]`, then a new metric is created.
string metric_name = 1;
// The updated metric.
LogMetric metric = 2;
}
// The parameters to DeleteLogMetric.
message DeleteLogMetricRequest {
// The resource name of the metric to delete:
//
// "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
string metric_name = 1;
}