Skip to content

Commit 2c28250

Browse files
dhermesdhermes
committed
Making monitoring subpackage into a proper package.
- Adding README, setup.py, MANIFEST.in, .coveragerc and tox.ini - Adding google-cloud-monitoring as a dependency to the umbrella package - Adding the monitoring subdirectory into the list of packages for verifying the docs - Incorporating the monitoring subdirectory into the umbrella coverage report - Adding the monitoring only tox tests to the Travis config - Adding {toxinidir}/../core as a dependency for the monitoring tox config
1 parent 0206bed commit 2c28250

File tree

9 files changed

+193
-0
lines changed

9 files changed

+193
-0
lines changed

‎.travis.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ script:
1313
- (cd bigquery && tox -e py27)
1414
- (cd pubsub && tox -e py27)
1515
- (cd logging && tox -e py27)
16+
- (cd monitoring && tox -e py27)
1617
- tox -e py34
1718
- (cd core && tox -e py34)
1819
- (cd bigtable && tox -e py34)
@@ -21,6 +22,7 @@ script:
2122
- (cd bigquery && tox -e py34)
2223
- (cd pubsub && tox -e py34)
2324
- (cd logging && tox -e py34)
25+
- (cd monitoring && tox -e py34)
2426
- tox -e lint
2527
- tox -e cover
2628
- (cd core && tox -e cover)
@@ -30,6 +32,7 @@ script:
3032
- (cd bigquery && tox -e cover)
3133
- (cd pubsub && tox -e cover)
3234
- (cd logging && tox -e cover)
35+
- (cd monitoring && tox -e cover)
3336
- tox -e system-tests
3437
- tox -e system-tests3
3538
- scripts/update_docs.sh

‎monitoring/.coveragerc‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[run]
2+
branch = True
3+
4+
[report]
5+
fail_under = 100
6+
show_missing = True
7+
exclude_lines =
8+
# Re-enable the standard pragma
9+
pragma: NO COVER
10+
# Ignore debug-only repr
11+
def __repr__

‎monitoring/MANIFEST.in‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
include README.rst
2+
graft google
3+
graft unit_tests
4+
global-exclude *.pyc

‎monitoring/README.rst‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
Python Client for Stackdriver Monitoring
2+
========================================
3+
4+
Python idiomatic client for `Stackdriver Monitoring`_
5+
6+
.. _Stackdriver Monitoring: https://cloud.google.com/monitoring/
7+
8+
- `Homepage`_
9+
- `API Documentation`_
10+
11+
.. _Homepage: https://googlecloudplatform.github.io/google-cloud-python/
12+
.. _API Documentation: http://googlecloudplatform.github.io/google-cloud-python/
13+
14+
Quick Start
15+
-----------
16+
17+
::
18+
19+
$ pip install --upgrade google-cloud-monitoring
20+
21+
Authentication
22+
--------------
23+
24+
With ``google-cloud-python`` we try to make authentication as painless as
25+
possible. Check out the `Authentication section`_ in our documentation to
26+
learn more. You may also find the `authentication document`_ shared by all
27+
the ``google-cloud-*`` libraries to be helpful.
28+
29+
.. _Authentication section: http://google-cloud-python.readthedocs.io/en/latest/google-cloud-auth.html
30+
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication
31+
32+
Using the API
33+
-------------
34+
35+
`Stackdriver Monitoring`_ (`Monitoring API docs`_) collects metrics,
36+
events, and metadata from Google Cloud Platform, Amazon Web Services (AWS),
37+
hosted uptime probes, application instrumentation, and a variety of common
38+
application components including Cassandra, Nginx, Apache Web Server,
39+
Elasticsearch and many others. Stackdriver ingests that data and generates
40+
insights via dashboards, charts, and alerts.
41+
42+
This package currently supports all Monitoring API operations other than
43+
writing custom metrics.
44+
45+
.. _Stackdriver Monitoring: https://cloud.google.com/monitoring/
46+
.. _Monitoring API docs: https://cloud.google.com/monitoring/api/ref_v3/rest/
47+
48+
List available metric types:
49+
50+
.. code:: python
51+
52+
from google.cloud import monitoring
53+
client = monitoring.Client()
54+
for descriptor in client.list_metric_descriptors():
55+
print(descriptor.type)
56+
57+
Display CPU utilization across your GCE instances during the last five minutes:
58+
59+
.. code:: python
60+
61+
metric = 'compute.googleapis.com/instance/cpu/utilization'
62+
query = client.query(metric, minutes=5)
63+
print(query.as_dataframe())
64+
65+
See the ``google-cloud-python`` API `monitoring documentation`_ to learn how
66+
to connect to Stackdriver Monitoring using this Client Library.
67+
68+
.. _monitoring documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/monitoring-usage.html

‎monitoring/setup.py‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Copyright 2016 Google Inc.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
import os
16+
17+
from setuptools import find_packages
18+
from setuptools import setup
19+
20+
21+
PACKAGE_ROOT = os.path.abspath(os.path.dirname(__file__))
22+
23+
with open(os.path.join(PACKAGE_ROOT, 'README.rst')) as file_obj:
24+
README = file_obj.read()
25+
26+
# NOTE: This is duplicated throughout and we should try to
27+
# consolidate.
28+
SETUP_BASE = {
29+
'author': 'Google Cloud Platform',
30+
'author_email': '[email protected]',
31+
'scripts': [],
32+
'url': 'https://github.com/GoogleCloudPlatform/google-cloud-python',
33+
'license': 'Apache 2.0',
34+
'platforms': 'Posix; MacOS X; Windows',
35+
'include_package_data': True,
36+
'zip_safe': False,
37+
'classifiers': [
38+
'Development Status :: 4 - Beta',
39+
'Intended Audience :: Developers',
40+
'License :: OSI Approved :: Apache Software License',
41+
'Operating System :: OS Independent',
42+
'Programming Language :: Python :: 2',
43+
'Programming Language :: Python :: 2.7',
44+
'Programming Language :: Python :: 3',
45+
'Programming Language :: Python :: 3.4',
46+
'Programming Language :: Python :: 3.5',
47+
'Topic :: Internet',
48+
],
49+
}
50+
51+
52+
REQUIREMENTS = [
53+
'google-cloud-core',
54+
]
55+
56+
setup(
57+
name='google-cloud-monitoring',
58+
version='0.20.0dev',
59+
description='Python Client for Stackdriver Monitoring',
60+
long_description=README,
61+
namespace_packages=[
62+
'google',
63+
'google.cloud',
64+
],
65+
packages=find_packages(),
66+
install_requires=REQUIREMENTS,
67+
**SETUP_BASE
68+
)

‎monitoring/tox.ini‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
[tox]
2+
envlist =
3+
py27,py34,py35,cover
4+
5+
[testing]
6+
deps =
7+
{toxinidir}/../core
8+
pytest
9+
covercmd =
10+
py.test --quiet \
11+
--cov=google.cloud.monitoring \
12+
--cov=unit_tests \
13+
--cov-config {toxinidir}/.coveragerc \
14+
unit_tests
15+
16+
[testenv]
17+
commands =
18+
py.test --quiet {posargs} unit_tests
19+
deps =
20+
{[testing]deps}
21+
22+
[testenv:cover]
23+
basepython =
24+
python2.7
25+
commands =
26+
{[testing]covercmd}
27+
deps =
28+
{[testenv]deps}
29+
coverage
30+
pytest-cov

‎scripts/verify_included_modules.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@
6464
'core',
6565
'datastore',
6666
'logging',
67+
'monitoring',
6768
'pubsub',
6869
'storage',
6970
)

‎setup.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@
5555
'google-cloud-core',
5656
'google-cloud-datastore',
5757
'google-cloud-logging',
58+
'google-cloud-monitoring',
5859
'google-cloud-pubsub',
5960
'google-cloud-storage',
6061
]

‎tox.ini‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ deps =
1111
{toxinidir}/bigquery
1212
{toxinidir}/pubsub
1313
{toxinidir}/logging
14+
{toxinidir}/monitoring
1415
pytest
1516
covercmd =
1617
py.test --quiet \
@@ -60,6 +61,12 @@ covercmd =
6061
--cov-append \
6162
--cov-config {toxinidir}/.coveragerc \
6263
logging/unit_tests
64+
py.test --quiet \
65+
--cov=google.cloud \
66+
--cov=unit_tests \
67+
--cov-append \
68+
--cov-config {toxinidir}/.coveragerc \
69+
monitoring/unit_tests
6370
coverage report --show-missing --fail-under=100
6471

6572
[testenv]

0 commit comments

Comments
 (0)