RedisTimeSeries Quick Start

RedisTimeSeries adds native time-series database capabilities to Redis.

Step 1: Add modules

Step 2: Connect

Download the “Redis Insight” desktop
tool to connect and interact

Mac | Windows | Linux
 

Quick start: Follow the steps below to get started in 10 minutes! 🚀

1. 🏎️ Register and subscribe

Getting started with Redis Cloud Essentials

To get started with Redis Enterprise Cloud Essentials, visit https://redislabs.com/try-redis-modules-for-free and fill out the form:

Fill out form

Once you click “Get Started,” we will send you an email with a link to activate your account and complete your signup process.


Adding your Redis Enterprise Cloud Essentials subscription

  1. In the Redis Enterprise Cloud menu, click Subscriptions
  2. At the bottom of the page, click the “+” sign, as shown below:

    Click the + sign

  3. Select your subscription configuration as shown here:

For the cloud provider, select Amazon AWS

Select Amazon AWS
The (1) arrow indicates where to choose AWS as your cloud provider for Redis Enterprise Cloud Essentials.

Select a region
The (2) arrow shows where to choose the ap-south-1 cloud region.

In the Redis Enterprise Cloud service levels, select the Redis Enterprise Cloud Essentials 30MB/1 Database level and click Create:

Select the Redis Enterprise Cloud Essentials 30MB/1 Database level and click Create
The (3) arrow shows how to create your first free database with the name “demotest”.

2. 🚃 Create a Database with Modules

Once you create a subscription, you are ready to create a database with modules enabled. As shown below, enter a name for the database you want to create:

Enter the database name
The (4) arrow shows where to enter the database name. The (5) arrow indicates where to enable modules on Redis Enterprise Cloud Essentials.

Move the toggle to select the module you want. You can choose one module at a time under Redis Enterprise Cloud Essentials. Please note that multiple modules capabilities are currently available only in Redis Cloud Pro.

Select the RediSearch module
The (6) arrow shows where to select the RediSearch module in Redis Enterprise Cloud Essentials.

Let’s go ahead and choose “RediSearch” as our first module. Click “Activate”:

Activate your new database
The (7) arrows shows where to Activate your new database.

The database will remain in “Pending” status until the process of configuring your new Redis database is completed. When the database is created, you will be able to see all the database settings, including:

  • Endpoint: The address you use to connect to the database.
  • Redis password: The password you must use in your application to connect to the database.

Copy the database endpoint
The (8) arrows shows where to copy the database endpoint (redis-16333.c212.ap-south-1.1.ec2.cloud.redislabs.com:16333) for future reference.

3. 🔌 Connect to the Database

Using RedisInsight

RedisInsight is an intuitive and efficient GUI for Redis, allowing you to interact with your databases and manage your data—with built-in support for most popular Redis modules. The free non-commercial add-on provides tools to analyze the memory, profile the performance of your database, and guide you toward better Redis usage.

Learn more about RedisInsight here!

RedisInsight provides built-in support for the RedisJSON, RediSearch, RedisGraph, Redis Streams, and RedisTimeSeries modules to make it even easier to query, visualize, and interactively manipulate search indexes, graphs, streams, and time-series data. Used properly, RedisInsight can make the experience of using modules with Redis Enterprise Cloud Essentials even smoother.

A full-featured desktop GUI client, RedisInsight is available for Windows, macOS, and Linux and is fully compatible with Redis Enterprise. It works with any cloud provider as long as you run it on a host with network access to your cloud-based Redis server. RedisInsight makes it easy to discover cloud databases and configure connection details with a single click. It allows you to automatically add Redis Enterprise Software and Redis Enterprise Cloud databases.

Local installation of RedisInsight:

To use RedisInsight on a local machine, download it for Windows, Mac, or Linux from the RedisInsight page on the RedisLabs website:

Click “Download” to open up a form that allows you to select the operating system of your choice. For example, let’s assume that you want to install RedisInsight on your macOS machine. Choose “Mac OS” as a platform as shown here:

 

Mac OS    Windows    Linux

 

Fill out the rest of the form and click “Download.” Please note that the package name is the combination of the platform and version as shown here:

redisinsight-<platform>-<version>

Running RedisInsight

Click on the RedisInsight executable and install it in your system.

Click on the RedisInsight executable

Head over to your web browser and go to http://localhost:8001


Using RedisInsight with Docker

You can also run RedisInsight inside Docker containers. Visit https://hub.docker.com/r/redislabs/redisinsight/tags to find the latest Docker image available over DockerHub.

$ docker run -v redisinsight:/db -p 8001:8001 redislabs/redisinsight:latest

Head over to your web browser and go to http://localhost:8001

Congratulations! You have successfully installed RedisInsight and are now ready to inspect your Redis data, monitor database health, and perform runtime server configuration with this browser-based management interface for your Redis deployment.

Once you accept the EULA and click “Confirm,” you are ready to add Redis databases, as shown here:

Accept the EULA and click Confirm

Select “ADD REDIS DATABASE” and then “Add Database”:

Select ADD REDIS DATABASE and then Add Dadtabase

Enter the requested details, including Name, Host (endpoint), Port, and Password in the form, as shown below. You can skip username for now. Then click “ADD REDIS DATABASE”:

Enter the requested details

Click on the pop-up box to see the RedisInsight dashboard:

Click on the pop-up box

How to use RedisInsight to run the Redis CLI

Finally, although RedisInsight is a great GUI, sometimes you want to work directly in the command-line interface (CLI). To do so, click “CLI” in the  menu on the left side of the RedisInsight UI:

 

The arrow highlights CLI option on RedisInsight

Then paste the appropriate Redis commands in the command section, marked with “>>” as shown below, and press Enter.

The (2) arrow points to where to set the string value of a key.

You can see the output displayed at the top of the screen. If it says “OK,” the command was executed successfully.

Now that RedisInsight is installed, we’re ready to look at individual Redis modules and see how they work with Redis Enterprise Cloud Essentials.

4. 🚀 RedisTimeSeries

This section will walk you through using some basic RedisTimeseries commands. You can run them from the Redis command-line interface (redis-cli) or use the CLI available in RedisInsight. (See part 2 of this tutorial to learn more about using the RedisInsight CLI.)

Using a basic air-quality dataset, we will show you how to:

  1. Create a new time series
  2. Add a new sample to the list of series
  3. Query a range across one or multiple time series

1. Create a new time series

Let’s create a time series representing air quality dataset measurements. To interact with RedisTimeSeries you will most often use the TS.RANGE command, but here you will create a time series per measurement using the TS.CREATE command. Once created, all the measurements will be sent using TS.ADD.

The sample command below creates a time series and populates it with three entries:

>> TS.CREATE ts:carbon_monoxide
>> TS.CREATE ts:relative_humidity
>> TS.CREATE ts:temperature RETENTION 60 LABELS sensor_id 2 area_id 32

In the above example, ts:carbon_monoxide, ts:relative_humidity and ts:temperature are key names. We are creating a time series with two labels (sensor_id and area_id are the fields with values 2 and 32 respectively) and a retention window of 60 milliseconds:

Add a new sample data to the time series

Let’s start to add samples into the keys that will be automatically created using this command:

>> TS.ADD ts:carbon_monoxide 1112596200 2.4
>> TS.ADD ts:relative_humidity 1112596200 18.3
>> TS.ADD ts:temperature 1112599800 28.3

>> TS.ADD ts:carbon_monoxide 1112599800 2.1
>> TS.ADD ts:relative_humidity 1112599800 13.5
>> TS.ADD ts:temperature 1112603400 28.5 

>> TS.ADD ts:carbon_monoxide 1112603400 2.2
>> TS.ADD ts:relative_humidity 1112603400 13.1
>> TS.ADD ts:temperature 1112607000 28.7

Querying the sample

Now that you have sample data in your time series, you’re ready to ask questions such as:

“How do I get the last sample?”

TS.GET is used to get the last sample. The returned array will contain the last sample timestamp followed by the last sample value, when the time series contains data:

>> TS.GET ts:temperature
1) (integer) 1112607000
2) "28.7"

“How do I get the last sample matching the specific filter?”

TS.MGET is used to get the last samples matching the specific filter:

>> TS.MGET FILTER area_id=32
1) 1) "ts:temperature"
   2) (empty list or set)
   3) 1) (integer) 1112607000
      2) "28.7"

“How do I get the sample with labels matching the specific filter?”

>> TS.MGET WITHLABELS FILTER area_id=32
1) 1) "ts:temperature"
   2) 1) 1) "sensor_id"
         2) "2"
      2) 1) "area_id"
         2) "32"
   3) 1) (integer) 1112607000
      2) "28.7"

Query a range across one or more time series

TS.RANGE is used to query a range in forward directions while TS.REVRANGE is used to query a range in reverse directions, They let you answer such questions as:

“How do I get the sample for a time range?”

>> TS.RANGE ts:carbon_monoxide 1112596200 1112603400
1) 1) (integer) 1112596200
   2) "2.4"
2) 1) (integer) 1112599800
   2) "2.1"
3) 1) (integer) 1112603400
   2) "2.2"

Aggregation

You can use various aggregation types such as  avg, sum, min, max, range, count, first, last etc. The example below example shows how to use “avg” aggregation type to answer such questions as:

“How do I get the sample for a time range on some aggregation rule?”

>> TS.RANGE ts:carbon_monoxide 1112596200 1112603400 AGGREGATION avg 2
1) 1) (integer) 1112596200
   2) "2.4"
2) 1) (integer) 1112599800
   2) "2.1"
3) 1) (integer) 1112603400
   2) "2.2"

Learn more about RedisTimeSeries in the Quickstart tutorial.


See what others are building