huginn_influxdb_write_data_agent 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 33d96c8625ddc57b31f90bfc0fc28dc8042219fa470a2a30b94080d85e720874
+  data.tar.gz: 3fd096ae7c498ef4946aabfed596996db90003291bdaf2ee24a5c5bb52c3ea24
+SHA512:
+  metadata.gz: 26eee623e65986322e3d8c6f51240bb2b853395a18136efd9760f24c6d2b8b277af32e187574fd27391acf2729f2aee9fcea75af32cb057611c4a7f57e1b76ff
+  data.tar.gz: b3c6077db358bd27dbcc256ac680e2cbe06a02b0edef6b2f3ef5ac7ea3967fbbe787105292011e87992115a271b62f330c0fbb0928995f48eedd2d238126f5ec

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2020 Nicolas Germain
+
+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/lib/huginn_influxdb_write_data_agent/influxdb_write_data_agent.rb

@@ -0,0 +1,192 @@
+module Agents
+  class InfluxdbWriteDataAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'never'
+
+    description do
+      <<-MD
+      The Influxdb Write Data Agent writes events to an InfluxDB time series database..
+
+      `url` is the influxdb url ( ex: http://influxdb:8086).
+
+      `influxdb_version` to choose if api V1 or V2.
+
+      `debug` is used for verbose mode.
+
+      `database` is the database's / bucket's name.
+
+      `token` is needed with v2 for auth.
+
+      `org` is needed with v2 for queries.
+
+       If `emit_events` is set to `true`, the server response will be emitted as an Event. No data processing
+       will be attempted by this Agent, so the Event's "body" value will always be raw text.
+
+      `data` is the equivalent of data-binary in curl command, in influx line protocol (ex: campaigns_number,region=fr value=1111 1603573200000000000).
+
+      `expected_receive_period_in_days` is used to determine if the Agent is working. Set it to the maximum number of days
+      that you anticipate passing without this Agent receiving an incoming Event.
+      MD
+    end
+
+    event_description <<-MD
+      Events look like this:
+
+          {
+            "http_status": "204"
+          }
+    MD
+
+    def default_options
+      {
+        'url' => '',
+        'token' => '',
+        'org' => '',
+        'influxdb_version' => '',
+        'database' => '',
+        'data' => '',
+        'debug' => 'false',
+        'expected_receive_period_in_days' => '2',
+        'emit_events' => 'false'
+      }
+    end
+
+    form_configurable :url, type: :string
+    form_configurable :token, type: :string
+    form_configurable :org, type: :string
+    form_configurable :influxdb_version, type: :array,values: ['v1', 'v2']
+    form_configurable :debug, type: :boolean
+    form_configurable :expected_receive_period_in_days, type: :string
+    form_configurable :database, type: :string
+    form_configurable :data, type: :string
+    form_configurable :emit_events, type: :boolean
+
+    def validate_options
+      errors.add(:base, "influxdb_version has invalid value: should be 'v1' 'v2'") if interpolated['influxdb_version'].present? && !%w(v1 v2).include?(interpolated['influxdb_version'])
+
+      unless options['database'].present?
+        errors.add(:base, "database is a required field")
+      end
+
+      unless options['token'].present? || !['v2'].include?(options['influxdb_version'])
+        errors.add(:base, "token is a required field")
+      end
+
+      unless options['org'].present? || !['v2'].include?(options['influxdb_version'])
+        errors.add(:base, "org is a required field")
+      end
+
+      unless options['url'].present?
+        errors.add(:base, "url is a required field")
+      end
+
+      unless options['data'].present?
+        errors.add(:base, "data is a required field")
+      end
+
+      if options.has_key?('emit_events') && boolify(options['emit_events']).nil?
+        errors.add(:base, "if provided, emit_events must be true or false")
+      end
+
+      if options.has_key?('debug') && boolify(options['debug']).nil?
+        errors.add(:base, "if provided, debug must be true or false")
+      end
+
+      unless options['expected_receive_period_in_days'].present? && options['expected_receive_period_in_days'].to_i > 0
+        errors.add(:base, "Please provide 'expected_receive_period_in_days' to indicate how many days can pass before this Agent is considered to be not working")
+      end
+    end
+
+    def working?
+      event_created_within?(options['expected_receive_period_in_days']) && !recent_error_logs?
+    end
+
+    def receive(incoming_events)
+      incoming_events.each do |event|
+        interpolate_with(event) do
+          log event
+          write_data
+        end
+      end
+    end
+
+    def check
+      write_data
+    end
+
+    private
+
+    def write_datav1
+
+      full_url = interpolated['url'] + '/write?db=' + interpolated['database']
+  
+      if interpolated['debug'] == 'true'
+        log full_url
+      end
+  
+      uri = URI.parse(full_url)
+      request = Net::HTTP::Post.new(uri)
+      request.body = "#{interpolated['data']}"
+      
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+      
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      log "request  status : #{response.code}"
+  
+      if interpolated['debug'] == 'true'
+        log "response body : #{response.body}"
+      end
+  
+      if interpolated['emit_events'] == 'true'
+        create_event :payload => { 'http_status' => "#{response.code}"}
+      end
+    end
+
+    def write_datav2
+
+      full_url = interpolated['url'] + '/api/v2/write?org=' + interpolated['org'] + '&bucket=' + interpolated['database'] + '&precision=ns'
+
+      if interpolated['debug'] == 'true'
+        log full_url
+      end
+
+      uri = URI.parse(full_url)
+      request = Net::HTTP::Post.new(uri)
+      request.content_type = "text/plain; charset=utf-8"
+      request["Authorization"] = "token #{interpolated['token']}"
+      request["Accept"] = "application/json"
+      request.body = "#{interpolated['data']}"
+
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      if interpolated['emit_events'] == 'true'
+        create_event :payload => { 'http_status' => "#{response.code}"}
+      end
+
+    end
+
+    def write_data
+      case interpolated['influxdb_version']
+      when "v1"
+         write_datav1()
+      when "v2"
+         write_datav2()
+      else
+        log "Error: influxdb_version has an invalid value (#{type})"
+      end
+    end
+  end
+end

data/lib/huginn_influxdb_write_data_agent.rb

@@ -0,0 +1,4 @@
+require 'huginn_agent'
+
+#HuginnAgent.load 'huginn_influxdb_write_data_agent/concerns/my_agent_concern'
+HuginnAgent.register 'huginn_influxdb_write_data_agent/influxdb_write_data_agent'

data/spec/influxdb_write_data_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::InfluxdbWriteDataAgent do
+  before(:each) do
+    @valid_options = Agents::InfluxdbWriteDataAgent.new.default_options
+    @checker = Agents::InfluxdbWriteDataAgent.new(:name => "InfluxdbWriteDataAgent", :options => @valid_options)
+    @checker.user = users(:bob)
+    @checker.save!
+  end
+
+  pending "add specs here"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: huginn_influxdb_write_data_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: huginn_agent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Write a longer description or delete this line.
+email:
+- ngermain@hihouhou.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/huginn_influxdb_write_data_agent.rb
+- lib/huginn_influxdb_write_data_agent/influxdb_write_data_agent.rb
+- spec/influxdb_write_data_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_influxdb_write_data_agent
+licenses:
+- MIT
+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: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because Rubygems requires one.
+test_files:
+- spec/influxdb_write_data_agent_spec.rb