pe_logdump2csv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d3d4627a63d13a7d09afdfeb2610e5a884e909e
+  data.tar.gz: 37de6bdcf8110f05eeb3fb067725c8684fa57b28
+SHA512:
+  metadata.gz: 10be1e5599e03fdd1185fe32a5e856bb02d747f08dfbcbd431f7c0f1869a4eac78451a5cf81e3449ef7e0743079163e4bf3a9f12f8940ac95793d6a3b3a49e3e
+  data.tar.gz: d53b5637623f7a65bb064949b56218f1ca17cdf84a7496d0a9348802226611998e0fa1afe0cee3c427ea10342cb88ec8fef41e4c8f58878fd3d300b850627024

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pe_logdump2csv.gemspec
+gemspec

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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Geoff Williams
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+# PeLogdump2csv
+
+Turn JSON dumps from PE into CSV!
+
+Give a monster directory of files, eg:
+```
+$ ls
+total 377M
+   0 127.0.0.1-10_28_16_09:05.json
+ 68K 127.0.0.1-10_28_16_09:10.json
+ 68K 127.0.0.1-10_28_16_09:15.json
+ 68K 127.0.0.1-10_28_16_09:20.json
+ 68K 127.0.0.1-10_28_16_09:25.json
+ 76K 127.0.0.1-10_28_16_09:30.json
+ 68K 127.0.0.1-10_28_16_09:35.json
+ 68K 127.0.0.1-10_28_16_09:40.json
+
+...
+```
+
+Scan each file for specific JSON values and output a cohesive set of values to STDOUT:
+```csv
+timestamp,pe-jruby-metrics.status.experimental.metrics.average-borrow-time,pe-jruby-metrics.status.experimental.metrics.num-free-jrubies,code-manager-service.status.file_sync
+10_28_16_09:10,1518,1,enabled
+10_28_16_09:15,1790,4,enabled
+10_28_16_09:20,1422,0,enabled
+10_28_16_09:25,1682,4,enabled
+10_28_16_09:30,1464,0,enabled
+```
+
+This way, data can be loaded into Excel to draw graphs
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pe_logdump2csv'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pe_logdump2csv
+
+
+
+## Usage
+1. `cd` into a directory of log files
+2. `pe_logdump2csv csv --pick xxx,yyy,zzz`
+  * This will output CSV on the commandline for each of the listed JSON keys
+  * Redirect output to a file and it can then be opened in Excel
+  * A header line will be printed, the timestamp is obtained from the filename
+  * Files must be called `SOMETHING-date.json` - we throw away the `SOMETHING` and the `.json` to obtain the timestamp
+  * You can pick as many fields as you like, just delimit them by commas with no spaces
+  * See below for how to figure out field names
+
+## Field names
+Field names are computed buy combining JSON keys with periods, eg given the following JSON, if you were interested in the value of `file_sync`, you would pass `code-manager-service.status.file_sync` to `--pick`
+```
+{
+    "code-manager-service": {
+        "detail_level": "debug",
+        "service_status_version": 1,
+        "service_version": "1.4.2",
+        "state": "running",
+        "status": {
+            "file_sync": "enabled",
+            "services": {
+                "file-sync-storage": "running"
+```
+
+## Example commands
+
+```shell
+pe_logdump2csv csv --pick pe-jruby-metrics.status.experimental.metrics.average-borrow-time,pe-jruby-metrics.status.experimental.metrics.num-free-jrubies,code-manager-service.status.file_sync
+```
+
+Collect:
+
+* average-borrow-time
+* num-free-jrubies
+* file sync status
+
+
+Output:
+```csv
+timestamp,pe-jruby-metrics.status.experimental.metrics.average-borrow-time,pe-jruby-metrics.status.experimental.metrics.num-free-jrubies,code-manager-service.status.file_sync
+10_28_16_09:10,1518,1,enabled
+10_28_16_09:15,1790,4,enabled
+10_28_16_09:20,1422,0,enabled
+10_28_16_09:25,1682,4,enabled
+10_28_16_09:30,1464,0,enabled
+10_28_16_09:35,1253,2,enabled
+10_28_16_09:40,1259,2,enabled
+```
+
+
+
+## Obtaining logs
+TODO: PR gratefully accepted :)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/GeoffWilliams/pe_logdump2csv.
+
+
+## License
+
+The gem is available as open source under the terms of the [Apache 2](https://www.apache.org/licenses/LICENSE-2.0).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pe_logdump2csv"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/pe_logdump2csv

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+require 'pe_logdump2csv'
+require 'escort'
+require 'json'
+
+Escort::App.create do |app|
+  app.version PeLogdump2csv::VERSION
+  app.summary "pe_logdump2csv"
+  app.description "Cherry pick json keys from a directory full of files into CSV"
+
+  app.command :csv do |command|
+    command.summary "cherrypick json values"
+    command.description "Scan all json files in the current directory for json values and output CSV"
+    command.options do |opts|
+      opts.opt(:pick,
+        'Path to JSON data to pick, delimited by periods.  eg:  pe-jruby-metrics.status.experimental.metrics.average-borrow-time',
+        :long    => '--pick',
+        :default => 'pe-jruby-metrics.status.experimental.metrics.average-borrow-time'
+      )
+    end
+    command.action do |options, arguments|
+      cmd = :csv
+      pick_raw  = options[:global][:commands][cmd][:options][:pick]
+      if pick_raw.empty?
+        Raise "Pick list was empty"
+      end
+      picks_raw = pick_raw.split(',')
+      picks = Array.new
+      picks_raw.each { |p|
+        pick = p.split('.')
+        picks.push(pick)
+      }
+      # now we have the pick list split on periods, should look like:
+      #   [
+      #     ['foo', 'bar', 'baz']
+      #     ['blinky', 'inky', 'clive']
+      # ]
+
+      # file headers
+      Escort::Logger.output.puts "timestamp,#{pick_raw}"
+
+      Dir.glob(Dir.pwd + File::SEPARATOR + '*.json') do |json_file|
+        # get the timestamp from the filename, there doesn't seem a definitive
+        # one in the debug output
+        ts = File.basename(json_file, '.json').split('-')[1]
+        row = Array.new
+        row.push(ts)
+        if File.size(json_file) > 0
+          json = JSON.parse(File.read(json_file))
+          picks.each { |p|
+            value = p.inject(json) { |json,v| json[v] }
+            row.push(value)
+          }
+          Escort::Logger.output.puts row.join(',')
+        end
+      end
+    end
+  end
+end

data/lib/pe_logdump2csv.rb

@@ -0,0 +1,5 @@
+require "pe_logdump2csv/version"
+
+module PeLogdump2csv
+  # Your code goes here...
+end

data/lib/pe_logdump2csv/version.rb

@@ -0,0 +1,3 @@
+module PeLogdump2csv
+  VERSION = "0.1.0"
+end

data/pe_logdump2csv.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pe_logdump2csv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pe_logdump2csv"
+  spec.version       = PeLogdump2csv::VERSION
+  spec.authors       = ["Geoff Williams"]
+  spec.email         = ["geoff.williams@puppetlabs.com"]
+
+  spec.summary       = %q{Turn JSON dumps from PE into CSV}
+  spec.description   = %q{Parse a directory full of JSON files from puppet and cherry pick keys we are interested in.}
+  spec.homepage      = "https://github.com/GeoffWilliams/pe_logdump2csv"
+  spec.license       = "Apache 2"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "escort", "0.4.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: pe_logdump2csv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Geoff Williams
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: escort
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+description: Parse a directory full of JSON files from puppet and cherry pick keys
+  we are interested in.
+email:
+- geoff.williams@puppetlabs.com
+executables:
+- pe_logdump2csv
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/pe_logdump2csv
+- lib/pe_logdump2csv.rb
+- lib/pe_logdump2csv/version.rb
+- pe_logdump2csv.gemspec
+homepage: https://github.com/GeoffWilliams/pe_logdump2csv
+licenses:
+- Apache 2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Turn JSON dumps from PE into CSV
+test_files: []
+has_rdoc: