ASB-3754 Add log file integration docs and cleanup integration section #59
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,14 @@ | ||
| # Setup SMTP / Email Notifications | ||
|
|
||
| On the Axonops application menu, select `Settings -> Integrations` . | ||
|
|
||
| Click on the `SMTP` area. | ||
|
|
||
| !!! infomy | ||
|
|
||
| [](imgs/integrations.jpg) | ||
|
|
||
| Fill in the appropriate details. | ||
|
|
||
| [](imgs/email-2.jpg) | ||
|
|
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Send Notifications to Log Files | ||
|
|
||
| Unlike the other integrations, the Log Files Integration is configured by adding the `alert_log` key to your `axon-server.yml`, typically located at `/etc/axonops/axon-server.yml`. | ||
|
|
||
| When `alert_log.enabled` is `true`, logs will be written to `alert_log.path` for consumption by external services like Splunk. | ||
|
|
||
| ```yaml | ||
| alert_log: | ||
| enabled: true | ||
| path: /var/log/axonops/axon-server-alert.log | ||
| max_size_mb: 50 | ||
| max_files: 5 | ||
| ``` | ||
|
|
||
| `max_size_mb` and `max_files` are used to define how log rotation is handled. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,31 @@ | ||
| # Setup Microsoft Teams Integration | ||
|
|
||
| ## Create Microsoft Teams Webhook | ||
|
|
||
| On the Microsoft Teams interface, go to `Connectors`. | ||
|
|
||
|  | ||
|
|
||
| `Configure` the `Incoming Webhook` connector. | ||
|
|
||
|  | ||
|
|
||
| Provide a name and select `Create`. | ||
|
|
||
|  | ||
|
|
||
| Copy the url provided to the clipboard. | ||
|
|
||
|  | ||
|
|
||
| ## Create the Microsoft Teams Integration on axon-server | ||
|
|
||
| On the AxonOps application menu, select `Settings -> Integrations`. | ||
|
|
||
| Click on the `Microsoft Teams` area. | ||
|
|
||
|  | ||
|
|
||
| Enter a `name`, copy the url in the `Webhook URL` field, and select `Create`. | ||
|
|
||
|  |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,19 @@ | ||
| # Setup ServiceNow Integration | ||
|
|
||
| ## Login to ServiceNow | ||
|
|
||
| Navigate to `Settings -> Integrations` and click on `ServiceNow`. | ||
|
|
||
|  | ||
|
|
||
| Gather the `instance name`, `username`, and `password` from ServiceNow to fill out the form: | ||
|  | ||
|
|
||
| ## Update ServiceNow Incident Template | ||
|
|
||
| If you want to see the detailed description of a notification, you'll need to add the `description` field into the ServiceNow incidents templates. | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,54 +1,46 @@ | ||
| # Setup Slack Integration | ||
|
|
||
| ### Create Slack Incoming Webhooks | ||
|
|
||
| Add the [Incoming WebHooks](https://slack.com/marketplace/A0F7XDUAZ-incoming-webhooks){target="_blank"} app to Slack. | ||
|
|
||
| > Note: Ensure you're on the correct Slack Workspace by using the Workspace indicator on the top left. | ||
|
|
||
| In the `Post to Channel` Box, select an option from the `Choose a channel...` dropdown menu. | ||
|
|
||
| Click `Add Incoming WebHooks Integration`. | ||
|
There was a problem hiding this comment. Rewrote the above section since it seems like things had changed and using a direct link seemed cleaner, since it's always a struggle for me to navigate to Slack Workspace settings. |
||
|
|
||
| !!! infomy | ||
|
|
||
| [](imgs/slack-1.png) | ||
|
|
||
| Copy and make a note of the `WebHook URL` that appears in the `Setup Instructions`. | ||
|
|
||
| !!! infomy | ||
|
|
||
| [](imgs/slack-2.png) | ||
|
|
||
|
|
||
| ### Creating the Slack integration on axon-server | ||
|
|
||
| On the Axonops application menu, select `Settings -> Integrations` . | ||
|
|
||
| Click on the `Slack` area. | ||
|
|
||
| !!! infomy | ||
|
|
||
| [](imgs/integrations.png) | ||
|
|
||
|
|
||
| [1]: #create-slack-incoming-webhooks | ||
|
|
||
| Add the `Webhook URL` from the previous step into the `url` field. | ||
|
|
||
| Optionally, set the `Channel` field to send alerts to a channel other than the default channel | ||
| that was defined when the WebHooks Integration was added to the Slack Workspace. | ||
|
|
||
| !!! infomy | ||
|
|
||
| [](imgs/slack-4.png) | ||
|
|
||
|
|
||
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The main intended change.