2022-11-10 17:09:06 +08:00
|
|
|
// 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 accesslog
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
"net"
|
|
|
|
"os"
|
2024-04-12 10:37:27 +08:00
|
|
|
"sync"
|
2022-11-10 17:09:06 +08:00
|
|
|
"testing"
|
|
|
|
"time"
|
|
|
|
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
"google.golang.org/grpc"
|
|
|
|
"google.golang.org/grpc/metadata"
|
|
|
|
"google.golang.org/grpc/peer"
|
2023-09-21 09:45:27 +08:00
|
|
|
|
|
|
|
"github.com/milvus-io/milvus-proto/go-api/v2/commonpb"
|
|
|
|
"github.com/milvus-io/milvus-proto/go-api/v2/milvuspb"
|
2024-04-12 10:37:27 +08:00
|
|
|
"github.com/milvus-io/milvus/internal/proxy/accesslog/info"
|
|
|
|
"github.com/milvus-io/milvus/pkg/util/etcd"
|
2023-09-21 09:45:27 +08:00
|
|
|
"github.com/milvus-io/milvus/pkg/util/paramtable"
|
2022-11-10 17:09:06 +08:00
|
|
|
)
|
|
|
|
|
2024-03-05 10:39:00 +08:00
|
|
|
func TestMain(m *testing.M) {
|
|
|
|
paramtable.Init()
|
|
|
|
os.Exit(m.Run())
|
|
|
|
}
|
|
|
|
|
2022-11-10 17:09:06 +08:00
|
|
|
func TestAccessLogger_NotEnable(t *testing.T) {
|
2024-04-12 10:37:27 +08:00
|
|
|
once = sync.Once{}
|
2022-11-10 17:09:06 +08:00
|
|
|
var Params paramtable.ComponentParam
|
|
|
|
|
2023-09-05 10:31:48 +08:00
|
|
|
Params.Init(paramtable.NewBaseTable(paramtable.SkipRemote(true)))
|
2022-12-07 18:01:19 +08:00
|
|
|
Params.Save(Params.ProxyCfg.AccessLog.Enable.Key, "false")
|
2022-11-10 17:09:06 +08:00
|
|
|
|
2024-04-12 10:37:27 +08:00
|
|
|
InitAccessLogger(&Params)
|
2022-11-10 17:09:06 +08:00
|
|
|
|
|
|
|
rpcInfo := &grpc.UnaryServerInfo{Server: nil, FullMethod: "testMethod"}
|
2024-04-12 10:37:27 +08:00
|
|
|
accessInfo := info.NewGrpcAccessInfo(context.Background(), rpcInfo, nil)
|
|
|
|
ok := _globalL.Write(accessInfo)
|
2022-11-10 17:09:06 +08:00
|
|
|
assert.False(t, ok)
|
|
|
|
}
|
|
|
|
|
2023-11-28 15:32:31 +08:00
|
|
|
func TestAccessLogger_InitFailed(t *testing.T) {
|
2024-04-12 10:37:27 +08:00
|
|
|
once = sync.Once{}
|
2023-11-28 15:32:31 +08:00
|
|
|
var Params paramtable.ComponentParam
|
2024-04-12 10:37:27 +08:00
|
|
|
// init formatter failed
|
2023-11-28 15:32:31 +08:00
|
|
|
Params.Init(paramtable.NewBaseTable(paramtable.SkipRemote(true)))
|
|
|
|
Params.Save(Params.ProxyCfg.AccessLog.Enable.Key, "true")
|
|
|
|
Params.SaveGroup(map[string]string{Params.ProxyCfg.AccessLog.Formatter.KeyPrefix + "testf.invaild": "invalidConfig"})
|
|
|
|
|
2024-04-12 10:37:27 +08:00
|
|
|
InitAccessLogger(&Params)
|
|
|
|
rpcInfo := &grpc.UnaryServerInfo{Server: nil, FullMethod: "testMethod"}
|
|
|
|
accessInfo := info.NewGrpcAccessInfo(context.Background(), rpcInfo, nil)
|
|
|
|
ok := _globalL.Write(accessInfo)
|
|
|
|
assert.False(t, ok)
|
|
|
|
|
|
|
|
// init minio error cause init writter failed
|
|
|
|
Params.Init(paramtable.NewBaseTable(paramtable.SkipRemote(true)))
|
|
|
|
Params.Save(Params.ProxyCfg.AccessLog.MinioEnable.Key, "true")
|
|
|
|
Params.Save(Params.MinioCfg.Address.Key, "")
|
|
|
|
|
|
|
|
InitAccessLogger(&Params)
|
|
|
|
rpcInfo = &grpc.UnaryServerInfo{Server: nil, FullMethod: "testMethod"}
|
|
|
|
accessInfo = info.NewGrpcAccessInfo(context.Background(), rpcInfo, nil)
|
|
|
|
ok = _globalL.Write(accessInfo)
|
|
|
|
assert.False(t, ok)
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestAccessLogger_DynamicEnable(t *testing.T) {
|
|
|
|
once = sync.Once{}
|
|
|
|
var Params paramtable.ComponentParam
|
|
|
|
Params.Init(paramtable.NewBaseTable())
|
|
|
|
Params.Save(Params.ProxyCfg.AccessLog.Enable.Key, "false")
|
|
|
|
// init with close accesslog
|
|
|
|
InitAccessLogger(&Params)
|
|
|
|
rpcInfo := &grpc.UnaryServerInfo{Server: nil, FullMethod: "testMethod"}
|
|
|
|
accessInfo := info.NewGrpcAccessInfo(context.Background(), rpcInfo, nil)
|
|
|
|
ok := _globalL.Write(accessInfo)
|
|
|
|
assert.False(t, ok)
|
|
|
|
|
|
|
|
etcdCli, _ := etcd.GetEtcdClient(
|
|
|
|
Params.EtcdCfg.UseEmbedEtcd.GetAsBool(),
|
|
|
|
Params.EtcdCfg.EtcdUseSSL.GetAsBool(),
|
|
|
|
Params.EtcdCfg.Endpoints.GetAsStrings(),
|
|
|
|
Params.EtcdCfg.EtcdTLSCert.GetValue(),
|
|
|
|
Params.EtcdCfg.EtcdTLSKey.GetValue(),
|
|
|
|
Params.EtcdCfg.EtcdTLSCACert.GetValue(),
|
|
|
|
Params.EtcdCfg.EtcdTLSMinVersion.GetValue())
|
|
|
|
|
|
|
|
// enable access log
|
|
|
|
ctx, cancel := context.WithCancel(context.Background())
|
|
|
|
defer cancel()
|
|
|
|
etcdCli.KV.Put(ctx, "by-dev/config/proxy/accessLog/enable", "true")
|
|
|
|
defer etcdCli.KV.Delete(ctx, "by-dev/config/proxy/accessLog/enable")
|
|
|
|
|
|
|
|
assert.Eventually(t, func() bool {
|
|
|
|
accessInfo := info.NewGrpcAccessInfo(context.Background(), rpcInfo, nil)
|
|
|
|
ok := _globalL.Write(accessInfo)
|
|
|
|
return ok
|
|
|
|
}, 10*time.Second, 500*time.Millisecond)
|
|
|
|
|
|
|
|
// disable access log
|
|
|
|
etcdCli.KV.Put(ctx, "by-dev/config/proxy/accessLog/enable", "false")
|
|
|
|
assert.Eventually(t, func() bool {
|
|
|
|
accessInfo := info.NewGrpcAccessInfo(context.Background(), rpcInfo, nil)
|
|
|
|
ok := _globalL.Write(accessInfo)
|
|
|
|
return !ok
|
|
|
|
}, 10*time.Second, 500*time.Millisecond)
|
2023-11-28 15:32:31 +08:00
|
|
|
}
|
|
|
|
|
2022-11-10 17:09:06 +08:00
|
|
|
func TestAccessLogger_Basic(t *testing.T) {
|
2024-04-12 10:37:27 +08:00
|
|
|
once = sync.Once{}
|
2022-11-10 17:09:06 +08:00
|
|
|
var Params paramtable.ComponentParam
|
|
|
|
|
2023-09-05 10:31:48 +08:00
|
|
|
Params.Init(paramtable.NewBaseTable(paramtable.SkipRemote(true)))
|
2022-11-10 17:09:06 +08:00
|
|
|
testPath := "/tmp/accesstest"
|
2023-10-25 10:30:10 +08:00
|
|
|
Params.Save(Params.ProxyCfg.AccessLog.Enable.Key, "true")
|
2022-12-07 18:01:19 +08:00
|
|
|
Params.Save(Params.ProxyCfg.AccessLog.LocalPath.Key, testPath)
|
2022-11-10 17:09:06 +08:00
|
|
|
defer os.RemoveAll(testPath)
|
|
|
|
|
2024-04-12 10:37:27 +08:00
|
|
|
InitAccessLogger(&Params)
|
2022-11-10 17:09:06 +08:00
|
|
|
|
|
|
|
ctx := peer.NewContext(
|
|
|
|
context.Background(),
|
|
|
|
&peer.Peer{
|
|
|
|
Addr: &net.IPAddr{
|
|
|
|
IP: net.IPv4(0, 0, 0, 0),
|
|
|
|
Zone: "test",
|
|
|
|
},
|
|
|
|
})
|
2024-04-12 10:37:27 +08:00
|
|
|
ctx = metadata.AppendToOutgoingContext(ctx, info.ClientRequestIDKey, "test")
|
2022-11-10 17:09:06 +08:00
|
|
|
|
2023-11-28 15:32:31 +08:00
|
|
|
req := &milvuspb.QueryRequest{
|
|
|
|
DbName: "test-db",
|
|
|
|
CollectionName: "test-collection",
|
|
|
|
PartitionNames: []string{"test-partition-1", "test-partition-2"},
|
|
|
|
}
|
|
|
|
|
2022-11-10 17:09:06 +08:00
|
|
|
resp := &milvuspb.BoolResponse{
|
|
|
|
Status: &commonpb.Status{
|
|
|
|
ErrorCode: commonpb.ErrorCode_UnexpectedError,
|
|
|
|
Reason: "",
|
|
|
|
},
|
|
|
|
Value: false,
|
|
|
|
}
|
|
|
|
|
|
|
|
rpcInfo := &grpc.UnaryServerInfo{Server: nil, FullMethod: "testMethod"}
|
2023-11-28 15:32:31 +08:00
|
|
|
|
2024-04-12 10:37:27 +08:00
|
|
|
accessInfo := info.NewGrpcAccessInfo(ctx, rpcInfo, req)
|
2023-11-28 15:32:31 +08:00
|
|
|
accessInfo.SetResult(resp, nil)
|
2024-04-12 10:37:27 +08:00
|
|
|
|
|
|
|
ok := _globalL.Write(accessInfo)
|
2022-11-10 17:09:06 +08:00
|
|
|
assert.True(t, ok)
|
|
|
|
}
|
|
|
|
|
2024-04-12 10:37:27 +08:00
|
|
|
func TestAccessLogger_WriteFailed(t *testing.T) {
|
|
|
|
once = sync.Once{}
|
|
|
|
var Params paramtable.ComponentParam
|
|
|
|
|
|
|
|
Params.Init(paramtable.NewBaseTable(paramtable.SkipRemote(true)))
|
|
|
|
Params.Save(Params.ProxyCfg.AccessLog.Enable.Key, "true")
|
|
|
|
Params.Save(Params.ProxyCfg.AccessLog.Filename.Key, "")
|
|
|
|
|
|
|
|
InitAccessLogger(&Params)
|
|
|
|
|
|
|
|
_globalL.formatters = NewFormatterManger()
|
|
|
|
accessInfo := info.NewGrpcAccessInfo(context.Background(), &grpc.UnaryServerInfo{Server: nil, FullMethod: "testMethod"}, nil)
|
|
|
|
ok := _globalL.Write(accessInfo)
|
|
|
|
assert.False(t, ok)
|
|
|
|
}
|
|
|
|
|
2022-11-10 17:09:06 +08:00
|
|
|
func TestAccessLogger_Stdout(t *testing.T) {
|
2024-04-12 10:37:27 +08:00
|
|
|
once = sync.Once{}
|
2022-11-10 17:09:06 +08:00
|
|
|
var Params paramtable.ComponentParam
|
|
|
|
|
2023-09-05 10:31:48 +08:00
|
|
|
Params.Init(paramtable.NewBaseTable(paramtable.SkipRemote(true)))
|
2023-10-25 10:30:10 +08:00
|
|
|
Params.Save(Params.ProxyCfg.AccessLog.Enable.Key, "true")
|
2022-12-07 18:01:19 +08:00
|
|
|
Params.Save(Params.ProxyCfg.AccessLog.Filename.Key, "")
|
2022-11-10 17:09:06 +08:00
|
|
|
|
2024-04-12 10:37:27 +08:00
|
|
|
InitAccessLogger(&Params)
|
2022-11-10 17:09:06 +08:00
|
|
|
|
|
|
|
ctx := peer.NewContext(
|
|
|
|
context.Background(),
|
|
|
|
&peer.Peer{
|
|
|
|
Addr: &net.IPAddr{
|
|
|
|
IP: net.IPv4(0, 0, 0, 0),
|
|
|
|
Zone: "test",
|
|
|
|
},
|
|
|
|
})
|
2024-04-12 10:37:27 +08:00
|
|
|
ctx = metadata.AppendToOutgoingContext(ctx, info.ClientRequestIDKey, "test")
|
2022-11-10 17:09:06 +08:00
|
|
|
|
2023-11-28 15:32:31 +08:00
|
|
|
req := &milvuspb.QueryRequest{
|
|
|
|
DbName: "test-db",
|
|
|
|
CollectionName: "test-collection",
|
|
|
|
PartitionNames: []string{"test-partition-1", "test-partition-2"},
|
|
|
|
}
|
|
|
|
|
2022-11-10 17:09:06 +08:00
|
|
|
resp := &milvuspb.BoolResponse{
|
|
|
|
Status: &commonpb.Status{
|
|
|
|
ErrorCode: commonpb.ErrorCode_UnexpectedError,
|
|
|
|
Reason: "",
|
|
|
|
},
|
|
|
|
Value: false,
|
|
|
|
}
|
|
|
|
|
|
|
|
rpcInfo := &grpc.UnaryServerInfo{Server: nil, FullMethod: "testMethod"}
|
2023-11-28 15:32:31 +08:00
|
|
|
|
2024-04-12 10:37:27 +08:00
|
|
|
accessInfo := info.NewGrpcAccessInfo(ctx, rpcInfo, req)
|
2023-11-28 15:32:31 +08:00
|
|
|
accessInfo.SetResult(resp, nil)
|
2024-04-12 10:37:27 +08:00
|
|
|
ok := _globalL.Write(accessInfo)
|
2022-11-10 17:09:06 +08:00
|
|
|
assert.True(t, ok)
|
|
|
|
}
|
2023-09-21 09:45:27 +08:00
|
|
|
|
2022-11-10 17:09:06 +08:00
|
|
|
func TestAccessLogger_WithMinio(t *testing.T) {
|
2024-04-12 10:37:27 +08:00
|
|
|
once = sync.Once{}
|
2022-11-10 17:09:06 +08:00
|
|
|
var Params paramtable.ComponentParam
|
|
|
|
|
2023-09-05 10:31:48 +08:00
|
|
|
Params.Init(paramtable.NewBaseTable(paramtable.SkipRemote(true)))
|
2022-11-10 17:09:06 +08:00
|
|
|
testPath := "/tmp/accesstest"
|
2023-10-25 10:30:10 +08:00
|
|
|
Params.Save(Params.ProxyCfg.AccessLog.Enable.Key, "true")
|
|
|
|
Params.Save(Params.ProxyCfg.AccessLog.Filename.Key, "test_access")
|
2022-12-07 18:01:19 +08:00
|
|
|
Params.Save(Params.ProxyCfg.AccessLog.LocalPath.Key, testPath)
|
|
|
|
Params.Save(Params.ProxyCfg.AccessLog.MinioEnable.Key, "true")
|
2023-11-28 15:32:31 +08:00
|
|
|
Params.Save(Params.ProxyCfg.AccessLog.CacheSize.Key, "0")
|
2022-12-07 18:01:19 +08:00
|
|
|
Params.Save(Params.ProxyCfg.AccessLog.RemotePath.Key, "access_log/")
|
|
|
|
Params.Save(Params.ProxyCfg.AccessLog.MaxSize.Key, "1")
|
2022-11-10 17:09:06 +08:00
|
|
|
defer os.RemoveAll(testPath)
|
|
|
|
|
2024-04-12 10:37:27 +08:00
|
|
|
InitAccessLogger(&Params)
|
|
|
|
writer, ok := _globalL.writer.(*RotateWriter)
|
|
|
|
assert.True(t, ok)
|
2022-11-10 17:09:06 +08:00
|
|
|
|
|
|
|
ctx := peer.NewContext(
|
|
|
|
context.Background(),
|
|
|
|
&peer.Peer{
|
|
|
|
Addr: &net.IPAddr{
|
|
|
|
IP: net.IPv4(0, 0, 0, 0),
|
|
|
|
Zone: "test",
|
|
|
|
},
|
|
|
|
})
|
2024-04-12 10:37:27 +08:00
|
|
|
ctx = metadata.AppendToOutgoingContext(ctx, info.ClientRequestIDKey, "test")
|
2022-11-10 17:09:06 +08:00
|
|
|
|
2023-11-28 15:32:31 +08:00
|
|
|
req := &milvuspb.QueryRequest{
|
|
|
|
DbName: "test-db",
|
|
|
|
CollectionName: "test-collection",
|
|
|
|
PartitionNames: []string{"test-partition-1", "test-partition-2"},
|
|
|
|
}
|
|
|
|
|
2022-11-10 17:09:06 +08:00
|
|
|
resp := &milvuspb.BoolResponse{
|
|
|
|
Status: &commonpb.Status{
|
|
|
|
ErrorCode: commonpb.ErrorCode_UnexpectedError,
|
|
|
|
Reason: "",
|
|
|
|
},
|
|
|
|
Value: false,
|
|
|
|
}
|
|
|
|
|
|
|
|
rpcInfo := &grpc.UnaryServerInfo{Server: nil, FullMethod: "testMethod"}
|
2023-11-28 15:32:31 +08:00
|
|
|
|
2024-04-12 10:37:27 +08:00
|
|
|
accessInfo := info.NewGrpcAccessInfo(ctx, rpcInfo, req)
|
2023-11-28 15:32:31 +08:00
|
|
|
accessInfo.SetResult(resp, nil)
|
2024-04-12 10:37:27 +08:00
|
|
|
ok = _globalL.Write(accessInfo)
|
2022-11-10 17:09:06 +08:00
|
|
|
assert.True(t, ok)
|
|
|
|
|
2024-04-12 10:37:27 +08:00
|
|
|
err := writer.Rotate()
|
|
|
|
assert.NoError(t, err)
|
|
|
|
defer writer.handler.Clean()
|
2022-11-10 17:09:06 +08:00
|
|
|
|
|
|
|
time.Sleep(time.Duration(1) * time.Second)
|
2024-04-12 10:37:27 +08:00
|
|
|
logfiles, err := writer.handler.listAll()
|
2022-11-10 17:09:06 +08:00
|
|
|
assert.NoError(t, err)
|
|
|
|
assert.Equal(t, 1, len(logfiles))
|
|
|
|
}
|