ContextQMD
Back to Redis

Rs Prometheus Grafana Quickstart

content/embeds/rs-prometheus-grafana-quickstart.md

latest10.4 KB
Original Source

You can use Prometheus and Grafana to collect and visualize your Redis Software metrics.

Metrics are exposed at the cluster, node, database, shard, and proxy levels.

  • Prometheus is an open source systems monitoring and alerting toolkit that aggregates metrics from different sources.
  • Grafana is an open source metrics visualization tool that processes Prometheus data.

You can use Prometheus and Grafana to:

  • Collect and display metrics not available in the Cluster Manager UI

  • Set up automatic alerts for all resources

  • Display Redis Software metrics alongside data from other systems

{{<image filename="images/rs/grafana-prometheus.png" alt="Graphic showing how Prometheus and Grafana collect and display data from a Redis Software Cluster. Prometheus collects metrics from the Redis Software cluster, and Grafana queries those metrics for visualization." width="80%" class="mx-auto block my-6 p-4 border border-redis-pen-300 rounded-lg shadow-sm">}}

To get started with Prometheus and Grafana, see the following quick start or see Redis Software Observability with Prometheus and Grafana for a more detailed tutorial.

Quick start

To get started with Prometheus and Grafana:

  1. Create a directory called 'prometheus' on your local machine.

  2. Within that directory, create a configuration file called prometheus.yml.

  3. Add the following contents to the configuration file and replace <cluster_name> with your Redis Software cluster's FQDN:

    {{< multitabs id="prometheus-config-yml" tab1="v2 (metrics stream engine)" tab2="v1" >}}

yml
global:
  scrape_interval: 15s
  evaluation_interval: 15s

# Attach these labels to any time series or alerts when communicating with
# external systems (federation, remote storage, Alertmanager).
  external_labels:
    monitor: "prometheus-stack-monitor"

# Load and evaluate rules in this file every 'evaluation_interval' seconds.
#rule_files:
# - "first.rules"
# - "second.rules"

scrape_configs:
# scrape Prometheus itself
  - job_name: prometheus
    scrape_interval: 10s
    scrape_timeout: 5s
    static_configs:
      - targets: ["localhost:9090"]

# scrape Redis Software
  - job_name: redis-enterprise
    scrape_interval: 30s
    scrape_timeout: 30s
    metrics_path: /v2
    scheme: https
    tls_config:
      insecure_skip_verify: true
    static_configs:
      - targets: ["<cluster_name>:8070"]

-tab-sep-

yml
global:
  scrape_interval: 15s
  evaluation_interval: 15s

# Attach these labels to any time series or alerts when communicating with
# external systems (federation, remote storage, Alertmanager).
  external_labels:
    monitor: "prometheus-stack-monitor"

# Load and evaluate rules in this file every 'evaluation_interval' seconds.
#rule_files:
# - "first.rules"
# - "second.rules"

scrape_configs:
# scrape Prometheus itself
  - job_name: prometheus
    scrape_interval: 10s
    scrape_timeout: 5s
    static_configs:
      - targets: ["localhost:9090"]

# scrape Redis Software
  - job_name: redis-enterprise
    scrape_interval: 30s
    scrape_timeout: 30s
    metrics_path: /
    scheme: https
    tls_config:
      insecure_skip_verify: true
    static_configs:
      - targets: ["<cluster_name>:8070"]

{{< /multitabs >}}

  1. Set up your Prometheus and Grafana servers.

    {{< note >}}

We recommend running Prometheus in Docker only for development and testing.

{{< /note >}}

To set up Prometheus and Grafana on Docker:
1. Create a _docker-compose.yml_ file:

    ```yml
    version: '3'
    services:
        prometheus-server:
            image: prom/prometheus
            ports:
                - 9090:9090
            volumes:
                - ./prometheus/prometheus.yml:/etc/prometheus/prometheus.yml

        grafana-ui:
            image: grafana/grafana
            ports:
                - 3000:3000
            environment:
                - GF_SECURITY_ADMIN_PASSWORD=secret
            links:
                - prometheus-server:prometheus
    ```

1. To start the containers, run:

    ```sh
    $ docker compose up -d
    ```

1. To check that all of the containers are up, run: 

    ```sh
    docker ps
    ```

1. In your browser, sign in to Prometheus at `http://localhost:9090` to make sure the server is running.

1. Select **Status** and then **Targets** to check that Prometheus is collecting data from your Redis Software cluster.

    {{<image filename="images/rs/prometheus-target.png" alt="The Redis Software target showing that Prometheus is connected to the Redis Software Cluster.">}}

    If Prometheus is connected to the cluster, you can type **node_up** in the Expression field on the Prometheus home page to see the cluster metrics.

  1. Configure the Grafana datasource:

    1. Sign in to Grafana. If you installed Grafana locally, go to http://localhost:3000 and sign in with:

      • Username: admin
      • Password: secret

    2. In the Grafana configuration menu, select Data Sources.

    3. Select Add data source.

    4. Select Prometheus from the list of data source types.

      {{<image filename="images/rs/prometheus-datasource.png" alt="The Prometheus data source in the list of data sources on Grafana.">}}

    5. Enter the Prometheus configuration information:

      • Name: redis-enterprise
      • URL: http://<your prometheus server name>:9090

      {{<image filename="images/rs/prometheus-connection.png" alt="The Prometheus connection form in Grafana.">}}

    {{< note >}}

  • If the network port is not accessible to the Grafana server, select the Browser option from the Access menu.

  • In a testing environment, you can select Skip TLS verification.

    {{< /note >}}

  1. Add dashboards for cluster, database, node, and shard metrics. To add preconfigured dashboards:
    1. In the Grafana dashboards menu, select Manage.
    2. Click Import.
    3. Upload one or more Grafana dashboards.

Grafana dashboards for Redis Software

Redis publishes preconfigured dashboards for Redis Software and Grafana.

{{< note >}} V1 dashboards are not compatible with the v2 metrics exporter endpoint. Make sure to use the correct dashboard version for your metrics endpoint. {{< /note >}}

These dashboards are open source. For additional dashboard options, or to file an issue, see the Redis Software observability Github repository.

For more information about configuring Grafana dashboards, see the Grafana documentation.

V1 metrics dashboards

Use the following dashboards when connecting to the v1 metrics endpoint (https://<cluster_name>:8070/):

V2 metrics dashboards

Use the following dashboards when connecting to the v2 metrics endpoint (https://<cluster_name>:8070/v2):