Skip to content

Add optional logging to trace region #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 14, 2025
+45 −4
Merged

Add optional logging to trace region #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
88158cf
Add missing atomic include
ryantrem Nov 14, 2025
c117bfd
Use level enum instead of boolean for api clarity
ryantrem Nov 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion Source/Android/arcana/tracing/trace_region.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@

namespace arcana
{
enum class trace_level
{
mark,
log,
};

// TODO: https://developer.android.com/topic/performance/tracing/custom-events-native
// https://developer.android.com/ndk/reference/group/tracing
class trace_region final
Expand All @@ -27,7 +33,7 @@ namespace arcana

trace_region& operator=(trace_region&&) = default;

static void enable()
static void enable(trace_level = trace_level::mark)
{
}

Expand Down
25 changes: 24 additions & 1 deletion Source/Apple/arcana/tracing/trace_region.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,20 @@

#pragma once

#include <atomic>
#include <os/signpost.h>
#include <os/log.h>

#define SIGNPOST_NAME "trace_region"

namespace arcana
{
enum class trace_level
{
mark,
log,
};

class trace_region final
{
public:
Expand All @@ -22,6 +30,10 @@ namespace arcana
{
if (m_id != OS_SIGNPOST_ID_NULL)
{
if (s_logEnabled)
{
os_log_debug(s_log, "[trace_region] BEGIN %s (id=%llu, this=%p)", name, m_id, this);
}
os_signpost_interval_begin(s_log, m_id, SIGNPOST_NAME, "%s", name);
}
}
Expand All @@ -36,6 +48,10 @@ namespace arcana
{
if (m_id != OS_SIGNPOST_ID_NULL)
{
if (s_logEnabled)
{
os_log_debug(s_log, "[trace_region] END (id=%llu, this=%p)", m_id, this);
}
os_signpost_interval_end(s_log, m_id, SIGNPOST_NAME);
}
}
Expand All @@ -44,6 +60,10 @@ namespace arcana
{
if (m_id != OS_SIGNPOST_ID_NULL)
{
if (s_logEnabled)
{
os_log_debug(s_log, "[trace_region] END (move) (id=%llu, this=%p)", m_id, this);
}
os_signpost_interval_end(s_log, m_id, SIGNPOST_NAME);
}

Expand All @@ -53,18 +73,21 @@ namespace arcana
return *this;
}

static void enable()
static void enable(trace_level level = trace_level::mark)
{
s_enabled = true;
s_logEnabled = level == trace_level::log;
}

static void disable()
{
s_enabled = false;
s_logEnabled = false;
}

private:
static inline std::atomic<bool> s_enabled{false};
static inline std::atomic<bool> s_logEnabled{false};
static inline os_log_t s_log{os_log_create("arcana", OS_LOG_CATEGORY_POINTS_OF_INTEREST)};
os_signpost_id_t m_id;
};
Expand Down
8 changes: 7 additions & 1 deletion Source/Unix/arcana/tracing/trace_region.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@

namespace arcana
{
enum class trace_level
{
mark,
log,
};

// TODO
class trace_region final
{
Expand All @@ -26,7 +32,7 @@ namespace arcana

trace_region& operator=(trace_region&&) = default;

static void enable()
static void enable(trace_level = trace_level::mark)
{
}

Expand Down
8 changes: 7 additions & 1 deletion Source/Windows/arcana/tracing/trace_region.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@

namespace arcana
{
enum class trace_level
{
mark,
log,
};

// TODO: https://docs.microsoft.com/en-us/windows/win32/tracelogging/tracelogging-native-quick-start
class trace_region final
{
Expand All @@ -26,7 +32,7 @@ namespace arcana

trace_region& operator=(trace_region&&) = default;

static void enable()
static void enable(trace_level = trace_level::mark)
{
}

Expand Down