Skip to content

[Obs Docs] Update Observability AI Assistant functions #2005

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 29 additions & 8 deletions solutions/observability/observability-ai-assistant.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,12 +278,39 @@ Main functions:
`alerts`
: Get alerts for {{observability}}.

`changes`
: Get change points like spikes and dips for logs and metrics data.

`context`
: Get context for what you're looking at on your screen and for recalled documents from the knowledge base that matches your query.

`elasticsearch`
: Call {{es}} APIs on your behalf.

`execute_connector`
: Call a {{kib}} connector on your behalf.

`execute_query`
: Run an ES|QL query.

`get_alerts_dataset_info`
: Get information about alerts data within a specified time range.

`get_data_on_screen`
: Get the structured data of content currently visible on the user's screen. Use this function to provide more accurate and context-aware responses to your questions.

`get_dataset_info`
: Get information about available indices and datasets and their fields.

`kibana`
: Call {{kib}} APIs on your behalf.

`query`
: Generate, execute, and visualize queries based on your request.

`retrieve_elastic_doc`
: Get relevant Elastic documentation.

`summarize`
: Summarize parts of the conversation.

Expand All @@ -292,18 +319,12 @@ Main functions:

Additional functions are available when your cluster has APM data:

`get_apm_correlations`
: Get field values that are more prominent in the foreground set than the background set. This can be useful in determining which attributes (such as `error.message`, `service.node.name`, or `transaction.name`) are contributing to, for instance, a higher latency. Another option is a time-based comparison, where you compare before and after a change point.
`get_apm_dataset_info`
: Get information about APM data.

`get_apm_downstream_dependencies`
: Get the downstream dependencies (services or uninstrumented backends) for a service. Map the downstream dependency name to a service by returning both `span.destination.service.resource` and `service.name`. Use this to drill down further if needed.

`get_apm_error_document`
: Get a sample error document based on the grouping name. This also includes the stacktrace of the error, which might hint to the cause.

`get_apm_service_summary`
: Get a summary of a single service, including the language, service version, deployments, the environments, and the infrastructure that it is running in. For example, the number of pods and a list of their downstream dependencies. It also returns active alerts and anomalies.

`get_apm_services_list`
: Get the list of monitored services, their health statuses, and alerts.

Expand Down
Loading