https://github.com/opensearch-project/dashboards-assistant

Dashboard assistant is a way for users on OpenSearch Dashboards to interact with an assistant through chat or the different OSD pages
https://github.com/opensearch-project/dashboards-assistant

Last synced: 2 months ago
JSON representation

Dashboard assistant is a way for users on OpenSearch Dashboards to interact with an assistant through chat or the different OSD pages

• Host: GitHub
• URL: https://github.com/opensearch-project/dashboards-assistant
• Owner: opensearch-project
• License: apache-2.0
• Created: 2023-09-21T02:55:09.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-04-21T06:46:32.000Z (2 months ago)
• Last Synced: 2025-04-21T07:44:07.478Z (2 months ago)
• Language: TypeScript
• Homepage: https://opensearch.org/
• Size: 1.9 MB
• Stars: 23
• Watchers: 11
• Forks: 34
• Open Issues: 34
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
[![Forum](https://img.shields.io/badge/chat-on%20forums-blue)](https://forum.opensearch.org/t/feedback-opensearch-assistant/16741)

![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success)



- [OpenSearch Assistant Dashboards](#opensearch-assistant-dashboards)

- [Highlights](#highlights)

- [Documentation](#documentation)

- [Contributing](#contributing)

- [Code of Conduct](#code-of-conduct)

- [Security](#security)

- [License](#license)

- [Copyright](#copyright)

# OpenSearch Assistant Dashboards

The OpenSearch Assistant Dashboards plugin lets you have an opensearch assistant to help dashboards users use OpenSearch.

## How to get started

See [getting started guide](GETTING_STARTED_GUIDE.md) to how to deploy this Assistant on your machine with docker images.

**Note** that the `feature/langchain` is the branch used in the getting started guide.

### Supported tools

This requires setting `assistant.chat.enabled` to `true` in `opensearch_dashboards.yml` to use these skills:

1. Query OpenSearch: Use to generate and run a PPL Query to get results for a generic user question related to data stored in their OpenSearch cluster.

2. Get log info: Use to get information of logs if the question contains an OpenSearch log index.

3. Get log error info: Use to get information of logs with errors if the question contains an OpenSearch log index.

4. Search Alerting Monitors By Index: Use this tool to search alerting monitors by index name in the OpenSearch cluster.

5. Get All Alerts: Use this tool to search all alerts triggered in the OpenSearch cluster.

6. Get ticket information: Use this tool to find tickets in the system with incidents that are relevant to a question about error causes. 

7. Get generic information: Use this tool to answer a generic question not related to OpenSearch cluster. This tool takes the question as input.

8. Get OpenSearch indices: Use this tool to get high-level information (e. health, status, index, docs.count) about indices in a cluster, including backing indices for data streams in the OpenSearch cluster.

9. Check OpenSearch index existence: Use this tool to check if a data stream, index, or alias exists in the OpenSearch cluster.

10. Find Visualizations: Use this tool to find user created visualizations.

11. Get trace groups: Use this to get information about each trace group.

12. Get traces: Use this to get information about each trace. 

13. Get trace services: Use this to get information about each service in trace analytics.

## Documentation

In the works.

## Contributing

See [developer guide](DEVELOPER_GUIDE.md) and [how to contribute to this project](CONTRIBUTING.md).

## Code of Conduct

This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

## Security

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue.

## License

This project is licensed under the [Apache v2.0 License](LICENSE).

## Copyright

Copyright OpenSearch Contributors. See [NOTICE](NOTICE) for details.