mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-11-09 16:00:22 +00:00
Add req-ID to logging
with this log format we can easily identify the logs per request Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
This commit is contained in:
parent
ed9330d2f6
commit
e395080cdc
@ -107,11 +107,49 @@ func RunControllerandNodePublishServer(endpoint, hstOption string, d *CSIDriver,
|
||||
s.Wait()
|
||||
}
|
||||
|
||||
func getReqID(req interface{}) string {
|
||||
// if req is nil empty string will be returned
|
||||
reqID := ""
|
||||
switch r := req.(type) {
|
||||
case *csi.CreateVolumeRequest:
|
||||
reqID = r.Name
|
||||
|
||||
case *csi.DeleteVolumeRequest:
|
||||
reqID = r.VolumeId
|
||||
|
||||
case *csi.CreateSnapshotRequest:
|
||||
reqID = r.Name
|
||||
case *csi.DeleteSnapshotRequest:
|
||||
reqID = r.SnapshotId
|
||||
|
||||
case *csi.ControllerExpandVolumeRequest:
|
||||
reqID = r.VolumeId
|
||||
|
||||
case *csi.NodeStageVolumeRequest:
|
||||
reqID = r.VolumeId
|
||||
case *csi.NodeUnstageVolumeRequest:
|
||||
reqID = r.VolumeId
|
||||
|
||||
case *csi.NodePublishVolumeRequest:
|
||||
reqID = r.VolumeId
|
||||
case *csi.NodeUnpublishVolumeRequest:
|
||||
reqID = r.VolumeId
|
||||
|
||||
case *csi.NodeExpandVolumeRequest:
|
||||
reqID = r.VolumeId
|
||||
}
|
||||
return reqID
|
||||
}
|
||||
|
||||
var id uint64
|
||||
|
||||
func contextIDInjector(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp interface{}, err error) {
|
||||
atomic.AddUint64(&id, 1)
|
||||
ctx = context.WithValue(ctx, util.CtxKey, id)
|
||||
reqID := getReqID(req)
|
||||
if reqID != "" {
|
||||
ctx = context.WithValue(ctx, util.ReqID, reqID)
|
||||
}
|
||||
return handler(ctx, req)
|
||||
}
|
||||
|
||||
|
71
pkg/csi-common/utils_test.go
Normal file
71
pkg/csi-common/utils_test.go
Normal file
@ -0,0 +1,71 @@
|
||||
/*
|
||||
Copyright 2019 ceph-csi authors.
|
||||
|
||||
Licensed 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 csicommon
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/container-storage-interface/spec/lib/go/csi"
|
||||
)
|
||||
|
||||
var fakeID = "fake-id"
|
||||
|
||||
func TestGetReqID(t *testing.T) {
|
||||
req := []interface{}{
|
||||
&csi.CreateVolumeRequest{
|
||||
Name: fakeID,
|
||||
},
|
||||
&csi.DeleteVolumeRequest{
|
||||
VolumeId: fakeID,
|
||||
},
|
||||
&csi.CreateSnapshotRequest{
|
||||
Name: fakeID,
|
||||
},
|
||||
&csi.DeleteSnapshotRequest{
|
||||
SnapshotId: fakeID,
|
||||
},
|
||||
|
||||
&csi.ControllerExpandVolumeRequest{
|
||||
VolumeId: fakeID,
|
||||
},
|
||||
&csi.NodeStageVolumeRequest{
|
||||
VolumeId: fakeID,
|
||||
},
|
||||
&csi.NodeUnstageVolumeRequest{
|
||||
VolumeId: fakeID,
|
||||
},
|
||||
&csi.NodePublishVolumeRequest{
|
||||
VolumeId: fakeID,
|
||||
},
|
||||
&csi.NodeUnpublishVolumeRequest{
|
||||
VolumeId: fakeID,
|
||||
},
|
||||
&csi.NodeExpandVolumeRequest{
|
||||
VolumeId: fakeID,
|
||||
},
|
||||
}
|
||||
for _, r := range req {
|
||||
if got := getReqID(r); got != fakeID {
|
||||
t.Errorf("getReqID() = %v, want %v", got, fakeID)
|
||||
}
|
||||
}
|
||||
|
||||
// test for nil request
|
||||
if got := getReqID(nil); got != "" {
|
||||
t.Errorf("getReqID() = %v, want empty string", got)
|
||||
}
|
||||
}
|
@ -23,6 +23,9 @@ type contextKey string
|
||||
// CtxKey for context based logging
|
||||
var CtxKey = contextKey("ID")
|
||||
|
||||
// ReqID for logging request ID
|
||||
var ReqID = contextKey("Req-ID")
|
||||
|
||||
// Log helps in context based logging
|
||||
func Log(ctx context.Context, format string) string {
|
||||
id := ctx.Value(CtxKey)
|
||||
@ -30,5 +33,10 @@ func Log(ctx context.Context, format string) string {
|
||||
return format
|
||||
}
|
||||
a := fmt.Sprintf("ID: %v ", id)
|
||||
reqID := ctx.Value(ReqID)
|
||||
if reqID == nil {
|
||||
return a + format
|
||||
}
|
||||
a += fmt.Sprintf("Req-ID: %v ", reqID)
|
||||
return a + format
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user