Class: Google::Cloud::Logging::V2::LogSink
- Inherits:
-
Object
- Object
- Google::Cloud::Logging::V2::LogSink
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/logging/v2/logging_config.rb
Overview
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.
Defined Under Namespace
Modules: VersionFormat
Instance Attribute Summary collapse
-
#bigquery_options ⇒ ::Google::Cloud::Logging::V2::BigQueryOptions
Optional.
-
#create_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#description ⇒ ::String
Optional.
-
#destination ⇒ ::String
Required.
-
#disabled ⇒ ::Boolean
Optional.
-
#exclusions ⇒ ::Array<::Google::Cloud::Logging::V2::LogExclusion>
Optional.
-
#filter ⇒ ::String
Optional.
-
#include_children ⇒ ::Boolean
Optional.
-
#name ⇒ ::String
Required.
-
#output_version_format ⇒ ::Google::Cloud::Logging::V2::LogSink::VersionFormat
Deprecated.
-
#update_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#writer_identity ⇒ ::String
readonly
Output only.
Instance Attribute Details
#bigquery_options ⇒ ::Google::Cloud::Logging::V2::BigQueryOptions
Returns Optional. Options that affect sinks exporting data to BigQuery.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 186 class LogSink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Deprecated. This is unused. module 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 end end |
#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The creation timestamp of the sink.
This field may not be present for older sinks.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 186 class LogSink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Deprecated. This is unused. module 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 end end |
#description ⇒ ::String
Returns Optional. A description of this sink. The maximum length of the description is 8000 characters.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 186 class LogSink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Deprecated. This is unused. module 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 end end |
#destination ⇒ ::String
Returns 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.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 186 class LogSink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Deprecated. This is unused. module 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 end end |
#disabled ⇒ ::Boolean
Returns Optional. If set to True, then this sink is disabled and it does not export any log entries.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 186 class LogSink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Deprecated. This is unused. module 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 end end |
#exclusions ⇒ ::Array<::Google::Cloud::Logging::V2::LogExclusion>
Returns Optional. Log entries that match any of the exclusion filters will not be exported.
If a log entry is matched by both filter
and one of exclusion_filters
it will not be exported.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 186 class LogSink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Deprecated. This is unused. module 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 end end |
#filter ⇒ ::String
Returns 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.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 186 class LogSink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Deprecated. This is unused. module 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 end end |
#include_children ⇒ ::Boolean
Returns 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.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 186 class LogSink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Deprecated. This is unused. module 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 end end |
#name ⇒ ::String
Returns 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.
First character has to be alphanumeric.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 186 class LogSink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Deprecated. This is unused. module 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 end end |
#output_version_format ⇒ ::Google::Cloud::Logging::V2::LogSink::VersionFormat
Returns Deprecated. This field is unused.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 186 class LogSink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Deprecated. This is unused. module 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 end end |
#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The last update timestamp of the sink.
This field may not be present for older sinks.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 186 class LogSink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Deprecated. This is unused. module 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 end end |
#writer_identity ⇒ ::String (readonly)
Returns Output only. An IAM identity—a service account or group—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.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'proto_docs/google/logging/v2/logging_config.rb', line 186 class LogSink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Deprecated. This is unused. module 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 end end |