Add documentation on Oncall/Iris integration for messaging

[HIT2022]

It is not clear to me from the documentation or config comments what config settings are required in order for Oncall to be able to pull from notification_queue and then trigger out a message to the recipient via Iris as the sender. I'm using the annotated config provided via a553c1e from #334, which seems to call out the default values related to SMTP, vendor, etc, and likewise I have an entry in the plugin section of Oncall's config defined for iris_messenger. Yet I'm unable to get email messages triggered out of either Iris (via Incident creation) or On-Call (via Reminders/Notifications). Notification_queue continues to hold a ton of rows all marked with NULL for column SENT. Long story short, additional documentation on using Iris as the messaging system would be appreciated.

[jrgp]

Can you provide the SMTP settings you are using? Also, do you have iris sender running?

[HIT2022]

Yep iris-sender is running. What am I missing here?

Iris config -

sender:
  debug: False
  process_title: iris-sender
  host: 127.0.0.1
  port: 2321

  workers_per_mode:
    email: 500

  master_sender:
    host: 127.0.0.1
    port: 2321

  api_host: http://localhost:16649

  sender_app: iris
 
  is_master: True

sender_workers: 1000

applications:
 - dummy_app

vendors:
 - type: iris_smtp
   name: email
   smtp_server: '<redacted>'
   smtp_gateway: '<redacted>'
   from: '<redacted>'

Oncall config -

messengers:
  - type: iris_messenger
    application: iris
    iris_api_key: magic
    api_host: http://localhost:16649
	
notifications:
  default_roles:
    - "primary"
    - "secondary"
    - "manager"
  default_times:
    - 86400
    - 604800
  default_modes:
    - "email"

reminder:
  activated: True
  polling_interval: 360
  default_timezone: 'US/Central'

Thanks!

[jrgp]

Are you getting any exceptions or errors/warnings in logs? It's possible/likely that the "iris" application oncall is configured to use is not present in the DB with the key 'magic'.

[HIT2022]

Hmm, it was not present but I just added it in. I'm still seeing pure GET/POST resource/API-related requests in the console, and nothing representing possible issues encountered during attempts to trigger messages out. Does the logger output go to a separate file that I'm not aware of (or might be getting blocked from being created due to permissions)?

[HIT2022]

Turns out that oncall-notifier wasn't running :( I'd still support extending the documentation related to this piece for non-experts (like myself :)), but we are good to go now, so we can close this Issue if needed

[jrgp]

Thanks for getting back to us. Glad to hear you got it working.