Issue WTO message on API Mediation Layer startup #3894

balhar-jakub · 2024-09-30T10:21:35Z

Describe your pull request here:
One of the common requests is issuing the specific message when the API Mediation Layer properly starts in the Syslog. This article explains all the configuration and pieces needed to achieve this goal with the current functionality.

List the file(s) included in this PR:
wto-message-on-startup.md

After creating the PR, follow the instructions in the comments.

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

github-actions · 2024-09-30T10:21:48Z

😺 Thank you for creating this PR! To publish your content to Zowe Docs, follow these required steps.

Add the label review: doc.
Identify your content topic with a label. (Examples: area: apiml, area: cli, area: install and config, etc.)
Specify the major Zowe release(s) for your content. (Examples: release: V1, release: V2, release: V3)
- If adding content that needs to be removed from V3 documentation, add the V3 N/A tag.
Select the master branch if your PR updates content that is on the live site. Select docs-staging if your PR updates content for a future release.
Notify the Doc Squad about this PR. If you don't know whom should review your content, message the #zowe-doc Slack channel. If you know which Doc Squad writer should approve your content, add that person as a reviewer.

Need help? Contact the Doc Squad in the #zowe-doc Slack channel.

github-actions · 2024-09-30T10:33:16Z

🚀 Deployed on https://66fbdb7a1ba9900b20489e15--zowe-docs-master.netlify.app

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

janan07 · 2024-09-30T12:12:59Z

docs/user-guide/api-mediation/wto-message-on-startup.md

+    `2024-09-30 10:17:53.814 <ZWEAGW1:DiscoveryClient-InstanceInfoReplicator-%d:3335> jb892003 INFO  ((o.z.a.g.c.GatewayHealthIndicator)) ZWEAM001I API Mediation Layer started`
+
+2. Prepare custom logging configuration.
+   The current default logging implementation starts with information about the current time. This message content is unlike the message id which is typical in z/OS. To change this message behavior, configure the logging configuration. For details about how to configure API Mediation logging, see [Customizing Zowe API Mediation Layer logging](./configuration-logging.md). 


I don't understand the meaning of this and why this is essential information in the instructions. Can you please modify or explain the reason this information is useful?

The article is more of a use case and how to achieve this. This part explains how to provide the custom configuration in general.

The article below explains how does it need to look like for this specific requirements e.g. Syslog message issued with message id in the beginning.

janan07 · 2024-09-30T12:13:50Z

docs/user-guide/api-mediation/wto-message-on-startup.md

+
+2. Prepare custom logging configuration.
+   The current default logging implementation starts with information about the current time. This message content is unlike the message id which is typical in z/OS. To change this message behavior, configure the logging configuration. For details about how to configure API Mediation logging, see [Customizing Zowe API Mediation Layer logging](./configuration-logging.md). 
+


Can you please provide a single line description of what this configuration is? Is this an example?

I tried to change it.

janan07 · 2024-09-30T12:14:56Z

docs/user-guide/api-mediation/wto-message-on-startup.md

+        </root>
+    </configuration>
+    ```
+3. Change the structure of the log messages for the Gateway within the API Mediation Layer:


Can you please explain what this change of structure achieves?

I tried in the change

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

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

1000TurquoisePogs · 2024-09-30T14:21:33Z

docs/user-guide/api-mediation/wto-message-on-startup.md

+
+This functionality requires the following changes to the zowe.yaml:
+
+1. Change the property `zowe.sysMessages` by adding the value `- "ZWWEAM001I""`


ZWWEAM001I -> ZWEAM001I

1000TurquoisePogs · 2024-09-30T17:46:24Z

It looks like ZWEAM001I is a new message that is better than ZWEAM000I for detecting readiness. That's great!

Please see the PRs I made to implement this.
Also note, I do not see this message in v3, only in v2.
Since this is going into master, check to see if it will show up in v2.18 documentation, where it is appropriate, versus v3 documentation, where it appears to not exist yet.
If it is a v3.1 feature, perhaps docs-staging is more appropriate?

balhar-jakub · 2024-10-01T07:27:53Z

It's been implemented only for V2 by now I believe. It should be in 2.x documentation.

As for v3 we originally intended something better, but it's probably good enough and we should bring it to the v3 as well at least.

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

janan07 · 2024-10-01T09:19:52Z

docs/user-guide/api-mediation/wto-message-on-startup.md

+
+This functionality requires the following changes to the zowe.yaml:
+
+1. Change the property `zowe.sysMessages` by adding the value `- "ZWEAM001I""`


Should there be two quotation marks at the end of "ZWEAM001I""` ?

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

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

janan07

Reviewed and edited by doc squad

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

balhar-jakub added 2 commits September 26, 2024 14:27

Initial version of the WTO message requirements.

d4704d0

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

Correct the shortening of the message

1d8ec38

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

balhar-jakub added area: apiml This issue is related to Zowe API Mediation Layer release: V2 Zowe V2 content review: doc Needs review by Doc Squad member labels Sep 30, 2024

balhar-jakub requested a review from janan07 September 30, 2024 10:21

balhar-jakub self-assigned this Sep 30, 2024

Merge branch 'master' into balhar-jakub/apiml/wto-message

07093a1

github-actions bot temporarily deployed to pull request September 30, 2024 10:33 Inactive

language refactoring

ce8c286

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

janan07 reviewed Sep 30, 2024

View reviewed changes

clarrification

5a114e3

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

github-actions bot temporarily deployed to pull request September 30, 2024 12:27 Inactive

Reflect concerns from Andrew

58bf7ee

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

github-actions bot temporarily deployed to pull request September 30, 2024 13:12 Inactive

1000TurquoisePogs reviewed Sep 30, 2024

View reviewed changes

This was referenced Sep 30, 2024

Update example-zowe.yaml for ZWEAM001I zowe/zowe-install-packaging#4025

Open

Update for new ZWEAM001I message zowe/zowe-install-packaging#4026

Open

language/formatting refactor

58c473b

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

janan07 reviewed Oct 1, 2024

View reviewed changes

balhar-jakub and others added 4 commits October 1, 2024 11:28

Update wto-message-on-startup.md

a59ad44

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

fix typo

984bcdf

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

resync branches

c6b192e

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

add wto-message to sidebars.js

05993ba

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

janan07 approved these changes Oct 1, 2024

View reviewed changes

github-actions bot temporarily deployed to pull request October 1, 2024 09:51 Inactive

fix broken links

e064cc6

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>

github-actions bot temporarily deployed to pull request October 1, 2024 11:24 Inactive

janan07 merged commit b122a82 into master Oct 1, 2024
3 of 4 checks passed

janan07 deleted the balhar-jakub/apiml/wto-message branch October 1, 2024 11:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue WTO message on API Mediation Layer startup #3894

Issue WTO message on API Mediation Layer startup #3894

balhar-jakub commented Sep 30, 2024

github-actions bot commented Sep 30, 2024

github-actions bot commented Sep 30, 2024 •

edited

Loading

janan07 Sep 30, 2024

balhar-jakub Sep 30, 2024

janan07 Sep 30, 2024

balhar-jakub Sep 30, 2024

janan07 Sep 30, 2024

balhar-jakub Sep 30, 2024

1000TurquoisePogs Sep 30, 2024

1000TurquoisePogs commented Sep 30, 2024

balhar-jakub commented Oct 1, 2024

janan07 Oct 1, 2024

janan07 left a comment


		2. Prepare custom logging configuration.
		The current default logging implementation starts with information about the current time. This message content is unlike the message id which is typical in z/OS. To change this message behavior, configure the logging configuration. For details about how to configure API Mediation logging, see [Customizing Zowe API Mediation Layer logging](./configuration-logging.md).


		This functionality requires the following changes to the zowe.yaml:

		1. Change the property `zowe.sysMessages` by adding the value `- "ZWWEAM001I""`

Issue WTO message on API Mediation Layer startup #3894

Issue WTO message on API Mediation Layer startup #3894

Conversation

balhar-jakub commented Sep 30, 2024

github-actions bot commented Sep 30, 2024

github-actions bot commented Sep 30, 2024 • edited Loading

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

Choose a reason for hiding this comment

1000TurquoisePogs commented Sep 30, 2024

balhar-jakub commented Oct 1, 2024

Choose a reason for hiding this comment

janan07 left a comment

Choose a reason for hiding this comment

github-actions bot commented Sep 30, 2024 •

edited

Loading