Skip to content

Commit

Permalink
Incorporate documentation suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
dkirov-dd committed Dec 19, 2024
1 parent caf2c33 commit 8ee1670
Show file tree
Hide file tree
Showing 2 changed files with 256 additions and 263 deletions.
13 changes: 3 additions & 10 deletions milvus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,7 @@

## Overview

This check monitors [Milvus][1] through the Datadog Agent.

Include a high level overview of what this integration does:
- What does your product do (in 1-2 sentences)?
- What value will customers get from this integration, and why is it valuable to them?
- What specific data will your integration monitor, and what's the value of that data?
This check monitors [Milvus][1] through the Datadog Agent. It provides insights into your Milvus deployment's performance by collecting information about the latency and number of executions of individual operations. This integration also allows for monitoring the size and ressource allocation of your deployment.

## Setup

Expand All @@ -20,7 +15,7 @@ No additional installation is needed on your server.

### Configuration

1. Edit the `milvus.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your milvus performance data. See the [sample milvus.d/conf.yaml][4] for all available configuration options.
1. Edit the `milvus.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your Milvus performance data. See the [sample milvus.d/conf.yaml][4] for all available configuration options.

2. [Restart the Agent][5].

Expand All @@ -42,14 +37,12 @@ The Milvus integration does not include any events.

The Milvus integration does not include any service checks.

See [service_checks.json][8] for a list of service checks provided by this integration.

## Troubleshooting

Need help? Contact [Datadog support][9].


[1]: **LINK_TO_INTEGRATION_SITE**
[1]: https://milvus.io/
[2]: https://app.datadoghq.com/account/settings/agent/latest
[3]: https://docs.datadoghq.com/agent/kubernetes/integrations/
[4]: https://github.com/DataDog/integrations-core/blob/master/milvus/datadog_checks/milvus/data/conf.yaml.example
Expand Down
Loading

0 comments on commit 8ee1670

Please sign in to comment.