diff --git a/src/app/README.md b/src/app/README.md index b8abdaf..8046c75 100644 --- a/src/app/README.md +++ b/src/app/README.md @@ -1,18 +1,14 @@ -# Slack Notification Alerts - -This app contains a Splunk custom alert action which allows you to send messages to Slack channels. - ## System requirements -* Splunk version 6.3 or greater -* Windows, Linux or Mac OS operating system +- Splunk version 6.3 or greater +- Windows, Linux or Mac OS operating system ## Installation -App installation requires admin priviledges. +App installation requires admin privileges. -* Navigate to "Manage apps" and click "Install app from file" -* Upload the app bundle +- Navigate to "Manage apps" and click "Install app from file" +- Upload the app bundle ## Configuration @@ -21,26 +17,34 @@ In order to setup the app, navigate to "Settings" -> "Alert actions". Click on " On the setup screen you'll want to supply a Webhook URL. You can obtain this URL by configuring a custom integration for you Slack workspace. -For more information see https://api.slack.com/incoming-webhooks +For more information see https://slack.com/apps/A0F7XDUAZ-incoming-webhooks ## Troubleshooting +### Known issue with Setup + +> Setup page shows "I am Legend" setup_stub + +An issue after upgrading the Slack Alerts app can cause an invalid redirect from the alert actions listing page to the setup page. Go to "Manage Apps" and click on "Set up" instead of using the Alert actions listing. + +Alternatively - to fix it - you can remove the `is_configured` flag from `$SPLUNK_HOME/etc/apps/slack_alerts/local/app.conf` and restart Splunk. + ### Logs In order to investigate problems with the Slack alert action, you can check the logs of the alert action. -* Navigate to "Settings" -> "Alert actions" -* Click on "View log events" for the Slack alert action +- Navigate to "Settings" -> "Alert actions" +- Click on "View log events" for the Slack alert action You can also increase the verbosity of logs generated by the alert action by adjusting the -* Navigate to "Settings" -> "Server settings" -> "Server logging" -* Search for the log channel "sendmodalert" -* Select logging level "DEBUG" +- Navigate to "Settings" -> "Server settings" -> "Server logging" +- Search for the log channel "sendmodalert" +- Select logging level "DEBUG" **NOTE**: This will increase cause detailed logs to be produced for all alert actions and might have an -inpact on system performance. It is not recommended to do this on a production system. +impact on system performance. It is not recommended to do this on a production system. ### Manually trigger the alert action @@ -60,24 +64,24 @@ In case of an error when manually triggering the Slack alert action, you'll noti Here are the possible error codes returned by the slack alert action: -* Error Code **`2`**: Validation Failed +- Error Code **`2`**: Validation Failed This error code indications that the parameters handed to the alert action were invalid. Check the configuration. -* Error Code **`3`**: Channel not found +- Error Code **`3`**: Channel not found This error code is returned if the given Slack channel was not found -* Error Code **`4`**: Forbidden +- Error Code **`4`**: Forbidden Slack indicates that sending the message to the given channel is not allowed. Contact your Slack workspace administrator to find out about possible restrictions. -* Error Code **`5`**: HTTP failure +- Error Code **`5`**: HTTP failure This error code indicates a problem with executing the HTTP request to the configured webhook URL. Possible reasons include network issues, proxy server issues See logs for details. -* Error Code **`6`**: Unexpected error +- Error Code **`6`**: Unexpected error - An unexpected error occured while attempting to send the slack message. + An unexpected error occurred while attempting to send the slack message. See logs for details. diff --git a/src/app/default/app.conf b/src/app/default/app.conf index dbd0dab..4a39b94 100644 --- a/src/app/default/app.conf +++ b/src/app/default/app.conf @@ -1,5 +1,6 @@ [ui] -is_visible = 0 +is_visible = 1 +show_in_nav = 0 label = Slack Alerts setup_view = slack_alerts_setup @@ -8,8 +9,5 @@ author = Siegfried Puchbauer description = Custom alert action to send messages to Slack channels version = 0.0.0 -[install] -is_configured = 0 - [package] id = slack_alerts diff --git a/src/app/default/data/ui/nav/default.xml b/src/app/default/data/ui/nav/default.xml new file mode 100644 index 0000000..65aebd4 --- /dev/null +++ b/src/app/default/data/ui/nav/default.xml @@ -0,0 +1,3 @@ + \ No newline at end of file