telemetry-metrics-parser 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 704cd22d5ad019cc1c1db2096ef17b7d57f81a6b0b4809fd56c90fdd0a49dce8
-  data.tar.gz: 36b3de51e2ecd3efb78c7fe99ec45ea32bcda4edbabbff3cb6c9d27479c78378
+  metadata.gz: 156821d84a53d9823378fa29da00d0e3fd89ac078f5462451c7bc4acb1a7066b
+  data.tar.gz: 6b2c1697d86683bed555fc543d82733fe1919fbd3fcd515af6b5c810107c05d2
 SHA512:
-  metadata.gz: 4396c2b1d44be0907f0aba1c6c165300e6182c50d6f10f6cfa8136c6676f98045fba74f902306f891b3e8dfd97af05f4fe5e7a9392ae4389721faf14fe5eb4e4
-  data.tar.gz: d9c48cf18ea0099cf3e6f1b230fd16dd3bdbaf4b4314a3a25fbad23edb0838ba438bb2fdcd8982bedb9718e9ee3ae8fe7e146e405c0a68f9bf5650aa6a8d5d15
+  metadata.gz: 4310a3f81f543cdc23f552bc87a5a368d1813ec3ec3c2d0a32a6a35cd0eeedfba770d2dbca7c3019e821471a7eb59e35d8bc2edb4049537ae6dec33733006ef8
+  data.tar.gz: bcbb5036d57bebac6d56d0edd906e11507196681c1b6a0ec8e5e5b7d939882f9005f08884ca6fa89281357e16a6537648a2db44715a6ee958a7f3b654c9b612f

data/CHANGELOG.md

@@ -1,4 +1,12 @@
 # Telemetry::Metrics::Parser Changelog
 
+## v0.2.0
+Adding new line validation methods
+
+## v0.1.1
+* Adding more rspec tests for shellwords
+* Adding in **opts to from_line_protocol method
+* Changing line protocol parser to use shellwords logic by default
+
 ## v0.1.0
 Initial Version

data/README.md

@@ -24,6 +24,11 @@ results[:fields] # => { temperature: 82 }
 results[:timestamp] # => 1465839830100400200
 ```
 
+#### Validations
+```ruby
+Telemetry::Metrics::Parser::LineProtocol.line_is_valid?('weather,location=us-midwest temperature=82 1465839830100400200') # true
+Telemetry::Metrics::Parser::LineProtocol.line_is_valid?('weather,location=us-midwest temperature=this_field_is_a_string 1465839830100400200') # false but returned as a string error
+```
 
 Authors
 ----------

data/lib/telemetry/metrics/parser/line_protocol.rb

@@ -7,11 +7,11 @@ module Telemetry
       module LineProtocol
         extend Telemetry::NumberHelper
 
-        def parse(line, use_shellwords: false)
+        def parse(line, use_shellwords: true)
           if use_shellwords
-            raw_tags, raw_fields, timestamp = Shellwords.split(line)
+            raw_tags, raw_fields, timestamp = Shellwords.split(line.strip)
           else
-            raw_tags, raw_fields, timestamp = line.split
+            raw_tags, raw_fields, timestamp = line.strip.split
           end
 
           {
@@ -33,6 +33,8 @@ module Telemetry
 
         def split_string_to_hash(raw_string)
           results = {}
+          return results if raw_string.nil?
+
           raw_string.split(',').each do |string|
             next unless string.include? '='
 
@@ -53,6 +55,83 @@ module Telemetry
           hash.map { |k, v| "#{k}=#{v}" }.join(',').strip.delete_suffix(',')
         end
         module_function :hash_to_line
+
+        def line_is_recent?(timestamp, max_age_sec: 86_400)
+          return false unless timestamp.is_a?(Integer)
+          return false unless max_age_sec.is_a?(Integer)
+
+          current_epoch_ns = DateTime.now.strftime('%s%9N').to_i
+          timestamp >= current_epoch_ns - (max_age_sec * 1000 * 1000 * 1000 * 3)
+        end
+        module_function :line_is_recent?
+
+        def field_is_number?(value)
+          return false if value.nil?
+          return true if value.is_a?(Integer)
+          return true if value.is_a?(Float)
+
+          %(f i).include?(value[-1])
+        end
+        module_function :field_is_number?
+
+        def tag_is_valid?(key, value)
+          return false if key.nil? || value.nil?
+          return false unless value.chars.detect { |ch| !valid_tag_chars.include?(ch) }.nil?
+          return false unless key.to_s.chars.detect { |ch| !valid_tag_chars.include?(ch) }.nil?
+
+          true
+        end
+        module_function :tag_is_valid?
+
+        def node_group_tag?(tags)
+          tags[:influxdb_node_group].is_a?(String)
+        end
+        module_function :node_group_tag?
+
+        def database_tag?(tags)
+          tags[:influxdb_database].is_a?(String)
+        end
+        module_function :database_tag?
+
+        def measurement_valid?(measurement)
+          return false unless measurement.is_a?(String)
+
+          measurement.chars.detect { |ch| !valid_measurement_chars.include?(ch) }.nil?
+        end
+        module_function :measurement_valid?
+
+        def valid_measurement_chars
+          @valid_measurement_chars ||= ('a'..'z').to_a + ('A'..'Z').to_a + (0..9).to_a + %w[_ - .]
+        end
+        module_function :valid_measurement_chars
+
+        def valid_tag_chars
+          @valid_tag_chars ||= ('a'..'z').to_a + ('A'..'Z').to_a + (0..9).to_a + %w[_ - .]
+        end
+        module_function :valid_tag_chars
+
+        def line_is_valid?(line) # rubocop:disable Metrics/AbcSize
+          line = parse(line) if line.is_a?(String)
+          return "line is too old, #{line}" unless line_is_recent?(line[:timestamp])
+          return "line is missing influxdb_database, #{line}" unless node_group_tag? line[:tags]
+          return "line is missing influxdb_node_group, #{line}" unless database_tag? line[:tags]
+          return "measurement name #{line[:measurement]} is not valid" unless measurement_valid?(line[:measurement])
+
+          line[:fields].each do |field, value|
+            next if field_is_number?(value)
+
+            return "field values must be an Integer or String, #{field} :#{value} #{value.class}"
+          end
+
+          line[:tags].each do |tag, value|
+            next if tag_is_valid?(tag, value)
+
+            return "tags must be a-z0-9_-. but was given #{tag}: #{value}"
+          end
+
+          true
+        end
+        module_function :line_is_valid?
       end
     end
   end

data/lib/telemetry/metrics/parser/version.rb

@@ -1,7 +1,7 @@
 module Telemetry
   module Metrics
     module Parser
-      VERSION = '0.1.0'.freeze
+      VERSION = '0.2.0'.freeze
     end
   end
 end

data/lib/telemetry/metrics/parser.rb

@@ -4,8 +4,8 @@ require 'telemetry/metrics/parser/line_protocol'
 module Telemetry
   module Metrics
     module Parser
-      def from_line_protocol(line)
-        Telemetry::Metrics::Parser::LineProtocol.parse(line)
+      def from_line_protocol(line, **opts)
+        Telemetry::Metrics::Parser::LineProtocol.parse(line, **opts)
       end
       module_function :from_line_protocol
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telemetry-metrics-parser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Esity
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2022-09-30 00:00:00.000000000 Z
 dependencies: []
 description: A metrics line parser gem for things like influxdb line protocol
 email:
@@ -55,7 +55,7 @@ metadata:
   homepage_uri: https://github.com/Optum/telemetry-metrics-parser
   source_code_uri: https://github.com/Optum/telemetry-metrics-parser
   wiki_uri: https://github.com/Optum/telemetry-metrics-parser/wiki
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -70,8 +70,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.3.11
+signing_key: 
 specification_version: 4
 summary: Parses common line formats for InfluxDB Line Protocol and turns it into a
   ruby hash