Skip to content

Commit

Permalink
Add coming soon banner (#15360)
Browse files Browse the repository at this point in the history
* add coming soon banner

* Grammar nits in metadata.csv

* add feedback fixes

* nit

---------

Co-authored-by: Ursula Chen <58821586+urseberry@users.noreply.github.com>
  • Loading branch information
steveny91 and urseberry authored Jul 25, 2023
1 parent d582828 commit 674091a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
19 changes: 13 additions & 6 deletions weaviate/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
# Agent Check: Weaviate

<div class="alert alert-info">
Coming soon: This integration is included in the upcoming 7.47.0 release of the Datadog Agent.
</div>

## Overview

This check monitors [Weaviate][1] through the Datadog Agent.
This check monitors [Weaviate][1] through the Datadog Agent. For more information, see [Weaviate monitoring][10].

## Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the [Autodiscovery Integration Templates][3] for guidance on applying these instructions.

### Installation

The Weaviate check is included in the [Datadog Agent][2] package. No additional installation is needed on your server.
Starting from Agent release 7.47.0, the Weaviate check is included in the [Datadog Agent][2] package.

**Note**: This check requires Agent v7.47.0 or later.

Expand All @@ -21,7 +25,7 @@ Weaviate can be configured to expose Prometheus-formatted metrics. The Datadog A
In addition, a small subset of metrics can be collected by communicating with different [API endpoints][11]. Specifically:
- `/v1/meta`: Version information
- `/v1/nodes`: Node-specific metrics such as objects and shards
- `/v1/.well-known`: HTTP response time and service liveness
- `/v1/.well-known/live`: HTTP response time and service liveness

**Note**: This check uses [OpenMetrics][12] for metric collection, which requires Python 3.

Expand All @@ -33,7 +37,7 @@ Make sure that the Prometheus-formatted metrics are exposed in your Weaviate clu
**Note**: The listed metrics can only be collected if they are available. Some metrics are generated only when certain actions are performed. For example, the object deletion metric is exposed only when an object is deleted.

The two most important parameters for configuring the Weaviate check are as follows:
- `openmetrics_endpoint`: This parameter should be set to the location where the Prometheus-formatted metrics are exposed. The default port is `2112`, but it can be configured using the `PROMETHEUS_MONITORING_PORT` [environment variable][10]. In containerized environments, `%%host%%` can be used for [host autodetection][3].
- `openmetrics_endpoint`: This parameter should be set to the location where the Prometheus-formatted metrics are exposed. The default port is `2112`, but it can be configured using the `PROMETHEUS_MONITORING_PORT` [environment variable][10]. In containerized environments, `%%host%%` should be used for [host autodetection][3].
- `weaviate_api_endpoint`: This parameter is optional. By default, this parameter is set to `<hostname>:8080` and it specifies the configuration of the [RESTful API][11].

If authentication is required for the RESTful API endpoints, the check can be configured to provide an API key as part of the [request header][13].
Expand Down Expand Up @@ -66,6 +70,8 @@ spec:
# (...)
```

**Note**: You can set these annotations directly in your [Weaviate Helm chart][14] using `annotations` key.

### Validation

[Run the Agent's status subcommand][6] and look for `weaviate` under the Checks section.
Expand All @@ -89,7 +95,7 @@ See [service_checks.json][8] for a list of service checks provided by this integ
Need help? Contact [Datadog support][9].


[1]: **LINK_TO_INTEGRATION_SITE**
[1]: https://weaviate.io/developers/weaviate
[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/weaviate/datadog_checks/weaviate/data/conf.yaml.example
Expand All @@ -101,4 +107,5 @@ Need help? Contact [Datadog support][9].
[10]: https://weaviate.io/developers/weaviate/configuration/monitoring
[11]: https://weaviate.io/developers/weaviate/api/rest
[12]: https://docs.datadoghq.com/integrations/openmetrics/
[13]: https://github.com/DataDog/integrations-core/blob/7.46.x/openmetrics/datadog_checks/openmetrics/data/conf.yaml.example#L544-L546
[13]: https://github.com/DataDog/integrations-core/blob/7.46.x/openmetrics/datadog_checks/openmetrics/data/conf.yaml.example#L544-L546
[14]: https://github.com/weaviate/weaviate-helm/blob/576f613bad3f8e25015c61a7143800123ab378d3/weaviate/values.yaml#L1196
6 changes: 3 additions & 3 deletions weaviate/metadata.csv
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ weaviate.go.memstats.heap.alloc_bytes,gauge,,byte,,The number of heap bytes allo
weaviate.go.memstats.heap.idle_bytes,gauge,,byte,,The number of heap bytes waiting to be used in the Weaviate instance,0,weaviate,weaviate go memstats heap idle_bytes,
weaviate.go.memstats.heap.inuse_bytes,gauge,,byte,,The number of heap bytes that are in use in the Weaviate instance,0,weaviate,weaviate go memstats heap inuse_bytes,
weaviate.go.memstats.heap.objects,gauge,,object,,The number of allocated objects in the Weaviate instance,0,weaviate,weaviate go memstats heap objects,
weaviate.go.memstats.heap.released_bytes,gauge,,byte,,The number of heap bytes released to OS in the Weaviate instance,0,weaviate,weaviate go memstats heap released_bytes,
weaviate.go.memstats.heap.released_bytes,gauge,,byte,,The number of heap bytes released to the OS in the Weaviate instance,0,weaviate,weaviate go memstats heap released_bytes,
weaviate.go.memstats.heap.sys_bytes,gauge,,byte,,The number of heap bytes obtained from system in the Weaviate instance,0,weaviate,weaviate go memstats heap sys_bytes,
weaviate.go.memstats.lookups.count,count,,,,The number of pointer lookups,0,weaviate,weaviate go memstats lookups,
weaviate.go.memstats.mallocs.count,count,,,,The number of mallocs,0,weaviate,weaviate go memstats mallocs,
Expand All @@ -52,7 +52,7 @@ weaviate.go.memstats.stack.sys_bytes,gauge,,byte,,The number of bytes obtained f
weaviate.go.memstats.sys_bytes,gauge,,byte,,The number of bytes obtained from system in the Weaviate instance,0,weaviate,weaviate go memstats sys_bytes,
weaviate.go.threads,gauge,,thread,,The number of OS threads created in the Weaviate instance,0,weaviate,weaviate go threads,
weaviate.lsm.active.segments,gauge,,segment,,The number of currently present segments per shard. Granularity is shard of a class. Grouped by strategy,0,weaviate,weaviate startup diskio throughput sum,
weaviate.lsm.bloom.filters.duration_ms.count,count,,operation,,The number of samples used to calculate the duration of an bloom operation,0,weaviate,weaviate lsm blood duration count,
weaviate.lsm.bloom.filters.duration_ms.count,count,,operation,,The number of samples used to calculate the duration of a bloom operation,0,weaviate,weaviate lsm blood duration count,
weaviate.lsm.bloom.filters.duration_ms.sum,count,,millisecond,,The duration of a bloom filter operation per shard in ms. Granularity is shard of a class. Grouped by strategy,0,weaviate,weaviate lsm blood duration sum,
weaviate.lsm.memtable.durations_ms.count,count,,operation,,The number of samples used to calculate the duration of a sync or async vector index maintenance operation,0,weaviate,weaviate vector index maintenance durations count,
weaviate.lsm.memtable.durations_ms.sum,count,,millisecond,,The duration of a sync or async vector index maintenance operation. The operation itself is defined through the operation label,0,weaviate,weaviate vector index maintenance durations sum,
Expand Down Expand Up @@ -98,4 +98,4 @@ weaviate.http.latency_ms,gauge,,millisecond,,The HTTP request response time late
weaviate.node.shard.objects,gauge,,object,,The number of objects inside a Weaviate shard,0,weaviate,weaviate node shard,
weaviate.node.stats.objects,gauge,,object,,The number of objects inside a Weaviate node,0,weaviate,weaviate node stats object,
weaviate.node.stats.shards,gauge,,shard,,The number of shard inside a Weaviate shard,0,weaviate,weaviate node stats shard,
weaviate.node.status,gauge,,,,"The current status of a Weaviate Node. 0:HEALTHY, 1:UNHEALTHY, 2:UNAVAILABLE, and 3:UNKNOWN",0,weaviate,weaviate node status,
weaviate.node.status,gauge,,,,"The current status of a Weaviate Node. 0:HEALTHY, 1:UNHEALTHY, 2:UNAVAILABLE, and 3:UNKNOWN",0,weaviate,weaviate node status,

0 comments on commit 674091a

Please sign in to comment.