fluent-plugin-k8s-metrics 1.1.1

data/README.md

@@ -0,0 +1,126 @@
+[![CircleCI](https://circleci.com/gh/git-lfs/git-lfs.svg?style=shield&circle-token=856152c2b02bfd236f54d21e1f581f3e4ebf47ad)](https://circleci.com/gh/splunk/fluent-plugin-kubernetes-metrics)
+# Fluentd Plugin for Kubernetes Metrics
+
+The [Fluentd](https://fluentd.org/) input plugin collects Kubernetes cluster metrics which are exposed by the [Kubelet API](https://kubernetes.io/docs/admin/kubelet/) and forwards them to fluentd.
+The plugin collects metrics from:
+   * The kubelet summary API
+   * The kubelet stats API
+   * The cAdvisor metrics API
+
+The Fluentd input plugin can be configured to fetch metrics from the Kubernetes API server or from the Kubelet. 
+For more details on the specific metrics that are collected and aggregated with this plugin, please refer to the 
+[metrics information](https://github.com/splunk/fluent-plugin-kubernetes-metrics/blob/master/metrics-information.md) document.
+
+## Installation
+
+See: [Plugin Management](https://docs.fluentd.org/v1.0/articles/plugin-management).
+
+### RubyGems
+
+```
+$ gem install fluent-plugin-kubernetes-metrics
+```
+
+### Bundler
+
+Add the following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-kubernetes-metrics"
+```
+
+Then execute:
+
+```
+$ bundle
+```
+
+## Plugin helpers
+
+* [timer](https://docs.fluentd.org/v1.0/articles/api-plugin-helper-timer)
+
+* See also: [Input Plugin Overview](https://docs.fluentd.org/v1.0/articles/input-plugin-overview)
+
+## Fluent::Plugin::KubernetesMetricsInput
+
+### tag (string) (optional)
+
+The tag for the event.
+
+Default value: `kubernetes.metrics.*`.
+
+### interval (time) (optional)
+
+How often the plugin should pull metrcs.
+
+Default value: `15s`.
+
+### kubeconfig (string) (optional)
+
+Path to a kubeconfig file that points to a cluster from which the plugin should collect metrics. Mostly useful when running fluentd outside of the cluster. When `kubeconfig` is set, `kubernetes_url`, `client_cert`, `client_key`, `ca_file`, `insecure_ssl`, `bearer_token_file`, and `secret_dir` are ignored.
+
+### kubernetes_url (string) (optional)
+
+URL of the kubernetes API server.
+
+### client_cert (string) (optional)
+
+Path to the certificate file for this client.
+
+### client_key (string) (optional)
+
+Path to the private key file for this client.
+
+### ca_file (string) (optional)
+
+Path to the CA file.
+
+### insecure_ssl (bool) (optional)
+
+If `insecure_ssl` is set to `true`, apiserver's certificate is not verified.
+
+### bearer_token_file (string) (optional)
+
+Path to the file that contains the API token. The default value is the file "token" in `secret_dir`.
+
+### secret_dir (string) (optional)
+
+Path of the location where the pod's service account credentials are stored.
+
+Default value: `/var/run/secrets/kubernetes.io/serviceaccount`.
+
+### node_name (string) (required)
+
+The name of the node from which the plugin should collect metrics. This enables the plugin to fetch metrics from a kubelet API. Used only when the use_rest_client configuration parameter is enabled. 
+
+### node_names Array(string) (required)
+
+Array of the nodes from which the this plugin should collect metrics. This enables the plugin to fetch metrics from kubeapiserver. Used only when use_rest_client configuration parameter is not enabled. 
+
+### kubelet_address (string) (optional)
+
+The hostname or IP address that kubelet will use to connect to. If not supplied, status.hostIP of the node is used to fetch metrics from the Kubelet API (via the $KUBERNETES_NODE_IP environment variable).
+
+Default value: `"#{ENV['KUBERNETES_NODE_IP']}"`.
+
+### kubelet_port (integer) (optional)
+
+The port that kubelet is listening on.
+
+Default value: `10250`.
+
+### use_rest_client (bool) (optional)
+
+Enable to use the rest client to get the metrics from summary api on each kubelet.
+
+Default value: `true`.
+
+### use_rest_client_ssl (bool) (optional)
+
+Enable to use SSL for rest client.
+
+Default value: `true`.
+
+## License
+
+See [License](LICENSE).

data/Rakefile

@@ -0,0 +1,29 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+require 'rake/clean'
+
+CLEAN.concat FileList[
+  'docker/*.gem',
+  'pkg'
+]
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push('lib', 'test')
+  t.test_files = FileList['test/**/test_*.rb']
+  t.verbose = true
+  t.warning = false
+end
+
+task default: [:test]
+
+namespace :docker do
+  desc 'Build docker image'
+  task :build, [:tag] => :build do |_t, args|
+    raise 'Argument `tag` was not provided.' unless args.tag
+
+    cp Dir['pkg/fluent-plugin-kubernetes-metrics-*.gem'], 'docker/'
+    sh "docker build  --no-cache -t splunk/connect-for-kubernetes:#{args.tag} ./docker"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.1

data/docker/CONTRIBUTING.md

@@ -0,0 +1,20 @@
+CONTRIBUTING
+
+By submitting a Contribution to this Work, You agree that Your Contribution is made subject to the primary LICENSE 
+file applicable to this Work.  In addition, You represent that: (i) You are the copyright owner of the Contribution 
+or (ii) You have the requisite rights to make the Contribution.
+
+Definitions:
+
+“You” shall mean: (i) yourself if you are making a Contribution on your own behalf; or (ii) your company, 
+if you are making a Contribution on behalf of your company.  If you are making a Contribution on behalf of your 
+company, you represent that you have the requisite authority to do so.    
+ 
+"Contribution" shall mean any original work of authorship, including any modifications or additions to an existing 
+work, that is intentionally submitted by You for inclusion in, or documentation of, this project/repository.  For the 
+purposes of this definition, "submitted" means any form of electronic, verbal, or written communication submitted for 
+inclusion in this project/repository, 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 maintainers of 
+the project/repository. 
+
+“Work” shall mean the collective software, content, and documentation in this project/repository.

data/docker/Dockerfile

@@ -0,0 +1,52 @@
+FROM alpine:3.8
+
+LABEL maintainer="Splunk Inc. <DataEdge@splunk.com>"
+LABEL Description="Splunk Connect for Kubernetes docker image" Vendor="Splunk Inc."
+
+ARG VERSION
+ENV VERSION=${VERSION}
+
+ENV DUMB_INIT_VERSION=1.2.1
+ENV SU_EXEC_VERSION=0.2
+
+COPY *.gem /tmp/
+
+ARG DEBIAN_FRONTEND=noninteractive
+# Do not split this into multiple RUN!
+# Docker creates a layer for every RUN-Statement
+# therefore an 'apk delete' has no effect
+RUN apk update \
+ && apk upgrade \
+ && apk add --no-cache \
+        ca-certificates \
+ && update-ca-certificates \
+ && apk add --no-cache \
+        ruby ruby-irb ruby-etc ruby-webrick ruby-json \
+        su-exec==${SU_EXEC_VERSION}-r0 \
+        dumb-init==${DUMB_INIT_VERSION}-r0 \
+ && apk add --no-cache --virtual .build-deps \
+        build-base \
+        ruby-dev wget gnupg \
+ && echo 'gem: --no-document' >> /etc/gemrc \
+ && gem install -N \
+         fluentd:1.4.0 \
+         fluent-plugin-record-modifier:2.0.1 \
+         fluent-plugin-splunk-hec:${VERSION} \
+         oj:3.7.9 \
+         multi_json:1.13.1 \
+         bigdecimal:1.4.3 \
+         kubeclient:4.3.0 \
+ && gem install -N /tmp/*.gem \
+ && apk del .build-deps \
+ && rm -rf /var/cache/apk/* \
+ && rm -rf /tmp/* /var/tmp/* /usr/lib/ruby/gems/*/cache/*.gem
+
+ENV LD_PRELOAD="" \
+    FLUENTD_CONF="fluent.conf" \
+    FLUENTD_OPT="" \
+    DUMB_INIT_SETSID=0
+
+COPY entrypoint.sh /bin/entrypoint.sh
+ENTRYPOINT ["/bin/entrypoint.sh"]
+
+CMD exec fluentd -c /fluentd/etc/${FLUENTD_CONF} -p /fluentd/plugins $FLUENTD_OPT

data/docker/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 2018 Splunk 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.

data/docker/README.md

@@ -0,0 +1 @@
+# Docker Image for Splunk Connect for Kubernetes

data/docker/entrypoint.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/dumb-init /bin/sh
+
+uid=${FLUENT_UID:-1000}
+
+# check if a old fluent user exists and delete it
+cat /etc/passwd | grep fluent
+if [ $? -eq 0 ]; then
+    deluser fluent
+fi
+
+# (re)add the fluent user with $FLUENT_UID
+adduser -D -g '' -u ${uid} -h /home/fluent fluent
+
+#source vars if file exists
+DEFAULT=/etc/default/fluentd
+
+if [ -r $DEFAULT ]; then
+    set -o allexport
+    source $DEFAULT
+    set +o allexport
+fi
+
+# chown home and data folder
+chown -R fluent /home/fluent
+chown -R fluent /fluentd
+
+exec su-exec fluent "$@"