Skip to content

Testing and logging related policies#2067

Open
balhar-jakub wants to merge 14 commits intomasterfrom
tsc/best-practices/testing
Open

Testing and logging related policies#2067
balhar-jakub wants to merge 14 commits intomasterfrom
tsc/best-practices/testing

Conversation

@balhar-jakub
Copy link
Member

No description provided.

Signed-off-by: Jakub Balhar <jakub@balhar.net>
Signed-off-by: Jakub Balhar <jakub@balhar.net>
Quality Assurance - Focus on possible team work.

Signed-off-by: Jakub Balhar <jakub@balhar.net>
Signed-off-by: Jakub Balhar <jakub@balhat.net>
Signed-off-by: Jakub Balhar <jakub@balhar.net>
Signed-off-by: Jakub Balhar <jakub@balhar.net>
Signed-off-by: Jakub Balhar <jakub@balhar.net>
Signed-off-by: Jakub Balhar <jakub@balhar.net>
Signed-off-by: Jakub Balhar <jakub@balhar.net>
Signed-off-by: Jakub Balhar <jakub@balhar.net>
Signed-off-by: Jakub Balhar <jakub@balhar.net>
Signed-off-by: Jakub Balhar <jakub@balhar.net>
Signed-off-by: Jakub Balhar <jakub.balhar@broadcom.com>

An example of a message is: *ZWEAG123E An error with z/OSMF authentication*

## What do we log
Copy link

@dkelosky dkelosky Jan 17, 2024

Choose a reason for hiding this comment

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

perhaps a subtle distinction - this section starts with "Message Management" but discusses "What do we log". Should it be "When to Issue Messages?"

I wonder if messages are something that are presented to a user to convey information while a log is something to help diagnose a previous problem. The difference being that backend logs for a component wouldnt need to prepend all of their log messages with a ZWE identifier

#### Client Side

C - Zowe CLI
E - Zowe VSCode Explorer

Choose a reason for hiding this comment

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

In practice, does this mean Zowe Explorer messages like job submission failed would be presented as a ZWEExxxxE message? The benefit being that we could distinguish this type of error from an extension error or some other error message?


**nnnn** - is a linear sequence starting from 0001 to 9999.

**t** - is a Type. One of (I, E, A, W) General conventions by IBM are **I**nform, **E**ventual Action (often construed as error), **A**ction, **W**arning or **S**evere error

Choose a reason for hiding this comment

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

"One of (I, W, E, S)"? Unless we think we have a need for "A"...


### Message Formats

ZWEcnnnnt, ZWEcsnnnt or ZWEcsxnnt {Actual message} where:

Choose a reason for hiding this comment

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

perhaps a note that WTO messages should be 8 characters with proper route and descriptor codes according to the message. we probably don't want to duplicate what's proper and rather refer to IBM publications?

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.

4 participants