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

Add Zilliz Cloud integration #2534

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
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
7 changes: 7 additions & 0 deletions zilliz_cloud_zilliz_cloud/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# CHANGELOG - zilliz-cloud

## 1.0.0 / 2024-11-08

_**Added**_:

* Adds Zilliz Cloud Datadog integration, including a dedicated metrics dashboard and several monitor templates.
33 changes: 33 additions & 0 deletions zilliz_cloud_zilliz_cloud/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Zilliz Cloud

## Overview

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a sentence to describe Zilliz.

Zilliz Cloud can push metrics to Datadog to visualize key Zilliz Cloud cluster metrics.

This integration includes a dashboard that give visibility into your vector database performance, and several monitor templates to help stay ahead of potential issues.
Comment on lines +5 to +7
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Zilliz Cloud can push metrics to Datadog to visualize key Zilliz Cloud cluster metrics.
This integration includes a dashboard that give visibility into your vector database performance, and several monitor templates to help stay ahead of potential issues.
Zilliz Cloud can push metrics to Datadog to visualize key Zilliz Cloud cluster metrics. This integration includes a dashboard for monitoring vector database performance and several monitor templates to help prevent potential issues.


Note: The Zilliz Cloud Datadog integration is only available on Enterprise clusters.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Note: The Zilliz Cloud Datadog integration is only available on Enterprise clusters.
**Note**: The Zilliz Cloud Datadog integration is only available on Enterprise clusters.


## Setup

You can install the Zilliz Cloud Datadog Integration through following steps:
- Retrieve or create a Datadog API key. Also note down the Datadog site.
- Log into your Zilliz Cloud Console.
- Enter the Project Integration page and select the Datadog card.
- Choose the Datadog site you wish to send metrics to, and enter the Datadog API key.
- Select clusters you wish to integrate.
Comment on lines +13 to +18
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can install the Zilliz Cloud Datadog Integration through following steps:
- Retrieve or create a Datadog API key. Also note down the Datadog site.
- Log into your Zilliz Cloud Console.
- Enter the Project Integration page and select the Datadog card.
- Choose the Datadog site you wish to send metrics to, and enter the Datadog API key.
- Select clusters you wish to integrate.
To install the Zilliz Cloud Datadog Integration, follow these steps:
1. Retrieve or create a [Datadog API key][3].
2. Take note of the Datadog site.
3. Log into your Zilliz Cloud Console.
- Navigate to the Project Integration page and select the Datadog card.
- Choose the Datadog site you wish to send metrics to, and enter the Datadog API key.
- Select the clusters you wish to integrate.


## Uninstallation

You can unintall the Zilliz Cloud Datadog Integration through following steps:
- Log into your Zilliz Cloud Console.
- Enter the Project Integration page and select the Datadog card.
- Remove the Datadog Integration.
Comment on lines +22 to +25
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can unintall the Zilliz Cloud Datadog Integration through following steps:
- Log into your Zilliz Cloud Console.
- Enter the Project Integration page and select the Datadog card.
- Remove the Datadog Integration.
To uninstall the Zilliz Cloud Datadog Integration, follow these steps:
1. Log into your Zilliz Cloud Console.
2. Navigate to the Project Integration page and select the Datadog card.
3. Remove the Datadog Integration.


## Support

Need help? Contact [Zilliz support][1] or [Datadog Support][2].


[1]: https://support.zilliz.com/
[2]: https://docs.datadoghq.com/help/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[2]: https://docs.datadoghq.com/help/
[2]: https://docs.datadoghq.com/help/
[3]: https://docs.datadoghq.com/account_management/api-app-keys/

Loading
Loading