xref: /aosp_15_r20/external/pigweed/pw_log_fuchsia/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker.. _module-pw_log_fuchsia:
2*61c4878aSAndroid Build Coastguard Worker
3*61c4878aSAndroid Build Coastguard Worker==============
4*61c4878aSAndroid Build Coastguard Workerpw_log_fuchsia
5*61c4878aSAndroid Build Coastguard Worker==============
6*61c4878aSAndroid Build Coastguard Worker.. pigweed-module::
7*61c4878aSAndroid Build Coastguard Worker   :name: pw_log_fuchsia
8*61c4878aSAndroid Build Coastguard Worker
9*61c4878aSAndroid Build Coastguard Worker--------
10*61c4878aSAndroid Build Coastguard WorkerOverview
11*61c4878aSAndroid Build Coastguard Worker--------
12*61c4878aSAndroid Build Coastguard WorkerThe ``pw_log_fuchsia`` module provides a ``PW_HANDLE_LOG`` backend for the
13*61c4878aSAndroid Build Coastguard Worker``pw_log`` module. The backend uses the ``fuchsia.logger.LogSink`` FIDL API
14*61c4878aSAndroid Build Coastguard Workerto send logs. Only Bazel is supported because the Fuchsia SDK only supports Bazel.
15*61c4878aSAndroid Build Coastguard Worker
16*61c4878aSAndroid Build Coastguard Worker---
17*61c4878aSAndroid Build Coastguard WorkerAPI
18*61c4878aSAndroid Build Coastguard Worker---
19*61c4878aSAndroid Build Coastguard WorkerBefore logging, ``pw::log_fuchsia::InitializeLogging(async_dispatcher_t*)`` must
20*61c4878aSAndroid Build Coastguard Workerbe called to initialize the logging state.
21*61c4878aSAndroid Build Coastguard Worker
22*61c4878aSAndroid Build Coastguard WorkerTwo log flags are supported to help with logging during tests:
23*61c4878aSAndroid Build Coastguard Worker``PW_LOG_FLAG_USE_PRINTF``, which uses printf to log instead of ``LogSink``,
24*61c4878aSAndroid Build Coastguard Workerand ``PW_LOG_FLAG_IGNORE``, which skips logging the log.
25