Skip to content

Commit 6818402

Browse files
cxharriscxharris
committed
Started work on Troubleshooting
1 parent d9066f2 commit 6818402

File tree

4 files changed

+103
-5
lines changed

4 files changed

+103
-5
lines changed

‎docs/_data/sidebars/cdp_sidebar.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ entries:
5050
- title: Log and trace files
5151
url: /cdp-Troubleshooting-General.html
5252
output: web
53+
- title: Potential problems
54+
url: /cdp-Troubleshooting-Symptoms.html
55+
output: web
5356

5457
- title: Commands - zowe profiles
5558
output: web

‎docs/js/customscripts.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ $(document).ready(function () {
2626
* Modified to use a fontawesome icon.
2727
*/
2828
// get all <pre> elements
29-
var allCodeBlocksElements = $("pre");
29+
var allCodeBlocksElements = $("pre:not(.messageText)");
3030

3131
allCodeBlocksElements.each(function (i) {
3232
// add different id for each code block

‎docs/pages/cdp/cdp-Troubleshooting-General.md

Lines changed: 48 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,54 @@ permalink: cdp-Troubleshooting-General.html
88
folder: cdp
99
---
1010

11+
### Console output
12+
All Zowe CLI cics deploy plugin commands send output to the console when invoked. Very often, enough information is provided for you to diagnose and pinpoint the cause of a problem. The commands `cics-deploy push`, `cics-deploy deploy` and `cics-deploy undeploy` accept a `--verbose` command-line option which can generate extra information if needed.
13+
1114
### zowe.log
12-
The .zowe directory contains log files, profiles, and plug-ins. The location of this directory can be customised as described in [ Setting the Zowe CLI home directory](https://zowe.github.io/docs-site/latest/user-guide/cli-configuringcli.html#setting-the-zowe-cli-home-directory) and logging level set as described in [Setting Zowe CLI log levels](https://zowe.github.io/docs-site/latest/user-guide/cli-configuringcli.html#setting-zowe-cli-log-levels).
15+
The .zowe directory on your local workstation contains log files, profiles, and plug-ins. The location of this directory can be customised as described in [ Setting the Zowe CLI home directory](https://zowe.github.io/docs-site/latest/user-guide/cli-configuringcli.html#setting-the-zowe-cli-home-directory) and logging level set as described in [Setting Zowe CLI log levels](https://zowe.github.io/docs-site/latest/user-guide/cli-configuringcli.html#setting-zowe-cli-log-levels).
1316

1417
You can use the following command to display messages written to the log file as they occur. This can be useful when troubleshooting problems when using `zowe` and `zowe cics-plugin` commands in another terminal.
15-
```console
16-
tail -f -n 0 ~/.zowe/zowe/logs/zowe.log
17-
```
18+
<ul id="profileTabs" class="nav nav-tabs">
19+
<li class="active"><a href="#windows" data-toggle="tab">Windows</a></li>
20+
<li><a href="#linux" data-toggle="tab">Linux</a></li>
21+
<li><a href="#macos" data-toggle="tab">macOS</a></li>
22+
</ul>
23+
<div class="tab-content">
24+
<div role="tabpanel" class="tab-pane active" id="windows">
25+
<p>On Windows, use the Powershell command
26+
<br/><br/>
27+
<tt>Get-Content $env:USERPROFILE\.zowe\zowe\logs\zowe.log -Tail 30 -wait</tt></p>
28+
</div>
29+
30+
<div role="tabpanel" class="tab-pane" id="linux">
31+
<p>On Linux, use <tt>tail -f -n 0 ~/.zowe/zowe/logs/zowe.log</tt></p></div>
32+
33+
<div role="tabpanel" class="tab-pane" id="macos">
34+
<p>On macOS, use <tt>tail -f -n 0 ~/.zowe/zowe/logs/zowe.log</tt></p>
35+
</div>
36+
</div>
37+
38+
### Node.js logs
39+
By default, CICS writes Node.js log files on z/OS to the `/tmp` directory. However, the `generate bundle` command creates a number of files including `nodejsapps/<my app name>.profile` (often referred to as the Node.js profile), which you can edit to specify a more convenient log file location. Such logs get written to the directory referenced by the environment variable `WORK_DIR`. For example, you might edit your Node.js profile so that it includes the line:
40+
41+
```
42+
WORK_DIR=/u/<your user id>/nodelogs
43+
```
44+
This causes CICS to write all Node.js logs to the specified directory.
45+
46+
Files typically written to `WORK_DIR` include:
47+
48+
* LOG
49+
* STDERR
50+
* STDOUT
51+
* TRACE
52+
53+
They can all be useful when identifying the cause of an error, especially STDERR.
54+
55+
{% include note.html content="If you use [Visual Studio Code](https://code.visualstudio.com/) as your editor, there is a [zowe extension](https://github.com/zowe/vscode-extension-for-zowe) that enables you to interact with USS files from your local workstation." %}
56+
57+
### JES job logs
58+
DFHDPLOY is a CICS utility which provides a set of commands that you can use to deploy, undeploy and set the state of CICS bundles. When you deploy or undeploy a Node.js application to or from CICS, a batch DFHDPLOY job is initiated on z/OS.
59+
60+
If you are familiar with the z/OS environment, you can often find some useful diagnostics by accessing z/OS file assigned to the MSGUSR DD name for the deploy/undeploy job associated with your CICS region. If you are not so fluent with the world of z/OS, you may need to discuss your needs with one of your organization's CICS Systems Programmers.
61+

‎docs/pages/cdp/cdp-Troubleshooting-Symptoms.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: Possible problems and their resolution
3+
tags: [troubleshooting]
4+
keywords:
5+
summary: "This section describes sets of problem symptoms, their possible causes and suggested solutions."
6+
sidebar: cdp_sidebar
7+
permalink: cdp-Troubleshooting-Symptoms.html
8+
folder: cdp
9+
---
10+
11+
{% include important.html content="To definitively diagnose a problem based on the suggested symptoms, you will need to refer to one or more [system logs and traces](cdp-Troubleshooting-General) particularly the STDERR Node.js log and the file assigned the MSGUSR DD name in the relevant CICS DFHDPLOY job. Depending on your familiarity with z/OS and CICS, and your system privileges, you may need to consult a CICS Systems Programmer to get to the bottom of certain problems." %}
12+
13+
## Deployment errors
14+
15+
### Application incorrectly deploys in a DISABLED state
16+
*Possible cause*: The port requested by the application is already in use.
17+
18+
*Suggested action*: Choose a new port number after double-checking that it is not in use. Redeploy the application using the new value for the port.
19+
20+
{% include note.html content="An application in a `DISABLED` state does not necessarily indicate an error condition. The `cics-deploy deploy`, `cics-deploy push` and `cics-deploy undeploy` commands allow you to specify a `--target-state` option which you may deliberately choose to set to `DISABLED`." %}
21+
22+
### Command error: DFHDPLOY stopped processing due to an error
23+
*Possible causes*:
24+
* The `--scope` and/or `--cicsplex` settings for the current deploy profile are wrong, and don't correctly identify a current CICS system, CICS System Group and/or a correct CICSPlex respectively.
25+
26+
* The CMAS for the current CICSPlex is inactive.
27+
28+
* CPSM is not functioning correctly.
29+
30+
*Representative output*:
31+
<pre class="messageText">
32+
16:22:50.058844 :  DFHDPLOY CICS TS APPLICATION DEPLOYMENT  2019/04/10 4:22pm
33+
16:22:50.059562 :  RELEASE: HCI7300.   SERVICE LEVEL: HCI7300.
34+
16:22:50.060903 :  *
35+
16:22:50.060910 :  SET CICSPLEX(CAPLE);
36+
16:22:50.062721 :  DFHRL2057S DFHDPLOY is unable to connect to CICSPLEX(CAPLE).
37+
16:22:50.065729 :  DFHRL2055I Errors have occurred, processing terminated.
38+
</pre>
39+
40+
*Suggested actions*:
41+
* Confirm that the `--scope` and `--cicsplex` settings are correct.
42+
43+
* Ask your CICS Systems Programmer to check that the CMAS for the current CICSPlex is alive and that CPSM is working properly.
44+
45+
46+
47+
## General errors
48+
49+
TBC
50+
51+

0 commit comments

Comments
 (0)