Skip to content
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

BitsAI updates #22336

Merged
merged 11 commits into from
Apr 9, 2024
36 changes: 28 additions & 8 deletions config/_default/menus/menus.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1115,12 +1115,32 @@ main:
identifier: watchdog_faulty_deployment_detection
parent: watchdog_top_level
weight: 5
- name: Bits AI
pre: bits-ai
identifier: bits_ai
parent: platform_heading
weight: 20000
- name: Getting Started
url: bits_ai/getting_started
identifier: bits_ai_getting_started
parent: bits_ai
weight: 1
- name: Managing Incidents
url: bits_ai/managing_incidents
identifier: bits_ai_managing_incidents
parent: bits_ai
weight: 2
- name: Natural Language Querying
url: bits_ai/query_examples
identifier: bits_ai_natural_language_querying
parent: bits_ai
weight: 3
- name: Dashboards
url: dashboards/
pre: dashboard
identifier: dashboards
parent: platform_heading
weight: 20000
weight: 30000
- name: Configure
identifier: dashboards_configure
url: dashboards/configure/
Expand Down Expand Up @@ -1236,7 +1256,7 @@ main:
identifier: infrastructure
pre: host-map
parent: platform_heading
weight: 30000
weight: 40000
- name: Host and Container Maps
url: infrastructure/hostmap/
parent: infrastructure
Expand Down Expand Up @@ -1297,7 +1317,7 @@ main:
identifier: metrics_top_level
pre: metric
parent: platform_heading
weight: 40000
weight: 50000
- name: Custom Metrics
url: metrics/custom_metrics/
parent: metrics_top_level
Expand Down Expand Up @@ -1388,7 +1408,7 @@ main:
identifier: notebooks
pre: notebook
parent: platform_heading
weight: 50000
weight: 60000
- name: Guides
url: notebooks/guide
parent: notebooks
Expand All @@ -1399,7 +1419,7 @@ main:
pre: monitor
identifier: alerting
parent: platform_heading
weight: 60000
weight: 70000
- name: Configure Monitors
url: monitors/configuration/
parent: alerting
Expand Down Expand Up @@ -1580,7 +1600,7 @@ main:
pre: service-catalog
parent: platform_heading
identifier: service_catalog
weight: 70000
weight: 80000
- name: Browsing
url: service_catalog/browsing
parent: service_catalog
Expand Down Expand Up @@ -1631,7 +1651,7 @@ main:
pre: api-catalog
parent: platform_heading
identifier: api_catalog
weight: 80000
weight: 90000
- name: Exploring APIs
url: /api_catalog/explore_apis/
identifier: api_catalog_explore
Expand Down Expand Up @@ -1677,7 +1697,7 @@ main:
pre: error-tracking
parent: platform_heading
identifier: error_tracking
weight: 90000
weight: 100000
- name: Explorer
url: error_tracking/explorer
parent: error_tracking
Expand Down
50 changes: 21 additions & 29 deletions content/en/bits_ai/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Bits AI
kind: documentation
disable_toc: false
private: true
private: false
is_beta: true
further_reading:
- link: "https://www.datadoghq.com/product/platform/bits-ai/"
Expand All @@ -16,60 +16,52 @@ further_reading:
text: "Bits AI announcement"
---

{{< callout url="https://docs.google.com/forms/d/e/1FAIpQLSfBuPfdyhgqjjduDYpOM5twJdkdDnTTxJdCCWonauaBxWTCnQ/viewform" >}}
Bits AI is in private beta. Fill out this form to join the wait list.
{{< /callout >}}
Bits AI is a platform-wide copilot that helps you identify and remediate issues in your applications and infrastructure. You can query Bits AI in the Datadog web app, the Datadog mobile app, and in Slack.

Bits AI is a generative AI interface that helps you identify and remediate issues in your applications and infrastructure. You can query Bits AI in the Datadog web app, the Datadog mobile app, and in Slack.

For detailed setup and usage instructions, see the additional Bits AI documentation:
- [Getting Started][1]
- [Query Examples][4]
- [Managing Incidents][3]
For detailed setup and usage instructions, see the [Getting Started][1] documentation.

## Features

### Query data in natural language

{{< beta-callout url="https://docs.google.com/forms/d/e/1FAIpQLSfBuPfdyhgqjjduDYpOM5twJdkdDnTTxJdCCWonauaBxWTCnQ/viewform" >}}
Natural language querying is in private beta. Fill out this form to join the wait list.
{{< /beta-callout >}}

Bits AI supports natural language querying for logs, APM traces, infrastructure data, cloud cost, and RUM. You can also ask Bits AI about the health and ownership of your services, and retrieve Datadog resources related to those services.

You can ask Bits AI questions such as
You can ask Bits AI questions such as:
- `Who is on call for example-service?`
- `Find me the example-service dashboard.`
- `What is going on with example-service?`
- `Are there any issues with example-service's dependencies?`

When relevant to your query, Bits AI surfaces faulty deployments, Watchdog anomalies, incidents, alerts, and more. It also expands on issues with upstream and downstream dependencies. This feature works best if your APM services are tagged by **team** and **service**.

For more example query syntax, see the [Example Natural Language Queries][2] guide.

### Streamline incident management

Within [Datadog Incident Management][2], Bits AI can help you
Within [Datadog Incident Management][3], Bits AI can help you

- **Stay informed:** Ask Datadog to send you an update on the incident in 15 minutes.
- **Stay informed:** Get an up-to-date summary of the incident when you join an incident Slack channel.
- **Engage responders:** Page on-call teams with PagerDuty with Slack queries like "`@DataDog` Page the team that owns example-service."
- **Update incidents:** Update the severity level and status of an incident.
- **Generate a postmortem:** Quickly create a first draft to review and revise.

See [Managing Incidents][3] for details.

### Run workflows in Slack
- **Find related incidents**: Search through your entire incident history and find similar incidents to the one you're currently in.
- **Generate a postmortem:** Get a head start with a first draft, which you can then review and revise.

If you have Datadog Workflows configured, you can trigger them from Slack. For example, sending `@Datadog Give me a workflow to block IPs in Cloudflare` starts a conversation in which Bits AI confirms the desired workflow and asks for any required parameters.

{{< img src="bits_ai/slack-cloudflare-workflow.png" alt="Workflow request to Bits AI in Slack" style="width:60%;">}}

See [Querying in Slack][5] for details.
See [Managing Incidents][4] for details.

## Feedback

Bits AI is in active development, and your feedback is valuable. To report issues or request features, contact your Customer Success Manager.

[1]: /bits_ai/getting_started/
[2]: /service_management/incident_management
[3]: /bits_ai/managing_incidents/
[4]: /bits_ai/query_examples
[5]: /bits_ai/getting_started/#querying-in-slack

## Further reading

{{< partial name="whats-next/whats-next.html" >}}
{{< partial name="whats-next/whats-next.html" >}}

[1]: /bits_ai/getting_started/
[2]: /bits_ai/query_examples
[3]: /service_management/incident_management
[4]: /bits_ai/managing_incidents/
52 changes: 26 additions & 26 deletions content/en/bits_ai/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,57 @@
---
title: Getting Started
kind: guide
disable_toc: false
private: true
is_beta: true
further_reading:
- link: "bits_ai/"
tag: "Documentation"
text: "Bits AI Overview"
- link: "bits_ai/query_examples"
tag: "Documentation"
text: "Example Natural Language Queries"
- link: "bits_ai/managing_incidents/"
tag: "Documentation"
text: "Managing Incidents"
---

{{< callout url="https://docs.google.com/forms/d/e/1FAIpQLSfBuPfdyhgqjjduDYpOM5twJdkdDnTTxJdCCWonauaBxWTCnQ/viewform" >}}
Bits AI is in private beta. Fill out this form to join the wait list.
{{< /callout >}}

The page describes how to run a natural language query in Datadog and in Slack. For example query verbiage, see [Example Natural Language Queries][2].

## Querying in Datadog

You can access Bits AI from its dedicated chat panel and from the search bars of some products.

### In the chat panel

To open the chat panel, click on **Ask Bits AI** at the bottom of the navigation bar, or use **Cmd + /** to show or hide the chat panel.

{{< img src="bits_ai/bits-ai-nav.png" alt="Bits AI link in the side nav of the Datadog app" style="width:30%;">}}
To open the chat panel in the app, click **Bits AI** at the bottom-left corner of the navigation menu, or use `Cmd + /` to show or hide the chat panel.

Some responses from Bits AI include a **suggestions** button. Clicking it displays additional queries that apply to the conversation's context.

{{< img src="bits_ai/chat-panel.png" alt="Bits AI chat panel" style="width:90%;">}}
{{< img src="bits_ai/getting_started/chat_panel_star_service.png" alt="Bits AI chat panel with example question of 'How do I star a service' and Bits AI's answer" style="width:90%;">}}

### In a search bar

Some Datadog search bars support natural language querying.

{{< img src="bits_ai/ai-enabled-search-bar.png" alt="Search bar with natural language querying enabled" style="width:90%;">}}
{{< img src="bits_ai/getting_started/ai-enabled-search-bar.png" alt="Search bar with natural language querying enabled" style="width:90%;">}}

Where available, the feature can be accessed by typing a space into the search bar, then choosing from the suggested queries or typing a new query.

{{< img src="bits_ai/search-bar-with-ai-suggestions.png" alt="Search bar displaying suggested natural language queries" style="width:90%;">}}
{{< img src="bits_ai/getting_started/search-bar-with-ai-suggestions.png" alt="Search bar displaying suggested natural language queries" style="width:90%;">}}

### On the mobile app

{{< img src="bits_ai/getting_started/bitsai_mobile_app.PNG" alt="View of the Mobile App Home dashboard with BitsAI" style="width:40%;" >}}
estherk15 marked this conversation as resolved.
Show resolved Hide resolved

Click Bits AI on the mobile app to access the same querying features available on the browser.

## Querying in Slack

1. [Connect your Datadog account to your Slack workspace][1].
1. Use the `/dd connect` command to display a list of accounts to connect to.
1. In Slack, use the `/dd connect` command to display a list of accounts to connect to.
1. Choose the name of your Datadog account in the dropdown.
1. Authorize additional permissions needed by Bits AI. Your Customer Success Manager should have emailed you a link for this step; contact them if you're unable to locate it.
1. Authorize additional permissions needed by Bits AI.

After setup is completed, you can send queries to `@Datadog` in natural language: `@Datadog Are there any issues with example-service's dependencies?`

{{< img src="bits_ai/example-slack-query.png" alt="Output of an example service-dependency query in Slack" style="width:60%;">}}
{{< img src="bits_ai/getting_started/example-slack-query.png" alt="Output of an example service-dependency query in Slack" style="width:60%;">}}

## Further reading

{{< whatsnext desc="Additional Bits AI documentation:">}}
{{< nextlink href="bits_ai/" >}}Feature Overview{{< /nextlink >}}
{{< nextlink href="bits_ai/query_examples" >}}Query Examples{{< /nextlink >}}
{{< nextlink href="bits_ai/managing_incidents/" >}}Managing Incidents{{< /nextlink >}}
{{< /whatsnext >}}
{{< partial name="whats-next/whats-next.html" >}}

[1]: /integrations/slack/?tab=applicationforslack
[2]: /bits_ai/query_examples/
74 changes: 48 additions & 26 deletions content/en/bits_ai/managing_incidents.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,68 @@
---
title: Managing Incidents
kind: guide
disable_toc: false
private: true
is_beta: true
further_reading:
- link: "bits_ai/"
tag: "Documentation"
text: "Bits AI Overview"
- link: "bits_ai/getting_started"
tag: "Documentation"
text: "Getting Started"
- link: "bits_ai/query_examples"
tag: "Documentation"
text: "Example Natural Language Queries"
---

{{< callout url="https://docs.google.com/forms/d/e/1FAIpQLSfBuPfdyhgqjjduDYpOM5twJdkdDnTTxJdCCWonauaBxWTCnQ/viewform" >}}
Bits AI is in private beta. Fill out this form to join the wait list.
{{< /callout >}}
## Overview

<div class="alert alert-warning">The following features are part of the <a href="https://www.datadoghq.com/product/incident-management/">Datadog Incident Management</a> product.</div>

Bits AI simplifies incident management processes, improves collaboration, and provides valuable support for incident responders, making it a beneficial tool for efficient incident resolution.

## Prerequisites

- Make sure you've enabled the "Mirror all incident Slack channel messages to its incident timeline in real-time" in **[Incident > Settings > Integrations][3] > Slack**. This allows Datadog to generate summaries and postmortems from Slack conversations.
- The incident channel name must be prefixed with `#incident-`. This enables you to use Bits AI in Slack (`@Datadog`) to ask questions about the incident.
- Your Datadog account must be connected to Slack. Running a query automatically initiates this process, which can be completed by following the prompts.
- Your Datadog account must be connected to Slack. Running the `/dd` connect command automatically initiates this process, which can be completed by following the prompts.
- In **[Incident > Settings > Integrations][3] > Slack**, enable the **"Push Slack channel messages to the incident timeline"** and **"Activate Bits AI features in incident Slack channels for your organization"** toggles. This allows Datadog to ingest Slack conversations into the incident timeline to generate summaries and postmortems. **Note**: a Slack workspace can only have Bits AI activated for one Datadog Organization.
estherk15 marked this conversation as resolved.
Show resolved Hide resolved
- Incident channels you'd like to work with Bits AI must be prefixed with `#incident-`.
- To ask Bits AI questions about incidents from any Slack channel, you must invite Bits AI to that channel. Run the `@Datadog` command and follow the instructions on the screen.

{{< img src="bits_ai/managing_incidents/bitsai_slack_prerequisites.png" alt="Slack integration settings in Datadog" style="width:90%;">}}

## View incident summaries

When you join an incident channel in Slack, you automatically receive a summary of the incident. The channel must be connected to Incident Management and **have at least ten messages**. The summary, which is only visible to you, does not persist across reloads, between desktop and mobile apps, or across sessions.

At any time, you can ask for a fresh summary by asking `@DataDog Give me a summary of this incident`.
estherk15 marked this conversation as resolved.
Show resolved Hide resolved

{{< img src="bits_ai/integration-settings.png" alt="Slack integration settings in Datadog" style="width:90%;">}}
## Search across your entire incident history and ask questions

## View incident summaries and schedule updates
You can ask Bits to find incidents that you're looking for. For instance,
estherk15 marked this conversation as resolved.
Show resolved Hide resolved
- `@Datadog How many incidents are currently ongoing?`
- `@Datadog Show me all Sev-1 incidents that occurred in the past week`

When you join an incident channel in Slack, you automatically receive a summary of the incident. The channel must be connected to Incident Management and have at least fifteen messages. The summary, which is only visible to you, does not persist across reloads, between desktop and mobile apps, or across sessions.
You can then investigate further and ask questions about those incidents, like `@Datadog What was the root cause of incident-123?` or `@Datadog What remediation actions did the responders take in incident-123?`

At any time, you can ask for a fresh summary by asking `@DataDog Give me a summary of this incident`. Schedule an update by asking `@DataDog Give me an update in X minutes`.
Bits AI can also perform semantic search for related incidents. If you're responding to an incident, you can ask Bits AI to find other active incidents that look similar to the one you're in (`@Datadog Are there any related incidents?`). Bits AI looks for incidents that were active within the past 2 hours. You can also specify the time frame you want Bits to look across. If you say `@Datadog Find me incidents related to DDOS attacks from the past month`, Bits AI returns both active and resolved DDOS incidents from the past month.
estherk15 marked this conversation as resolved.
Show resolved Hide resolved

## Ask questions
Or if you suspect there's an issue before an incident is even declared, you can ask Bits AI a question like `@Datadog A customer is unable to check out. Is there an incident?` or `@Datadog Are there any incidents now impacting the payments service?`
estherk15 marked this conversation as resolved.
Show resolved Hide resolved

You can use the Bits AI chatbot in Slack to ask customized questions about your incident: `@Datadog I am a customer relations manager, and my customer is asking for an update on incident 2781. Can you give me a few bullet points that I can send to my customer?`
**Note**: Incident search is limited to the past 120 days.

## Update the severity level and status
## Manage incidents

- Severity level: `@Datadog Update this incident to SEV-3`
- Status: `@Datadog Mark this incident as stable`
Without going into the Datadog web app, you can ask Bits AI in Slack to:
- Open an incident: `@Datadog Declare an incident`
- Change an incident's severity level: `@Datadog Update this incident to SEV-3`
- Change an incident's status: `@Datadog Mark this incident as stable`

## Generate a first draft of a postmortem

To generate an AI-assisted postmortem draft,
<div class="alert alert-info">AI-assisted postmortem drafting is in private beta.</div>

To generate an AI-assisted postmortem draft:

1. Navigate to the incident page in Datadog. For example, to view Incident 2679, you might search for `2679` on the [**Incidents**][2] page and click the relevant match.
1. Ensure that the incident is resolved and that the timeline has 15 or more messages.
1. Ensure that the incident is resolved and that the timeline has ten or more messages.
1. Click the **Generate Postmortem** button.
1. Select the AI template.
1. Allow up to one minute for the postmortem to be generated. Do not close the tab during this time.
Expand All @@ -56,17 +78,17 @@ If an incident already has a linked postmortem, you can unlink it before [genera

## Customize the postmortem template

1. Navigate to [**Service Management > Settings > Postmortems**][1].
1. Navigate to [**Service Mgmt > Incident > Settings > Postmortems**][1].
1. Click **New Postmortem Template** and customize your template using the provided incident variables.
- Variables prefixed by `ai`, such as `incident.ai_action_items`, yield AI-generated content instead of fixed values.
- You must use a heading before each variable.
1. Save your template to make it available as a template option during [postmortem generation](#generate-a-first-draft-of-a-postmortem).

{{< whatsnext desc="Additional Bits AI documentation:">}}
{{< nextlink href="bits_ai/" >}}Feature Overview{{< /nextlink >}}
{{< nextlink href="bits_ai/getting_started" >}}Getting Started{{< /nextlink >}}
{{< nextlink href="bits_ai/query_examples" >}}Query Examples{{< /nextlink >}}
{{< /whatsnext >}}

## Further reading

{{< partial name="whats-next/whats-next.html" >}}


[1]: https://app.datadoghq.com/incidents/settings#Postmortems
[2]: https://app.datadoghq.com/incidents
Expand Down
Loading
Loading