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
// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
#pragma once
#include <string>
#include <string_view>
namespace wpi::log {
class DataLog;
} // namespace wpi::log
namespace frc {
/**
* Centralized data log that provides automatic data log file management. It
* automatically cleans up old files when disk space is low and renames the file
* based either on current date/time or (if available) competition match number.
* The data file will be saved to a USB flash drive in a folder named "logs" if
* one is attached, or to /home/lvuser/logs otherwise.
*
* Log files are initially named "FRC_TBD_{random}.wpilog" until the DS
* connects. After the DS connects, the log file is renamed to
* "FRC_yyyyMMdd_HHmmss.wpilog" (where the date/time is UTC). If the FMS is
* connected and provides a match number, the log file is renamed to
* "FRC_yyyyMMdd_HHmmss_{event}_{match}.wpilog".
*
* On startup, all existing FRC_TBD log files are deleted. If there is less than
* 50 MB of free space on the target storage, FRC_ log files are deleted (oldest
* to newest) until there is 50 MB free OR there are 10 files remaining.
*
* By default, all NetworkTables value changes are stored to the data log.
*/
class DataLogManager final {
public:
DataLogManager() = delete;
/**
* Start data log manager. The parameters have no effect if the data log
* manager was already started (e.g. by calling another static function).
*
* @param dir if not empty, directory to use for data log storage
* @param filename filename to use; if none provided, the filename is
* automatically generated
* @param period time between automatic flushes to disk, in seconds;
* this is a time/storage tradeoff
*/
static void Start(std::string_view dir = "", std::string_view filename = "",
double period = 0.25);
/**
* Stop data log manager.
*/
static void Stop();
/**
* Log a message to the "messages" entry. The message is also printed to
* standard output (followed by a newline).
*
* @param message message
*/
static void Log(std::string_view message);
/**
* Get the managed data log (for custom logging). Starts the data log manager
* if not already started.
*
* @return data log
*/
static wpi::log::DataLog& GetLog();
/**
* Get the log directory.
*
* @return log directory
*/
static std::string GetLogDir();
/**
* Enable or disable logging of NetworkTables data. Note that unlike the
* network interface for NetworkTables, this will capture every value change.
* Defaults to enabled.
*
* @param enabled true to enable, false to disable
*/
static void LogNetworkTables(bool enabled);
/**
* Enable or disable logging of the console output. Defaults to enabled.
* @param enabled true to enable, false to disable
*/
static void LogConsoleOutput(bool enabled);
};
} // namespace frc