Send data to Redis

Most recent version: v0.0.1

See the changelog of the Redis Data sink type here.

Overview

Onum supports integration with Redis.

Prerequisites

The location of your Redis endpoint URL depends on how and where your Redis instance is hosted.

1. Local Redis

If you installed Redis directly on your server or are running it locally:

• Default Endpoint: The endpoint is typically the IP address or hostname of the machine running Redis, along with the default port.

  • Host: 127.0.0.1 (localhost) or the server's specific IP/hostname.

  • Port: 6379 (default Redis port).

• Configuration File: If you changed the default host or port, you'll find the configuration in the Redis configuration file (redis.conf). Look for the bind and port directives.

2. AWS ElastiCache for Redis

If you are using Amazon ElastiCache:

• AWS Management Console:

  1. Go to the ElastiCache console.

  2. Navigate to Redis clusters.

  3. Select the name of your cluster.

  4. The Primary Endpoint and Reader Endpoint(s) (for clusters with replicas) will be listed in the details section. The endpoint will look something like my-redis-instance.xxxxx.ng.0001.use1.cache.amazonaws.com:6379.

• AWS CLI: You can use the describe-cache-clusters command.

  • aws elasticache describe-cache-clusters --show-cache-node-info

3. Redis on Other Cloud Providers

For other managed cloud services:

• Cloud Console: Navigate to the dashboard or overview page for your Redis service instance. The endpoint (often called a Connection String, Host, or Endpoint URL) and port will be displayed there.

4. Docker Environments

If Redis is running in a Docker container:

• Docker Configuration: The endpoint is based on how you exposed the port.

  • If you mapped the container port to a local port (e.g., -p 6379:6379), the endpoint is often localhost:6379 (or the host's IP).

  • If running in a Docker network, you might use the container name or service name as the hostname.

Save these credentials for use in your sink.

Onum Setup

1

Log in to your Onum tenant and click Data Sinks> New Data sink.

2

Double-click the Redis Sink.

3

Enter a Name for the new Data Sink. Optionally, add a Description and some Tags to identify the Sink.

4

Decide whether or not to include this Data sink info in the metrics and graphs of the Home area.

5

Enter the URL of your Redis Endpoint* to establish the connection.

6

The Network Timeout settings determine the maximum amount of time Onum will wait for a response before taking an action.

• Read timeout* - how many milliseconds to wait to receive data from the server after a connection has been established.

• Write timeout* - the number of milliseconds to wait before considering the request a timeout.

Click Finish when complete. Your new Data sink will appear in the Data sinks area list.

Pipeline configuration

When you use this sink in a Pipeline, you can configure the output parameters. This is where you give the message the required format to be processed in Redis.

Output configuration

Decide how to store your data in Redis, which affects how you organize, access, and manage the data it receives.

SET

• Redis Key* - Select the field to be used as the Redis Key.

• Value* - Select the field to be used as the value (to create key-value pairs).

• Expiration (in seconds) - Set how many seconds must elapse before the key is considered expired.

HSET

• Redis Key* - Select the field to be used as the Redis Key.

• Redis field* - Select the field to be used as the Redis field in the HSET command.

• Value* - Select the field to be used as the value (to create key-value pairs).

• Expiration (in seconds) - Set how many seconds must elapse before the key is considered expired.

Add as many HSET commands as needed.

Click Save to save your configuration.