redis

README

xk6-redis

This is a k6 extension using the xk6 system.

❗ This is a proof of concept, isn't supported by the k6 team, and may break in the future. USE AT YOUR OWN RISK!

Build

To build a k6 binary with this extension, first ensure you have the prerequisites:

• Go toolchain
• Git

Then:

1. Install xk6:

$ go install github.com/k6io/xk6/cmd/xk6@latest

1. Build the binary:

$ xk6 build --with github.com/dgzlopes/xk6-redis@latest

Example

import redis from 'k6/x/redis';

const client = redis.newClient();

export function setup() {
  redis.set(client,"snake","camel",0)
  redis.set(client,"foo",100,10)
}

export default function () {
  console.log(redis.get(client,"snake"))
  console.log(redis.get(client,"foo"))
  if (redis.do(client,"PING","bzzz") == "bzzz"){
    console.log("PONG!")
  }
}

export function teardown () {
  redis.del(client,"foo")
}

Result output:

$ ./k6 run script.js

          /\      |‾‾| /‾‾/   /‾‾/   
     /\  /  \     |  |/  /   /  /    
    /  \/    \    |     (   /   ‾‾\  
   /          \   |  |\  \ |  (‾)  | 
  / __________ \  |__| \__\ \_____/ .io

  execution: local
     script: ../example.js
     output: -

  scenarios: (100.00%) 1 scenario, 1 max VUs, 10m30s max duration (incl. graceful stop):
           * default: 1 iterations for each of 1 VUs (maxDuration: 10m0s, gracefulStop: 30s)

INFO[0000] bar                                           source=console
INFO[0000] PONG!                                         source=console

running (00m00.0s), 0/1 VUs, 1 complete and 0 interrupted iterations
default ✓ [======================================] 1 VUs  00m00.0s/10m0s  1/1 iters, 1 per VU

    █ setup

    █ teardown

    data_received........: 0 B 0 B/s
    data_sent............: 0 B 0 B/s
    iteration_duration...: avg=544.06µs min=428.6µs med=597.41µs max=606.18µs p(90)=604.43µs p(95)=605.31µs
    iterations...........: 1   46.10603/s

Documentation

Index

• func ReportError(err error, msg string)
• type REDIS
  • func (*REDIS) Del(client *redis.Client, key string)
  • func (*REDIS) Do(client *redis.Client, cmd string, key string) string
  • func (*REDIS) Expire(client *redis.Client, key string, expiration time.Duration)
  • func (*REDIS) Expirec(client *redis.ClusterClient, key string, expiration time.Duration)
  • func (*REDIS) Get(client *redis.Client, key string) string
  • func (*REDIS) NewClient(addr string, password string, bd int) *redis.Client
  • func (*REDIS) NewClient2(addrs []string) *redis.ClusterClient
  • func (*REDIS) Sayhi(value string) string
  • func (*REDIS) Set(client *redis.Client, key string, value interface{}, expiration time.Duration)
  • func (*REDIS) Set2(client *redis.Client, key string, a []string, b []string)
  • func (*REDIS) Set2c(client *redis.ClusterClient, key string, a []string, b []string)
  • func (*REDIS) Set3(client *redis.Client, key string, values interface{})
  • func (*REDIS) Set3c(client *redis.ClusterClient, key string, values interface{})
  • func (*REDIS) Setc(client *redis.ClusterClient, key string, value interface{}, ...)

Functions

func ReportError

func ReportError(err error, msg string)

ReportError is a handy function to show errors

Types

type REDIS

type REDIS struct{}

REDIS is the k6 Redis extension.

func (*REDIS) Del

func (*REDIS) Del(client *redis.Client, key string)

Del removes a key/value

func (*REDIS) Do

func (*REDIS) Do(client *redis.Client, cmd string, key string) string

Do runs arbitrary/custom commands

func (*REDIS) Expire

func (*REDIS) Expire(client *redis.Client, key string, expiration time.Duration)

Expire add the expiration time to the specified key

func (*REDIS) Expirec

func (*REDIS) Expirec(client *redis.ClusterClient, key string, expiration time.Duration)

func (*REDIS) Get

func (*REDIS) Get(client *redis.Client, key string) string

Get gets a key/value

func (*REDIS) NewClient

func (*REDIS) NewClient(addr string, password string, bd int) *redis.Client

NewClient creates a new Redis client

func (*REDIS) NewClient2

func (*REDIS) NewClient2(addrs []string) *redis.ClusterClient

func (*REDIS) Sayhi

func (*REDIS) Sayhi(value string) string

Test Function, returns Hello + string

func (*REDIS) Set

func (*REDIS) Set(client *redis.Client, key string, value interface{}, expiration time.Duration)

Set adds a key/value

func (*REDIS) Set2

func (*REDIS) Set2(client *redis.Client, key string, a []string, b []string)

Set2 is like Set but it works inserting multiple fields with values.

func (*REDIS) Set2c

func (*REDIS) Set2c(client *redis.ClusterClient, key string, a []string, b []string)

func (*REDIS) Set3

func (*REDIS) Set3(client *redis.Client, key string, values interface{})

Expire add the expiration time to the specified key

func (*REDIS) Set3c

func (*REDIS) Set3c(client *redis.ClusterClient, key string, values interface{})

func (*REDIS) Setc

func (*REDIS) Setc(client *redis.ClusterClient, key string, value interface{}, expiration time.Duration)