Introduction to Diagnostic Logs provider #11

ArekBalysNordic · 2024-01-25T11:48:26Z

No description provided.

doc/nrf/protocols/matter/getting_started/advanced_kconfigs.rst

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

samples/matter/common/src/Kconfig

doc/nrf/protocols/matter/getting_started/advanced_kconfigs.rst

samples/matter/common/src/diagnostic/diagnostic_logs_provider.cpp

samples/matter/common/src/diagnostic/diagnostic_logs_provider.h

samples/matter/common/src/diagnostic/diagnostic_logs_provider.cpp

samples/matter/common/src/diagnostic/diagnostic_logs_provider.h

kkasperczyk-no · 2024-01-29T09:34:23Z

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

@@ -127,6 +127,10 @@ Matter
    In |NCS| Matter samples, the default reaction to migration failure is a factory reset of the device.
    To change the default reaction, set the :kconfig:option:`CONFIG_NCS_SAMPLE_MATTER_FACTORY_RESET_ON_KEY_MIGRATION_FAILURE` Kconfig option to ``n``.

+  * Diagnostic logs provider that collects the diagnostic logs that come from the end user, network stack, or system crashes, and sends them to the Matter controller.


To be honest I'm not sure if we need a docs changes at this stage, because this component is going to evolve and the docs will be likely changed as well. Nevertheless if we really want to do that, it would be good to mention, that network stack or end user logs are not yet supported.

As long as the network stack and end user parts come before the next release, I'm fine with leaving the entry as is. If there's any chance that one or both might not make it, then I suggest changing the entry to:

Suggested change

* Diagnostic logs provider that collects the diagnostic logs that come from the end user, network stack, or system crashes, and sends them to the Matter controller.

* Diagnostic logs provider that collects the diagnostic logs and sends them to the Matter controller.

The current implementation collects logs from system crashes.

This entry can then be updated when the other parts are added, with the final expected addition changing "current implementation" to "the provider" to remove the implication that the functionality will be further expanded.

samples/matter/common/src/diagnostic/diagnostic_logs_provider.cpp

samples/matter/common/src/diagnostic/diagnostic_logs_provider.h

samples/matter/common/src/diagnostic/diagnostic_logs_provider.cpp

samples/matter/common/src/util/finite_map.h

samples/matter/common/src/diagnostic/diagnostic_logs_provider.cpp

samples/matter/common/src/diagnostic/diagnostic_logs_provider.h

kkasperczyk-no · 2024-01-30T06:31:25Z

samples/matter/common/src/diagnostic/diagnostic_logs_provider.cpp

+	VerifyOrExit(CHIP_NO_ERROR == err, );
+
+exit:
+	outBuffer.reduce_size(0);


Should we do that in case of success? I think we don't want to set size to 0 in other case than err != CHIP_NO_ERROR.

Oh, I forgot to push the recent changes

kkasperczyk-no · 2024-01-30T06:34:40Z

samples/matter/common/src/Kconfig

@@ -39,3 +39,19 @@ config NCS_SAMPLE_MATTER_FACTORY_RESET_ON_KEY_MIGRATION_FAILURE
 	help
 	  Allow device to perform factory reset if the operational key for Fabric has not been migrated
 	  properly to PSA ITS storage.
+
+config NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS


It's fair to not enable it by default, but I think we should enable it for door lock in its prj.conf/Kconfig, as we are going to test it during TE.

OK, enabling it by default.

I mean enabling it for door lock in its prj.conf/Kconfig not for all samples 😄 Nvm, we can merge it as is, because it's only for the test event purposes.

kkasperczyk-no · 2024-01-31T13:38:21Z

samples/matter/common/src/diagnostic/diagnostic_logs_provider.cpp

+	VerifyOrExit(CHIP_NO_ERROR == err, );
+
+	err = EndLogCollection(sessionHandle);
+	VerifyOrExit(CHIP_NO_ERROR == err, );


I believe it's redundant, as we go to exit in the next line anyway.

Moved finite map implementation from bridge_util to common util to make it available for all samples. Signed-off-by: Arkadiusz Balys <[email protected]>

markaj-nordic · 2024-02-01T08:36:18Z

samples/matter/common/src/diagnostic/diagnostic_logs_provider.h

+	{
+	}
+
+	/* Not movable */


I meant if this class shall be movable (it it supports move semantics) and if not we can explicitly delete move assign operator and move constructor to be consistent with the "copy" part :) (the comment about copyable was fine)

This commit introduces the diagnostics logs provider and adds new Kconfigs to manage it. Signed-off-by: Arkadiusz Balys <[email protected]>

added CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS=y to lock prj.conf Signed-off-by: Arkadiusz Balys <[email protected]>

ArekBalysNordic requested review from LuDuda, markaj-nordic, Damian-Nordic and kkasperczyk-no January 25, 2024 11:48

github-actions bot added the changelog-entry-required label Jan 25, 2024

ArekBalysNordic force-pushed the diagnostic_log_first branch 2 times, most recently from 61243be to e54c2be Compare January 25, 2024 12:27

github-actions bot added the doc-required label Jan 25, 2024

wiba-nordic suggested changes Jan 25, 2024

View reviewed changes

ArekBalysNordic force-pushed the nordic_matter_TE_1_3 branch from 0b09596 to d1e65d8 Compare January 25, 2024 14:23

ArekBalysNordic force-pushed the diagnostic_log_first branch 2 times, most recently from 2be0176 to d371fb7 Compare January 25, 2024 14:41

wiba-nordic suggested changes Jan 25, 2024

View reviewed changes

doc/nrf/protocols/matter/getting_started/advanced_kconfigs.rst Outdated Show resolved Hide resolved

kkasperczyk-no reviewed Jan 29, 2024

View reviewed changes

ArekBalysNordic force-pushed the diagnostic_log_first branch 3 times, most recently from b32b77e to 156e9a9 Compare January 29, 2024 11:56

wiba-nordic approved these changes Jan 29, 2024

View reviewed changes

markaj-nordic reviewed Jan 29, 2024

View reviewed changes

ArekBalysNordic force-pushed the diagnostic_log_first branch from 156e9a9 to 0888203 Compare January 29, 2024 15:16

ArekBalysNordic requested review from markaj-nordic and kkasperczyk-no January 29, 2024 15:18

ArekBalysNordic force-pushed the diagnostic_log_first branch from 0888203 to 590b751 Compare January 29, 2024 15:23

kkasperczyk-no reviewed Jan 30, 2024

View reviewed changes

ArekBalysNordic force-pushed the diagnostic_log_first branch from 590b751 to a38f90a Compare January 30, 2024 07:42

kkasperczyk-no approved these changes Jan 31, 2024

View reviewed changes

kkasperczyk-no reviewed Jan 31, 2024

View reviewed changes

ArekBalysNordic force-pushed the diagnostic_log_first branch from a38f90a to 5f1a61b Compare February 1, 2024 08:24

samples: matter: Move finite map to common util

8d7055a

Moved finite map implementation from bridge_util to common util to make it available for all samples. Signed-off-by: Arkadiusz Balys <[email protected]>

ArekBalysNordic force-pushed the diagnostic_log_first branch from 5f1a61b to b2e9b80 Compare February 1, 2024 08:26

markaj-nordic reviewed Feb 1, 2024

View reviewed changes

markaj-nordic approved these changes Feb 1, 2024

View reviewed changes

ArekBalysNordic force-pushed the diagnostic_log_first branch from b2e9b80 to eb78bc8 Compare February 1, 2024 09:06

ArekBalysNordic added 2 commits February 1, 2024 10:08

samples: matter: Introduce diagnostic logs provider

feb281b

This commit introduces the diagnostics logs provider and adds new Kconfigs to manage it. Signed-off-by: Arkadiusz Balys <[email protected]>

[TestEvent] Enable diagnostics logs in Lock sample by default.

deac664

added CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS=y to lock prj.conf Signed-off-by: Arkadiusz Balys <[email protected]>

ArekBalysNordic force-pushed the diagnostic_log_first branch from eb78bc8 to deac664 Compare February 1, 2024 09:09

ArekBalysNordic merged this pull request into nordic_matter_TE_1_3 Feb 1, 2024
6 of 8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduction to Diagnostic Logs provider #11

Introduction to Diagnostic Logs provider #11

ArekBalysNordic commented Jan 25, 2024

kkasperczyk-no Jan 29, 2024

wiba-nordic Jan 29, 2024

kkasperczyk-no Jan 30, 2024

ArekBalysNordic Jan 30, 2024

kkasperczyk-no Jan 30, 2024

ArekBalysNordic Jan 30, 2024

kkasperczyk-no Jan 31, 2024 •

edited

Loading

kkasperczyk-no Jan 31, 2024

markaj-nordic Feb 1, 2024

	* Diagnostic logs provider that collects the diagnostic logs that come from the end user, network stack, or system crashes, and sends them to the Matter controller.
	* Diagnostic logs provider that collects the diagnostic logs and sends them to the Matter controller.
	The current implementation collects logs from system crashes.

Introduction to Diagnostic Logs provider #11

Introduction to Diagnostic Logs provider #11

Conversation

ArekBalysNordic commented Jan 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kkasperczyk-no Jan 31, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kkasperczyk-no Jan 31, 2024 •

edited

Loading