Class: Google::Cloud::Logging::Sink
- Inherits:
-
Object
- Object
- Google::Cloud::Logging::Sink
- Defined in:
- lib/google/cloud/logging/sink.rb,
lib/google/cloud/logging/sink/list.rb
Overview
Sink
Used to export log entries outside Stackdriver Logging. When you create a sink, new log entries are exported. Stackdriver Logging does not send previously-ingested log entries to the sink's destination.
Before creating the sink, ensure that you have granted
cloud-logs@google.com
permission to write logs to the destination. See
Permissions for writing exported
logs.
You can retrieve an existing sink with Project#sink.
Defined Under Namespace
Classes: List
Instance Method Summary collapse
-
#delete ⇒ Boolean
Permanently deletes the logs-based sink.
-
#destination ⇒ Object
The export destination.
-
#destination=(destination) ⇒ Object
Updates the export destination.
-
#filter ⇒ Object
An advanced logs filter that defines the log entries to be exported.
-
#filter=(filter) ⇒ Object
Updates the advanced logs filter that defines the log entries to be exported.
-
#name ⇒ Object
The client-assigned sink identifier.
-
#reload! ⇒ Object
(also: #refresh!)
Reloads the logs-based sink with current data from the Logging service.
-
#save ⇒ Object
Updates the logs-based sink.
-
#unspecified? ⇒ Boolean
Helper to determine if the sink's version is
VERSION_FORMAT_UNSPECIFIED
. -
#v1? ⇒ Boolean
Helper to determine if the sink's version is
V1
. -
#v2? ⇒ Boolean
Helper to determine if the sink's version is
V2
. -
#version ⇒ Object
The log entry version used when exporting log entries from this sink.
-
#version=(version) ⇒ Object
Updates the log entry version used when exporting log entries from this sink.
Instance Method Details
#delete ⇒ Boolean
Permanently deletes the logs-based sink.
194 195 196 197 198 |
# File 'lib/google/cloud/logging/sink.rb', line 194 def delete ensure_service! service.delete_sink name true end |
#destination ⇒ Object
The export destination. See Exporting Logs With Sinks.
86 87 88 |
# File 'lib/google/cloud/logging/sink.rb', line 86 def destination @grpc.destination end |
#destination=(destination) ⇒ Object
Updates the export destination. See Exporting Logs With Sinks.
93 94 95 |
# File 'lib/google/cloud/logging/sink.rb', line 93 def destination= destination @grpc.destination = destination end |
#filter ⇒ Object
An advanced logs
filter
that defines the log entries to be exported. The filter must be
consistent with the log entry format designed by the version
parameter, regardless of the format of the log entry that was
originally written to Stackdriver Logging.
104 105 106 |
# File 'lib/google/cloud/logging/sink.rb', line 104 def filter @grpc.filter end |
#filter=(filter) ⇒ Object
Updates the advanced logs
filter
that defines the log entries to be exported. The filter must be
consistent with the log entry format designed by the version
parameter, regardless of the format of the log entry that was
originally written to Stackdriver Logging.
115 116 117 |
# File 'lib/google/cloud/logging/sink.rb', line 115 def filter= filter @grpc.filter = filter end |
#name ⇒ Object
The client-assigned sink identifier. Sink identifiers are limited to
1000 characters and can include only the following characters: A-Z
,
a-z
, 0-9
, and the special characters _-.
.
79 80 81 |
# File 'lib/google/cloud/logging/sink.rb', line 79 def name @grpc.name end |
#reload! ⇒ Object Also known as: refresh!
Reloads the logs-based sink with current data from the Logging service.
175 176 177 178 |
# File 'lib/google/cloud/logging/sink.rb', line 175 def reload! ensure_service! @grpc = service.get_sink name end |
#save ⇒ Object
Updates the logs-based sink.
167 168 169 170 |
# File 'lib/google/cloud/logging/sink.rb', line 167 def save ensure_service! @grpc = service.update_sink name, destination, filter, version end |
#unspecified? ⇒ Boolean
Helper to determine if the sink's version is
VERSION_FORMAT_UNSPECIFIED
.
139 140 141 |
# File 'lib/google/cloud/logging/sink.rb', line 139 def unspecified? !(v1? || v2?) end |
#v1? ⇒ Boolean
Helper to determine if the sink's version is V1
.
151 152 153 |
# File 'lib/google/cloud/logging/sink.rb', line 151 def v1? version == :V1 end |
#v2? ⇒ Boolean
Helper to determine if the sink's version is V2
.
145 146 147 |
# File 'lib/google/cloud/logging/sink.rb', line 145 def v2? version == :V2 end |
#version ⇒ Object
The log entry version used when exporting log entries from this sink. This version does not have to correspond to the version of the log entry when it was written to Stackdriver Logging.
123 124 125 |
# File 'lib/google/cloud/logging/sink.rb', line 123 def version @grpc.output_version_format end |
#version=(version) ⇒ Object
Updates the log entry version used when exporting log entries from
this sink. This version does not have to correspond to the version of
the log entry when it was written to Stackdriver Logging. Accepted
values are :VERSION_FORMAT_UNSPECIFIED
, :V2
, and :V1
.
132 133 134 |
# File 'lib/google/cloud/logging/sink.rb', line 132 def version= version @grpc.output_version_format = self.class.resolve_version(version) end |