// Licensed to the LF AI & Data foundation under one // or more contributor license agreements. See the NOTICE file // distributed with this work for additional information // regarding copyright ownership. The ASF licenses this file // to you under the Apache License, Version 2.0 (the // "License"); you may not use this file except in compliance // with the License. You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package etcdkv import ( "context" "fmt" "path" "time" "github.com/milvus-io/milvus/internal/log" clientv3 "go.etcd.io/etcd/client/v3" "go.uber.org/zap" ) const ( // RequestTimeout is default timeout for etcd request. RequestTimeout = 10 * time.Second ) // EtcdKV implements TxnKV interface, it supports to process multiple kvs in a transaction. type EtcdKV struct { client *clientv3.Client rootPath string } // NewEtcdKV creates a new etcd kv. func NewEtcdKV(etcdEndpoints []string, rootPath string) (*EtcdKV, error) { client, err := clientv3.New(clientv3.Config{ Endpoints: etcdEndpoints, DialTimeout: 5 * time.Second, }) if err != nil { return nil, err } kv := &EtcdKV{ client: client, rootPath: rootPath, } return kv, nil } // NewEtcdKVWithClient creates a new etcd kv with a client. func NewEtcdKVWithClient(cli *clientv3.Client, rootPath string) *EtcdKV { return &EtcdKV{ client: cli, rootPath: rootPath, } } // Close closes the connection to etcd. func (kv *EtcdKV) Close() { kv.client.Close() } // GetPath returns the path of the key. func (kv *EtcdKV) GetPath(key string) string { return path.Join(kv.rootPath, key) } // LoadWithPrefix returns all the keys and values with the given key prefix. func (kv *EtcdKV) LoadWithPrefix(key string) ([]string, []string, error) { start := time.Now() key = path.Join(kv.rootPath, key) ctx, cancel := context.WithTimeout(context.TODO(), RequestTimeout) defer cancel() resp, err := kv.client.Get(ctx, key, clientv3.WithPrefix(), clientv3.WithSort(clientv3.SortByKey, clientv3.SortAscend)) if err != nil { return nil, nil, err } keys := make([]string, 0, resp.Count) values := make([]string, 0, resp.Count) for _, kv := range resp.Kvs { keys = append(keys, string(kv.Key)) values = append(values, string(kv.Value)) } CheckElapseAndWarn(start, "Slow etcd operation load with prefix") return keys, values, nil } // LoadWithPrefix2 returns all the the keys,values and key versions with the given key prefix. func (kv *EtcdKV) LoadWithPrefix2(key string) ([]string, []string, []int64, error) { start := time.Now() key = path.Join(kv.rootPath, key) ctx, cancel := context.WithTimeout(context.TODO(), RequestTimeout) defer cancel() resp, err := kv.client.Get(ctx, key, clientv3.WithPrefix(), clientv3.WithSort(clientv3.SortByKey, clientv3.SortAscend)) if err != nil { return nil, nil, nil, err } keys := make([]string, 0, resp.Count) values := make([]string, 0, resp.Count) versions := make([]int64, 0, resp.Count) for _, kv := range resp.Kvs { keys = append(keys, string(kv.Key)) values = append(values, string(kv.Value)) versions = append(versions, kv.Version) } CheckElapseAndWarn(start, "Slow etcd operation load with prefix2") return keys, values, versions, nil } // Load returns value of the key. func (kv *EtcdKV) Load(key string) (string, error) { start := time.Now() key = path.Join(kv.rootPath, key) ctx, cancel := context.WithTimeout(context.TODO(), RequestTimeout) defer cancel() resp, err := kv.client.Get(ctx, key) if err != nil { return "", err } if resp.Count <= 0 { return "", fmt.Errorf("there is no value on key = %s", key) } CheckElapseAndWarn(start, "Slow etcd operation load") return string(resp.Kvs[0].Value), nil } // MultiLoad gets the values of the keys in a transaction. func (kv *EtcdKV) MultiLoad(keys []string) ([]string, error) { start := time.Now() ops := make([]clientv3.Op, 0, len(keys)) for _, keyLoad := range keys { ops = append(ops, clientv3.OpGet(path.Join(kv.rootPath, keyLoad))) } ctx, cancel := context.WithTimeout(context.TODO(), RequestTimeout) defer cancel() resp, err := kv.client.Txn(ctx).If().Then(ops...).Commit() if err != nil { return []string{}, err } result := make([]string, 0, len(keys)) invalid := make([]string, 0, len(keys)) for index, rp := range resp.Responses { if rp.GetResponseRange().Kvs == nil || len(rp.GetResponseRange().Kvs) == 0 { invalid = append(invalid, keys[index]) result = append(result, "") } for _, ev := range rp.GetResponseRange().Kvs { result = append(result, string(ev.Value)) } } if len(invalid) != 0 { log.Warn("MultiLoad: there are invalid keys", zap.Strings("keys", invalid)) err = fmt.Errorf("there are invalid keys: %s", invalid) return result, err } CheckElapseAndWarn(start, "Slow etcd operation multi load") return result, nil } // LoadWithRevision returns keys, values and revision by given key prefix. func (kv *EtcdKV) LoadWithRevision(key string) ([]string, []string, int64, error) { start := time.Now() key = path.Join(kv.rootPath, key) ctx, cancel := context.WithTimeout(context.TODO(), RequestTimeout) defer cancel() resp, err := kv.client.Get(ctx, key, clientv3.WithPrefix(), clientv3.WithSort(clientv3.SortByKey, clientv3.SortAscend)) if err != nil { return nil, nil, 0, err } keys := make([]string, 0, resp.Count) values := make([]string, 0, resp.Count) for _, kv := range resp.Kvs { keys = append(keys, string(kv.Key)) values = append(values, string(kv.Value)) } CheckElapseAndWarn(start, "Slow etcd operation load with revision") return keys, values, resp.Header.Revision, nil } // Save saves the key-value pair. func (kv *EtcdKV) Save(key, value string) error { start := time.Now() key = path.Join(kv.rootPath, key) ctx, cancel := context.WithTimeout(context.TODO(), RequestTimeout) defer cancel() _, err := kv.client.Put(ctx, key, value) CheckElapseAndWarn(start, "Slow etcd operation save") return err } // SaveWithLease is a function to put value in etcd with etcd lease options. func (kv *EtcdKV) SaveWithLease(key, value string, id clientv3.LeaseID) error { start := time.Now() key = path.Join(kv.rootPath, key) ctx, cancel := context.WithTimeout(context.TODO(), RequestTimeout) defer cancel() _, err := kv.client.Put(ctx, key, value, clientv3.WithLease(id)) CheckElapseAndWarn(start, "Slow etcd operation save with lease") return err } // MultiSave saves the key-value pairs in a transaction. func (kv *EtcdKV) MultiSave(kvs map[string]string) error { start := time.Now() ops := make([]clientv3.Op, 0, len(kvs)) for key, value := range kvs { ops = append(ops, clientv3.OpPut(path.Join(kv.rootPath, key), value)) } ctx, cancel := context.WithTimeout(context.TODO(), RequestTimeout) defer cancel() _, err := kv.client.Txn(ctx).If().Then(ops...).Commit() CheckElapseAndWarn(start, "Slow etcd operation multi save") return err } // RemoveWithPrefix removes the keys with given prefix. func (kv *EtcdKV) RemoveWithPrefix(prefix string) error { start := time.Now() key := path.Join(kv.rootPath, prefix) ctx, cancel := context.WithTimeout(context.TODO(), RequestTimeout) defer cancel() _, err := kv.client.Delete(ctx, key, clientv3.WithPrefix()) CheckElapseAndWarn(start, "Slow etcd operation remove with prefix") return err } // Remove removes the key. func (kv *EtcdKV) Remove(key string) error { start := time.Now() key = path.Join(kv.rootPath, key) ctx, cancel := context.WithTimeout(context.TODO(), RequestTimeout) defer cancel() _, err := kv.client.Delete(ctx, key) CheckElapseAndWarn(start, "Slow etcd operation remove") return err } // MultiRemove removes the keys in a transaction. func (kv *EtcdKV) MultiRemove(keys []string) error { start := time.Now() ops := make([]clientv3.Op, 0, len(keys)) for _, key := range keys { ops = append(ops, clientv3.OpDelete(path.Join(kv.rootPath, key))) } ctx, cancel := context.WithTimeout(context.TODO(), RequestTimeout) defer cancel() _, err := kv.client.Txn(ctx).If().Then(ops...).Commit() CheckElapseAndWarn(start, "Slow etcd operation multi remove") return err } // MultiSaveAndRemove saves the key-value pairs and removes the keys in a transaction. func (kv *EtcdKV) MultiSaveAndRemove(saves map[string]string, removals []string) error { start := time.Now() ops := make([]clientv3.Op, 0, len(saves)+len(removals)) for key, value := range saves { ops = append(ops, clientv3.OpPut(path.Join(kv.rootPath, key), value)) } for _, keyDelete := range removals { ops = append(ops, clientv3.OpDelete(path.Join(kv.rootPath, keyDelete))) } ctx, cancel := context.WithTimeout(context.TODO(), RequestTimeout) defer cancel() _, err := kv.client.Txn(ctx).If().Then(ops...).Commit() CheckElapseAndWarn(start, "Slow etcd operation multi save and remove") return err } // Watch starts watching a key, returns a watch channel. func (kv *EtcdKV) Watch(key string) clientv3.WatchChan { start := time.Now() key = path.Join(kv.rootPath, key) rch := kv.client.Watch(context.Background(), key, clientv3.WithCreatedNotify()) CheckElapseAndWarn(start, "Slow etcd operation watch") return rch } // WatchWithPrefix starts watching a key with prefix, returns a watch channel. func (kv *EtcdKV) WatchWithPrefix(key string) clientv3.WatchChan { start := time.Now() key = path.Join(kv.rootPath, key) rch := kv.client.Watch(context.Background(), key, clientv3.WithPrefix(), clientv3.WithCreatedNotify()) CheckElapseAndWarn(start, "Slow etcd operation watch with prefix") return rch } // WatchWithRevision starts watching a key with revision, returns a watch channel. func (kv *EtcdKV) WatchWithRevision(key string, revision int64) clientv3.WatchChan { start := time.Now() key = path.Join(kv.rootPath, key) rch := kv.client.Watch(context.Background(), key, clientv3.WithPrefix(), clientv3.WithPrevKV(), clientv3.WithRev(revision)) CheckElapseAndWarn(start, "Slow etcd operation watch with revision") return rch } // MultiRemoveWithPrefix removes the keys with given prefix. func (kv *EtcdKV) MultiRemoveWithPrefix(keys []string) error { start := time.Now() ops := make([]clientv3.Op, 0, len(keys)) for _, k := range keys { op := clientv3.OpDelete(path.Join(kv.rootPath, k), clientv3.WithPrefix()) ops = append(ops, op) } ctx, cancel := context.WithTimeout(context.TODO(), RequestTimeout) defer cancel() _, err := kv.client.Txn(ctx).If().Then(ops...).Commit() CheckElapseAndWarn(start, "Slow etcd operation multi remove with prefix") return err } // MultiSaveAndRemoveWithPrefix saves kv in @saves and removes the keys with given prefix in @removals. func (kv *EtcdKV) MultiSaveAndRemoveWithPrefix(saves map[string]string, removals []string) error { start := time.Now() ops := make([]clientv3.Op, 0, len(saves)) for key, value := range saves { ops = append(ops, clientv3.OpPut(path.Join(kv.rootPath, key), value)) } for _, keyDelete := range removals { ops = append(ops, clientv3.OpDelete(path.Join(kv.rootPath, keyDelete), clientv3.WithPrefix())) } ctx, cancel := context.WithTimeout(context.TODO(), RequestTimeout) defer cancel() _, err := kv.client.Txn(ctx).If().Then(ops...).Commit() CheckElapseAndWarn(start, "Slow etcd operation multi save and move with prefix") return err } // Grant creates a new lease implemented in etcd grant interface. func (kv *EtcdKV) Grant(ttl int64) (id clientv3.LeaseID, err error) { start := time.Now() resp, err := kv.client.Grant(context.Background(), ttl) CheckElapseAndWarn(start, "Slow etcd operation grant") return resp.ID, err } // KeepAlive keeps the lease alive forever with leaseID. // Implemented in etcd interface. func (kv *EtcdKV) KeepAlive(id clientv3.LeaseID) (<-chan *clientv3.LeaseKeepAliveResponse, error) { start := time.Now() ch, err := kv.client.KeepAlive(context.Background(), id) if err != nil { return nil, err } CheckElapseAndWarn(start, "Slow etcd operation keepAlive") return ch, nil } // CompareValueAndSwap compares the existing value with compare, and if they are // equal, the target is stored in etcd. func (kv *EtcdKV) CompareValueAndSwap(key, value, target string, opts ...clientv3.OpOption) error { start := time.Now() ctx, cancel := context.WithTimeout(context.TODO(), RequestTimeout) defer cancel() resp, err := kv.client.Txn(ctx).If( clientv3.Compare( clientv3.Value(path.Join(kv.rootPath, key)), "=", value)). Then(clientv3.OpPut(path.Join(kv.rootPath, key), target, opts...)).Commit() if err != nil { return err } if !resp.Succeeded { return fmt.Errorf("function CompareAndSwap error for compare is false for key: %s", key) } CheckElapseAndWarn(start, "Slow etcd operation compare value and swap") return nil } // CompareVersionAndSwap compares the existing key-value's version with version, and if // they are equal, the target is stored in etcd. func (kv *EtcdKV) CompareVersionAndSwap(key string, source int64, target string, opts ...clientv3.OpOption) error { start := time.Now() ctx, cancel := context.WithTimeout(context.TODO(), RequestTimeout) defer cancel() resp, err := kv.client.Txn(ctx).If( clientv3.Compare( clientv3.Version(path.Join(kv.rootPath, key)), "=", source)). Then(clientv3.OpPut(path.Join(kv.rootPath, key), target, opts...)).Commit() if err != nil { return err } if !resp.Succeeded { return fmt.Errorf("function CompareAndSwap error for compare is false for key: %s,"+ " source version: %d, target version: %s", key, source, target) } CheckElapseAndWarn(start, "Slow etcd operation compare version and swap") return nil } // CheckElapseAndWarn checks the elapsed time and warns if it is too long. func CheckElapseAndWarn(start time.Time, message string) bool { elapsed := time.Since(start) if elapsed.Milliseconds() > 2000 { log.Warn(message, zap.String("time spent", elapsed.String())) return true } return false }