Configure the Prometheus receiver to collect Weaviate metrics

Learn how to configure the Prometheus receiver to collect Weaviate metrics.

You can monitor the performance of Weaviate databases by configuring your Weaviate instance to send metrics to Splunk Observability Cloud. This solution uses the Prometheus receiver to collect metrics from Weaviate, which exposes a /metrics endpoint that publishes Prometheus-compatible metrics.

Complete the following high-level steps to collect data from and monitor the performance of Weaviate databases.

Ensure that you meet the prerequisites.
Configure and activate the component for Weaviate.
Use the Weaviate navigator to monitor the performance of Weaviate databases.

Prerequisites

Learn about the prerequisites required to configure the Prometheus receiver to collect Weaviate metrics.

To configure the Prometheus receiver to collect metrics from Weaviate, you must meet the following requirements:

You have installed Weaviate on your host or container platform. For more information, see How to install Weaviate in the Weaviate documentation.
You have configured your Weaviate instance to expose the /metrics endpoint, which publishes Prometheus-compatible metrics. For more information, see Enable within Weaviate in the Weaviate documentation.

Configure and activate the component for Weaviate

Learn how to configure and activate the component for Weaviate.

Complete the following steps to configure and activate the component for Weaviate.

Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
Activate the Prometheus receiver for Weaviate manually in the Splunk Distribution of the OpenTelemetry Collector configuration by making the following changes to your configuration file:
1. Add prometheus/weaviate to the receivers section. For example:
```
prometheus/weaviate:
  config:
    scrape_configs:
      - job_name: 'weaviate-metrics'
        metrics_path: /metrics
        scrape_interval: 15s
        static_configs:
          - targets: ['localhost:2112']
```
2. Add the receiver in the metrics pipeline of the service section. For example:
```
service:
  pipelines:
    metrics:
      receivers: [prometheus/weaviate]
```
Restart the Splunk Distribution of the OpenTelemetry Collector.

Monitor the performance of Weaviate databases

Learn how to navigate to the Weaviate navigator, which you can use to monitor the performance of Weaviate databases.

Complete the following steps to access the Weaviate navigator and monitor the performance of Weaviate databases. For more information on navigators, see Use navigators.

From the Splunk Observability Cloud main menu, select Infrastructure.
Under AI/ML, select AI Frameworks.
Select the Weaviate summary card.

Metrics and attributes

Learn about the available monitoring metrics for Weaviate databases.

For the complete list of metrics and resource attributes obtainable through Weaviate’s metric system, see the prometheus.go source file in the Weaviate GitHub repository.

For a subset of notable metrics, see Obtainable Metrics in the Weaviate documentation.

Troubleshoot

Learn how to get help if you can't see your data in Splunk Observability Cloud.

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways:

Splunk Observability Cloud customers can submit a case in the Splunk Support Portal or contact Splunk Support.

Prospective customers and free trial users can ask a question and get answers through community support in the Splunk Community.

Documentation