fluent-plugin-google-cloud 0.7.7 → 0.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 879269ac20c2d076425ee263549a1d607e77cbbac7d7d892c54c6ffa8afc2ca4
-  data.tar.gz: bbe85ed54dfd554340cdaef53d035dc03261cccef115beef817add71cc64ef55
+  metadata.gz: 11e7c3f24960a167f14a79ccd2c0252309edcea31cd16ad7f10fa19ebfe9d186
+  data.tar.gz: 7e5f63454446b63abb2b5052c61d2d6a05d9c0f4b5b365fa77cb7b09884aa9c6
 SHA512:
-  metadata.gz: db71bdb463dc4ca700c7f6d8a5f243ede666c408377cd5ee4468284d746a49d1ac7a1898ddc559ea288543c2546dc57eaba92cbb068e5c3aedb1a2cf58211783
-  data.tar.gz: 57c6b73189a5bed30a75993c9ed1cabc7f8100d667eafd5ea3a2cd626d980a3d3da01acb583e657c069d999a206d85f5ab6e30b543e14b4399ac01b092a7626f
+  metadata.gz: 2394c4f1c83bf050e5350878add926227554162d47a1d3223daf64535a676e67acd7a22c7c2276a2ff407d478957f59463d4c9b65085bc470fb04a2d9659f926
+  data.tar.gz: 44d03991a7175721775dfbaa7870ce33b3f4861e0f696c12ce946d829d28a7aef18fc5ace6b196a027dfe7e2225c696aea27cbc38d0b577d5511e6c611af803f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fluent-plugin-google-cloud (0.7.7)
+    fluent-plugin-google-cloud (0.7.8)
       fluentd (= 1.2.5)
       google-api-client (= 0.28.4)
       google-cloud-logging (= 1.6.0)
@@ -18,7 +18,7 @@ GEM
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
     concurrent-ruby (1.1.5)
-    cool.io (1.5.3)
+    cool.io (1.5.4)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     declarative (0.0.10)
@@ -66,7 +66,7 @@ GEM
       google-protobuf (~> 3.0)
       googleapis-common-protos-types (~> 1.0)
       grpc (~> 1.0)
-    googleapis-common-protos-types (1.0.3)
+    googleapis-common-protos-types (1.0.4)
       google-protobuf (~> 3.0)
     googleauth (0.6.6)
       faraday (~> 0.12)
@@ -87,7 +87,7 @@ GEM
     metaclass (0.0.4)
     mime-types (3.2.2)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2018.0812)
+    mime-types-data (3.2019.0331)
     mocha (1.8.0)
       metaclass (~> 0.0.1)
     msgpack (1.2.9)

data/fluent-plugin-google-cloud.gemspec

@@ -10,7 +10,7 @@ eos
   gem.homepage      =
     'https://github.com/GoogleCloudPlatform/fluent-plugin-google-cloud'
   gem.license       = 'Apache-2.0'
-  gem.version       = '0.7.7'
+  gem.version       = '0.7.8'
   gem.authors       = ['Stackdriver Agents Team']
   gem.email         = ['stackdriver-agents@google.com']
   gem.required_ruby_version = Gem::Requirement.new('>= 2.2')

data/lib/fluent/plugin/out_google_cloud.rb

@@ -11,6 +11,7 @@
 # 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.
+require 'cgi'
 require 'erb'
 require 'grpc'
 require 'json'
@@ -28,6 +29,7 @@ require 'google/logging/v2/log_entry_pb'
 require 'googleauth'
 
 require_relative 'monitoring'
+require_relative 'statusz'
 
 module Google
   module Protobuf
@@ -241,6 +243,8 @@ module Fluent
 
     Fluent::Plugin.register_output('google_cloud', self)
 
+    helpers :server
+
     PLUGIN_NAME = 'Fluentd Google Cloud Logging plugin'.freeze
 
     PLUGIN_VERSION = begin
@@ -441,6 +445,11 @@ module Fluent
     # LogEntry.trace.
     config_param :autoformat_stackdriver_trace, :bool, :default => true
 
+    # Port for web server that exposes a /statusz endpoint with
+    # diagnostic information in HTML format.  If the value is 0,
+    # the server is not created.
+    config_param :statusz_port, :integer, :default => 0
+
     # rubocop:enable Style/HashSyntax
 
     # TODO: Add a log_name config option rather than just using the tag?
@@ -594,6 +603,19 @@ module Fluent
       init_api_client
       @successful_call = false
       @timenanos_warning = false
+
+      if @statusz_port > 0
+        @log.info "Starting statusz server on port #{@statusz_port}"
+        server_create(:out_google_cloud_statusz,
+                      @statusz_port,
+                      bind: '127.0.0.1') do |data, conn|
+          if data.split(' ')[1] == '/statusz'
+            write_html_response(data, conn, 200, Statusz.response)
+          else
+            write_html_response(data, conn, 404, "Not found\n")
+          end
+        end
+      end
     end
 
     def shutdown
@@ -729,6 +751,17 @@ module Fluent
 
     private
 
+    def write_html_response(data, conn, code, response)
+      @log.info "#{conn.remote_host} - - " \
+                "#{Time.now.strftime('%d/%b/%Y:%H:%M:%S %z')} " \
+                "\"#{data.lines.first.strip}\" #{code} #{response.bytesize}"
+      conn.write "HTTP/1.1 #{code}\r\n"
+      conn.write "Content-Type: text/html\r\n"
+      conn.write "Content-Length: #{response.bytesize}\r\n"
+      conn.write "\r\n"
+      conn.write response
+    end
+
     def compute_trace(trace)
       return trace unless @autoformat_stackdriver_trace &&
                           STACKDRIVER_TRACE_ID_REGEXP.match(trace)

data/lib/fluent/plugin/statusz.rb

@@ -0,0 +1,31 @@
+# Copyright 2019 Google Inc. All rights reserved.
+#
+# 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.
+
+# Module for collecting diagnostic information and formatting it as an
+# HTML page to serve on the /statusz endpoint.
+module Statusz
+  module_function
+
+  def response
+    # TODO(davidbtucker): Add more status information here.
+    [
+      '<html>',
+      '<body>',
+      '<h1>Status</h1>',
+      "<b>Command-line flags:</b> #{CGI.escapeHTML(ARGV.join(' '))}",
+      '</body>',
+      '</html>'
+    ].join("\n") + "\n"
+  end
+end

data/test/plugin/constants.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 # Copyright 2017 Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/test/plugin/test_out_google_cloud.rb

@@ -12,12 +12,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'fluent/test/startup_shutdown'
+require 'net/http'
+
 require_relative 'base_test'
 require_relative 'test_driver'
 
 # Unit tests for Google Cloud Logging plugin
 class GoogleCloudOutputTest < Test::Unit::TestCase
   include BaseTest
+  extend Fluent::Test::StartupShutdown
 
   def test_configure_use_grpc
     setup_gce_metadata_stubs
@@ -330,6 +334,18 @@ class GoogleCloudOutputTest < Test::Unit::TestCase
     end
   end
 
+  def test_statusz_endpoint
+    setup_gce_metadata_stubs
+    WebMock.disable_net_connect!(allow_localhost: true)
+    # TODO(davidbtucker): Consider searching for an unused port
+    # instead of hardcoding a constant here.
+    d = create_driver('statusz_port 5678')
+    d.run do
+      assert_match Regexp.new('.*<h1>Status</h1>.*'),
+                   Net::HTTP.get('127.0.0.1', '/statusz', 5678)
+    end
+  end
+
   private
 
   WRITE_LOG_ENTRIES_URI =

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-google-cloud
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.7.8
 platform: ruby
 authors:
 - Stackdriver Agents Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-29 00:00:00.000000000 Z
+date: 2019-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -228,6 +228,7 @@ files:
 - lib/fluent/plugin/filter_add_insert_ids.rb
 - lib/fluent/plugin/monitoring.rb
 - lib/fluent/plugin/out_google_cloud.rb
+- lib/fluent/plugin/statusz.rb
 - test/helper.rb
 - test/plugin/base_test.rb
 - test/plugin/constants.rb