Skip to main content

Notification

Connectors for IgniteConnex Monitoring​

IgniteConnex Monitoring offers a set of versatile connectors that enhance your monitoring capabilities and facilitate seamless communication with the monitoring system. These connectors enable you to push various types of information to IgniteConnex for efficient tracking and management of your runtime applications. Below are the connectors available for notifications:

1) Push Notification​

Use this connector to relay notification details to IgniteConnex Monitoring, facilitating tracking and email notifications related to your runtime application. It's an effective way to stay informed about important events.


Sample msg.data:

msg.data = { 
"error_message": "database not connected", 
"code": "401" 
}

2) Get Notification​

Allows you to check important updates in your app, like glancing at messages. It makes it easy to stay in the know about essential events in your runtime application.


Note: You need to save "IGNITE_API_SECRET" in the environments of a runtime.

Sample flow json:

[{"id":"766bb45c7cf2cf66","type":"subflow","name":"Get Notifications","info":"# About Get Notifications:\r\nUsing this connector we can get notifications from igniteconnex monitoring system.\r\n\r\nAll notifications are respective to an app created in igniteconnex dashboard.\r\n\r\nThis connector will give, 50 response object maximum at a time.\r\n\r\n`\r\nNote: You need to save **\"IGNITE_API_SECRET\"** in environments of a runtime.\r\n`\r\n\r\n## Overriding Connector Properties:\r\n\r\nYou have the option to override certain connector properties by using the following message properties:\r\n\r\n- **QUERY** - This corresponds to **msg.config.query**.\r\n\r\n## Available Query Parameters:\r\n- **mode** : If you pass \"raw\" in mode, it will give you raw data (no modifications).\r\n- **panel** : If you are working for observability platform, we have panel query param for you.\r\n    Available Panels are:\r\n    - reported_notifications\r\n    - notification_time_series.\r\n\r\nIf you are passing panel, you are required to pass:\r\n- **from** : Starting time from which you want to retrieve data. (expected timestamp)\r\n- **to** : Ending time from which you want to retrieve data. (expected timestamp)\r\n\r\n`\r\nNote: Data will be modified as per the given panel name and sent as a response.\r\n`\r\n\r\n### Sample query object: \r\nFor instance, if you wish to retrieve notifications without modifications, you can easily achieve this by including the \"mode=raw\" parameter in your query object.","category":"","in":[{"x":20,"y":80,"wires":[{"id":"8333e57d3f6cb661"}]}],"out":[{"x":720,"y":80,"wires":[{"id":"7474bdc7a4b3995b","port":0}]},{"x":720,"y":80,"wires":[{"id":"7474bdc7a4b3995b","port":1}]}],"env":[{"name":"QUERY","type":"str","value":""}],"meta":{},"color":"#F3F3F3","icon":"ignite-connectors/igniteConnex.png"},{"id":"8333e57d3f6cb661","type":"function","z":"766bb45c7cf2cf66","name":"API parameter setting","func":"let base_uri = env.get(\"IGNITE_API_BASE_URL\") || \"https://api.igniteconnex.io\"\nlet query = env.get(\"QUERY\") || msg.config.query || \"\";\n\nmsg.method = 'GET';\n\nmsg.url = `${base_uri}/monitor/api/v1/monitor/notifications`;\n\nif (query) {\n    msg.url = `${msg.url}?${query}`\n};\n\nmsg.headers = {\n    \"x-ignite-api-secret\": env.get(\"IGNITE_API_SECRET\"),\n};\n\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[{"var":"_","module":"lodash"}],"x":200,"y":80,"wires":[["b452e1fca465fc57"]]},{"id":"b452e1fca465fc57","type":"http request","z":"766bb45c7cf2cf66","name":"request","method":"use","ret":"txt","paytoqs":"ignore","url":"","tls":"","persist":false,"proxy":"","insecureHTTPParser":false,"authType":"","senderr":false,"headers":[],"x":420,"y":80,"wires":[["7474bdc7a4b3995b"]]},{"id":"7474bdc7a4b3995b","type":"switch","z":"766bb45c7cf2cf66","name":"success ?","property":"statusCode","propertyType":"msg","rules":[{"t":"btwn","v":"199","vt":"num","v2":"299","v2t":"num"},{"t":"else"}],"checkall":"true","repair":false,"outputs":2,"x":580,"y":80,"wires":[[],[]]},{"id":"1a9e1b541ce52a6f","type":"subflow:766bb45c7cf2cf66","z":"c52e470e7ef6e459","name":"","x":460,"y":500,"wires":[["5388cc3f5394b873"],["589f31ab696f1b2e"]]},{"id":"83b0e626e6d8165d","type":"inject","z":"c52e470e7ef6e459","name":"","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","payload":"","payloadType":"date","x":260,"y":500,"wires":[["1a9e1b541ce52a6f"]]},{"id":"5388cc3f5394b873","type":"debug","z":"c52e470e7ef6e459","name":"debug 20","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"false","statusVal":"","statusType":"auto","x":640,"y":480,"wires":[]},{"id":"589f31ab696f1b2e","type":"debug","z":"c52e470e7ef6e459","name":"debug 21","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"false","statusVal":"","statusType":"auto","x":640,"y":520,"wires":[]}]

Overriding Connector Properties:​

You have the option to override certain connector properties by using the following message properties:

  • QUERY - This corresponds to msg.config.query.

Available Query Parameters:​

  • mode : If you pass "raw" in mode, it will give you raw data (no modifications).

  • panel : If you are working for observability platform, we have panel query param for you.
    Available Panels are:

    • reported_notifications
    • notification_time_series

    If you are passing panel, you are required to pass:

  • from : Starting time from which you want to retrieve data. (expected timestamp)

  • to : Ending time from which you want to retrieve data. (expected timestamp)

Note: Data will be modified as per the given panel name and sent as a response.