Skip to content

Commit

Permalink
Error_reporting: prep docs for repo split. (#6155)
Browse files Browse the repository at this point in the history
* Harmonize / DRY 'error_reporting/README.rst' / 'error_reporting/docs/index.rst'.

Toward #5912.

* Move 'docs/error-reporting/*' -> 'error_reporting/docs/'.

Leave behind a symlink (note its name uses a hyphen rather than an
underscore).

Make the 'usage.rst' page only do usage docs -- the rest is in 'index.rst'.
  • Loading branch information
tseaver committed Oct 17, 2018
1 parent 0ccd143 commit ec5e02e
Show file tree
Hide file tree
Showing 10 changed files with 199 additions and 270 deletions.
1 change: 1 addition & 0 deletions docs/error-reporting
1 change: 0 additions & 1 deletion docs/error-reporting/changelog.md

This file was deleted.

142 changes: 0 additions & 142 deletions docs/error-reporting/usage.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
Translate <translate/index>
Vision <vision/index>
Video Intelligence <videointelligence/index>
Stackdriver Error Reporting <error-reporting/usage>
Stackdriver Error Reporting <error-reporting/index>
Stackdriver Logging <logging/index>
Stackdriver Monitoring <monitoring/index>
Stackdriver Trace <trace/index>
Expand Down
98 changes: 61 additions & 37 deletions error_reporting/README.rst
Original file line number Diff line number Diff line change
@@ -1,58 +1,82 @@
Python Client for Stackdriver Error Reporting
=============================================

Python idiomatic client for `Stackdriver Error Reporting`_

.. _Stackdriver Error Reporting: https://cloud.google.com/error-reporting/

|pypi| |versions|

- `Documentation`_
The Stackdriver `Error Reporting`_ API counts, analyzes and aggregates the
crashes in your running cloud services. A centralized error management
interface displays the results with sorting and filtering capabilities. A
dedicated view shows the error details: time chart, occurrences, affected user
count, first and last seen dates and a cleaned exception stack trace. Opt-in
to receive email and mobile alerts on new errors.

- `Client Library Documentation`_
- `Product Documentation`_

.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/error-reporting/usage.html
.. _Error Reporting: https://cloud.google.com/error-reporting/
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/error-reporting/usage.html
.. _Product Documentation: https://cloud.google.com/error-reporting/reference/
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-error-reporting.svg
:target: https://pypi.org/project/google-cloud-error-reporting/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-error-reporting.svg
:target: https://pypi.org/project/google-cloud-error-reporting/

Quick Start
-----------

.. code-block:: console
In order to use this library, you first need to go through the following steps:

$ pip install --upgrade google-cloud-error-reporting
1. `Select or create a Cloud Platform project.`_
2. `Enable billing for your project.`_
3. `Enable the Google Cloud Datastore API.`_
4. `Setup Authentication.`_

For more information on setting up your Python development environment,
such as installing ``pip`` and ``virtualenv`` on your system, please refer
to `Python Development Environment Setup Guide`_ for Google Cloud Platform.
.. _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 Google Cloud Datastore API.: https://cloud.google.com/error-reporting
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html

.. _Python Development Environment Setup Guide: https://cloud.google.com/python/setup
Installation
~~~~~~~~~~~~

Authentication
--------------
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
create isolated Python environments. The basic problem it addresses is one of
dependencies and versions, and indirectly permissions.

With ``google-cloud-python`` we try to make authentication as painless as
possible. Check out the `Authentication section`_ in our documentation to
learn more. You may also find the `authentication document`_ shared by all
the ``google-cloud-*`` libraries to be helpful.
With `virtualenv`_, it's possible to install this library without needing system
install permissions, and without clashing with the installed system
dependencies.

.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/google-cloud-common/tree/master/authentication
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/

Using the API
-------------

The Stackdriver `Error Reporting`_ API (`Error Reporting API docs`_)
counts, analyzes and aggregates the crashes in your running cloud services.
A centralized error management interface displays the results with sorting
and filtering capabilities. A dedicated view shows the error details: time
chart, occurrences, affected user count, first and last seen dates and a
cleaned exception stack trace. Opt-in to receive email and mobile alerts
on new errors.
Mac/Linux
^^^^^^^^^

.. _Error Reporting: https://cloud.google.com/error-reporting/
.. _Error Reporting API docs: https://cloud.google.com/error-reporting/reference/
.. code-block:: console
See the ``google-cloud-python`` API Error Reporting `Documentation`_ to learn
how to get started using this library.
pip install virtualenv
virtualenv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-error-reporting
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-error-reporting.svg
:target: https://pypi.org/project/google-cloud-error-reporting/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-error-reporting.svg
:target: https://pypi.org/project/google-cloud-error-reporting/
Windows
^^^^^^^

.. code-block:: console
pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install google-cloud-error-reporting
Next Steps
~~~~~~~~~~

- Read the `Client Library Documentation`_ for Google Cloud Datastore API
API to see other available methods on the client.
- Read the `Product documentation`_ to learn
more about the product and see How-to Guides.
1 change: 1 addition & 0 deletions error_reporting/docs/changelog.md
File renamed without changes.
Loading

0 comments on commit ec5e02e

Please sign in to comment.