Feature/better logging by jimcase · Pull Request #1413 · cardano-foundation/veridian-wallet

jimcase · 2025-10-29T10:36:33Z

Description

This PR introduces a new, modular logging system with configurable output strategies including console, local file, and remote (SigNoz). This enhancement significantly improves the application's observability and flexibility in managing logs.

Modular Logging Strategies: Implements console, local file, and remote (SigNoz via OpenTelemetry) logging strategies.
Configurability: Logging behavior is highly configurable via environment variables.
Batch Processing: Remote logging includes batching for efficiency.

Checklist before requesting a review

Issue ticket number and link

This PR has a valid ticket number or issue: VT20-1532

Testing & Validation

This PR has been tested/validated in iOS, Android and browser.
Added new unit tests, if relevant.

Design Review

In case this PR contains changes to the UI, add some screenshots and/or videos to show the changes on relevant devices.

jimcase · 2025-10-30T09:52:52Z

android/app/src/main/AndroidManifest.xml

    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.CAMERA" />
    <uses-permission android:name="android.permission.USE_BIOMETRIC" />
+    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>


Needed for the filesystem API

jimcase · 2025-10-30T09:56:20Z

src/core/services/LogSyncService.ts

+    remoteStrategyFactory: (otlpEndpoint: string, ingestionKey: string) => SigNozProvider =
+      (otlpEndpoint, ingestionKey) => new SigNozProvider(otlpEndpoint, ingestionKey),
+    delay: (ms: number) => Promise<void> = (ms) => new Promise(resolve => setTimeout(resolve, ms)),
+    syncMode: SyncMode = SyncMode.Manual


By default, syncing logs with the cloud is a manual process, so the user needs to confirm it using an Alert in the UI

jimcase · 2025-10-30T09:57:39Z

src/core/services/LogSyncService.ts

+import { logger } from "../../utils/logger/Logger";
+
+export enum SyncMode {
+  Auto = "auto",


The Auto mode can be very helpful for PoCs and other test cases

jimcase · 2025-10-30T09:58:51Z

src/core/services/LogSyncService.ts

+            await local.writeLogs(remainingLogs);
+          }
+
+          logger.debug("Logs sync attempt completed successfully.", undefined, true);


This log wil be shown just in the console as consoleOnly param is true

jimcase · 2025-10-30T10:01:13Z

src/ui/components/AppWrapper/AppWrapper.tsx

+  useEffect(() => {
+    if (initializationPhase === InitializationPhase.PHASE_TWO) {
+      if (authentication.loggedIn) {
+        if (logSyncService.syncMode === SyncMode.Auto) {


If we are in Auto mode, logs will be auto sent to the cloud(PoC). By default the mode is always Manual.

Should we not just combine these changes with the useEffect directly above this for keriaNotification polling?

jimcase · 2025-10-30T10:02:44Z

src/ui/components/Error/GenericError.tsx

+    setIsOpen(false);
+  };
+
+  const handleShareLogs = async () => {


The user shares the logs manually

How come we share everything automatically but here we ask the user?

jimcase · 2025-10-30T10:03:17Z

src/ui/context/LoggerContext.tsx

+export const useLogger = () => useContext(LoggerContext);
+
+export const LoggerProvider: React.FC<{ children: React.ReactNode }> = ({ children }) => (
+  <LoggerContext.Provider value={logger}>{children}</LoggerContext.Provider>


This is the context to use logs in the UI components

jimcase · 2025-10-30T10:03:31Z

src/ui/pages/SetupGroupProfile/components/InitializeGroup/InitializeGroup.tsx

  const [openEditMembers, setOpenEditMembers] = useState(false);
  const [loading, setLoading] = useState(false);
  const history = useHistory();
+  const logger = useLogger();


Here we use the context

jimcase · 2025-10-30T10:18:09Z

src/utils/logger/strategies/LocalFileStrategy.ts

+    console.debug(`LocalFileStrategy initialized. Log file name: ${this.logFile}`);
+
+    // Log the full path using console.info
+    Filesystem.getUri({


We console the path of the logs file in the device. We could avoid this in production

Not really a problem imo

jimcase · 2025-10-30T10:25:45Z

.env.example

 ## iOS
 APP_TEAM_ID=yourTeamID
+# Logging Configuration
+LOGGING_MODE=info # Possible values: off, debug, info, warn, error. If 'off', no logs will be processed. Otherwise, logs with a level lower than this will be ignored. Default is info.


Should we store all these log variables in the configs? loca, remote, prod

iFergal · 2025-10-30T14:23:50Z

src/core/services/LogSyncService.ts

+  private listener: PluginListenerHandle | undefined;
+  private localStrategyFactory: () => LocalFileStrategy;
+  private remoteStrategyFactory: (otlpEndpoint: string, ingestionKey: string) => SigNozProvider;
+  private delay: (ms: number) => Promise<void>;


Do we need this as a variable? I would just inline new Promise(resolve => setTimeout(resolve, loggingConfig.retryDelayMs);

I added this to be able to mock it in the tests

jest fake timers is usually the strategy then. If it causes issues we can move on though

iFergal · 2025-10-30T14:26:03Z

src/core/services/LogSyncService.ts

+          if (pending.length === 0) {
+            return;
+          }
+          for (let i = 0; i < pending.length; i += loggingConfig.batchSize) {


This loops too many times unless the batchSize is 1. e.g. if batch size is 10, and there are 10 items, it should loop once

iFergal · 2025-10-30T14:26:54Z

src/core/services/LogSyncService.ts

+        if (loggingConfig.signozOtlpEndpoint && loggingConfig.signozIngestionKey) {
+          const local = this.localStrategyFactory();
+          const remote = this.remoteStrategyFactory(loggingConfig.signozOtlpEndpoint, loggingConfig.signozIngestionKey);
+          const pending: ParsedLogEntry[] = await local.readLogs();


What if there are a massive amount of logs, will this variable not become huge?

iFergal · 2025-10-30T14:28:17Z

src/core/services/LogSyncService.ts

+
+          if (successfullySentLogIds.size > 0) {
+            const remainingLogs = pending.filter(log => !successfullySentLogIds.has(log.id));
+            await local.writeLogs(remainingLogs);


Why would we delete them from local after syncing?

iFergal · 2025-10-30T14:28:57Z

src/core/services/LogSyncService.ts

+      } catch (error) {
+        logger.error(`Log sync attempt ${attempt} failed:`, { error, attempt });
+        if (attempt < loggingConfig.maxSyncRetries) {
+          await this.delay(loggingConfig.retryDelayMs);


If this fails halfway through - it might re-send previous logs, right?

iFergal · 2025-10-30T17:02:12Z

src/utils/logger/strategies/LocalFileStrategy.ts

+    }).then((result) => {
+      // eslint-disable-next-line no-console
+      console.info(`Full path to local log file: ${result.uri}`);
+    }).catch((e) => {


Hmm. In this case we continue usage of the app but without logging. I wonder if we should just let it throw.

iFergal · 2025-10-30T17:05:25Z

src/utils/logger/strategies/LocalFileStrategy.ts

+    // - Android: Use Android Studio > View > Tool Windows > Device File Explorer > /data/data/org.cardanofoundation.idw/files/local-logs.txt
+  }
+
+  async log(logEntry: ParsedLogEntry) {


File loggers will always write to rotate log files so they don't get too big, and eventually delete old ones where we will just have an ever growing log file. We need to consider how to handle this.

iFergal · 2025-10-30T17:07:09Z

src/utils/logger/strategies/LocalFileStrategy.ts

+
+    // Log the full path using console.info
+    Filesystem.getUri({
+      directory: Directory.Data,


I would put a subdirectory here for logs maybe

iFergal · 2025-10-30T17:08:28Z

src/utils/logger/strategies/LocalFileStrategy.ts

+
+  async log(logEntry: ParsedLogEntry) {
+    const entry = JSON.stringify(logEntry) + "\n";
+    await Filesystem.appendFile({


Do you know how this handles the opened files? If it opens and closes for each log we need to think of another strategy - but if it maintains the file handle and automatically tidies up, we're OK - it just doesn't seem like that

iFergal · 2025-10-30T17:08:41Z

src/utils/logger/strategies/LocalFileStrategy.ts

+    console.debug(`LocalFileStrategy initialized. Log file name: ${this.logFile}`);
+
+    // Log the full path using console.info
+    Filesystem.getUri({


Not really a problem imo

sdisalvo-crd

Only adding these comments for now and I will take another look later once all other comments have been solved. It would be nice if you could add a little video demo.

sdisalvo-crd · 2025-10-31T09:27:01Z

src/locales/en/custom.json

-{
-
-}


FYI: This is not just an empty file, it's currently being overwritten with actual stuff when you build the whitelabel - Duke is currently working on a clean up.

sdisalvo-crd · 2025-10-31T09:31:55Z

src/ui/components/Error/GenericError.tsx

+    setIsOpen(false);
+  };
+
+  const handleShareLogs = async () => {


How come we share everything automatically but here we ask the user?

jimcase added 18 commits October 22, 2025 14:51

feat: add logger wip

5fa3e98

feat: refactor

ec5ca2b

feat: add unit tests

acfe04f

feat: add LogSyncService.ts

394192a

feat: using open telemetry

33cf117

feat: merge develop

d27a268

feat: wip replace console.*

a431786

feat: fix unit test misisng babel config

c8a5e64

fix: unit test

d00aeda

feat: add comments in CloudLoggingAdapter

51e42fd

fox: rename to SigNozProvider

03da97a

feat: add some error logs

33b38ef

feat: test native console

beea367

fix: logs in filesystem and verify path

b5264c9

fix: unit tests

48f2958

feat: add signozIngestionKey in LoggingConfig

2637783

feat: signozOtlpEndpoint optional

426e11d

fix: remove debugs

174a9e4

jimcase self-assigned this Oct 29, 2025

jimcase requested review from iFergal and sdisalvo-crd as code owners October 29, 2025 10:36

fix: AndroidManifest.xml

a80f3b0

jimcase marked this pull request as draft October 29, 2025 10:39

jimcase added 3 commits October 29, 2025 19:51

feat: confirm share logs

fc7c824

fix: unit tests

3ebf441

fix: actionConfirm

ad680f2

jimcase commented Oct 30, 2025

View reviewed changes

jimcase added 3 commits October 30, 2025 11:35

fix: format unit tests

b8a29ab

fix: logger comment

5616f14

fix: merge develop

e8ad3da

jimcase marked this pull request as ready for review October 30, 2025 10:52

jimcase force-pushed the feature/better-logging branch from f19edf3 to e8ad3da Compare October 30, 2025 12:54

iFergal reviewed Oct 30, 2025

View reviewed changes

sdisalvo-crd reviewed Oct 31, 2025

View reviewed changes

jimcase added 2 commits November 1, 2025 22:17

fix: unit tests

25028a1

feat: include suggestions

799957d

jimcase mentioned this pull request Jan 27, 2026

feat(core): Implement Failure Queue and Retry for Core Long-Running O… #1561

Open

3 tasks

		{

		} No newline at end of file

Conversation

jimcase commented Oct 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist before requesting a review

Issue ticket number and link

Testing & Validation

Design Review

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iFergal Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sdisalvo-crd left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jimcase commented Oct 29, 2025 •

edited

Loading

iFergal Oct 31, 2025 •

edited

Loading