blob: 0a2747584665c71b694a1bed4af7837236e66620 [file] [log] [blame]
android-t13d2c5b22022-10-12 13:43:18 +08001/*
2 * Copyright (C) 2021 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ART_ODREFRESH_INCLUDE_ODR_STATSLOG_ODR_STATSLOG_H_
18#define ART_ODREFRESH_INCLUDE_ODR_STATSLOG_ODR_STATSLOG_H_
19
20#include <iosfwd> // For forward-declaration of std::string.
21namespace art {
22namespace odrefresh {
23
24// Upload the metrics (if any) generated by odrefresh by passing the data `statsd` process.
25//
26// Metrics from odrefresh a persisted to the path specified by `OdrefreshMetricsFile`. This method
27// reads the saved metrics, passes them to statsd, then removes the file to avoid uploading them
28// in future.
29//
30// Returns true on success. On failure `error_msg` summarizes the failure and this method returns
31// false.
32bool UploadStatsIfAvailable(/*out*/std::string* error_msg);
33
34} // namespace odrefresh
35} // namespace art
36
37#endif // ART_ODREFRESH_INCLUDE_ODR_STATSLOG_ODR_STATSLOG_H_