forked from cockroachdb/cockroach
-
Notifications
You must be signed in to change notification settings - Fork 0
/
log.go
193 lines (178 loc) · 5.9 KB
/
log.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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
// 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.
package storage
import (
"encoding/json"
"time"
"github.com/pkg/errors"
"golang.org/x/net/context"
"github.com/cockroachdb/cockroach/pkg/internal/client"
"github.com/cockroachdb/cockroach/pkg/roachpb"
"github.com/cockroachdb/cockroach/pkg/util/hlc"
"github.com/cockroachdb/cockroach/pkg/util/log"
)
// RangeLogEventReason specifies the reason why a range-log event happened.
type RangeLogEventReason string
// The set of possible reasons for range events to happen.
const (
ReasonUnknown RangeLogEventReason = ""
ReasonRangeUnderReplicated RangeLogEventReason = "range under-replicated"
ReasonRangeOverReplicated RangeLogEventReason = "range over-replicated"
ReasonStoreDead RangeLogEventReason = "store dead"
ReasonStoreDecommissioning RangeLogEventReason = "store decommissioning"
ReasonRebalance RangeLogEventReason = "rebalance"
ReasonAdminRequest RangeLogEventReason = "admin request"
)
func (s *Store) insertRangeLogEvent(
ctx context.Context, txn *client.Txn, event RangeLogEvent,
) error {
// Record range log event to console log.
var info string
if event.Info != nil {
info = event.Info.String()
}
if log.V(1) {
log.Infof(ctx, "Range Event: %q, range: %d, info: %s",
event.EventType, event.RangeID, info)
}
const insertEventTableStmt = `
INSERT INTO system.rangelog (
timestamp, "rangeID", "storeID", "eventType", "otherRangeID", info
)
VALUES(
$1, $2, $3, $4, $5, $6
)
`
args := []interface{}{
event.Timestamp,
event.RangeID,
event.StoreID,
event.EventType.String(),
nil, // otherRangeID
nil, // info
}
if event.OtherRangeID != 0 {
args[4] = event.OtherRangeID
}
if event.Info != nil {
infoBytes, err := json.Marshal(*event.Info)
if err != nil {
return err
}
args[5] = string(infoBytes)
}
// Update range event metrics. We do this close to the insertion of the
// corresponding range log entry to reduce potential skew between metrics and
// range log.
switch event.EventType {
case RangeLogEventType_split:
s.metrics.RangeSplits.Inc(1)
case RangeLogEventType_add:
s.metrics.RangeAdds.Inc(1)
case RangeLogEventType_remove:
s.metrics.RangeRemoves.Inc(1)
}
rows, err := s.cfg.SQLExecutor.ExecuteStatementInTransaction(ctx, "log-range-event", txn, insertEventTableStmt, args...)
if err != nil {
return err
}
if rows != 1 {
return errors.Errorf("%d rows affected by log insertion; expected exactly one row affected.", rows)
}
return nil
}
// logSplit logs a range split event into the event table. The affected range is
// the range which previously existed and is being split in half; the "other"
// range is the new range which is being created.
// TODO(mrtracy): There are several different reasons that a replica split
// could occur, and that information should be logged.
func (s *Store) logSplit(
ctx context.Context, txn *client.Txn, updatedDesc, newDesc roachpb.RangeDescriptor,
) error {
if !s.cfg.LogRangeEvents {
return nil
}
return s.insertRangeLogEvent(ctx, txn, RangeLogEvent{
Timestamp: selectEventTimestamp(s, txn.Proto().Timestamp),
RangeID: updatedDesc.RangeID,
EventType: RangeLogEventType_split,
StoreID: s.StoreID(),
OtherRangeID: newDesc.RangeID,
Info: &RangeLogEvent_Info{
UpdatedDesc: &updatedDesc,
NewDesc: &newDesc,
},
})
}
// logChange logs a replica change event, which represents a replica being added
// to or removed from a range.
// TODO(mrtracy): There are several different reasons that a replica change
// could occur, and that information should be logged.
func (s *Store) logChange(
ctx context.Context,
txn *client.Txn,
changeType roachpb.ReplicaChangeType,
replica roachpb.ReplicaDescriptor,
desc roachpb.RangeDescriptor,
reason RangeLogEventReason,
details string,
) error {
if !s.cfg.LogRangeEvents {
return nil
}
var logType RangeLogEventType
var info RangeLogEvent_Info
switch changeType {
case roachpb.ADD_REPLICA:
logType = RangeLogEventType_add
info = RangeLogEvent_Info{
AddedReplica: &replica,
UpdatedDesc: &desc,
Reason: reason,
Details: details,
}
case roachpb.REMOVE_REPLICA:
logType = RangeLogEventType_remove
info = RangeLogEvent_Info{
RemovedReplica: &replica,
UpdatedDesc: &desc,
Reason: reason,
Details: details,
}
default:
return errors.Errorf("unknown replica change type %s", changeType)
}
return s.insertRangeLogEvent(ctx, txn, RangeLogEvent{
Timestamp: selectEventTimestamp(s, txn.Proto().Timestamp),
RangeID: desc.RangeID,
EventType: logType,
StoreID: s.StoreID(),
Info: &info,
})
}
// selectEventTimestamp selects a timestamp for this log message. If the
// transaction this event is being written in has a non-zero timestamp, then that
// timestamp should be used; otherwise, the store's physical clock is used.
// This helps with testing; in normal usage, the logging of an event will never
// be the first action in the transaction, and thus the transaction will have an
// assigned database timestamp. However, in the case of our tests log events
// *are* the first action in a transaction, and we must elect to use the store's
// physical time instead.
func selectEventTimestamp(s *Store, input hlc.Timestamp) time.Time {
if input == (hlc.Timestamp{}) {
return s.Clock().PhysicalTime()
}
return input.GoTime()
}