Skip to content

Add logging showcase#267

Open
ShivamPatidar24 wants to merge 7 commits into
eclipse-score:mainfrom
ShivamPatidar24:add_logging_showcase
Open

Add logging showcase#267
ShivamPatidar24 wants to merge 7 commits into
eclipse-score:mainfrom
ShivamPatidar24:add_logging_showcase

Conversation

@ShivamPatidar24

@ShivamPatidar24 ShivamPatidar24 commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR adds a Logging example showcase demonstrating local and remote logging.

The example generates logs for all supported severity levels.

Related

Issue: #229

This PR Depends on : #281

Verification
DEBUG, INFO, WARN, ERROR and FATAL logs generated
Logs visible in console output
Logs visible in DLT Viewer and Chipmunk

@ShivamPatidar24 ShivamPatidar24 force-pushed the add_logging_showcase branch 9 times, most recently from 67795eb to 5591382 Compare June 26, 2026 05:08
@ShivamPatidar24 ShivamPatidar24 force-pushed the add_logging_showcase branch 6 times, most recently from ee0df41 to 5cb2f27 Compare June 30, 2026 09:32
@github-actions

Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html

@ShivamPatidar24 ShivamPatidar24 force-pushed the add_logging_showcase branch 4 times, most recently from 7fdfb65 to 38c3c66 Compare July 1, 2026 07:04
ShivamPatidar24 and others added 3 commits July 1, 2026 12:47
Signed-off-by: Cvam7 <108720572+ShivamPatidar24@users.noreply.github.com>
Comment thread known_good.json
"//patches/logging:001-logging-example-visibility.patch",
"//patches/logging:002-deps-visibility.patch"],
"metadata": {
"code_root_path": "//score/mw/...",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Score/datarouter and other coding folders (if any) from logging cannot be skipped from code root path

Comment thread showcases/standalone/README.md Outdated
Comment thread showcases/standalone/README.md Outdated
@ShivamPatidar24 ShivamPatidar24 marked this pull request as ready for review July 1, 2026 10:33
@@ -0,0 +1,13 @@
diff --git a/MODULE.bazel b/MODULE.bazel

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the patch file name and the patch (intent) does not match.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


# OCI / Docker image rules for integration tests
bazel_dep(name = "rules_oci", version = "2.2.7", dev_dependency = True)
-bazel_dep(name = "rules_pkg", version = "1.2.0", dev_dependency = True)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead why not load it in reference_integration directly? IS the dep not allowed in ref_integration?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without the patch, the build fails with a rules_pkg visibility error. Adding rules_pkg to the root MODULE.bazel results in a duplicate bazel_dep error.

Comment thread showcases/standalone/logging.score.json Outdated
@@ -0,0 +1,27 @@
{
"name": "Logging example",
"description": "Example for running logging with all log levels via remote and console",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"description": "Example for running logging with all log levels via remote and console",
"description": "A Logging app that demonstrates logging with mw::log with kConsole|kRemote|kFile config.",

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Comment thread showcases/standalone/logging.score.json Outdated
@@ -0,0 +1,27 @@
{
"name": "Logging example",

@rmaddikery rmaddikery Jul 7, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"name": "Logging example",
"name": "LoggingApp Demo",

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Comment thread showcases/README.md Outdated
Comment thread showcases/README.md Outdated
@@ -0,0 +1,7 @@
# Logging Example

This example demonstrates logging with all log levels via Console Logging and Remote Logging.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This example demonstrates logging with all log levels via Console Logging and Remote Logging.
This Logging App demonstrates logging using mw::log with all log levels and configured backends (kConsole|kRemote|kFile) enabled.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Comment thread showcases/README.md Outdated

This example demonstrates logging with all log levels via Console Logging and Remote Logging.

For remote logging details, refer to the following documentation:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For remote logging details, refer to the following documentation:
For remote (DLT) logging, please refer to the following documentation:

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done



def test_remote_logging(datarouter_running, dlt_config):
def test_remote_logging(datarouter_running, target, dlt_config):

@rmaddikery rmaddikery Jul 7, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The test here verifies if datarouter logs are available in DLT. You should add another assert statement verifying if the Logging App logs end up in DLT. I would suggest adding a seperate test for this to seperate the expectations. E.g.:

# Verifies logging app logs are forwarded to DLT by capturing DLT traces
def test_logging_app_logs_forwarded_to_dlt(datarouter_running, target, dlt_config):

@rmaddikery rmaddikery left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/eclipse-score/reference_integration/pull/267/changes#r3534900206

The verification should be showcased in the Test and NOT manually!

@ShivamPatidar24 ShivamPatidar24 force-pushed the add_logging_showcase branch 2 times, most recently from ac3e99b to 9f49a98 Compare July 9, 2026 10:15
Co-authored-by: Raghavendra Maddikery <raghav.maddikery@gmail.com>
Signed-off-by: Cvam7 <108720572+ShivamPatidar24@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants