Skip to content

Commit

Permalink
Edit info and add screen captures
Browse files Browse the repository at this point in the history
  • Loading branch information
dedemorton committed May 24, 2024
1 parent fca21d1 commit c0f9a94
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 12 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 25 additions & 12 deletions docs/en/observability/observability-ai-assistant.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -235,27 +235,40 @@ You can continue a conversation from a contextual prompt by clicking *Start chat
[[obs-ai-connector]]
=== AI Assistant connector

The Observability AI Assistant connector enables you to add AI-generated insights and custom actions to your alerting workflows.
//TODO: Make "configure the Observability AI Assistant connector" an active link to the connector configuration docs after those
//docs are merged.

Use the Observability AI Assistant connector to add AI-generated insights and custom actions to your alerting workflows.
After defining a rule to trigger an alert, you configure the Observability AI Assistant connector as an action in the alerting rule.
In the connector configuration, you specify a message that gets passed along with contextual information to the AI Assistant:
In the connector configuration, you specify a message that gets passed along with contextual information to the AI Assistant.
In the message, you can ask the assistant to generate a report of the alert that fired,
recall any information or potential resolutions of past occurrences stored in the knowledge base,
and also include other active alerts that may be related.
As a last step, you can ask the assistant to trigger an action,
such as sending the report (or any other message) to a slack webhook.
For example:

[role="screenshot"]
image::images/obs-ai-assistant-action.png[Add an Observability AI assistant action while creating a rule in the Observability UI]

For example, you can specify a message that asks the assistant to generate a report of the alert that fired (by initially providing some context in the first message), recalling any information or potential resolutions of previous occurrences stored in the knowledge base, and also including other active alerts that may be related. As a last step, you can ask the assistant to trigger an action, such as sending the report (or any other message) to a slack webhook.
image::images/obs-ai-assistant-action-high-cpu.png[Add an Observability AI assistant action while creating a rule in the Observability UI]

When the alert fires, contextual details about the event (for example, when the alert fired,
the service impacted, and the threshold breached) are sent to the AI Assistant,
When the alert fires, contextual details about the event (such as when the alert fired,
the service or host impacted, and the threshold breached) are sent to the AI Assistant,
along with the message provided during configuration.
The AI Assistant runs the tasks requested in the message and creates a conversation that you can use to chat with the assistant:
The AI Assistant runs the tasks requested in the message and creates a conversation you can use to chat with the assistant:

TODO: ADD SCREEN CAPTURE HERE.
[role="screenshot"]
image::images/obs-ai-assistant-output.png[AI Assistant conversation that reports on ]

IMPORTANT: Conversations created by the AI Assistant are public and accessible to every user with permissions to use the assistant.

When asked to send a message to another connector,
the AI Assistant will attempt to include a link to the generated conversation.
The `server.publicBaseUrl` setting must be correctly specified under {kib} settings, or the AI Assistant will be unable to generate this link.
When asked to send a message to another connector, such as Slack,
the AI Assistant attempts to include a link to the generated conversation. For example:

[role="screenshot"]
image::images/obs-ai-assistant-slack-message.png[Message sent by Slack by the AI Assistant includes a link to the coversation]

TIP: The `server.publicBaseUrl` setting must be correctly specified under {kib} settings,
or the AI Assistant is unable to generate this link.

The Observability AI Assistant connector will also be called when the alert recovers.

Expand Down

0 comments on commit c0f9a94

Please sign in to comment.