GoogleCloudPlatform
diff --git a/‎logging/samples/AUTHORING_GUIDE.md‎
Lines changed: 1 addition & 0 deletions b/‎logging/samples/AUTHORING_GUIDE.md‎
Lines changed: 1 addition & 0 deletions
diff --git a/‎logging/samples/CONTRIBUTING.md‎
Lines changed: 1 addition & 0 deletions b/‎logging/samples/CONTRIBUTING.md‎
Lines changed: 1 addition & 0 deletions
diff --git a/‎logging/samples/snippets/README.rst.in‎
Lines changed: 28 additions & 0 deletions b/‎logging/samples/snippets/README.rst.in‎
Lines changed: 28 additions & 0 deletions
diff --git a/‎logging/samples/snippets/export.py‎
Lines changed: 138 additions & 0 deletions b/‎logging/samples/snippets/export.py‎
Lines changed: 138 additions & 0 deletions
diff --git a/‎logging/samples/snippets/export_test.py‎
Lines changed: 135 additions & 0 deletions b/‎logging/samples/snippets/export_test.py‎
Lines changed: 135 additions & 0 deletions
diff --git a/‎logging/samples/snippets/handler.py‎
Lines changed: 50 additions & 0 deletions b/‎logging/samples/snippets/handler.py‎
Lines changed: 50 additions & 0 deletions
diff --git a/‎logging/samples/snippets/handler_test.py‎
Lines changed: 22 additions & 0 deletions b/‎logging/samples/snippets/handler_test.py‎
Lines changed: 22 additions & 0 deletions
@@ -0,0 +1 @@
+See https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/AUTHORING_GUIDE.md
@@ -0,0 +1 @@
+See https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/CONTRIBUTING.md
@@ -0,0 +1,28 @@
+# This file is used to generate README.rst
+
+product:
+  name: Cloud Logging
+  short_name: Cloud Logging
+  url: https://cloud.google.com/logging/docs
+  description: > 
+    `Cloud Logging`_ allows you to store, search, analyze, monitor,
+    and alert on log data and events from Google Cloud Platform and Amazon
+    Web Services.
+
+setup:
+- auth
+- install_deps
+
+samples:
+- name: Quickstart
+  file: quickstart.py
+- name: Snippets
+  file: snippets.py
+  show_help: true
+- name: Export
+  file: export.py
+  show_help: true
+
+cloud_client_library: true
+
+folder: logging/cloud-client
@@ -0,0 +1,138 @@
+#!/usr/bin/env python
+
+# Copyright 2016 Google Inc. All Rights Reserved.
+#
+# 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.
+
+import argparse
+
+from google.cloud import logging
+
+
+# [START logging_list_sinks]
+def list_sinks():
+    """Lists all sinks."""
+    logging_client = logging.Client()
+
+    sinks = list(logging_client.list_sinks())
+
+    if not sinks:
+        print("No sinks.")
+
+    for sink in sinks:
+        print("{}: {} -> {}".format(sink.name, sink.filter_, sink.destination))
+
+
+# [END logging_list_sinks]
+
+
+# [START logging_create_sink]
+def create_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))
+
+
+# [END logging_create_sink]
+
+
+# [START logging_update_sink]
+def update_sink(sink_name, filter_):
+    """Changes a sink's filter.
+
+    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()
+    sink = logging_client.sink(sink_name)
+
+    sink.reload()
+
+    sink.filter_ = filter_
+    print("Updated sink {}".format(sink.name))
+    sink.update()
+
+
+# [END logging_update_sink]
+
+
+# [START logging_delete_sink]
+def delete_sink(sink_name):
+    """Deletes a sink."""
+    logging_client = logging.Client()
+    sink = logging_client.sink(sink_name)
+
+    sink.delete()
+
+    print("Deleted sink {}".format(sink.name))
+
+
+# [END logging_delete_sink]
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+        description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter
+    )
+
+    subparsers = parser.add_subparsers(dest="command")
+    subparsers.add_parser("list", help=list_sinks.__doc__)
+
+    create_parser = subparsers.add_parser("create", help=list_sinks.__doc__)
+    create_parser.add_argument("sink_name", help="Name of the log export sink.")
+    create_parser.add_argument(
+        "destination_bucket", help="Cloud Storage bucket where logs will be exported."
+    )
+    create_parser.add_argument("filter", help="The filter used to match logs.")
+
+    update_parser = subparsers.add_parser("update", help=update_sink.__doc__)
+    update_parser.add_argument("sink_name", help="Name of the log export sink.")
+    update_parser.add_argument("filter", help="The filter used to match logs.")
+
+    delete_parser = subparsers.add_parser("delete", help=delete_sink.__doc__)
+    delete_parser.add_argument("sink_name", help="Name of the log export sink.")
+
+    args = parser.parse_args()
+
+    if args.command == "list":
+        list_sinks()
+    elif args.command == "create":
+        create_sink(args.sink_name, args.destination_bucket, args.filter)
+    elif args.command == "update":
+        update_sink(args.sink_name, args.filter)
+    elif args.command == "delete":
+        delete_sink(args.sink_name)
@@ -0,0 +1,135 @@
+# Copyright 2016 Google Inc. All Rights Reserved.
+#
+# 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.
+
+import os
+import re
+import random
+import string
+import time
+
+import backoff
+from google.cloud import logging, storage
+import pytest
+
+import export
+
+
+BUCKET = os.environ["CLOUD_STORAGE_BUCKET"]
+TEST_SINK_NAME_TMPL = "example_sink_{}_{}"
+TEST_SINK_FILTER = "severity>=CRITICAL"
+TIMESTAMP = int(time.time())
+
+# Threshold beyond which the cleanup_old_sinks fixture will delete
+# old sink, in seconds
+CLEANUP_THRESHOLD = 7200  # 2 hours
+
+# Max buckets to delete at a time, to mitigate operation timeout
+# issues. To turn off in the future, set to None.
+MAX_BUCKETS = 1500
+
+
+def _random_id():
+    return "".join(
+        random.choice(string.ascii_uppercase + string.digits) for _ in range(6)
+    )
+
+
+def _create_sink_name():
+    return TEST_SINK_NAME_TMPL.format(TIMESTAMP, _random_id())
+
+
+@backoff.on_exception(backoff.expo, Exception, max_time=60, raise_on_giveup=False)
+def _delete_object(obj, **kwargs):
+    obj.delete(**kwargs)
+
+
+# Runs once for entire test suite
+@pytest.fixture(scope="module")
+def cleanup_old_sinks():
+    client = logging.Client()
+    test_sink_name_regex = (
+        r"^" + TEST_SINK_NAME_TMPL.format(r"(\d+)", r"[A-Z0-9]{6}") + r"$"
+    )
+    for sink in client.list_sinks():
+        match = re.match(test_sink_name_regex, sink.name)
+        if match:
+            sink_timestamp = int(match.group(1))
+            if TIMESTAMP - sink_timestamp > CLEANUP_THRESHOLD:
+                _delete_object(sink)
+
+    storage_client = storage.Client()
+
+    # See _sink_storage_setup in usage_guide.py for details about how
+    # sinks are named.
+    test_bucket_name_regex = r"^sink\-storage\-(\d+)$"
+    for bucket in storage_client.list_buckets(max_results=MAX_BUCKETS):
+        match = re.match(test_bucket_name_regex, bucket.name)
+        if match:
+            # Bucket timestamp is int(time.time() * 1000)
+            bucket_timestamp = int(match.group(1))
+            if TIMESTAMP - bucket_timestamp // 1000 > CLEANUP_THRESHOLD:
+                _delete_object(bucket, force=True)
+
+
+@pytest.fixture
+def example_sink(cleanup_old_sinks):
+    client = logging.Client()
+
+    sink = client.sink(
+        _create_sink_name(),
+        filter_=TEST_SINK_FILTER,
+        destination="storage.googleapis.com/{bucket}".format(bucket=BUCKET),
+    )
+
+    sink.create()
+
+    yield sink
+
+    _delete_object(sink)
+
+
+def test_list(example_sink, capsys):
+    @backoff.on_exception(backoff.expo, AssertionError, max_time=60)
+    def eventually_consistent_test():
+        export.list_sinks()
+        out, _ = capsys.readouterr()
+        assert example_sink.name in out
+
+    eventually_consistent_test()
+
+
+def test_create(capsys):
+    sink_name = _create_sink_name()
+
+    try:
+        export.create_sink(sink_name, BUCKET, TEST_SINK_FILTER)
+    # Clean-up the temporary sink.
+    finally:
+        _delete_object(logging.Client().sink(sink_name))
+
+    out, _ = capsys.readouterr()
+    assert sink_name in out
+
+
+def test_update(example_sink, capsys):
+    updated_filter = "severity>=INFO"
+    export.update_sink(example_sink.name, updated_filter)
+
+    example_sink.reload()
+    assert example_sink.filter_ == updated_filter
+
+
+def test_delete(example_sink, capsys):
+    export.delete_sink(example_sink.name)
+    assert not example_sink.exists()
@@ -0,0 +1,50 @@
+#!/usr/bin/env python
+
+# Copyright 2016 Google Inc. All Rights Reserved.
+#
+# 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.
+
+
+def use_logging_handler():
+    # [START logging_stdlogging]
+    # [START logging_handler_setup]
+    # Imports the Cloud Logging client library
+    import google.cloud.logging
+
+    # Instantiates a client
+    client = google.cloud.logging.Client()
+
+    # Retrieves a Cloud Logging handler based on the environment
+    # you're running in and integrates the handler with the
+    # Python logging module. By default this captures all logs
+    # at INFO level and higher
+    client.setup_logging()
+    # [END logging_handler_setup]
+
+    # [START logging_handler_usage]
+    # Imports Python standard library logging
+    import logging
+
+    # The data to log
+    text = "Hello, world!"
+
+    # Emits the data using the standard logging module
+    logging.warning(text)
+    # [END logging_handler_usage]
+
+    print("Logged: {}".format(text))
+    # [END logging_stdlogging]
+
+
+if __name__ == "__main__":
+    use_logging_handler()
@@ -0,0 +1,22 @@
+# Copyright 2016 Google Inc. All Rights Reserved.
+#
+# 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.
+
+
+import handler
+
+
+def test_handler(capsys):
+    handler.use_logging_handler()
+    out, _ = capsys.readouterr()
+    assert "Logged" in out
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+See https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/AUTHORING_GUIDE.md`