1 // -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
2 // vim: ts=8 sw=2 smarttab
4 #include "common/Clock.h"
5 #include "common/Timer.h"
6 #include "common/utf8.h"
7 #include "common/OutputDataSocket.h"
8 #include "common/Formatter.h"
10 #include "rgw_bucket.h"
13 #include "rgw_rados.h"
14 #include "rgw_client_io.h"
17 #define dout_subsys ceph_subsys_rgw
19 static void set_param_str(struct req_state
*s
, const char *name
, string
& str
)
21 const char *p
= s
->info
.env
->get(name
);
26 string
render_log_object_name(const string
& format
,
27 struct tm
*dt
, string
& bucket_id
,
28 const string
& bucket_name
)
31 for (unsigned i
=0; i
<format
.size(); i
++) {
32 if (format
[i
] == '%' && i
+1 < format
.size()) {
40 sprintf(buf
, "%.4d", dt
->tm_year
+ 1900);
43 sprintf(buf
, "%.2d", dt
->tm_year
% 100);
46 sprintf(buf
, "%.2d", dt
->tm_mon
+ 1);
49 sprintf(buf
, "%.2d", dt
->tm_mday
);
52 sprintf(buf
, "%.2d", dt
->tm_hour
);
55 sprintf(buf
, "%.2d", (dt
->tm_hour
% 12) + 1);
58 sprintf(buf
, "%d", dt
->tm_hour
);
61 sprintf(buf
, "%d", (dt
->tm_hour
% 12) + 1);
64 sprintf(buf
, "%.2d", dt
->tm_min
);
75 sprintf(buf
, "%%%c", format
[i
]);
90 map
<rgw_user_bucket
, RGWUsageBatch
> usage_map
;
95 utime_t round_timestamp
;
97 class C_UsageLogTimeout
: public Context
{
100 explicit C_UsageLogTimeout(UsageLogger
*_l
) : logger(_l
) {}
101 void finish(int r
) override
{
108 timer
.add_event_after(cct
->_conf
->rgw_usage_log_tick_interval
, new C_UsageLogTimeout(this));
112 UsageLogger(CephContext
*_cct
, RGWRados
*_store
) : cct(_cct
), store(_store
), lock("UsageLogger"), num_entries(0), timer_lock("UsageLogger::timer_lock"), timer(cct
, timer_lock
) {
114 Mutex::Locker
l(timer_lock
);
116 utime_t ts
= ceph_clock_now();
117 recalc_round_timestamp(ts
);
121 Mutex::Locker
l(timer_lock
);
123 timer
.cancel_all_events();
127 void recalc_round_timestamp(utime_t
& ts
) {
128 round_timestamp
= ts
.round_to_hour();
131 void insert_user(utime_t
& timestamp
, const rgw_user
& user
, rgw_usage_log_entry
& entry
) {
133 if (timestamp
.sec() > round_timestamp
+ 3600)
134 recalc_round_timestamp(timestamp
);
135 entry
.epoch
= round_timestamp
.sec();
137 string u
= user
.to_str();
138 rgw_user_bucket
ub(u
, entry
.bucket
);
139 real_time rt
= round_timestamp
.to_real_time();
140 usage_map
[ub
].insert(rt
, entry
, &account
);
143 bool need_flush
= (num_entries
> cct
->_conf
->rgw_usage_log_flush_threshold
);
146 Mutex::Locker
l(timer_lock
);
151 void insert(utime_t
& timestamp
, rgw_usage_log_entry
& entry
) {
152 if (entry
.payer
.empty()) {
153 insert_user(timestamp
, entry
.owner
, entry
);
155 insert_user(timestamp
, entry
.payer
, entry
);
160 map
<rgw_user_bucket
, RGWUsageBatch
> old_map
;
162 old_map
.swap(usage_map
);
166 store
->log_usage(old_map
);
170 static UsageLogger
*usage_logger
= NULL
;
172 void rgw_log_usage_init(CephContext
*cct
, RGWRados
*store
)
174 usage_logger
= new UsageLogger(cct
, store
);
177 void rgw_log_usage_finalize()
183 static void log_usage(struct req_state
*s
, const string
& op_name
)
185 if (s
->system_request
) /* don't log system user operations */
195 bucket_name
= s
->bucket_name
;
197 if (!bucket_name
.empty()) {
198 user
= s
->bucket_owner
.get_id();
199 if (s
->bucket_info
.requester_pays
) {
200 payer
= s
->user
->user_id
;
203 user
= s
->user
->user_id
;
206 bool error
= s
->err
.is_err();
207 if (error
&& s
->err
.http_ret
== 404) {
208 bucket_name
= "-"; /* bucket not found, use the invalid '-' as bucket name */
211 string u
= user
.to_str();
212 string p
= payer
.to_str();
213 rgw_usage_log_entry
entry(u
, p
, bucket_name
);
215 uint64_t bytes_sent
= ACCOUNTING_IO(s
)->get_bytes_sent();
216 uint64_t bytes_received
= ACCOUNTING_IO(s
)->get_bytes_received();
218 rgw_usage_data
data(bytes_sent
, bytes_received
);
222 data
.successful_ops
= 1;
224 entry
.add(op_name
, data
);
226 utime_t ts
= ceph_clock_now();
228 usage_logger
->insert(ts
, entry
);
231 void rgw_format_ops_log_entry(struct rgw_log_entry
& entry
, Formatter
*formatter
)
233 formatter
->open_object_section("log_entry");
234 formatter
->dump_string("bucket", entry
.bucket
);
235 entry
.time
.gmtime(formatter
->dump_stream("time")); // UTC
236 entry
.time
.localtime(formatter
->dump_stream("time_local"));
237 formatter
->dump_string("remote_addr", entry
.remote_addr
);
238 string obj_owner
= entry
.object_owner
.to_str();
239 if (obj_owner
.length())
240 formatter
->dump_string("object_owner", obj_owner
);
241 formatter
->dump_string("user", entry
.user
);
242 formatter
->dump_string("operation", entry
.op
);
243 formatter
->dump_string("uri", entry
.uri
);
244 formatter
->dump_string("http_status", entry
.http_status
);
245 formatter
->dump_string("error_code", entry
.error_code
);
246 formatter
->dump_int("bytes_sent", entry
.bytes_sent
);
247 formatter
->dump_int("bytes_received", entry
.bytes_received
);
248 formatter
->dump_int("object_size", entry
.obj_size
);
249 uint64_t total_time
= entry
.total_time
.sec() * 1000000LL + entry
.total_time
.usec();
251 formatter
->dump_int("total_time", total_time
);
252 formatter
->dump_string("user_agent", entry
.user_agent
);
253 formatter
->dump_string("referrer", entry
.referrer
);
254 if (entry
.x_headers
.size() > 0) {
255 formatter
->open_array_section("http_x_headers");
256 for (const auto& iter
: entry
.x_headers
) {
257 formatter
->open_object_section(iter
.first
.c_str());
258 formatter
->dump_string(iter
.first
.c_str(), iter
.second
);
259 formatter
->close_section();
261 formatter
->close_section();
263 formatter
->close_section();
266 void OpsLogSocket::formatter_to_bl(bufferlist
& bl
)
269 formatter
->flush(ss
);
270 const string
& s
= ss
.str();
275 void OpsLogSocket::init_connection(bufferlist
& bl
)
280 OpsLogSocket::OpsLogSocket(CephContext
*cct
, uint64_t _backlog
) : OutputDataSocket(cct
, _backlog
), lock("OpsLogSocket")
282 formatter
= new JSONFormatter
;
286 OpsLogSocket::~OpsLogSocket()
291 void OpsLogSocket::log(struct rgw_log_entry
& entry
)
296 rgw_format_ops_log_entry(entry
, formatter
);
303 int rgw_log_op(RGWRados
*store
, RGWREST
* const rest
, struct req_state
*s
,
304 const string
& op_name
, OpsLogSocket
*olog
)
306 struct rgw_log_entry entry
;
309 if (s
->enable_usage_log
)
310 log_usage(s
, op_name
);
312 if (!s
->enable_ops_log
)
315 if (s
->bucket_name
.empty()) {
316 ldout(s
->cct
, 5) << "nothing to log for operation" << dendl
;
319 if (s
->err
.ret
== -ERR_NO_SUCH_BUCKET
) {
320 if (!s
->cct
->_conf
->rgw_log_nonexistent_bucket
) {
321 ldout(s
->cct
, 5) << "bucket " << s
->bucket
<< " doesn't exist, not logging" << dendl
;
326 bucket_id
= s
->bucket
.bucket_id
;
328 rgw_make_bucket_entry_name(s
->bucket_tenant
, s
->bucket_name
, entry
.bucket
);
330 if (check_utf8(s
->bucket_name
.c_str(), entry
.bucket
.size()) != 0) {
331 ldout(s
->cct
, 5) << "not logging op on bucket with non-utf8 name" << dendl
;
335 if (!s
->object
.empty()) {
336 entry
.obj
= s
->object
;
338 entry
.obj
= rgw_obj_key("-");
341 entry
.obj_size
= s
->obj_size
;
343 if (s
->cct
->_conf
->rgw_remote_addr_param
.length())
344 set_param_str(s
, s
->cct
->_conf
->rgw_remote_addr_param
.c_str(),
347 set_param_str(s
, "REMOTE_ADDR", entry
.remote_addr
);
348 set_param_str(s
, "HTTP_USER_AGENT", entry
.user_agent
);
349 set_param_str(s
, "HTTP_REFERRER", entry
.referrer
);
350 set_param_str(s
, "REQUEST_URI", entry
.uri
);
351 set_param_str(s
, "REQUEST_METHOD", entry
.op
);
353 /* custom header logging */
355 if (rest
->log_x_headers()) {
356 for (const auto& iter
: s
->info
.env
->get_map()) {
357 if (rest
->log_x_header(iter
.first
)) {
358 entry
.x_headers
.insert(
359 rgw_log_entry::headers_map::value_type(iter
.first
, iter
.second
));
365 entry
.user
= s
->user
->user_id
.to_str();
367 entry
.object_owner
= s
->object_acl
->get_owner().get_id();
368 entry
.bucket_owner
= s
->bucket_owner
.get_id();
370 uint64_t bytes_sent
= ACCOUNTING_IO(s
)->get_bytes_sent();
371 uint64_t bytes_received
= ACCOUNTING_IO(s
)->get_bytes_received();
373 entry
.time
= s
->time
;
374 entry
.total_time
= ceph_clock_now() - s
->time
;
375 entry
.bytes_sent
= bytes_sent
;
376 entry
.bytes_received
= bytes_received
;
377 if (s
->err
.http_ret
) {
379 snprintf(buf
, sizeof(buf
), "%d", s
->err
.http_ret
);
380 entry
.http_status
= buf
;
382 entry
.http_status
= "200"; // default
384 entry
.error_code
= s
->err
.s3_code
;
385 entry
.bucket_id
= bucket_id
;
391 time_t t
= entry
.time
.sec();
392 if (s
->cct
->_conf
->rgw_log_object_name_utc
)
395 localtime_r(&t
, &bdt
);
399 if (s
->cct
->_conf
->rgw_ops_log_rados
) {
400 string oid
= render_log_object_name(s
->cct
->_conf
->rgw_log_object_name
, &bdt
,
401 s
->bucket
.bucket_id
, entry
.bucket
);
403 rgw_raw_obj
obj(store
->get_zone_params().log_pool
, oid
);
405 ret
= store
->append_async(obj
, bl
.length(), bl
);
406 if (ret
== -ENOENT
) {
407 ret
= store
->create_pool(store
->get_zone_params().log_pool
);
411 ret
= store
->append_async(obj
, bl
.length(), bl
);
420 ldout(s
->cct
, 0) << "ERROR: failed to log entry" << dendl
;