fluent-plugin-kubernetes_metadata_filter_v0.14 0.24.1

data/test/cassettes/valid_kubernetes_api_server.yml

@@ -0,0 +1,55 @@
+#
+# Fluentd Kubernetes Metadata Filter Plugin - Enrich Fluentd events with
+# Kubernetes metadata
+#
+# Copyright 2015 Red Hat, Inc.
+#
+# 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.
+#
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://localhost:8443/api
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Fri, 08 May 2015 10:13:54 GMT
+      Content-Length:
+      - '67'
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "versions": [
+            "v1"
+          ]
+        }
+    http_version: 
+  recorded_at: Fri, 08 May 2015 10:13:54 GMT
+recorded_with: VCR 2.9.3

data/test/helper.rb

@@ -0,0 +1,63 @@
+#
+# Fluentd Kubernetes Metadata Filter Plugin - Enrich Fluentd events with
+# Kubernetes metadata
+#
+# Copyright 2015 Red Hat, Inc.
+#
+# 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.
+#
+require 'codeclimate-test-reporter'
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter.new [
+    SimpleCov::Formatter::HTMLFormatter,
+    CodeClimate::TestReporter::Formatter
+  ]
+end
+
+require 'rr'
+require 'test/unit'
+require 'test/unit/rr'
+require 'fileutils'
+require 'fluent/log'
+require 'fluent/test'
+require 'webmock/test_unit'
+require 'vcr'
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'test/cassettes'
+  config.hook_into :webmock # or :fakeweb
+  config.ignore_hosts 'codeclimate.com'
+end
+
+unless defined?(Test::Unit::AssertionFailedError)
+  class Test::Unit::AssertionFailedError < StandardError
+  end
+end
+
+def unused_port
+  s = TCPServer.open(0)
+  port = s.addr[1]
+  s.close
+  port
+end
+
+def ipv6_enabled?
+  require 'socket'
+
+  begin
+    TCPServer.open('::1', 0)
+    true
+  rescue
+    false
+  end
+end

data/test/plugin/test.token

@@ -0,0 +1 @@
+12345

data/test/plugin/test_filter_kubernetes_metadata.rb

@@ -0,0 +1,537 @@
+#
+# Fluentd Kubernetes Metadata Filter Plugin - Enrich Fluentd events with
+# Kubernetes metadata
+#
+# Copyright 2015 Red Hat, Inc.
+#
+# 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.
+#
+require_relative '../helper'
+require 'fluent/plugin/filter_kubernetes_metadata'
+
+require 'webmock/test_unit'
+WebMock.disable_net_connect!
+
+class KubernetesMetadataFilterTest < Test::Unit::TestCase
+  include Fluent
+
+  setup do
+    Fluent::Test.setup
+    @time = Fluent::Engine.now
+  end
+
+  def create_driver(conf = '')
+    Test::FilterTestDriver.new(KubernetesMetadataFilter, 'var.log.containers.fabric8-console-controller-98rqc_default_fabric8-console-container-49095a2894da899d3b327c5fde1e056a81376cc9a8f8b09a195f2a92bceed459.log').configure(conf, true)
+  end
+
+  sub_test_case 'configure' do
+    test 'check default' do
+      d = create_driver
+      assert_equal(1000, d.instance.cache_size)
+    end
+
+    test 'kubernetes url' do
+      VCR.use_cassette('valid_kubernetes_api_server') do
+        d = create_driver('
+          kubernetes_url https://localhost:8443
+          watch false
+        ')
+        assert_equal('https://localhost:8443', d.instance.kubernetes_url)
+        assert_equal(1000, d.instance.cache_size)
+      end
+    end
+
+    test 'cache size' do
+      VCR.use_cassette('valid_kubernetes_api_server') do
+        d = create_driver('
+          kubernetes_url https://localhost:8443
+          watch false
+          cache_size 1
+        ')
+        assert_equal('https://localhost:8443', d.instance.kubernetes_url)
+        assert_equal(1, d.instance.cache_size)
+      end
+    end
+
+    test 'invalid API server config' do
+      VCR.use_cassette('invalid_api_server_config') do
+        assert_raise Fluent::ConfigError do
+          create_driver('
+            kubernetes_url https://localhost:8443
+            bearer_token_file test/plugin/test.token
+            watch false
+            verify_ssl false
+          ')
+        end
+      end
+    end
+
+    test 'service account credentials' do
+      VCR.use_cassette('valid_kubernetes_api_server') do
+        begin
+          ENV['KUBERNETES_SERVICE_HOST'] = 'localhost'
+          ENV['KUBERNETES_SERVICE_PORT'] = '8443'
+
+          Dir.mktmpdir { |dir|
+            # Fake token file and CA crt.
+            expected_cert_path = File.join(dir, KubernetesMetadataFilter::K8_POD_CA_CERT)
+            expected_token_path = File.join(dir, KubernetesMetadataFilter::K8_POD_TOKEN)
+
+            File.open(expected_cert_path, "w") {}
+            File.open(expected_token_path, "w") {}
+
+            d = create_driver("
+              watch false
+              secret_dir #{dir}
+            ")
+
+            assert_equal(d.instance.kubernetes_url, "https://localhost:8443/api")
+            assert_equal(d.instance.ca_file, expected_cert_path)
+            assert_equal(d.instance.bearer_token_file, expected_token_path)
+          }
+        ensure
+          ENV['KUBERNETES_SERVICE_HOST'] = nil
+          ENV['KUBERNETES_SERVICE_PORT'] = nil
+        end
+      end
+    end
+
+    test 'service account credential files are tested for existence' do
+      VCR.use_cassette('valid_kubernetes_api_server') do
+        begin
+          ENV['KUBERNETES_SERVICE_HOST'] = 'localhost'
+          ENV['KUBERNETES_SERVICE_PORT'] = '8443'
+
+          Dir.mktmpdir { |dir|
+            d = create_driver("
+              watch false
+              secret_dir #{dir}
+            ")
+            assert_equal(d.instance.kubernetes_url, "https://localhost:8443/api")
+            assert_false(d.instance.ca_file.present?)
+            assert_false(d.instance.bearer_token_file.present?)
+          }
+        ensure
+          ENV['KUBERNETES_SERVICE_HOST'] = nil
+          ENV['KUBERNETES_SERVICE_PORT'] = nil
+        end
+      end
+    end
+  end
+
+  sub_test_case 'filter_stream' do
+
+    def emit(msg={}, config='
+          kubernetes_url https://localhost:8443
+          watch false
+          cache_size 1
+        ')
+      d = create_driver(config)
+      d.run {
+        d.emit(msg, @time)
+      }.filtered
+    end
+
+    def emit_with_tag(tag, msg={}, config='
+          kubernetes_url https://localhost:8443
+          watch false
+          cache_size 1
+        ')
+      d = create_driver(config)
+      d.run {
+        d.emit_with_tag(tag, msg, @time)
+      }.filtered
+    end
+
+    test 'with docker & kubernetes metadata' do
+      VCR.use_cassette('kubernetes_docker_metadata') do
+        es = emit()
+        expected_kube_metadata = {
+          'docker' => {
+              'container_id' => '49095a2894da899d3b327c5fde1e056a81376cc9a8f8b09a195f2a92bceed459'
+          },
+          'kubernetes' => {
+            'host'           => 'jimmi-redhat.localnet',
+            'pod_name'       => 'fabric8-console-controller-98rqc',
+            'container_name' => 'fabric8-console-container',
+            'namespace_name' => 'default',
+            'pod_id'         => 'c76927af-f563-11e4-b32d-54ee7527188d',
+            'labels' => {
+              'component' => 'fabric8Console'
+            }
+          }
+        }
+        assert_equal(expected_kube_metadata, es.instance_variable_get(:@record_array)[0])
+      end
+    end
+
+    test 'with docker & kubernetes metadata & namespace_id enabled' do
+      VCR.use_cassette('metadata_with_namespace_id') do
+        es = emit({}, '
+          kubernetes_url https://localhost:8443
+          watch false
+          cache_size 1
+          include_namespace_id true
+        ')
+        expected_kube_metadata = {
+          'docker' => {
+              'container_id' => '49095a2894da899d3b327c5fde1e056a81376cc9a8f8b09a195f2a92bceed459'
+          },
+          'kubernetes' => {
+            'host'           => 'jimmi-redhat.localnet',
+            'pod_name'       => 'fabric8-console-controller-98rqc',
+            'container_name' => 'fabric8-console-container',
+            'namespace_name' => 'default',
+            'namespace_id'   => '898268c8-4a36-11e5-9d81-42010af0194c',
+            'pod_id'         => 'c76927af-f563-11e4-b32d-54ee7527188d',
+            'labels' => {
+              'component' => 'fabric8Console'
+            }
+          }
+        }
+        assert_equal(expected_kube_metadata, es.instance_variable_get(:@record_array)[0])
+      end
+    end
+
+    test 'with docker & kubernetes metadata using bearer token' do
+      VCR.use_cassette('kubernetes_docker_metadata_using_bearer_token') do
+        es = emit({}, '
+          kubernetes_url https://localhost:8443
+          verify_ssl false
+          watch false
+          bearer_token_file test/plugin/test.token
+        ')
+        expected_kube_metadata = {
+          'docker' => {
+            'container_id' => '49095a2894da899d3b327c5fde1e056a81376cc9a8f8b09a195f2a92bceed459'
+          },
+          'kubernetes' => {
+            'host'           => 'jimmi-redhat.localnet',
+            'pod_name'       => 'fabric8-console-controller-98rqc',
+            'container_name' => 'fabric8-console-container',
+            'namespace_name' => 'default',
+            'pod_id'         => 'c76927af-f563-11e4-b32d-54ee7527188d',
+            'labels' => {
+              'component' => 'fabric8Console'
+            }
+          }
+        }
+        assert_equal(expected_kube_metadata, es.instance_variable_get(:@record_array)[0])
+      end
+    end
+
+    test 'with docker & kubernetes metadata but no configured api server' do
+      es = emit({}, '')
+      expected_kube_metadata = {
+          'docker' => {
+              'container_id' => '49095a2894da899d3b327c5fde1e056a81376cc9a8f8b09a195f2a92bceed459'
+          },
+          'kubernetes' => {
+              'pod_name'       => 'fabric8-console-controller-98rqc',
+              'container_name' => 'fabric8-console-container',
+              'namespace_name' => 'default',
+          }
+      }
+      assert_equal(expected_kube_metadata, es.instance_variable_get(:@record_array)[0])
+    end
+
+    test 'with docker & inaccessible kubernetes metadata' do
+      stub_request(:any, 'https://localhost:8443/api').to_return(
+        'body' => {
+          'versions' => ['v1beta3', 'v1']
+        }.to_json
+      )
+      stub_request(:any, 'https://localhost:8443/api/v1/namespaces/default/pods/fabric8-console-controller-98rqc').to_timeout
+      es = emit()
+      expected_kube_metadata = {
+        'docker' => {
+          'container_id' => '49095a2894da899d3b327c5fde1e056a81376cc9a8f8b09a195f2a92bceed459'
+        },
+        'kubernetes' => {
+          'pod_name'       => 'fabric8-console-controller-98rqc',
+          'container_name' => 'fabric8-console-container',
+          'namespace_name' => 'default'
+        }
+      }
+      assert_equal(expected_kube_metadata, es.instance_variable_get(:@record_array)[0])
+    end
+
+    test 'with dot in pod name' do
+      stub_request(:any, 'https://localhost:8443/api').to_return(
+        'body' => {
+          'versions' => ['v1beta3', 'v1']
+        }.to_json
+      )
+      stub_request(:any, 'https://localhost:8443/api/v1/namespaces/default/pods/fabric8-console-controller.98rqc').to_timeout
+      es = emit_with_tag('var.log.containers.fabric8-console-controller.98rqc_default_fabric8-console-container-49095a2894da899d3b327c5fde1e056a81376cc9a8f8b09a195f2a92bceed459.log', {}, '')
+      expected_kube_metadata = {
+        'docker' => {
+          'container_id' => '49095a2894da899d3b327c5fde1e056a81376cc9a8f8b09a195f2a92bceed459'
+        },
+        'kubernetes' => {
+          'pod_name'       => 'fabric8-console-controller.98rqc',
+          'container_name' => 'fabric8-console-container',
+          'namespace_name' => 'default'
+        }
+      }
+      assert_equal(expected_kube_metadata, es.instance_variable_get(:@record_array)[0])
+    end
+
+    test 'with docker metadata, non-kubernetes' do
+      es = emit_with_tag('non-kubernetes', {}, '')
+      assert_false(es.instance_variable_get(:@record_array)[0].has_key?(:kubernetes))
+    end
+
+    test 'merges json log data' do
+      json_log = {
+        'hello' => 'world'
+      }
+      msg = {
+        'log' => "#{json_log.to_json}"
+      }
+      es = emit_with_tag('non-kubernetes', msg, '')
+      assert_equal(msg.merge(json_log), es.instance_variable_get(:@record_array)[0])
+    end
+
+    test 'merges json log data in MESSAGE' do
+      json_log = {
+        'hello' => 'world'
+      }
+      msg = {
+        'MESSAGE' => "#{json_log.to_json}"
+      }
+      es = emit_with_tag('non-kubernetes', msg, 'use_journal true')
+      assert_equal(msg.merge(json_log), es.instance_variable_get(:@record_array)[0])
+    end
+
+    test 'merges json log data with message field' do
+      json_log = {
+        'timeMillis' => 1459853347608,
+        'thread' => 'main',
+        'level' => 'INFO',
+        'loggerName' => 'org.apache.camel.spring.SpringCamelContext',
+        'message' => 'Total 1 routes, of which 1 is started.',
+        'endOfBatch' => false,
+        'loggerFqcn' => 'org.apache.logging.slf4j.Log4jLogger'
+      }
+      msg = {
+        'log' => "#{json_log.to_json}"
+      }
+      es = emit_with_tag('non-kubernetes', msg, '')
+      assert_equal(msg.merge(json_log), es.instance_variable_get(:@record_array)[0])
+    end
+
+    test 'merges json log data with message field in MESSAGE' do
+      json_log = {
+        'timeMillis' => 1459853347608,
+        'thread' => 'main',
+        'level' => 'INFO',
+        'loggerName' => 'org.apache.camel.spring.SpringCamelContext',
+        'message' => 'Total 1 routes, of which 1 is started.',
+        'endOfBatch' => false,
+        'loggerFqcn' => 'org.apache.logging.slf4j.Log4jLogger'
+      }
+      msg = {
+        'MESSAGE' => "#{json_log.to_json}"
+      }
+      es = emit_with_tag('non-kubernetes', msg, 'use_journal true')
+      assert_equal(msg.merge(json_log), es.instance_variable_get(:@record_array)[0])
+    end
+
+    test 'emit individual fields from json, throw out whole original string' do
+      json_log = {
+        'hello' => 'world',
+        'more' => 'data'
+      }
+      msg = {
+        'log' => "#{json_log.to_json}"
+      }
+      es = emit_with_tag('non-kubernetes', msg, 'preserve_json_log false')
+      assert_equal(json_log, es.instance_variable_get(:@record_array)[0])
+    end
+
+    test 'emit individual fields from json, throw out whole original string in MESSAGE' do
+      json_log = {
+        'hello' => 'world',
+        'more' => 'data'
+      }
+      msg = {
+        'MESSAGE' => "#{json_log.to_json}"
+      }
+      es = emit_with_tag('non-kubernetes', msg, '
+preserve_json_log false
+use_journal true
+')
+      assert_equal(json_log, es.instance_variable_get(:@record_array)[0])
+    end
+
+    test 'with kubernetes dotted labels, de_dot enabled' do
+      VCR.use_cassette('kubernetes_docker_metadata_dotted_labels') do
+        es = emit()
+        expected_kube_metadata = {
+          'docker' => {
+              'container_id' => '49095a2894da899d3b327c5fde1e056a81376cc9a8f8b09a195f2a92bceed459'
+          },
+          'kubernetes' => {
+            'host'           => 'jimmi-redhat.localnet',
+            'pod_name'       => 'fabric8-console-controller-98rqc',
+            'container_name' => 'fabric8-console-container',
+            'namespace_name' => 'default',
+            'pod_id'         => 'c76927af-f563-11e4-b32d-54ee7527188d',
+            'labels' => {
+              'kubernetes_io/test' => 'somevalue'
+            }
+          }
+        }
+        assert_equal(expected_kube_metadata, es.instance_variable_get(:@record_array)[0])
+      end
+    end
+
+    test 'with kubernetes dotted labels, de_dot disabled' do
+      VCR.use_cassette('kubernetes_docker_metadata_dotted_labels') do
+        es = emit({}, '
+          kubernetes_url https://localhost:8443
+          watch false
+          cache_size 1
+          de_dot false
+        ')
+        expected_kube_metadata = {
+          'docker' => {
+              'container_id' => '49095a2894da899d3b327c5fde1e056a81376cc9a8f8b09a195f2a92bceed459'
+          },
+          'kubernetes' => {
+            'host'           => 'jimmi-redhat.localnet',
+            'pod_name'       => 'fabric8-console-controller-98rqc',
+            'container_name' => 'fabric8-console-container',
+            'namespace_name' => 'default',
+            'pod_id'         => 'c76927af-f563-11e4-b32d-54ee7527188d',
+            'labels' => {
+              'kubernetes.io/test' => 'somevalue'
+            }
+          }
+        }
+        assert_equal(expected_kube_metadata, es.instance_variable_get(:@record_array)[0])
+      end
+    end
+
+    test 'invalid de_dot_separator config' do
+      assert_raise Fluent::ConfigError do
+        create_driver('
+          de_dot_separator contains.
+        ')
+      end
+    end
+
+    test 'with records from journald and docker & kubernetes metadata' do
+      # with use_journal true should ignore tags and use CONTAINER_NAME and CONTAINER_ID_FULL
+      tag = 'var.log.containers.junk1_junk2_junk3-49095a2894da899d3b327c5fde1e056a81376cc9a8f8b09a195f2a92bceed450.log'
+      msg = {
+        'CONTAINER_NAME' => 'k8s_fabric8-console-container.db89db89_fabric8-console-controller-98rqc_default_c76927af-f563-11e4-b32d-54ee7527188d_89db89db',
+        'CONTAINER_ID_FULL' => '49095a2894da899d3b327c5fde1e056a81376cc9a8f8b09a195f2a92bceed459',
+        'randomfield' => 'randomvalue'
+      }
+      VCR.use_cassette('kubernetes_docker_metadata') do
+        es = emit_with_tag(tag, msg, '
+          kubernetes_url https://localhost:8443
+          watch false
+          cache_size 1
+          use_journal true
+        ')
+        expected_kube_metadata = {
+          'docker' => {
+              'container_id' => '49095a2894da899d3b327c5fde1e056a81376cc9a8f8b09a195f2a92bceed459'
+          },
+          'kubernetes' => {
+            'host'           => 'jimmi-redhat.localnet',
+            'pod_name'       => 'fabric8-console-controller-98rqc',
+            'container_name' => 'fabric8-console-container',
+            'namespace_name' => 'default',
+            'pod_id'         => 'c76927af-f563-11e4-b32d-54ee7527188d',
+            'labels' => {
+              'component' => 'fabric8Console'
+            }
+          }
+        }.merge(msg)
+        assert_equal(expected_kube_metadata, es.instance_variable_get(:@record_array)[0])
+      end
+    end
+
+    test 'with records from journald and docker & kubernetes metadata & namespace_id enabled' do
+      # with use_journal true should ignore tags and use CONTAINER_NAME and CONTAINER_ID_FULL
+      tag = 'var.log.containers.junk1_junk2_junk3-49095a2894da899d3b327c5fde1e056a81376cc9a8f8b09a195f2a92bceed450.log'
+      msg = {
+        'CONTAINER_NAME' => 'k8s_fabric8-console-container.db89db89_fabric8-console-controller-98rqc_default_c76927af-f563-11e4-b32d-54ee7527188d_89db89db',
+        'CONTAINER_ID_FULL' => '49095a2894da899d3b327c5fde1e056a81376cc9a8f8b09a195f2a92bceed459',
+        'randomfield' => 'randomvalue'
+      }
+      VCR.use_cassette('metadata_with_namespace_id') do
+        es = emit_with_tag(tag, msg, '
+          kubernetes_url https://localhost:8443
+          watch false
+          cache_size 1
+          include_namespace_id true
+          use_journal true
+        ')
+        expected_kube_metadata = {
+          'docker' => {
+              'container_id' => '49095a2894da899d3b327c5fde1e056a81376cc9a8f8b09a195f2a92bceed459'
+          },
+          'kubernetes' => {
+            'host'           => 'jimmi-redhat.localnet',
+            'pod_name'       => 'fabric8-console-controller-98rqc',
+            'container_name' => 'fabric8-console-container',
+            'namespace_name' => 'default',
+            'namespace_id'   => '898268c8-4a36-11e5-9d81-42010af0194c',
+            'pod_id'         => 'c76927af-f563-11e4-b32d-54ee7527188d',
+            'labels' => {
+              'component' => 'fabric8Console'
+            }
+          }
+        }.merge(msg)
+        assert_equal(expected_kube_metadata, es.instance_variable_get(:@record_array)[0])
+      end
+    end
+
+    test 'with kubernetes annotations' do
+      VCR.use_cassette('kubernetes_docker_metadata_annotations') do
+        es = emit({},'
+          kubernetes_url https://localhost:8443
+          watch false
+          cache_size 1
+          annotation_match [ "^custom.+", "two"]
+        ')
+        expected_kube_metadata = {
+            'docker' => {
+                'container_id' => '49095a2894da899d3b327c5fde1e056a81376cc9a8f8b09a195f2a92bceed459'
+            },
+            'kubernetes' => {
+                'host'           => 'jimmi-redhat.localnet',
+                'pod_name'       => 'fabric8-console-controller-98rqc',
+                'container_name' => 'fabric8-console-container',
+                'namespace_name' => 'default',
+                'pod_id'         => 'c76927af-f563-11e4-b32d-54ee7527188d',
+                'labels'         => {
+                    'component' => 'fabric8Console'
+                },
+                'annotations'    => {
+                    'custom.field1' => 'hello_kitty',
+                    'field.two' => 'value'
+                }
+            }
+        }
+        assert_equal(expected_kube_metadata, es.instance_variable_get(:@record_array)[0])
+      end
+    end
+
+  end
+end