huginn_pagerduty_agent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa095d93a5d6200329d552185456398db77ffaabce6cbf1793f863de4ca66a11
+  data.tar.gz: 271d7604e4720bbf8446bc354f210956b138fb41da89aa4ba27dda045629768b
+SHA512:
+  metadata.gz: dd97c96427c54b98f026e2f66ef97f3ed8b215fff30e095ef007c7510741b692995389e7f693ba0cb7234d83fef57df0eca9168a754417185d51ece6843eeb14
+  data.tar.gz: 7e57b86e1be763e7e0e3236f32023eb2665cbbdc17bf3b930027b898aa26d2852e2f265bf4d4fda7961cc1676ad3acb8ca382af4f05f07d153d0f75a9aec54d6

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2025 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_pagerduty_agent/pagerduty_agent.rb

@@ -0,0 +1,294 @@
+module Agents
+  class PagerdutyAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_5m'
+
+    description do
+      <<-MD
+      The PagerDuty Agent creates events / checks incidents  with the PG api..
+
+      The `type` can be like check_incidents or create_incident for example.
+
+      `token` is needed for the authentication.
+
+      `data` is the payload (alert / system / foo / bar).
+
+      `debug` is used for verbose mode.
+
+      `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:
+
+          {
+            "incident": {
+              "incident_number": 3,
+              "title": "test",
+              "description": "test",
+              "created_at": "2021-07-31T16:34:10Z",
+              "status": "triggered",
+              "incident_key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+              "service": {
+                "id": "XXXXXX",
+                "type": "service_reference",
+                "summary": "test",
+                "self": "https://api.pagerduty.com/services/XXXXXX",
+                "html_url": "https://XXXXXXXXXXXXXX.pagerduty.com/service-directory/XXXXXX"
+              },
+              "assignments": [
+                {
+                  "at": "2021-07-31T16:34:11Z",
+                  "assignee": {
+                    "id": "XXXXXX",
+                    "type": "user_reference",
+                    "summary": "XXXXXXXXXXXXXXX",
+                    "self": "https://api.pagerduty.com/users/XXXXXX",
+                    "html_url": "https://XXXXXXXXXXXXXX.pagerduty.com/users/XXXXXX"
+                  }
+                }
+              ],
+              "assigned_via": "escalation_policy",
+              "last_status_change_at": "2021-07-31T16:34:10Z",
+              "first_trigger_log_entry": {
+                "id": "XXXXXXXXXXXXXXXXXXXXXXXXXX",
+                "type": "trigger_log_entry_reference",
+                "summary": "Triggered through the website",
+                "self": "https://api.pagerduty.com/log_entries/XXXXXXXXXXXXXXXXXXXXXXXXXX",
+                "html_url": "https://XXXXXXXXXXXXXX.pagerduty.com/incidents/XXXXXX/log_entries/XXXXXXXXXXXXXXXXXXXXXXXXXX"
+              },
+              "alert_counts": {
+                "all": 0,
+                "triggered": 0,
+                "resolved": 0
+              },
+              "is_mergeable": true,
+              "escalation_policy": {
+                "id": "XXXXXX",
+                "type": "escalation_policy_reference",
+                "summary": "test-ep",
+                "self": "https://api.pagerduty.com/escalation_policies/XXXXXX",
+                "html_url": "https://XXXXXXXXXXXXXX.pagerduty.com/escalation_policies/XXXXXX"
+              },
+              "teams": [],
+              "impacted_services": [
+                {
+                  "id": "XXXXXX",
+                  "type": "service_reference",
+                  "summary": "test",
+                  "self": "https://api.pagerduty.com/services/XXXXXX",
+                  "html_url": "https://XXXXXXXXXXXXXX.pagerduty.com/service-directory/XXXXXX"
+                }
+              ],
+              "pending_actions": [],
+              "acknowledgements": [],
+              "basic_alert_grouping": null,
+              "alert_grouping": null,
+              "last_status_change_by": {
+                "id": "XXXXXX",
+                "type": "service_reference",
+                "summary": "test",
+                "self": "https://api.pagerduty.com/services/XXXXXX",
+                "html_url": "https://XXXXXXXXXXXXXX.pagerduty.com/service-directory/XXXXXX"
+              },
+              "incidents_responders": [],
+              "responder_requests": [],
+              "subscriber_requests": [],
+              "urgency": "high",
+              "id": "XXXXXX",
+              "type": "incident",
+              "summary": "[#3] test",
+              "self": "https://api.pagerduty.com/incidents/XXXXXX",
+              "html_url": "https://XXXXXXXXXXXXXX.pagerduty.com/incidents/XXXXXX"
+            }
+          }
+    MD
+
+    def default_options
+      {
+        'email' => '',
+        'team_id' => '',
+        'data' => '',
+        'debug' => 'false',
+        'emit_events' => 'true',
+        'expected_receive_period_in_days' => '7',
+        'token' => ''
+      }
+    end
+
+    form_configurable :team_id, type: :string
+    form_configurable :debug, type: :boolean
+    form_configurable :emit_events, type: :boolean
+    form_configurable :token, type: :string
+    form_configurable :expected_receive_period_in_days, type: :string
+    form_configurable :email, type: :string
+    form_configurable :type, type: :array, values: ['check_incidents', 'create_incident']
+    form_configurable :data, type: :string
+
+    def validate_options
+      errors.add(:base, "type has invalid value: should be 'check_incidents', 'create_incident'") if interpolated['type'].present? && !%w(check_incidents create_incident).include?(interpolated['type'])
+
+      unless options['team_id'].present? || !['check_incidents'].include?(options['type'])
+        errors.add(:base, "team_id is a required field")
+      end
+
+      unless options['data'].present? || !['create_incident'].include?(options['type'])
+        errors.add(:base, "data is a required field")
+      end
+
+      if options.has_key?('debug') && boolify(options['debug']).nil?
+        errors.add(:base, "if provided, debug must be true or false")
+      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
+
+      unless options['token'].present?
+        errors.add(:base, "token is a required field")
+      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
+          trigger_action
+        end
+      end
+    end
+
+    def check
+      trigger_action
+    end
+
+    private
+
+    def log_curl_output(code,body)
+
+      log "request status : #{code}"
+
+      if interpolated['debug'] == 'true'
+        log "body"
+        log body
+      end
+
+    end
+
+    def create_incident
+  
+      if interpolated['debug'] == 'true'
+        log "data : #{interpolated['data']}"
+      end
+
+      uri = URI.parse("https://api.pagerduty.com/incidents")
+      request = Net::HTTP::Post.new(uri)
+      request.content_type = "application/json"
+      request["From"] = "#{interpolated['email']}"
+      request["Accept"] = "application/vnd.pagerduty+json;version=2"
+      request["Authorization"] = "Token token=#{interpolated['token']}"
+      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_curl_output(response.code,response.body)
+  
+      if interpolated['emit_events'] == 'true'
+        create_event :payload => response.body 
+      end
+
+    end
+
+    def check_incidents
+
+      uri = URI.parse("https://api.pagerduty.com/incidents")
+      request = Net::HTTP::Get.new(uri)
+      request.content_type = "application/json"
+      request["Accept"] = "application/json"
+      request["Authorization"] = "Token token=#{interpolated['token']}"
+      request.body = JSON.dump({
+        "team_ids" => [
+          "#{interpolated['team_id']}"
+        ],
+        "sort_by" => "created_at:DESC"
+      })
+
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      log_curl_output(response.code,response.body)
+
+      payload = JSON.parse(response.body)
+      if payload != memory['last_status']
+        payload['incidents'].each do |incident|
+          found = false
+          if interpolated['debug'] == 'true'
+            log "incident"
+            log incident
+          end
+          if !memory['last_status'].nil? and memory['last_status'].present?
+            if interpolated['debug'] == 'true'
+              log "memory"
+              log memory['last_status']
+            end
+            last_status = memory['last_status']
+            last_status['incidents'].each do |incidentbis|
+              if incident == incidentbis
+                found = true
+              end
+              if interpolated['debug'] == 'true'
+                log "incidentbis"
+                log incidentbis
+                log "found is #{found}!"
+              end
+            end
+          end
+          if found == false
+            create_event payload: incident
+          end
+        end
+      else
+        if interpolated['debug'] == 'true'
+          log "nothing to compare"
+        end
+      end
+      memory['last_status'] = payload
+
+    end
+
+    def trigger_action
+
+      case interpolated['type']
+      when "check_incidents"
+        check_incidents()
+      when "create_incident"
+        create_incident()
+      else
+        log "Error: type has an invalid value (#{interpolated['type']})"
+      end
+    end
+  end
+end

data/lib/huginn_pagerduty_agent.rb

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

data/spec/pagerduty_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::PagerdutyAgent do
+  before(:each) do
+    @valid_options = Agents::PagerdutyAgent.new.default_options
+    @checker = Agents::PagerdutyAgent.new(:name => "PagerdutyAgent", :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_pagerduty_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-01-04 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_pagerduty_agent.rb
+- lib/huginn_pagerduty_agent/pagerduty_agent.rb
+- spec/pagerduty_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_pagerduty_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/pagerduty_agent_spec.rb