Create a sink
Stay organized with collections
Save and categorize content based on your preferences.
Demonstrates how to create a Cloud Logging Sink.
Code sample
C#
To learn how to install and use the client library for Logging, see Logging client libraries.
To authenticate to Logging, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.
privatevoidCreateSink(stringsinkId,stringlogId)
{
varsinkClient=ConfigServiceV2Client.Create();
LogSinkmyLogSink=newLogSink();
myLogSink.Name=sinkId;
// This creates a sink using a Google Cloud Storage bucket
// named the same as the projectId.
// This requires editing the bucket's permissions to add the Entity Group
// named 'cloud-logs@google.com' with 'Owner' access for the bucket.
// If this is being run with a Google Cloud service account,
// that account will need to be granted 'Owner' access to the Project.
// In Powershell, use this command:
// PS > Add-GcsBucketAcl <your-bucket-name> -Role OWNER -Group cloud-logs@google.com
myLogSink.Destination="storage.googleapis.com/"+s_projectId;
LogNamelogName=newLogName(s_projectId,logId);
myLogSink.Filter=$"logName={logName.ToString()}AND severity<=ERROR";
ProjectNameprojectName=newProjectName(s_projectId);
sinkClient.CreateSink(projectName,myLogSink,_retryAWhile);
Console.WriteLine($"Created sink: {sinkId}.");
}
Go
To learn how to install and use the client library for Logging, see Logging client libraries.
To authenticate to Logging, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.
import(
"context"
"log"
"cloud.google.com/go/logging/logadmin"
)
funccreateSink(projectIDstring)(*logadmin.Sink,error){
ctx:=context.Background()
client,err:=logadmin.NewClient (ctx,projectID)
iferr!=nil{
log.Fatalf("logadmin.NewClient: %v",err)
}
deferclient.Close ()
sink,err:=client.CreateSink (ctx,&logadmin.Sink{
ID:"severe-errors-to-gcs",
Destination:"storage.googleapis.com/logsinks-bucket",
Filter:"severity >= ERROR",
})
returnsink,err
}
Java
To learn how to install and use the client library for Logging, see Logging client libraries.
To authenticate to Logging, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.
SinkInfosinkInfo=SinkInfo.of(sinkName,DatasetDestination.of(datasetName));
Sinksink=logging.create(sinkInfo);Node.js
To learn how to install and use the client library for Logging, see Logging client libraries.
To authenticate to Logging, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.
// Imports the Google Cloud client libraries
const{Logging}=require('@google-cloud/logging');
const{Storage}=require('@google-cloud/storage');
// Creates clients
constlogging=newLogging ();
conststorage=newStorage ();
/**
* TODO(developer): Uncomment the following lines to run the code.
*/
// const sinkName = 'Name of your sink, e.g. my-sink';
// const bucketName = 'Desination bucket, e.g. my-bucket';
// const filter = 'Optional log filer, e.g. severity=ERROR';
// The destination can be a Cloud Storage bucket, a Cloud Pub/Sub topic,
// or a BigQuery dataset. In this case, it is a Cloud Storage Bucket.
// See https://cloud.google.com/logging/docs/api/tasks/exporting-logs for
// information on the destination format.
constdestination=storage.bucket(bucketName);
constsink=logging.sink(sinkName);
/**
* The filter determines which logs this sink matches and will be exported
* to the destination. For example a filter of 'severity>=INFO' will send
* all logs that have a severity of INFO or greater to the destination.
* See https://cloud.google.com/logging/docs/view/advanced_filters for more
* filter information.
*/
constconfig={
destination:destination,
filter:filter,
};
asyncfunctioncreateSink(){
// See https://googleapis.dev/nodejs/logging/latest/Sink.html#create
awaitsink.create(config);
console.log(`Created sink ${sinkName} to ${bucketName}`);
}
createSink();PHP
To learn how to install and use the client library for Logging, see Logging client libraries.
To authenticate to Logging, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.
use Google\Cloud\Logging\LoggingClient;
/**
* Create a log sink.
*
* @param string $projectId The Google project ID.
* @param string $sinkName The name of the sink.
* @param string $destination The destination of the sink.
* @param string $filterString The filter for the sink.
*/
function create_sink($projectId, $sinkName, $destination, $filterString)
{
$logging = new LoggingClient(['projectId' => $projectId]);
$logging->createSink(
$sinkName,
$destination,
['filter' => $filterString]
);
printf("Created a sink '%s'." . PHP_EOL, $sinkName);
}Python
To learn how to install and use the client library for Logging, see Logging client libraries.
To authenticate to Logging, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.
defcreate_sink(sink_name, destination_bucket, filter_):
"""Creates a sink to export logs to the given Cloud Storage bucket.
The filter determines which logs this sink matches and will be exported
to the destination. For example a filter of 'severity>=INFO' will send
all logs that have a severity of INFO or greater to the destination.
See https://cloud.google.com/logging/docs/view/advanced_filters for more
filter information.
"""
logging_client = logging.Client()
# The destination can be a Cloud Storage bucket, a Cloud Pub/Sub topic,
# or a BigQuery dataset. In this case, it is a Cloud Storage Bucket.
# See https://cloud.google.com/logging/docs/api/tasks/exporting-logs for
# information on the destination format.
destination = "storage.googleapis.com/{bucket}".format(bucket=destination_bucket)
sink = logging_client.sink(sink_name, filter_=filter_, destination=destination)
if sink.exists():
print("Sink {} already exists.".format(sink.name))
return
sink.create()
print("Created sink {}".format(sink.name))
Ruby
To learn how to install and use the client library for Logging, see Logging client libraries.
To authenticate to Logging, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.
require"google/cloud/logging"
logging=Google::Cloud::Logging .new
storage=Google::Cloud::Storage .new
# bucket_name = "name-of-my-storage-bucket"
bucket=storage.create_bucketbucket_name
# Grant owner permission to Cloud Logging service
email="cloud-logs@google.com"
bucket.acl.add_owner"group-#{email}"
# sink_name = "name-of-my-sink"
sink=logging.create_sinksink_name,"storage.googleapis.com/#{bucket.id}"
puts"#{sink.name}: #{sink.filter} -> #{sink.destination}"What's next
To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser.