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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
#include <library/cpp/json/json_value.h>
#include <library/cpp/json/json_writer.h>
#include <library/cpp/logger/record.h>
#include <library/cpp/logger/backend.h>
#include <ydb/core/base/events.h>
#include <ydb/library/actors/core/log.h>
#include <ydb/library/actors/core/actor.h>
#include <ydb/library/actors/core/events.h>
#include <ydb/library/actors/core/hfunc.h>
#include <ydb/library/services/services.pb.h>
#include "audit_log_item_builder.h"
#include "audit_log_service.h"
#include "audit_log.h"
#if defined LOG_T || \
defined LOG_D || \
defined LOG_I || \
defined LOG_N || \
defined LOG_W || \
defined LOG_E
# error log macro redefinition
#endif
#define LOG_T(stream) LOG_TRACE_S((TlsActivationContext->AsActorContext()), NKikimrServices::AUDIT_LOG_WRITER, stream)
#define LOG_D(stream) LOG_DEBUG_S((TlsActivationContext->AsActorContext()), NKikimrServices::AUDIT_LOG_WRITER, stream)
#define LOG_I(stream) LOG_INFO_S((TlsActivationContext->AsActorContext()), NKikimrServices::AUDIT_LOG_WRITER, stream)
#define LOG_N(stream) LOG_NOTICE_S((TlsActivationContext->AsActorContext()), NKikimrServices::AUDIT_LOG_WRITER, stream)
#define LOG_W(stream) LOG_WARN_S((TlsActivationContext->AsActorContext()), NKikimrServices::AUDIT_LOG_WRITER, stream)
#define LOG_E(stream) LOG_ERROR_S((TlsActivationContext->AsActorContext()), NKikimrServices::AUDIT_LOG_WRITER, stream)
namespace NKikimr::NAudit {
// TAuditLogActor
//
struct TEvAuditLog {
//
// Events declaration
//
enum EEvents {
EvBegin = EventSpaceBegin(TKikimrEvents::ES_YDB_AUDIT_LOG),
// Request actors
EvWriteAuditLog = EvBegin + 0,
EvEnd
};
static_assert(EvEnd <= EventSpaceEnd(TKikimrEvents::ES_YDB_AUDIT_LOG),
"expected EvEnd <= EventSpaceEnd(TKikimrEvents::ES_YDB_AUDIT_LOG)"
);
struct TEvWriteAuditLog : public NActors::TEventLocal<TEvWriteAuditLog, EvWriteAuditLog> {
TInstant Time;
TAuditLogParts Parts;
TEvWriteAuditLog(TInstant time, TAuditLogParts&& parts)
: Time(time)
, Parts(std::move(parts))
{}
};
};
void WriteLog(const TString& log, const TVector<THolder<TLogBackend>>& logBackends) {
for (auto& logBackend : logBackends) {
try {
logBackend->WriteData(TLogRecord(
ELogPriority::TLOG_INFO,
log.data(),
log.length()
));
} catch (const yexception& e) {
LOG_E("WriteLog: unable to write audit log (error: " << e.what() << ")");
}
}
}
TString GetJsonLog(TInstant time, const TAuditLogParts& parts) {
TStringStream ss;
ss << time << ": ";
NJson::TJsonMap m;
for (auto& [k, v] : parts) {
m[k] = v;
}
NJson::WriteJson(&ss, &m, false, false);
ss << Endl;
return ss.Str();
}
TString GetJsonLogCompatibleLog(TInstant time, const TAuditLogParts& parts) {
TStringStream ss;
NJsonWriter::TBuf json(NJsonWriter::HEM_DONT_ESCAPE_HTML, &ss);
{
auto obj = json.BeginObject();
obj
.WriteKey("@timestamp")
.WriteString(time.ToString().data())
.WriteKey("@log_type")
.WriteString("audit");
for (auto& [k, v] : parts) {
obj.WriteKey(k).WriteString(v);
}
json.EndObject();
}
ss << Endl;
return ss.Str();
}
TString GetTxtLog(TInstant time, const TAuditLogParts& parts) {
TStringStream ss;
ss << time << ": ";
for (auto it = parts.begin(); it != parts.end(); it++) {
if (it != parts.begin())
ss << ", ";
ss << it->first << "=" << it->second;
}
ss << Endl;
return ss.Str();
}
// Array of functions for converting a audit event parameters to a string.
// Indexing in the array occurs by the value of the NKikimrConfig::TAuditConfig::EFormat enumeration.
// For each new format, we need to register the audit event conversion function.
// The size of AuditLogItemBuilders must be larger by one of the maximum value of the NKikimrConfig::TAuditConfig::EFormat enumeration.
// The first value of AuditLogItemBuilders is a stub for the convenience of indexing by enumeration value.
static std::vector<TAuditLogItemBuilder> AuditLogItemBuilders = { nullptr, GetJsonLog, GetTxtLog, GetJsonLogCompatibleLog, nullptr };
// numbering enumeration starts from one
static constexpr size_t DefaultAuditLogItemBuilder = static_cast<size_t>(NKikimrConfig::TAuditConfig::JSON);
void RegisterAuditLogItemBuilder(NKikimrConfig::TAuditConfig::EFormat format, TAuditLogItemBuilder builder) {
size_t index = static_cast<size_t>(format);
if (index < AuditLogItemBuilders.size()) {
AuditLogItemBuilders[index] = builder;
}
}
class TAuditLogActor final : public TActor<TAuditLogActor> {
private:
const TAuditLogBackends LogBackends;
public:
TAuditLogActor(TAuditLogBackends&& logBackends)
: TActor(&TThis::StateWork)
, LogBackends(std::move(logBackends))
{}
static constexpr NKikimrServices::TActivity::EType ActorActivityType() {
return NKikimrServices::TActivity::AUDIT_WRITER_ACTOR;
}
private:
STFUNC(StateWork) {
switch (ev->GetTypeRewrite()) {
HFunc(TEvents::TEvPoisonPill, HandlePoisonPill);
HFunc(TEvAuditLog::TEvWriteAuditLog, HandleWriteAuditLog);
default:
HandleUnexpectedEvent(ev);
break;
}
}
void HandlePoisonPill(const TEvents::TEvPoisonPill::TPtr& ev, const TActorContext& ctx) {
Y_UNUSED(ev);
AUDIT_LOG_ENABLED.store(false);
Die(ctx);
}
void HandleWriteAuditLog(const TEvAuditLog::TEvWriteAuditLog::TPtr& ev, const TActorContext& ctx) {
Y_UNUSED(ctx);
for (auto& logBackends : LogBackends) {
const auto builderIndex = static_cast<size_t>(logBackends.first);
const auto builder = builderIndex < AuditLogItemBuilders.size() && AuditLogItemBuilders[builderIndex] != nullptr
? AuditLogItemBuilders[builderIndex] : AuditLogItemBuilders[DefaultAuditLogItemBuilder];
const auto msg = ev->Get();
const auto auditLogItem = builder(msg->Time, msg->Parts);
WriteLog(auditLogItem, logBackends.second);
}
}
void HandleUnexpectedEvent(STFUNC_SIG) {
LOG_W("TAuditLogActor:"
<< " unhandled event type: " << ev->GetTypeRewrite()
<< " event: " << ev->GetTypeName()
);
}
};
// Client interface implementation
//
std::atomic<bool> AUDIT_LOG_ENABLED = false;
void SendAuditLog(const NActors::TActorSystem* sys, TAuditLogParts&& parts)
{
auto request = MakeHolder<TEvAuditLog::TEvWriteAuditLog>(Now(), std::move(parts));
sys->Send(MakeAuditServiceID(), request.Release());
}
// Service interface implementation
//
THolder<NActors::IActor> CreateAuditWriter(TAuditLogBackends&& logBackends)
{
AUDIT_LOG_ENABLED.store(true);
return MakeHolder<TAuditLogActor>(std::move(logBackends));
}
} // namespace NKikimr::NAudit
|
