11#include "as_components.hpp"
12#include "component_column.hpp"
14#include "spawn_options.hpp"
15#include "time_column.hpp"
18 struct ComponentBatch;
20 enum class StoreKind {
64 static constexpr const char PROPERTIES_ENTITY_PATH[] =
"__properties/";
65 static constexpr const char RECORDING_PROPERTIES_ENTITY_PATH[] =
"__properties/recording/";
74 std::string_view app_id, std::string_view recording_id = std::string_view(),
75 StoreKind store_kind = StoreKind::Recording
159 std::string_view url =
"rerun+http://127.0.0.1:9876/proxy",
160 float flush_timeout_sec = 2.0
173 std::string_view bind_ip =
"0.0.0.0", uint16_t port = 9876,
174 std::string_view server_memory_limit =
"75%"
194 template <
typename TRep,
typename TPeriod>
197 std::chrono::duration<TRep, TPeriod> flush_timeout = std::chrono::seconds(2)
199 using seconds_float = std::chrono::duration<float>;
200 return spawn(options, std::chrono::duration_cast<seconds_float>(flush_timeout).count());
258 template <
typename TRep,
typename TPeriod>
260 std::string_view timeline_name, std::chrono::duration<TRep, TPeriod> duration
262 auto nanos = std::chrono::duration_cast<std::chrono::nanoseconds>(duration).count();
299 template <
typename TClock>
301 std::string_view timeline_name, std::chrono::time_point<TClock> timestamp
305 std::chrono::duration_cast<std::chrono::nanoseconds>(timestamp.time_since_epoch())
323 static_cast<int64_t
>(1e9 * seconds)
348 template <
typename TClock>
349 [[deprecated(
"Renamed to `set_time_timestamp`")]]
void set_time(
350 std::string_view timeline_name, std::chrono::time_point<TClock> time
352 set_time(timeline_name, time.time_since_epoch());
364 template <
typename TRep,
typename TPeriod>
365 [[deprecated(
"Renamed `set_time_duration`")]]
void set_time(
366 std::string_view timeline_name, std::chrono::duration<TRep, TPeriod> time
380 [[deprecated(
"Use either `set_time_duration_secs` or `set_time_timestamp_secs_since_epoch`"
396 "Use either `set_time_duration_nanos` or `set_time_timestamp_nanos_since_epoch`"
463 template <
typename... Ts>
464 void log(std::string_view entity_path,
const Ts&... as_components)
const {
485 template <
typename... Ts>
486 void log_static(std::string_view entity_path,
const Ts&... as_components)
const {
504 template <
typename... Ts>
505 Error try_log(std::string_view entity_path,
const Ts&... as_components)
const {
524 template <
typename... Ts>
548 template <
typename... Ts>
549 void log_with_static(std::string_view entity_path,
bool static_,
const Ts&... as_components)
571 template <
typename... Ts>
573 std::string_view entity_path,
bool static_,
const Ts&... as_components
578 std::vector<ComponentBatch> serialized_columns;
587 AsComponents<Ts>().as_batches(as_components);
588 if (serialization_result.
is_err()) {
589 err = serialization_result.error;
593 if (serialized_columns.empty()) {
595 serialized_columns = std::move(serialization_result.value).to_vector();
597 serialized_columns.insert(
598 serialized_columns.end(),
599 std::make_move_iterator(serialization_result.value.begin()),
600 std::make_move_iterator(serialization_result.value.end())
606 RR_RETURN_NOT_OK(err);
626 std::string_view entity_path,
bool static_, std::vector<ComponentBatch> batches
642 std::string_view entity_path,
size_t num_data_cells,
const ComponentBatch* data_cells,
665 const std::filesystem::path& filepath,
666 std::string_view entity_path_prefix = std::string_view(),
bool static_ =
false
690 const std::filesystem::path& filepath,
691 std::string_view entity_path_prefix = std::string_view(),
bool static_ =
false
715 const std::filesystem::path& filepath,
const std::byte* contents,
size_t contents_size,
716 std::string_view entity_path_prefix = std::string_view(),
bool static_ =
false
749 const std::filesystem::path& filepath,
const std::byte* contents,
size_t contents_size,
750 std::string_view entity_path_prefix = std::string_view(),
bool static_ =
false
772 template <
typename... Ts>
775 Ts... component_columns
797 template <
typename... Ts>
800 Ts... component_columns
802 if constexpr (
sizeof...(Ts) == 1) {
807 std::move(time_columns),
808 Collection(std::forward<Ts...>(component_columns...))
812 std::vector<ComponentColumn> flat_column_list;
817 std::is_constructible_v<Collection<ComponentColumn>, Ts>,
818 "Ts must be ComponentColumn or a collection thereof"
821 push_back_columns(flat_column_list, std::move(component_columns));
827 std::move(time_columns),
884 template <
typename... Ts>
896 template <
typename... Ts>
899 this->PROPERTIES_ENTITY_PATH + std::string(name),
940 static void push_back_columns(
943 for (
const auto& new_column : new_columns) {
944 component_columns.emplace_back(std::move(new_column));
948 static void push_back_columns(
949 std::vector<ComponentColumn>& component_columns, ComponentColumn new_column
951 component_columns.emplace_back(std::move(new_column));
957 StoreKind _store_kind;
Generic collection of elements that are roughly contiguous in memory.
Definition collection.hpp:49
Status outcome object (success or error) returned for fallible operations.
Definition error.hpp:99
void handle() const
Handle this error based on the set log handler.
bool is_err() const
Returns true if the code is not Ok.
Definition error.hpp:135
static Error ok()
Creates a new error set to ok.
Definition error.hpp:120
A RecordingStream handles everything related to logging data into Rerun.
Definition recording_stream.hpp:60
Error try_log_with_static(std::string_view entity_path, bool static_, const Ts &... as_components) const
Logs one or more archetype and/or component batches optionally static, returning an error.
Definition recording_stream.hpp:572
Error try_send_property(std::string_view name, const Ts &... values) const
Set a property of a recording.
Definition recording_stream.hpp:897
Error spawn(const SpawnOptions &options={}, float flush_timeout_sec=2.0) const
Spawns a new Rerun Viewer process from an executable available in PATH, then connects to it over gRPC...
Error try_send_columns(std::string_view entity_path, Collection< TimeColumn > time_columns, Collection< ComponentColumn > component_columns) const
Directly log a columns of data to Rerun.
Result< std::string > serve_grpc(std::string_view bind_ip="0.0.0.0", uint16_t port=9876, std::string_view server_memory_limit="75%") const
Swaps the underlying sink for a gRPC server sink pre-configured to listen on rerun+http://{bind_ip}:{...
void log_file_from_path(const std::filesystem::path &filepath, std::string_view entity_path_prefix=std::string_view(), bool static_=false) const
Logs the file at the given path using all DataLoaders available.
Definition recording_stream.hpp:664
bool is_enabled() const
Returns whether the recording stream is enabled.
Definition recording_stream.hpp:105
void set_time_duration_nanos(std::string_view timeline_name, int64_t nanos) const
Set the index value of the given timeline as a duration in nanoseconds, for the current calling threa...
void send_property(std::string_view name, const Ts &... values) const
Set a property of a recording.
Definition recording_stream.hpp:885
Error try_send_recording_start_time_nanos(int64_t nanos) const
Set the start time of a recording.
Error try_log(std::string_view entity_path, const Ts &... as_components) const
Logs one or more archetype and/or component batches.
Definition recording_stream.hpp:505
void disable_timeline(std::string_view timeline_name) const
Stops logging to the specified timeline for subsequent log calls.
void reset_time() const
Clears out the current time of the recording, for the current calling thread.
Error connect_grpc(std::string_view url="rerun+http://127.0.0.1:9876/proxy", float flush_timeout_sec=2.0) const
Connect to a remote Rerun Viewer on the given URL.
Error to_stdout() const
Stream all log-data to standard output.
void send_columns(std::string_view entity_path, Collection< TimeColumn > time_columns, Collection< ComponentColumn > component_columns) const
Directly log a columns of data to Rerun.
Definition recording_stream.hpp:850
Error try_log_file_from_path(const std::filesystem::path &filepath, std::string_view entity_path_prefix=std::string_view(), bool static_=false) const
Logs the file at the given path using all DataLoaders available.
Error save(std::string_view path) const
Stream all log-data to a given .rrd file.
Error try_log_static(std::string_view entity_path, const Ts &... as_components) const
Logs one or more archetype and/or component batches as static data, returning an error.
Definition recording_stream.hpp:525
StoreKind kind() const
Returns the store kind as passed during construction.
Definition recording_stream.hpp:97
Error spawn(const SpawnOptions &options={}, std::chrono::duration< TRep, TPeriod > flush_timeout=std::chrono::seconds(2)) const
Definition recording_stream.hpp:195
Error try_log_data_row(std::string_view entity_path, size_t num_data_cells, const ComponentBatch *data_cells, bool inject_time) const
Bottom level API that logs raw data cells to the recording stream.
void log_file_from_contents(const std::filesystem::path &filepath, const std::byte *contents, size_t contents_size, std::string_view entity_path_prefix=std::string_view(), bool static_=false) const
Logs the given contents using all DataLoaders available.
Definition recording_stream.hpp:714
void set_time_timestamp_secs_since_epoch(std::string_view timeline_name, double seconds) const
Set the index value of the given timeline as seconds since Unix Epoch (1970), for the current calling...
Definition recording_stream.hpp:319
void set_time_duration_secs(std::string_view timeline_name, double secs) const
Set the index value of the given timeline as a duration in seconds, for the current calling thread.
Definition recording_stream.hpp:275
void set_time_duration(std::string_view timeline_name, std::chrono::duration< TRep, TPeriod > duration) const
Set the index value of the given timeline as a duration, for the current calling thread.
Definition recording_stream.hpp:259
void flush_blocking() const
Initiates a flush the batching pipeline and waits for it to propagate.
void set_time_nanos(std::string_view timeline_name, int64_t nanos) const
Set the current time of the recording, for the current calling thread.
Definition recording_stream.hpp:398
void set_time(std::string_view timeline_name, std::chrono::duration< TRep, TPeriod > time) const
Set the current time of the recording, for the current calling thread.
Definition recording_stream.hpp:365
void send_recording_start_time_nanos(int64_t nanos) const
Set the start time of a recording.
Definition recording_stream.hpp:926
void log_with_static(std::string_view entity_path, bool static_, const Ts &... as_components) const
Logs one or more archetype and/or component batches optionally static, returning an error.
Definition recording_stream.hpp:549
static RecordingStream & current(StoreKind store_kind=StoreKind::Recording)
Retrieves the most appropriate globally available recording stream for the given kind.
RecordingStream(std::string_view app_id, std::string_view recording_id=std::string_view(), StoreKind store_kind=StoreKind::Recording)
Creates a new recording stream to log to.
void log(std::string_view entity_path, const Ts &... as_components) const
Logs one or more archetype and/or component batches.
Definition recording_stream.hpp:464
void set_thread_local() const
Replaces the currently active recording for this stream's store kind in the thread-local scope with t...
Error try_send_recording_name(std::string_view name) const
Set the name of a recording.
Error try_log_serialized_batches(std::string_view entity_path, bool static_, std::vector< ComponentBatch > batches) const
Logs several serialized batches batches, returning an error on failure.
void set_time(std::string_view timeline_name, std::chrono::time_point< TClock > time) const
Set the current time of the recording, for the current calling thread.
Definition recording_stream.hpp:349
void set_time_seconds(std::string_view timeline_name, double seconds) const
Set the current time of the recording, for the current calling thread.
Definition recording_stream.hpp:382
void set_time_timestamp_nanos_since_epoch(std::string_view timeline_name, int64_t nanos) const
Set the index value of the given timeline as nanoseconds since Unix Epoch (1970), for the current cal...
void send_columns(std::string_view entity_path, Collection< TimeColumn > time_columns, Ts... component_columns) const
Directly log a columns of data to Rerun.
Definition recording_stream.hpp:773
Error try_log_file_from_contents(const std::filesystem::path &filepath, const std::byte *contents, size_t contents_size, std::string_view entity_path_prefix=std::string_view(), bool static_=false) const
Logs the given contents using all DataLoaders available.
void send_recording_name(std::string_view name) const
Set the name of a recording.
Definition recording_stream.hpp:910
void set_global() const
Replaces the currently active recording for this stream's store kind in the global scope with this on...
void set_time_timestamp(std::string_view timeline_name, std::chrono::time_point< TClock > timestamp) const
Set the index value of the given timeline as a timestamp, for the current calling thread.
Definition recording_stream.hpp:300
void set_time_sequence(std::string_view timeline_name, int64_t sequence_nr) const
Set the index value of the given timeline as a sequence number, for the current calling thread.
Error try_send_columns(std::string_view entity_path, Collection< TimeColumn > time_columns, Ts... component_columns) const
Directly log a columns of data to Rerun.
Definition recording_stream.hpp:798
void log_static(std::string_view entity_path, const Ts &... as_components) const
Logs one or more archetype and/or component batches as static data.
Definition recording_stream.hpp:486
A class for representing either a usable value, or an error.
Definition result.hpp:14
bool is_err() const
Returns true if error is not set to rerun::ErrorCode::Ok, implying that no value is contained,...
Definition result.hpp:44
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:23
Arrow-encoded data of a single batch of components together with a component descriptor.
Definition component_batch.hpp:28
Arrow-encoded data of a column of components.
Definition component_column.hpp:20
Options to control the behavior of spawn.
Definition spawn_options.hpp:17