fluent-plugin-windows-exporter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c6b4018dcfba002d79792ed6643624955c803a439c84e445152ba5fe339cf4c
+  data.tar.gz: 0205e2d822b2f99e349937c80849e498f6b95be81ae273d9a361149e6efdd6ff
+SHA512:
+  metadata.gz: dfc5bafe8fed502ba88b190e5eb9c44bab7b1f2d6768483a07f28785d5e5b5421e150f85b6315260cc0e16a1eb255e0e1191875bc4f0cd516382fa13a212f5b4
+  data.tar.gz: ee382c808cde7c415cb1fbaaa2aa3406a7a3a80ab436de35017a548eb34d3cbeb5da716e86c759d7c503f747f8b84eb1c2891f9ce8dbe5e9c55b77c7476b8c71

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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,77 @@
+# fluent-plugin-windows-exporter
+
+[Fluentd](https://fluentd.org/) plugin to collect Windows metrics.
+
+ | Platform | Support Version       |
+ | -------- | --------------------- |
+ | Fluentd  | Fluentd v1.x          |
+ | OS       | Windows Server 2008R2 or later |
+
+This is a Fluentd port of [Prometheus' Windows exporter](https://github.com/prometheus-community/windows_exporter).
+This plugin emits metrics as event stream, so can be used in combination with any output plugins.
+
+## Installation
+
+```sh
+% gem install fluent-plugin-windows-exporter
+```
+
+## Configuration
+
+### List of Options
+
+| Option           | Description              | Default           |
+| ---------------- | ------------------------ | ----------------- |
+| `tag`            | Tag of the output events | `windows.metrics` |
+| `scrape_interval`| The interval time between data collection | `60` |
+| `cpu`            | Enable cpu collector     | `true` |
+| `logical_disk`   | Enable disk collector    | `true` |
+| `memory`         | Enable memory collector  | `true` |
+| `net`            | Enable network collector | `true` |
+| `os`             | Enable OS collector      | `true` |
+
+### Example Configuration
+
+```
+<source>
+  @type windows_exporter
+  tag windows.metrics  # optional
+  scrape_interval 60   # optional
+  cpu true             # optional
+  memory true          # optional
+  os trues             # optional
+  net true             # optional
+  logical_disk true    # optional
+</source>
+```
+
+### Output format
+
+This plugin is desinged to export the equivalent amount of information with Prometheus.
+Here is what a typical event looks like:
+
+```ruby
+{
+    "type": "gauge",
+    "name": "windows_memory_system_code_resident_bytes",
+    "desc": "(SystemCodeResidentBytes)",
+    "labels": {},
+    "value": 8192
+}
+```
+
+This is equivalent to the following exposition of Prometheus's Windows exporter:
+
+```
+# HELP windows_memory_system_code_resident_bytes (SystemCodeResidentBytes)
+# TYPE windows_memory_system_code_resident_bytes gauge
+windows_memory_system_code_resident_bytes 8192
+```
+
+For further details, please refer to [Prometheus' exposition format specification](https://github.com/prometheus/docs/blob/main/content/docs/instrumenting/exposition_formats.md).
+
+## Copyright
+
+* Copyright(c) 2021- Fujimoto Seiji, Fukuda Daijiro
+* License
+  * Apache License, Version 2.0

data/lib/fluent/plugin/hkey_perf_data_converted_type.rb

@@ -0,0 +1,148 @@
+#
+# Copyright 2021- Fujimoto Seiji, Fukuda Daijiro
+#
+# 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 "hkey_perf_data_raw_type"
+
+module HKeyPerfDataReader::ConvertedType
+  class PerfDataBlock
+    attr_reader :signature
+    attr_reader :version
+    attr_reader :revision
+    attr_reader :totalByteLength
+    attr_reader :headerLength
+    attr_reader :numObjectTypes
+
+    def initialize(raw_perf_data_block)
+      @signature = raw_perf_data_block.signature.pack("c*")
+      @version = raw_perf_data_block.version
+      @revision = raw_perf_data_block.revision
+      @totalByteLength = raw_perf_data_block.totalByteLength
+      @headerLength = raw_perf_data_block.headerLength
+      @numObjectTypes = raw_perf_data_block.numObjectTypes
+    end
+  end
+
+  class PerfObject
+    attr_reader :name
+    attr_reader :instances
+    attr_reader :counter_defs
+    attr_reader :perf_freq
+
+    def initialize(name, object_type)
+      @name = name
+      @instances = []
+      @counter_defs = []
+      @perf_freq = object_type.perfFreq
+    end
+
+    def instance_names
+      @instances.map { |i| i.name }
+    end
+
+    def add_counter_def(counter_def)
+      @counter_defs.append(counter_def)
+    end
+
+    def add_instance(perf_instance)
+      @instances.append(perf_instance)
+    end
+  end
+
+  class PerfCounterDef
+    attr_reader :name
+    attr_reader :counter_offset
+    attr_reader :counter_size
+    attr_reader :counter_type
+
+    # https://github.com/Kochise/Picat-win32/blob/master/emu/windows/winperf.h
+    PERF_COUNTER_BASE = 0x30000
+    PERF_TIMER_100NS = 0x100000
+
+    def initialize(name, raw_counter_def)
+      @name = name
+      @counter_offset = raw_counter_def.counterOffset
+      @counter_size = raw_counter_def.counterSize
+      @counter_type = raw_counter_def.counterType
+    end
+
+    def is_base
+      # https://github.com/leoluk/perflib_exporter/blob/master/perflib/perflib.go
+      is_base_counter && !is_nano_second_counter
+    end
+
+    def is_base_counter
+      # https://github.com/leoluk/perflib_exporter/blob/master/perflib/perflib.go
+      (@counter_type & PERF_COUNTER_BASE) == PERF_COUNTER_BASE
+    end
+
+    def is_nano_second_counter
+      # https://github.com/leoluk/perflib_exporter/blob/master/perflib/perflib.go
+      (@counter_type & PERF_TIMER_100NS) == PERF_TIMER_100NS
+    end
+  end
+
+  class PerfCounter
+    attr_reader :name
+    attr_reader :type
+    attr_accessor :value
+    attr_accessor :base_value
+
+    def initialize(counter_def)
+      # https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2003/cc785636(v=ws.10)
+      # https://docs.microsoft.com/en-us/dotnet/api/system.diagnostics.performancecountertype
+
+      @name = counter_def.name
+      @type = counter_def.counter_type
+
+      # Raw value, which has not been calculated according to the counter type
+      @value = 0
+
+      # For example, a value of counter type: `RawBase`
+      @base_value = 0
+    end
+  end
+
+  class NullPerfCounter < PerfCounter
+    def initialize()
+      @name = nil
+      @type = 0
+      @value = 0
+      @base_value = 0
+    end
+  end
+
+  class PerfInstance
+    attr_reader :name
+    attr_reader :counters
+
+    def initialize(name)
+      @name = name
+      @counters = {}
+      @counters.default = NullPerfCounter.new()
+    end
+
+    def add_counter(counter_def, value)
+      unless @counters.key?(counter_def.name)
+        @counters[counter_def.name] = PerfCounter.new(counter_def)
+      end
+
+      if counter_def.is_base
+        @counters[counter_def.name].base_value = value
+      else
+        @counters[counter_def.name].value = value
+      end
+    end
+  end
+end

data/lib/fluent/plugin/hkey_perf_data_raw_type.rb

@@ -0,0 +1,143 @@
+#
+# Copyright 2021- Fujimoto Seiji, Fukuda Daijiro
+#
+# 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 "bindata"
+
+module HKeyPerfDataReader
+  module RawType
+    # https://docs.microsoft.com/en-us/windows/win32/api/winperf/ns-winperf-perf_data_block
+    class PerfDataBlock < BinData::Record
+      endian :big_and_little
+      array :signature, :type => :uint16, :initial_length => 4
+      uint32 :littleEndian
+      uint32 :version
+      uint32 :revision
+      uint32 :totalByteLength
+      uint32 :headerLength
+      uint32 :numObjectTypes
+      int32 :defaultObject
+      # If the following values are needed, we have to handle win32-SYSTEMTIME in ruby.
+      # SYSTEMTIME :systemTime
+      # int64 :perfTime
+      # int64 :perfFreq
+      # int64 :perfTime100nSec
+      # uint32 :systemNameLength
+      # uint32 :systemNameOffset
+    end
+
+    # https://docs.microsoft.com/en-us/windows/win32/api/winperf/ns-winperf-perf_object_type
+    class PerfObjectType < BinData::Record
+      endian :big_and_little
+      uint32 :totalByteLength
+      uint32 :definitionLength
+      uint32 :headerLength
+      uint32 :objectNameTitleIndex
+      uint32 :objectNameTitle
+      uint32 :objectHelpTitleIndex
+      uint32 :objectHelpTitle
+      uint32 :detailLevel
+      uint32 :numCounters
+      int32 :defaultCounter
+      int32 :numInstances
+      uint32 :codePage
+      int64 :perfTime
+      int64 :perfFreq
+    end
+
+    # https://docs.microsoft.com/en-us/windows/win32/api/winperf/ns-winperf-perf_counter_definition
+    class PerfCounterDefinition < BinData::Record
+      endian :big_and_little
+      uint32 :byteLength
+      uint32 :counterNameTitleIndex
+      uint32 :counterNameTitle
+      uint32 :counterHelpTitleIndex
+      uint32 :counterHelpTitle
+      int32 :defaultScale
+      uint32 :detailLevel
+      uint32 :counterType
+      uint32 :counterSize
+      uint32 :counterOffset
+    end
+
+    # https://docs.microsoft.com/en-us/windows/win32/api/winperf/ns-winperf-perf_counter_block
+    class PerfCounterBlock < BinData::Record
+      endian :big_and_little
+      uint32 :byteLength
+    end
+
+    # https://docs.microsoft.com/en-us/windows/win32/api/winperf/ns-winperf-perf_instance_definition
+    class PerfInstanceDefinition < BinData::Record
+      endian :big_and_little
+      uint32 :byteLength
+      uint32 :parentObjectTitleIndex
+      uint32 :parentObjectInstance
+      uint32 :uniqueID
+      uint32 :nameOffset
+      uint32 :nameLength
+    end
+  end
+
+  class BinaryParser
+    include RawType
+
+    def initialize(is_little_endian: true)
+      @is_little_endian = is_little_endian
+
+      # In order to speed up the parsing, initialize each bindata first.
+      # https://github.com/dmendel/bindata/wiki/FAQ#how-do-i-speed-up-initialization
+      @data_block = PerfDataBlock.new(:endian => endian)
+      @object_type = PerfObjectType.new(:endian => endian)
+      @counter_definition = PerfCounterDefinition.new(:endian => endian)
+      @counter_block = PerfCounterBlock.new(:endian => endian)
+      @instance_definition = PerfInstanceDefinition.new(:endian => endian)
+    end
+
+    def parse_data_block(data)
+      result = @data_block.read(data).snapshot
+      @data_block.clear
+      result
+    end
+
+    def parse_object_type(data)
+      result = @object_type.read(data).snapshot
+      @object_type.clear
+      result
+    end
+
+    def parse_counter_definition(data)
+      result = @counter_definition.read(data).snapshot
+      @counter_definition.clear
+      result
+    end
+
+    def parse_counter_block(data)
+      result = @counter_block.read(data).snapshot
+      @counter_block.clear
+      result
+    end
+
+    def parse_instance_definition(data)
+      result = @instance_definition.read(data).snapshot
+      @instance_definition.clear
+      result
+    end
+
+    private
+
+    def endian
+      @is_little_endian ? :little : :big
+    end
+  end
+end