telemetry-metrics-parser 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b495c7a2172e397b350c2c30d3ebe57517024af5ddef9792959db5e0c07dfed7
-  data.tar.gz: 62dd6baeb7e3a17cc92300714e8ea00d611f1f809eacf538675a8f031ada8c77
+  metadata.gz: 156821d84a53d9823378fa29da00d0e3fd89ac078f5462451c7bc4acb1a7066b
+  data.tar.gz: 6b2c1697d86683bed555fc543d82733fe1919fbd3fcd515af6b5c810107c05d2
 SHA512:
-  metadata.gz: a41b4aec7089102e51a31dc054a341ba5cbb2046235f55d5f24f84d7d880b41e529248ac0a3d1e7cc9d3dd4897aa26cf726152895f11984b6e23c7942880f415
-  data.tar.gz: 29a726191c6fb767c95a37118ddbd6f612f2cc47a413c6721580b7b5f2d3e8d1cf7c3b535d0f79c4ccb9a77870cc12304192bf4ed0f024be3a9872ba1309f979
+  metadata.gz: 4310a3f81f543cdc23f552bc87a5a368d1813ec3ec3c2d0a32a6a35cd0eeedfba770d2dbca7c3019e821471a7eb59e35d8bc2edb4049537ae6dec33733006ef8
+  data.tar.gz: bcbb5036d57bebac6d56d0edd906e11507196681c1b6a0ec8e5e5b7d939882f9005f08884ca6fa89281357e16a6537648a2db44715a6ee958a7f3b654c9b612f

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # 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

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

@@ -55,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.1'.freeze
+      VERSION = '0.2.0'.freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telemetry-metrics-parser
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Esity
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-22 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.2.15
-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