Skip to content

Commit

Permalink
chore: add api-logging to codeowners (#81)
Browse files Browse the repository at this point in the history
  • Loading branch information
Simon Zeltser committed Oct 27, 2020
1 parent 0a1dd94 commit a58e1de
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Expand Up @@ -5,7 +5,7 @@
# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax

# The @googleapis/yoshi-python is the default owner for changes in this repo
* @googleapis/yoshi-python
* @googleapis/api-logging @googleapis/yoshi-python

# The python-samples-reviewers team is the default owner for samples changes
/samples/ @googleapis/python-samples-owners
5 changes: 3 additions & 2 deletions .repo-metadata.json
@@ -1,12 +1,13 @@
{
"name": "logging",
"name_pretty": "Stackdriver Logging",
"name_pretty": "Cloud Logging",
"product_documentation": "https://cloud.google.com/logging/docs",
"client_documentation": "https://googleapis.dev/python/logging/latest",
"issue_tracker": "https://issuetracker.google.com/savedsearches/559764",
"release_level": "ga",
"language": "python",
"repo": "googleapis/python-logging",
"distribution_name": "google-cloud-logging",
"api_id": "logging.googleapis.com"
"api_id": "logging.googleapis.com",
"codeowner_team": "@googleapis/api-logging"
}
2 changes: 1 addition & 1 deletion CHANGELOG.md
Expand Up @@ -62,7 +62,7 @@

### Implementation Changes
- Remove gRPC size restrictions (4MB default) ([#8860](https://github.com/googleapis/google-cloud-python/pull/8860))
- Map stdlib loglevels to Stackdriver severity enum values. ([#8837](https://github.com/googleapis/google-cloud-python/pull/8837))
- Map stdlib loglevels to Cloud Logging severity enum values. ([#8837](https://github.com/googleapis/google-cloud-python/pull/8837))

### Documentation
- Fix 'list_entries' example with projects. ([#8858](https://github.com/googleapis/google-cloud-python/pull/8858))
Expand Down
10 changes: 5 additions & 5 deletions README.rst
@@ -1,9 +1,9 @@
Python Client for Stackdriver Logging
Python Client for Cloud Logging
=====================================

|pypi| |versions|

`Stackdriver Logging API`_: Writes log entries and manages your Stackdriver
`Cloud Logging API`_: Writes log entries and manages your Cloud
Logging configuration.

- `Client Library Documentation`_
Expand All @@ -13,7 +13,7 @@ Logging configuration.
:target: https://pypi.org/project/google-cloud-logging/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-logging.svg
:target: https://pypi.org/project/google-cloud-logging/
.. _Stackdriver Logging API: https://cloud.google.com/logging
.. _Cloud Logging API: https://cloud.google.com/logging
.. _Client Library Documentation: https://googleapis.dev/python/logging/latest
.. _Product Documentation: https://cloud.google.com/logging/docs

Expand All @@ -24,12 +24,12 @@ In order to use this library, you first need to go through the following steps:

1. `Select or create a Cloud Platform project.`_
2. `Enable billing for your project.`_
3. `Enable the Stackdriver Logging API.`_
3. `Enable the Cloud Logging API.`_
4. `Setup Authentication.`_

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Stackdriver Logging API.: https://cloud.google.com/logging
.. _Enable the Cloud Logging API.: https://cloud.google.com/logging
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
Expand Down
2 changes: 1 addition & 1 deletion docs/client.rst
@@ -1,4 +1,4 @@
Stackdriver Logging Client
Cloud Logging Client
==========================

.. automodule:: google.cloud.logging.client
Expand Down
12 changes: 6 additions & 6 deletions docs/usage.rst
Expand Up @@ -112,7 +112,7 @@ Manage log metrics
------------------

Metrics are counters of entries which match a given filter. They can be
used within Stackdriver Monitoring to create charts and alerts.
used within Cloud Monitoring to create charts and alerts.

List all metrics for a project:

Expand Down Expand Up @@ -259,7 +259,7 @@ Integration with Python logging module
--------------------------------------

It's possible to tie the Python :mod:`logging` module directly into Google
Stackdriver Logging. There are different handler options to accomplish this.
Cloud Logging. There are different handler options to accomplish this.
To automatically pick the default for your current environment, use
:meth:`~google.cloud.logging.client.Client.get_default_handler`.

Expand All @@ -269,7 +269,7 @@ To automatically pick the default for your current environment, use
:dedent: 4

It is also possible to attach the handler to the root Python logger, so that
for example a plain ``logging.warn`` call would be sent to Stackdriver Logging,
for example a plain ``logging.warn`` call would be sent to Cloud Logging,
as well as any other loggers created. A helper method
:meth:`~google.cloud.logging.client.Client.setup_logging` is provided
to configure this automatically.
Expand All @@ -281,7 +281,7 @@ to configure this automatically.

.. note::

To reduce cost and quota usage, do not enable Stackdriver logging
To reduce cost and quota usage, do not enable Cloud Logging
handlers while testing locally.

You can also exclude certain loggers:
Expand Down Expand Up @@ -348,14 +348,14 @@ recommended when running on the Google App Engine Flexible vanilla runtimes
(i.e. your app.yaml contains ``runtime: python``), and
:class:`~google.cloud.logging.handlers.container_engine.ContainerEngineHandler`
, which is recommended when running on `Google Container Engine`_ with the
Stackdriver Logging plugin enabled.
Cloud Logging plugin enabled.

:meth:`~google.cloud.logging.client.Client.get_default_handler` and
:meth:`~google.cloud.logging.client.Client.setup_logging` will attempt to use
the environment to automatically detect whether the code is running in
these platforms and use the appropriate handler.

In both cases, the fluentd agent is configured to automatically parse log files
in an expected format and forward them to Stackdriver logging. The handlers
in an expected format and forward them to Cloud logging. The handlers
provided help set the correct metadata such as log level so that logs can be
filtered accordingly.

0 comments on commit a58e1de

Please sign in to comment.