forked from cockroachdb/cockroach
-
Notifications
You must be signed in to change notification settings - Fork 0
/
raft.go
155 lines (133 loc) · 4.58 KB
/
raft.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
// Copyright 2015 The Cockroach 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. See the AUTHORS file
// for names of contributors.
//
// Author: Ben Darnell
package storage
import (
"fmt"
"sync"
"github.com/cockroachdb/cockroach/roachpb"
"github.com/cockroachdb/cockroach/security"
"github.com/cockroachdb/cockroach/util/log"
"github.com/coreos/etcd/raft"
)
// init installs an adapter to use clog for log messages from raft which
// don't belong to any raft group.
func init() {
raft.SetLogger(&raftLogger{})
}
// *clogLogger implements the raft.Logger interface. Note that all methods
// must be defined on the pointer type rather than the value type because
// (at least in the go 1.4 compiler), methods on a value type called through
// an interface pointer go through an additional layer of indirection that
// appears on the stack, and would make all our stack frame offsets incorrect.
//
// Raft is fairly verbose at the "info" level, so we map "info" messages to
// clog.V(1) and "debug" messages to clog.V(2).
//
// This file is named raft.go instead of something like logger.go because this
// file's name is used to determine the vmodule parameter: --vmodule=raft=1
type raftLogger struct {
group uint64
}
// logPrefix returns a string that will prefix logs emitted by
// raftLogger. Bad things will happen if this method returns a string
// containing unescaped '%' characters.
func (r *raftLogger) logPrefix() string {
if r.group != 0 {
return fmt.Sprintf("[group %d] ", r.group)
}
return ""
}
func (r *raftLogger) Debug(v ...interface{}) {
if log.V(2) {
log.InfofDepth(1, r.logPrefix(), v...)
}
}
func (r *raftLogger) Debugf(format string, v ...interface{}) {
if log.V(2) {
log.InfofDepth(1, r.logPrefix()+format, v...)
}
}
func (r *raftLogger) Info(v ...interface{}) {
if log.V(1) {
log.InfofDepth(1, r.logPrefix(), v...)
}
}
func (r *raftLogger) Infof(format string, v ...interface{}) {
if log.V(1) {
log.InfofDepth(1, r.logPrefix()+format, v...)
}
}
func (r *raftLogger) Warning(v ...interface{}) {
log.WarningfDepth(1, r.logPrefix(), v...)
}
func (r *raftLogger) Warningf(format string, v ...interface{}) {
log.WarningfDepth(1, r.logPrefix()+format, v...)
}
func (r *raftLogger) Error(v ...interface{}) {
log.ErrorfDepth(1, r.logPrefix(), v...)
}
func (r *raftLogger) Errorf(format string, v ...interface{}) {
log.ErrorfDepth(1, r.logPrefix()+format, v...)
}
func (r *raftLogger) Fatal(v ...interface{}) {
log.FatalfDepth(1, r.logPrefix(), v...)
}
func (r *raftLogger) Fatalf(format string, v ...interface{}) {
log.FatalfDepth(1, r.logPrefix()+format, v...)
}
func (r *raftLogger) Panic(v ...interface{}) {
s := fmt.Sprint(v...)
log.ErrorfDepth(1, s)
panic(s)
}
func (r *raftLogger) Panicf(format string, v ...interface{}) {
log.ErrorfDepth(1, r.logPrefix()+format, v...)
panic(fmt.Sprintf(r.logPrefix()+format, v...))
}
var logRaftReadyMu sync.Mutex
func logRaftReady(storeID roachpb.StoreID, groupID roachpb.RangeID, ready raft.Ready) {
if log.V(5) {
// Globally synchronize to avoid interleaving different sets of logs in tests.
logRaftReadyMu.Lock()
defer logRaftReadyMu.Unlock()
log.Infof("store %s: group %s raft ready", storeID, groupID)
if ready.SoftState != nil {
log.Infof("SoftState updated: %+v", *ready.SoftState)
}
if !raft.IsEmptyHardState(ready.HardState) {
log.Infof("HardState updated: %+v", ready.HardState)
}
for i, e := range ready.Entries {
log.Infof("New Entry[%d]: %.200s", i, raft.DescribeEntry(e, raftEntryFormatter))
}
for i, e := range ready.CommittedEntries {
log.Infof("Committed Entry[%d]: %.200s", i, raft.DescribeEntry(e, raftEntryFormatter))
}
if !raft.IsEmptySnap(ready.Snapshot) {
log.Infof("Snapshot updated: %.200s", ready.Snapshot.String())
}
for i, m := range ready.Messages {
log.Infof("Outgoing Message[%d]: %.200s", i, raft.DescribeMessage(m, raftEntryFormatter))
}
}
}
var _ security.RequestWithUser = &RaftMessageRequest{}
// GetUser implements security.RequestWithUser.
// Raft messages are always sent by the node user.
func (*RaftMessageRequest) GetUser() string {
return security.NodeUser
}