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
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_METRICS_SERIALIZATION_SERIALIZATION_UTILS_H_
#define COMPONENTS_METRICS_SERIALIZATION_SERIALIZATION_UTILS_H_
#include <memory>
#include <string>
#include <vector>
namespace metrics {
class MetricSample;
// Metrics helpers to serialize and deserialize metrics collected by
// ChromeOS.
namespace SerializationUtils {
// If there are more than 100,000 messages in the file, discard the remaining
// messages to avoid running out of memory.
// This value is used as a max value in a histogram,
// Platform.ExternalMetrics.SamplesRead. If it changes, the histogram will need
// to be renamed.
inline constexpr int kMaxMessagesPerRead = 100000;
// Deserializes a sample passed as a string and return a sample.
// The return value will either be a scoped_ptr to a Metric sample (if the
// deserialization was successful) or a nullptr scoped_ptr.
std::unique_ptr<MetricSample> ParseSample(const std::string& sample);
// Reads all samples from a file and truncates the file when done.
void ReadAndTruncateMetricsFromFile(
const std::string& filename,
std::vector<std::unique_ptr<MetricSample>>* metrics);
// Reads all samples from a file and deletes the file when done.
void ReadAndDeleteMetricsFromFile(
const std::string& filename,
std::vector<std::unique_ptr<MetricSample>>* metrics);
// Serializes a sample and write it to filename.
// The format for the message is:
// message_size, serialized_message
// where
// * message_size is the total length of the message (message_size +
// serialized_message) on 4 bytes
// * serialized_message is the serialized version of sample (using ToString)
//
// NB: the file will never leave the device so message_size will be written
// with the architecture's endianness.
bool WriteMetricToFile(const MetricSample& sample, const std::string& filename);
// Maximum length of a serialized message
inline constexpr size_t kMessageMaxLength = 1024;
} // namespace SerializationUtils
} // namespace metrics
#endif // COMPONENTS_METRICS_SERIALIZATION_SERIALIZATION_UTILS_H_
|
