This is an automated email from the ASF dual-hosted git repository.
tison pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-kvrocks-website.git
The following commit(s) were added to refs/heads/main by this push:
new fa74a4d Add a post about Kvrocks and go-redis (#27)
fa74a4d is described below
commit fa74a4dfc865f6835ed3096cdde076a0322bce8f
Author: Vladimir Mihailenco <[email protected]>
AuthorDate: Mon Nov 21 09:53:23 2022 +0200
Add a post about Kvrocks and go-redis (#27)
---
.../index.md | 2 +
.../db-dashboard.png | Bin 0 -> 11984 bytes
.../index.md | 252 +++++++++++++++++++++
.../redis-metrics.png | Bin 0 -> 16740 bytes
.../used-disk-percent.png | Bin 0 -> 15163 bytes
blog/authors.yml | 6 +
6 files changed, 260 insertions(+)
diff --git a/blog/2021-11-07-how-to-implement-bitmap-on-rocksdb/index.md
b/blog/2021-11-07-how-to-implement-bitmap-on-rocksdb/index.md
index 55d263b..ec063ee 100644
--- a/blog/2021-11-07-how-to-implement-bitmap-on-rocksdb/index.md
+++ b/blog/2021-11-07-how-to-implement-bitmap-on-rocksdb/index.md
@@ -6,6 +6,8 @@ authors: [hulk]
Most developers should be familiar with bitmap, in addition to the storage
implementation for the bloom filter, and many databases also provide bitmap
type indexes. For memory storage, the bitmap can be regarded as the special
type of sparse bit array, which would not cause the read-write amplification
issue (means read/write bytes far more than the request). While Redis supports
bit-related operations on string types, it is a big challenge for disk KV-based
storage like [Kvrocks](https: [...]
+<!--truncate-->
+
## Why amplification occurs
Amplification mainly comes from two aspects:
diff --git a/blog/2022-11-20-go-redis-kvrocks-opentelemetry/db-dashboard.png
b/blog/2022-11-20-go-redis-kvrocks-opentelemetry/db-dashboard.png
new file mode 100644
index 0000000..0a4113c
Binary files /dev/null and
b/blog/2022-11-20-go-redis-kvrocks-opentelemetry/db-dashboard.png differ
diff --git a/blog/2022-11-20-go-redis-kvrocks-opentelemetry/index.md
b/blog/2022-11-20-go-redis-kvrocks-opentelemetry/index.md
new file mode 100644
index 0000000..e8d96d8
--- /dev/null
+++ b/blog/2022-11-20-go-redis-kvrocks-opentelemetry/index.md
@@ -0,0 +1,252 @@
+---
+slug: go-redis-kvrocks-opentelemetry
+title: Getting started with Kvrocks and go-redis
+authors: [vmihailenco]
+---
+
+This post explains how to get started with Apache Kvrocks using go-redis
client. It also
+demonstrates how you can use OpenTelemetry and Uptrace to monitor Kvrocks on
both client and server
+sides.
+
+<!--truncate-->
+
+## What is Kvrocks?
+
+[Apache Kvrocks](https://kvrocks.apache.org/) is a distributed key-value NoSQL
database that uses
+RocksDB as a storage engine and is compatible with Redis protocol.
+
+You can use Kvrocks as a drop-in replacement for Redis to store data on SSD
decreasing the cost of
+memory and increasing the capacity. For example, imagine taking one of the
many existing Redis-based
+job queues and using them with Kvrocks and SSD storage.
+
+Kvrocks supports most [Redis commands](/docs/supported-commands) with a
+single notable exception being that `watch` and `unwatch` commands are not
+[supported yet](https://github.com/apache/incubator-kvrocks/issues/315).
+
+[Kvrocks Cluster](/docs/Cluster/kvrocks-cluster-introduction) and
+[replication](/docs/Design/replication) are available as well.
+
+## Getting started with Kvrocks
+
+You can launch Kvrocks using Docker:
+
+```shell
+docker run -it -p 6666:6666 apache/kvrocks
+```
+
+And start using it right away:
+
+```shell
+redis-cli -p 6666
+
+127.0.0.1:6666> get foo
+(nil)
+127.0.0.1:6666> set foo bar
+OK
+127.0.0.1:6666> get foo
+"bar"
+```
+
+You can also
[build](https://github.com/apache/incubator-kvrocks#build-and-run-kvrocks)
Kvrocks with
+GCC yourself.
+
+## Connecting to Kvrocks from Go
+
+Since Kvrocks uses Redis-compatible protocol, you can use your favorite Redis
client to work with
+Kvrocks, for example, [Go Redis client](https://redis.uptrace.dev/):
+
+```go
+package main
+
+import (
+ "context"
+ "github.com/go-redis/redis/v8"
+)
+
+func main() {
+ ctx := context.Background()
+
+ rdb := redis.NewClient(&redis.Options{
+ Addr: "localhost:6666",
+ })
+
+ err := rdb.Set(ctx, "key", "value", 0).Err()
+ if err != nil {
+ panic(err)
+ }
+
+ val, err := rdb.Get(ctx, "key").Result()
+ if err != nil {
+ panic(err)
+ }
+ fmt.Println("key", val)
+}
+```
+
+[Pipelines](https://redis.uptrace.dev/guide/go-redis-pipelines.html),
+[pub/sub](https://redis.uptrace.dev/guide/go-redis-pubsub.html), and even
+[Lua scripts](https://redis.uptrace.dev/guide/lua-scripting.html) are working
as well:
+
+```go
+var incrBy = redis.NewScript(`
+local key = KEYS[1]
+local change = ARGV[1]
+
+local value = redis.call("GET", key)
+if not value then
+ value = 0
+end
+
+value = value + change
+redis.call("SET", key, value)
+
+return value
+`)
+```
+
+You can then run the script like this:
+
+```go
+keys := []string{"my_counter"}
+values := []interface{}{+1}
+num, err := incrBy.Run(ctx, rdb, keys, values...).Int()
+```
+
+## What is OpenTelemetry?
+
+[OpenTelemetry](https://opentelemetry.io/) is a vendor-neutral standard that
allows you to
+collect and export traces, logs, and metrics.
+
+Uptrace, one of its vendor, provides a series of good documents about the
terminology and usages:
+
+* [What is OpenTelemetry?](https://uptrace.dev/opentelemetry)
+* [OpenTelemetry Distributed
Tracing](https://uptrace.dev/opentelemetry/distributed-tracing.html)
+* [OpenTelemetry Metrics](https://uptrace.dev/opentelemetry/metrics.html)
+
+Otel allows developers to collect and export telemetry data in a vendor
agnostic way. With
+OpenTelemetry, you can instrument your application once and then add or change
vendors without
+changing the instrumentation, for example, here is a list
+[DataDog
competitors](https://uptrace.dev/get/compare/datadog-competitors.html) that
support
+OpenTelemetry.
+
+## What is Uptrace?
+
+Uptrace is an [source-available APM
tool](https://uptrace.dev/get/open-source-apm.html) that supports
+distributed tracing, metrics, and logs. You can use it to monitor applications
and set up automatic
+alerts to receive notifications via email, Slack, Telegram, and more.
+
+Uptrace uses OpenTelelemetry to collect data and ClickHouse database to store
it. ClickHouse is the
+only dependency.
+
+## Monitoring Kvrocks client
+
+You can use OpenTelemetry and Uptrace together to monitor Kvrocks performance
using the go-redis
+instrumentation:
+
+```go
+import "github.com/go-redis/redis/extra/redisotel/v9"
+
+rdb := redis.NewClient(&redis.Options{
+ Addr: ":6666",
+})
+
+if err := redisotel.InstrumentTracing(rdb, redisotel.WithDBSystem("kvrocks"));
err != nil {
+ panic(err)
+}
+if err := redisotel.InstrumentMetrics(rdb, redisotel.WithDBSystem("kvrocks"));
err != nil {
+ panic(err)
+}
+```
+
+Once the data reaches Uptrace, it will generate the following dashboard for
you:
+
+
+
+See [Getting started with Uptrace](https://uptrace.dev/get/get-started.html)
for details.
+
+## Monitoring Kvrocks server
+
+You can also configure OpenTelemetry Redis
+[receiver](https://uptrace.dev/opentelemetry/collector-config.html?receiver=redis)
to monitor
+Kvrocks:
+
+```yaml
+receivers:
+ redis/kvrocks:
+ endpoint: 'kvrocks:6666'
+ collection_interval: 10s
+```
+
+The receiver works by parsing the output of `INFO` command and produces a
number of useful metrics:
+
+
+
+See [GitHub
example](https://github.com/uptrace/uptrace/tree/master/example/kvrocks) and
+[OpenTelemetry Redis
monitoring](https://uptrace.dev/opentelemetry/redis-monitoring.html) for
+details.
+
+## Custom metrics
+
+Using OpenTelemetry Metrics API, you can even create custom Kvrocks metrics.
For example, the
+following function parses `used_disk_percent` to create
`kvrocks.used_disk_percent` metric:
+
+```go
+var re = regexp.MustCompile(`used_disk_percent:\s(\d+)%`)
+
+func monitorKvrocks(ctx context.Context, rdb *redis.Client) error {
+ mp := global.MeterProvider()
+ meter := mp.Meter("github.com/uptrace/uptrace/example/kvrocks")
+
+ usedDiskPct, err := meter.AsyncFloat64().Gauge(
+ "kvrocks.used_disk_percent",
+ instrument.WithUnit("%"),
+ )
+ if err != nil {
+ return err
+ }
+
+ return meter.RegisterCallback(
+ []instrument.Asynchronous{
+ usedDiskPct,
+ },
+ func(ctx context.Context) {
+ pct, err := getUsedDiskPercent(ctx, rdb)
+ if err != nil {
+ otel.Handle(err)
+ }
+ usedDiskPct.Observe(ctx, pct,
semconv.DBSystemKey.String("kvrocks"))
+ },
+ )
+}
+
+func getUsedDiskPercent(ctx context.Context, rdb *redis.Client) (float64,
error) {
+ info, err := rdb.Info(ctx, "keyspace").Result()
+ if err != nil {
+ return 0, err
+ }
+
+ m := re.FindStringSubmatch(info)
+ if m == nil {
+ return 0, errors.New("can't find used_disk_percent metric")
+ }
+
+ n, err := strconv.ParseInt(m[1], 10, 64)
+ if err != nil {
+ return 0, err
+ }
+
+ return float64(n) / 100, nil
+}
+```
+
+The metric looks like this in Uptrace:
+
+
+
+See [OpenTelemetry Go Metrics
API](https://uptrace.dev/opentelemetry/go-metrics.html) for details.
+
+## Useful links
+
+- [Kvrocks Server Installation](/docs/server-installation)
+- [Go Redis](https://redis.uptrace.dev/guide/go-redis.html)
+- [Get started with Uptrace](https://uptrace.dev/get/get-started.html)
diff --git a/blog/2022-11-20-go-redis-kvrocks-opentelemetry/redis-metrics.png
b/blog/2022-11-20-go-redis-kvrocks-opentelemetry/redis-metrics.png
new file mode 100644
index 0000000..fa5fc1d
Binary files /dev/null and
b/blog/2022-11-20-go-redis-kvrocks-opentelemetry/redis-metrics.png differ
diff --git
a/blog/2022-11-20-go-redis-kvrocks-opentelemetry/used-disk-percent.png
b/blog/2022-11-20-go-redis-kvrocks-opentelemetry/used-disk-percent.png
new file mode 100644
index 0000000..e1d7d91
Binary files /dev/null and
b/blog/2022-11-20-go-redis-kvrocks-opentelemetry/used-disk-percent.png differ
diff --git a/blog/authors.yml b/blog/authors.yml
index da83a20..6a6c0c4 100644
--- a/blog/authors.yml
+++ b/blog/authors.yml
@@ -3,3 +3,9 @@ hulk:
title: Apache Kvrocks (Incubating) Founders
url: https://github.com/git-hulk
image_url: https://github.com/git-hulk.png
+
+vmihailenco:
+ name: Vladimir Mihailenco
+ title: Grumpy Gopher
+ url: https://github.com/vmihailenco
+ image_url: https://github.com/vmihailenco.png
