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
|
/*
* Copyright 2021 Google LLC
*
* 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.
*/
#ifndef FCP_CLIENT_OPSTATS_OPSTATS_LOGGER_H_
#define FCP_CLIENT_OPSTATS_OPSTATS_LOGGER_H_
#include <memory>
#include <string>
#include "fcp/client/opstats/opstats_db.h"
#include "fcp/client/stats.h"
#include "fcp/protos/federated_api.pb.h"
#include "fcp/protos/opstats.pb.h"
namespace fcp {
namespace client {
namespace opstats {
// Base no-op class for the OpStats logger.
class OpStatsLogger {
public:
OpStatsLogger() = default;
explicit OpStatsLogger(bool opstats_enabled)
: opstats_enabled_(opstats_enabled),
db_(std::make_unique<OpStatsDb>()),
init_status_(absl::OkStatus()) {}
OpStatsLogger(bool opstats_enabled, absl::Status init_status)
: opstats_enabled_(opstats_enabled),
db_(std::make_unique<OpStatsDb>()),
init_status_(init_status) {}
virtual ~OpStatsLogger() = default;
// Log a checkin accepted event and the corresponding task name.
virtual void AddEventAndSetTaskName(
const std::string& task_name, OperationalStats::Event::EventKind event) {}
// Log an event.
virtual void AddEvent(OperationalStats::Event::EventKind event) {}
// Log an event and corresponding error message.
virtual void AddEventWithErrorMessage(
OperationalStats::Event::EventKind event,
const std::string& error_message) {}
// Log info associated with a dataset created for a given collection. If this
// is called multiple times for the same collection, the example counts and
// sizes should be aggregated.
virtual void UpdateDatasetStats(const std::string& collection_uri,
int additional_example_count,
int64_t additional_example_size_bytes) {}
// Log network stats, replacing any old stats for the run.
virtual void SetNetworkStats(const NetworkStats& network_stats) {}
// Log the retry window, replacing any old retry window. Ignore any retry
// token in the retry window message.
virtual void SetRetryWindow(
google::internal::federatedml::v2::RetryWindow retry_window) {}
// Get the underlying opstats database.
virtual OpStatsDb* GetOpStatsDb() { return db_.get(); }
// Whether opstats is enabled.
virtual bool IsOpStatsEnabled() const { return opstats_enabled_; }
// Syncs all logged events to storage.
virtual absl::Status CommitToStorage() { return absl::OkStatus(); }
// Returns a status holding an initialization error if OpStats was enabled but
// failed to initialize.
absl::Status GetInitStatus() { return init_status_; }
// Returns the task name of the currently executing task. Only returns a valid
// task name if called after `AddEventAndSetTaskName` is called.
virtual std::string GetCurrentTaskName() { return ""; }
private:
bool opstats_enabled_;
std::unique_ptr<OpStatsDb> db_;
// If there was an error initializing the OpStats logger such that the no-op
// impl was returned instead, this will hold the status detailing the error.
absl::Status init_status_;
};
} // namespace opstats
} // namespace client
} // namespace fcp
#endif // FCP_CLIENT_OPSTATS_OPSTATS_LOGGER_H_
|
