Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ This client supports the following Google Cloud Platform services:
- `Google Cloud Pub/Sub`_
- `Google BigQuery`_
- `Google Cloud Resource Manager`_
- `Google Cloud Logging`_
- `Google Stackdriver Logging`_

This comment was marked as spam.


.. _Google Cloud Datastore: https://github.com/GoogleCloudPlatform/gcloud-python#google-cloud-datastore
.. _Google Cloud Storage: https://github.com/GoogleCloudPlatform/gcloud-python#google-cloud-storage
.. _Google Cloud Pub/Sub: https://github.com/GoogleCloudPlatform/gcloud-python#google-cloud-pubsub
.. _Google BigQuery: https://github.com/GoogleCloudPlatform/gcloud-python#google-bigquery
.. _Google Cloud Resource Manager: https://github.com/GoogleCloudPlatform/gcloud-python#google-cloud-resource-manager
.. _Google Cloud Logging: https://github.com/GoogleCloudPlatform/gcloud-python#google-cloud-logging
.. _Google Stackdriver Logging: https://github.com/GoogleCloudPlatform/gcloud-python#google-cloud-logging

If you need support for other Google APIs, check out the
`Google APIs Python Client library`_.
Expand Down Expand Up @@ -239,8 +239,8 @@ manage projects using this Client Library.

.. _Resource Manager documentation: https://googlecloudplatform.github.io/gcloud-python/stable/resource-manager-api.html

Google Cloud Logging
--------------------
Google Stackdriver Logging
--------------------------

`Stackdriver Logging`_ API (`Logging API docs`_) allows you to store, search,
analyze, monitor, and alert on log data and events from Google Cloud Platform.
Expand All @@ -264,7 +264,7 @@ Example of fetching entries:
print entry.payload

See the ``gcloud-python`` API `logging documentation`_ to learn how to connect
to Cloud logging using this Client Library.
to Stackdriver Logging using this Client Library.

.. _logging documentation: https://googlecloudplatform.github.io/gcloud-python/stable/logging-usage.html

Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
.. toctree::
:maxdepth: 0
:hidden:
:caption: Cloud Logging
:caption: Stackdriver Logging

logging-usage
Client <logging-client>
Expand All @@ -114,7 +114,7 @@
.. toctree::
:maxdepth: 0
:hidden:
:caption: Cloud Monitoring
:caption: Stackdriver Monitoring

monitoring-usage
Client <monitoring-client>
Expand Down
5 changes: 2 additions & 3 deletions docs/logging-client.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Logging Client
==============
Stackdriver Logging Client
==========================

.. automodule:: gcloud.logging.client
:members:
Expand All @@ -11,4 +11,3 @@ Connection
.. automodule:: gcloud.logging.connection
:members:
:show-inheritance:

2 changes: 1 addition & 1 deletion docs/logging-usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Manage log metrics
------------------

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

Create a metric:

Expand Down
5 changes: 2 additions & 3 deletions docs/monitoring-client.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Monitoring Client
=================
Stackdriver Monitoring Client
=============================

.. automodule:: gcloud.monitoring.client
:members:
Expand All @@ -11,4 +11,3 @@ Connection
.. automodule:: gcloud.monitoring.connection
:members:
:show-inheritance:

12 changes: 6 additions & 6 deletions docs/monitoring-usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Using the API
Introduction
------------

With the Monitoring API, you can work with Stackdriver metric data
With the Stackdriver Monitoring API, you can work with Stackdriver metric data
pertaining to monitored resources in Google Cloud Platform (GCP)
or elsewhere.

Expand All @@ -21,7 +21,7 @@ Essential concepts:
- A **time series** is a collection of data points associated with
points or intervals in time.

Please refer to the documentation for the `Monitoring API`_ for
Please refer to the documentation for the `Stackdriver Monitoring API`_ for
more information.

At present, this client library supports the following features
Expand All @@ -32,13 +32,13 @@ of the API:
- Creation and deletion of metric descriptors for custom metrics.
- (Writing of custom metric data will be coming soon.)

.. _Monitoring API: https://cloud.google.com/monitoring/api/v3/
.. _Stackdriver Monitoring API: https://cloud.google.com/monitoring/api/v3/


The Monitoring Client Object
----------------------------
The Stackdriver Monitoring Client Object
----------------------------------------

The monitoring client library generally makes its
The Stackdriver Monitoring client library generally makes its
functionality available as methods of the monitoring
:class:`~gcloud.monitoring.client.Client` class.
A :class:`~gcloud.monitoring.client.Client` instance holds
Expand Down
2 changes: 1 addition & 1 deletion gcloud/logging/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Google Cloud Logging API wrapper."""
"""Google Stackdriver Logging API wrapper."""

from gcloud.logging.client import Client
from gcloud.logging.connection import Connection
Expand Down
2 changes: 1 addition & 1 deletion gcloud/logging/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Client for interacting with the Google Cloud Logging API."""
"""Client for interacting with the Google Stackdriver Logging API."""

import os

Expand Down
6 changes: 3 additions & 3 deletions gcloud/logging/connection.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Create / interact with gcloud logging connections."""
"""Create / interact with Stackdriver Logging connections."""

from gcloud import connection as base_connection


class Connection(base_connection.JSONConnection):
"""A connection to Google Cloud Logging via the JSON REST API.
"""A connection to Google Stackdriver Logging via the JSON REST API.

:type credentials: :class:`oauth2client.client.OAuth2Credentials`
:param credentials: (Optional) The OAuth2 Credentials to use for this
Expand All @@ -45,7 +45,7 @@ class Connection(base_connection.JSONConnection):
'https://www.googleapis.com/auth/logging.write',
'https://www.googleapis.com/auth/logging.admin',
'https://www.googleapis.com/auth/cloud-platform')
"""The scopes required for authenticating as a Cloud Logging consumer."""
"""The scopes required for authenticating as a Logging consumer."""


class _LoggingAPI(object):
Expand Down
2 changes: 1 addition & 1 deletion gcloud/logging/entries.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Log entries within the Google Cloud Logging API."""
"""Log entries within the Google Stackdriver Logging API."""

import json
import re
Expand Down
2 changes: 1 addition & 1 deletion gcloud/logging/metric.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Define Logging API Metrics."""
"""Define Stackdriver Logging API Metrics."""

from gcloud.exceptions import NotFound

Expand Down
2 changes: 1 addition & 1 deletion gcloud/logging/sink.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Define Logging API Sinks."""
"""Define Stackdriver Logging API Sinks."""

from gcloud.exceptions import NotFound

Expand Down
2 changes: 1 addition & 1 deletion gcloud/monitoring/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Google Monitoring API wrapper."""
"""Google Stackdriver Monitoring API wrapper."""

from gcloud.monitoring.client import Client
from gcloud.monitoring.connection import Connection
Expand Down
5 changes: 3 additions & 2 deletions gcloud/monitoring/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Client for interacting with the `Google Monitoring API (V3)`_.
"""Client for interacting with the `Google Stackdriver Monitoring API (V3)`_.

Example::

Expand All @@ -24,7 +24,8 @@
At present, the client supports querying of time series, metric descriptors,
and monitored resource descriptors.

.. _Google Monitoring API (V3): https://cloud.google.com/monitoring/api/v3/
.. _Google Stackdriver Monitoring API (V3):
https://cloud.google.com/monitoring/api/v3/
"""

from gcloud.client import JSONClient
Expand Down
4 changes: 2 additions & 2 deletions gcloud/monitoring/connection.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Create / interact with gcloud monitoring connections."""
"""Create / interact with Stackdriver Monitoring connections."""

from gcloud import connection as base_connection


class Connection(base_connection.JSONConnection):
"""A connection to Google Monitoring via the JSON REST API.
"""A connection to Google Stackdriver Monitoring via the JSON REST API.

:type credentials: :class:`oauth2client.client.OAuth2Credentials`
:param credentials: (Optional) The OAuth2 Credentials to use for this
Expand Down
4 changes: 2 additions & 2 deletions gcloud/monitoring/metric.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Metric Descriptors for the `Google Monitoring API (V3)`_.
"""Metric Descriptors for the `Google Stackdriver Monitoring API (V3)`_.

.. _Google Monitoring API (V3):
.. _Google Stackdriver Monitoring API (V3):
https://cloud.google.com/monitoring/api/ref_v3/rest/v3/\
projects.metricDescriptors
"""
Expand Down
4 changes: 2 additions & 2 deletions gcloud/monitoring/query.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Time series query for the `Google Monitoring API (V3)`_.
"""Time series query for the `Google Stackdriver Monitoring API (V3)`_.

.. _Google Monitoring API (V3):
.. _Google Stackdriver Monitoring API (V3):
https://cloud.google.com/monitoring/api/ref_v3/rest/v3/\
projects.timeSeries/list
"""
Expand Down
5 changes: 3 additions & 2 deletions gcloud/monitoring/resource.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Monitored Resource Descriptors for the `Google Monitoring API (V3)`_.
"""Monitored Resource Descriptors for the
`Google Stackdriver Monitoring API (V3)`_.

.. _Google Monitoring API (V3):
.. _Google Stackdriver Monitoring API (V3):
https://cloud.google.com/monitoring/api/ref_v3/rest/v3/\
projects.monitoredResourceDescriptors
"""
Expand Down
4 changes: 2 additions & 2 deletions gcloud/monitoring/timeseries.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Time series for the `Google Monitoring API (V3)`_.
"""Time series for the `Google Stackdriver Monitoring API (V3)`_.

Features intentionally omitted from this first version of the client library:
* Writing time series.
* Natural representation of distribution values.

.. _Google Monitoring API (V3):
.. _Google Stackdriver Monitoring API (V3):
https://cloud.google.com/monitoring/api/ref_v3/rest/v3/TimeSeries
"""

Expand Down
6 changes: 3 additions & 3 deletions system_tests/logging_.py
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ def _init_storage_bucket(self):
BUCKET_URI = 'storage.googleapis.com/%s' % (BUCKET_NAME,)

# Create the destination bucket, and set up the ACL to allow
# Cloud Logging to write into it.
# Stackdriver Logging to write into it.
storage_client = storage.Client()
bucket = storage_client.create_bucket(BUCKET_NAME)
self.to_delete.append(bucket)
Expand All @@ -231,7 +231,7 @@ def test_create_sink_pubsub_topic(self):
from gcloud import pubsub

# Create the destination topic, and set up the IAM policy to allow
# Cloud Logging to write into it.
# Stackdriver Logging to write into it.
pubsub_client = pubsub.Client()
topic = pubsub_client.topic(TOPIC_NAME)
topic.create()
Expand All @@ -256,7 +256,7 @@ def _init_bigquery_dataset(self):
Config.CLIENT.project, DATASET_NAME,)

# Create the destination dataset, and set up the ACL to allow
# Cloud Logging to write into it.
# Stackdriver Logging to write into it.
bigquery_client = bigquery.Client()
dataset = bigquery_client.dataset(DATASET_NAME)
dataset.create()
Expand Down