add docs

Author: aabmass

opentelemetry-exporter-gcp-logging/README.rst

@@ -68,6 +68,30 @@ Usage
 
     logger1.warning("string log %s", "here")
 
+If your code is running in a GCP environment with a supported Cloud Logging agent (like GKE,
+Cloud Run, GCE, etc.), you can write logs to stdout in Cloud Logging `structured JSON format
+<https://cloud.google.com/logging/docs/structured-logging>`_. Pass the ``structured_json_file``
+argument and use ``SimpleLogRecordProcessor``:
+
+.. code:: python
+
+    import sys
+    from opentelemetry.exporter.cloud_logging import (
+        CloudLoggingExporter,
+    )
+    from opentelemetry._logs import set_logger_provider
+    from opentelemetry.sdk._logs import LoggerProvider
+    from opentelemetry.sdk._logs.export import SimpleLogRecordProcessor
+
+    logger_provider = LoggerProvider()
+    set_logger_provider(logger_provider)
+    exporter = CloudLoggingExporter(structured_json_file=sys.stdout)
+    logger_provider.add_log_record_processor(SimpleLogRecordProcessor(exporter))
+
+
+    otel_logger = logger_provider.get_logger(__name__)
+    otel_logger.emit(attributes={"hello": "world"}, body={"foo": {"bar": "baz"}})
+
 References
 ----------
 

opentelemetry-exporter-gcp-logging/src/opentelemetry/exporter/cloud_logging/__init__.py

@@ -220,7 +220,25 @@ def __init__(
         client: Optional[LoggingServiceV2Client] = None,
         *,
         structured_json_file: Optional[TextIO] = None,
-    ):
+    ) -> None:
+        """Create a CloudLoggingExporter
+
+        Args:
+            project_id: The GCP project ID to which the logs will be sent. If not
+                provided, the exporter will infer it from Application Default Credentials.
+            default_log_name: The default log name to use for log entries.
+                If not provided, a default name will be used.
+            client: An optional `LoggingServiceV2Client` instance to use for
+                sending logs. If not provided and ``structured_json_file`` is not provided, a
+                new client will be created. Passing both ``client`` and
+                ``structured_json_file`` is not supported.
+            structured_json_file: An optional file-like object (like `sys.stdout`) to write
+                logs to in Cloud Logging `structured JSON format
+                <https://cloud.google.com/logging/docs/structured-logging>`_. If provided,
+                ``client`` must not be provided and logs will only be written to the file-like
+                object.
+        """
+
         self.project_id: str
         if not project_id:
             _, default_project_id = google.auth.default()