Reference documentation and code samples for the Stackdriver Logging V2 Client class LogSink.
Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, a Pub/Sub topic or a Cloud Logging log bucket. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
Generated from protobuf message google.logging.v2.LogSink
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The client-assigned sink identifier, unique within the project. For example: |
↳ destination |
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 |
↳ filter |
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: |
↳ description |
string
Optional. A description of this sink. The maximum length of the description is 8000 characters. |
↳ disabled |
bool
Optional. If set to true, then this sink is disabled and it does not export any log entries. |
↳ exclusions |
array<Google\Cloud\Logging\V2\LogExclusion>
Optional. Log entries that match any of these exclusion filters will not be exported. If a log entry is matched by both |
↳ output_version_format |
int
Deprecated. This field is unused. |
↳ writer_identity |
string
Output only. An IAM identity—a service account or group—under which Cloud 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 |
↳ include_children |
bool
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 log entries 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 |
↳ bigquery_options |
Google\Cloud\Logging\V2\BigQueryOptions
Optional. Options that affect sinks exporting data to BigQuery. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The creation timestamp of the sink. This field may not be present for older sinks. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The last update timestamp of the sink. This field may not be present for older sinks. |
getName
Required. The client-assigned sink identifier, unique within the project.
For 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.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. The client-assigned sink identifier, unique within the project.
For 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDestination
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.
| Returns | |
|---|---|
| Type | Description |
string | |
setDestination
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
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
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
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
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Optional. A description of this sink.
The maximum length of the description is 8000 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Optional. A description of this sink.
The maximum length of the description is 8000 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisabled
Optional. If set to true, then this sink is disabled and it does not export any log entries.
| Returns | |
|---|---|
| Type | Description |
bool | |
setDisabled
Optional. If set to true, then this sink is disabled and it does not export any log entries.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getExclusions
Optional. Log entries that match any of these 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setExclusions
Optional. Log entries that match any of these 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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Logging\V2\LogExclusion>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOutputVersionFormat
Deprecated. This field is unused.
| Returns | |
|---|---|
| Type | Description |
int | |
setOutputVersionFormat
Deprecated. This field is unused.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getWriterIdentity
Output only. An IAM identity—a service account or group—under which Cloud
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. Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required.
| Returns | |
|---|---|
| Type | Description |
string | |
setWriterIdentity
Output only. An IAM identity—a service account or group—under which Cloud
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. Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIncludeChildren
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 log entries 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
| Returns | |
|---|---|
| Type | Description |
bool | |
setIncludeChildren
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 log entries 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
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBigqueryOptions
Optional. Options that affect sinks exporting data to BigQuery.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Logging\V2\BigQueryOptions|null | |
hasBigqueryOptions
setBigqueryOptions
Optional. Options that affect sinks exporting data to BigQuery.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Logging\V2\BigQueryOptions
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The creation timestamp of the sink.
This field may not be present for older sinks.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The creation timestamp of the sink.
This field may not be present for older sinks.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The last update timestamp of the sink.
This field may not be present for older sinks.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The last update timestamp of the sink.
This field may not be present for older sinks.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOptions
| Returns | |
|---|---|
| Type | Description |
string | |