google-cloud-logging 0.21.0 → 0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c9421790cb4f209636fe57644a348a9076ed293
-  data.tar.gz: 79e077faf17e8a77e8f4a471a3421207743d826c
+  metadata.gz: 936eb8b3aaef66ea34ca02e835f8b634dee850a9
+  data.tar.gz: 2789bd3fd24688240b34373725a379cb3a4a698d
 SHA512:
-  metadata.gz: 6d797aa5a7888d7b6f617439f37e8b20695fd4ac8c5b2f241ac52376bfdcf5154c2faf268e3411c09697d4ee37d13f3abe2f7428b5650ce7db3cdc581fae4eaf
-  data.tar.gz: 9c6ec7fe172ac640ebaa6c94c0501ed0e90b3b8004ba2387de6aadbaafcb134500a7d7ebf6a9aa921afa181ff663b48aa79d6271d2da86fdac2942d2cfbe1fc9
+  metadata.gz: 9590b979032aebbcbf9929deae3b566c718982aedfb04196bd58e0b5b812b9af9bb0ba762aaafc8362085cd474587ea5836d4a3022820ae4b064ad6f148127d5
+  data.tar.gz: 87d87acf7de854a47d9214554ee2467b0909380a76fb69b6c367e615d6774bb12ec771772adbce6361451b913643402897c6bffe162771b6805a0af4faf1d9b9

data/.yardopts

@@ -0,0 +1,10 @@
+--no-private
+--title=Stackdriver Logging
+--exclude lib/google/logging
+--exclude lib/google/cloud/logging/v2
+--exclude lib/google/cloud/logging/v2.rb
+--markup markdown
+
+./lib/**/*.rb
+-
+README.md

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,115 @@
+# google-cloud-logging
+
+[Stackdriver Logging](https://cloud.google.com/logging/) ([docs](https://cloud.google.com/logging/docs/)) allows you to store, search, analyze, monitor, and alert on log data and events from Google Cloud Platform and Amazon Web Services (AWS). It supports ingestion of any custom log data from any source. Stackdriver Logging is a fully-managed service that performs at scale and can ingest application and system log data from thousands of VMs. Even better, you can analyze all that log data in real-time.
+
+- [google-cloud-logging API documentation](http://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/master/google/cloud/logging)
+- [google-cloud-logging on RubyGems](https://rubygems.org/gems/google-cloud-logging)
+- [Stackdriver Logging documentation](https://cloud.google.com/logging/docs/)
+
+## Quick Start
+
+```sh
+$ gem install google-cloud-logging
+```
+
+## Authentication
+
+This library uses Service Account credentials to connect to Google Cloud services. When running on Compute Engine the credentials will be discovered automatically. When running on other environments the Service Account credentials can be specified by providing the path to the JSON file, or the JSON itself, in environment variables.
+
+Instructions and configuration options are covered in the [Authentication Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/guides/authentication).
+
+## Example
+
+```ruby
+require "google/cloud/logging"
+
+logging = Google::Cloud::Logging.new
+
+# List all log entries
+logging.entries.each do |e|
+  puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
+end
+
+# List only entries from a single log
+entries = logging.entries filter: "log:syslog"
+
+# Write a log entry
+entry = logging.entry
+entry.payload = "Job started."
+entry.log_name = "my_app_log"
+entry.resource.type = "gae_app"
+entry.resource.labels[:module_id] = "1"
+entry.resource.labels[:version_id] = "20150925t173233"
+
+logging.write_entries entry
+```
+
+## Rails Integration
+
+This library also provides a built in Railtie for Ruby on Rails integration. When enabled, it sets an instance of Google::Cloud::Logging::Logger as the default Rails logger. Then all consequent log entries will be submitted to the Stackdriver Logging service. 
+
+To do this, simply add this line to config/application.rb:
+```ruby
+require "google/cloud/logging/rails"
+```
+Then the library can be configured through this set of Rails parameters in config/environments/*.rb:
+```ruby
+# Sharing authentication parameters
+config.google_cloud.project_id = "gcp-project-id"
+config.google_cloud.keyfile = "/path/to/gcp/secret.json"
+# Or more specificly for Logging
+config.google_cloud.logging.project_id = "gcp-project-id"
+config.google_cloud.logging.keyfile = "/path/to/gcp/sercret.json"
+ 
+# Explicitly enable or disable Logging
+config.google_cloud.use_logging = true
+ 
+# Set Stackdriver Logging log name
+config.google_cloud.logging.log_name = "my-app-log"
+ 
+# Override default monitored resource if needed. E.g. used on AWS
+config.google_cloud.logging.monitored_resource.type = "aws_ec2_instance"
+config.google_cloud.logging.monitored_resource.labels.instance_id = "ec2-instance-id"
+config.google_cloud.logging.monitored_resource.labels.aws_account = "AWS account number"
+```
+Alternatively, check out [stackdriver](../stackdriver) gem, which includes this Railtie by default.
+
+## Rack Integration
+
+Other Rack base framework can also directly leverage the built-in Middleware.
+```ruby
+require "google/cloud/logging"
+
+logging = Google::Cloud::Logging.new
+resource = Google::Cloud::Logging::Middleware.build_monitored_resource
+logger = logging.logger "my-log-name",
+                        resource
+use Google::Cloud::Logging::Middleware, logger: logger
+```
+
+## Supported Ruby Versions
+
+This library is supported on Ruby 2.0+.
+
+## Versioning
+
+This library follows [Semantic Versioning](http://semver.org/).
+
+It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable.
+
+## Contributing
+
+Contributions to this library are always welcome and highly encouraged.
+
+See the [Contributing Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/contributing) for more information on how to get started.
+
+Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct](../CODE_OF_CONDUCT.md) for more information.
+
+## License
+
+This library is licensed under Apache 2.0. Full license text is available in [LICENSE](LICENSE).
+
+## Support
+
+Please [report bugs at the project on Github](https://github.com/GoogleCloudPlatform/google-cloud-ruby/issues).
+Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby) about the client or APIs on [StackOverflow](http://stackoverflow.com).

data/lib/google/cloud/logging.rb

@@ -45,7 +45,9 @@ module Google
     # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
     #
     # If you just want to write your application's logs to the Stackdriver
-    # Logging service, you may find it easiest to use the [Ruby Logger
+    # Logging service, you may find it easiest to use the [Stackdriver Logging
+    # Instrumentation](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/instrumentation)
+    # or the [Ruby Logger
     # implementation](#creating-a-ruby-logger-implementation) provided by this
     # library. Otherwise, read on to learn more about the Logging API.
     #

data/lib/google/cloud/logging/logger.rb

@@ -335,6 +335,7 @@ module Google
         # @private Write a log entry to the Stackdriver Logging service.
         def write_entry severity, message
           entry = Entry.new.tap do |e|
+            e.timestamp = Time.now
             e.severity = gcloud_severity(severity)
             e.payload = message
           end

data/lib/google/cloud/logging/middleware.rb

@@ -24,8 +24,7 @@ module Google
         ##
         # Create a new AppEngine logging Middleware.
         #
-        # @param app Rack application
-        #
+        # @param [Rack Application] app Rack application
         # @param [Google::Cloud::Logging::Logger] logger A logger to be used by
         #   this middleware. The middleware will be interacting with the logger
         #   to track Stackdriver request trace ID. It also properly sets
@@ -48,7 +47,7 @@ module Google
         #
         # @param [Hash] env Rack environment hash
         #
-        # @return The response from downstream Rack app
+        # @return [Rack::Response] The response from downstream Rack app
         #
         def call env
           env["rack.logger"] = logger
@@ -73,40 +72,94 @@ module Google
           trace_context.sub(%r{/.*}, "")
         end
 
+        ##
+        # Construct a monitored resource based on the given type and label if
+        # both are provided. Otherwise, construct a default monitored resource
+        # based on the current environment.
+        #
+        # @example If both type and labels are provided, it returns resource:
+        #   rc = Middleware.build_monitored_resource "aws_ec2_instance",
+        #                                            { instance_id: "ec2-id",
+        #                                              aws_account: "aws-id" }
+        #   rc.type   #=> "aws_ec2_instance"
+        #   rc.labels #=> { instance_id: "ec2-id", aws_account: "aws-id" }
+        #
+        # @example If running from GAE, returns default resource:
+        #   rc = Middleware.build_monitored_resource
+        #   rc.type   #=> "gae_app"
+        #   rc.labels #=> { module_id: [GAE module name],
+        #             #     version_id: [GAE module version] }
+        #
+        # @example If running from GKE, returns default resource:
+        #   rc = Middleware.build_monitored_resource
+        #   rc.type   #=> "container"
+        #   rc.labels #=> { cluster_name: [GKE cluster name],
+        #             #     namespace_id: [GKE namespace_id] }
+        #
+        # @example If running from GCE, return default resource:
+        #   rc = Middleware.build_monitored_resource
+        #   rc.type   #=> "gce_instance"
+        #   rc.labels #=> { instance_id: [GCE VM instance id],
+        #             #     zone: [GCE vm group zone] }
+        #
+        # @example Otherwise default to generic "global" type:
+        #   rc = Middleware.build_monitored_resource
+        #   rc.type   #=> "global"
+        #   rc.labels #=> {}
+        #
+        # Reference https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/MonitoredResource
+        # for a full list of monitoring resources
+        #
+        # @param [String] type Type of Google::Cloud::Logging::Resource
+        # @param [Hash<String, String>] labels Metadata lebels of
+        #   Google::Cloud::Logging::Resource
+        #
+        # @return [Google::Cloud::Logging::Resource] An Resource object with
+        #   type and labels
+        def self.build_monitored_resource type = nil, labels = nil
+          if type && labels
+            Google::Cloud::Logging::Resource.new.tap do |r|
+              r.type = type
+              r.labels = labels
+            end
+          else
+            default_monitored_resource
+          end
+        end
+
         ##
         # @private Extract information from current environment and construct
         # the correct monitoring resource types and labels.
         #
-        # If running from GAE, return resource:
-        # {
-        #   type: "gae_app", {
-        #     module_id: [GAE module name],
-        #     version_id: [GAE module version]
-        #   }
-        # }
-        # If running from GKE, return resource:
-        # {
-        #   type: "container", {
-        #     cluster_name: [GKE cluster name],
-        #     namespace_id: [GKE namespace_id]
-        #   }
-        # }
-        # If running from GCE, return resource:
-        # {
-        #   type: "gce_instance", {
-        #     instance_id: [GCE VM instance id],
-        #     zone: [GCE vm group zone]
-        #   }
-        # }
-        # Otherwise default to { type: "global" }, which means not associated
-        # with GCP.
+        # @example If running from GAE, returns default resource:
+        #   rc = Middleware.build_monitored_resource
+        #   rc.type   #=> "gae_app"
+        #   rc.labels #=> { module_id: [GAE module name],
+        #             #     version_id: [GAE module version] }
+        #
+        # @example If running from GKE, returns default resource:
+        #   rc = Middleware.build_monitored_resource
+        #   rc.type   #=> "container"
+        #   rc.labels #=> { cluster_name: [GKE cluster name],
+        #             #     namespace_id: [GKE namespace_id] }
+        #
+        # @example If running from GCE, return default resource:
+        #   rc = Middleware.build_monitored_resource
+        #   rc.type   #=> "gce_instance"
+        #   rc.labels #=> { instance_id: [GCE VM instance id],
+        #             #     zone: [GCE vm group zone] }
+        #
+        # @example Otherwise default to generic "global" type:
+        #   rc = Middleware.build_monitored_resource
+        #   rc.type   #=> "global"
+        #   rc.labels #=> {}
         #
         # Reference https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/MonitoredResource
         # for a full list of monitoring resources
         #
         # @return [Google::Cloud::Logging::Resource] An Resource object with
         #   correct type and labels
-        def self.build_monitoring_resource
+        def self.default_monitored_resource
           type, labels =
             if Core::Environment.gae?
               ["gae_app", {
@@ -129,6 +182,8 @@ module Google
             r.labels = labels
           end
         end
+
+        private_class_method :default_monitored_resource
       end
     end
   end