Skip to content

Latest commit

 

History

History
56 lines (35 loc) · 2.61 KB

diagnostics.md

File metadata and controls

56 lines (35 loc) · 2.61 KB

Diagnostics

The running services need to be diagnosed when there are problems. Spring Boot Actuator provides a lot of useful REST API endpoints to know more about the application state. The issue is that they should not be opened to public.

The default configuration exposes just few endpoints that are safe. For local development a profile diag is turned on to enable all of them.

See config/local/gateway-service.yml file and look for:

spring.profiles.include: diag

Actuator endpoints can be accessed on /application/ URL for each service. For example, the Gateway on localhost has this URL:

https://localhost:10010/application/

Build Information

It can be useful to know what code is used. This is available at /application/info endpoint for each service. E.g:

https://localhost:10010/application/info

It is also printed to the log as the very first messsage:

[DS] 16:32:04.022 [main] INFO org.zowe.apiml.product.service.BuildInfo - Service discovery-service version xyz #n/a on 2018-08-23T14:28:33.223Z by plape03mac850 commit 6fd7c53
[GS] 16:32:04.098 [main] INFO org.zowe.apiml.product.service.BuildInfo - Service gateway-service version xyz #n/a on 2018-08-23T14:28:33.231Z by plape03mac850 commit 6fd7c53
[DC] 16:32:04.195 [main] INFO org.zowe.apiml.product.service.BuildInfo - Service discoverable-client version xyz #n/a on 2018-08-23T14:28:33.217Z by plape03mac850 commit 6fd7c53
[AC] 16:32:04.317 [main] INFO org.zowe.apiml.product.service.BuildInfo - Service api-catalog-services version xyz #n/a on 2018-08-23T14:28:33.201Z by plape03mac850 commit 6fd7c53

Version Information

It is also possible to know the version of API ML and Zowe (if API ML used as part of Zowe), using the /gateway/api/v1/version endpoint in the API Gateway service. E.g.:

https://localhost:10010/gateway/api/v1/version

To view the Zowe version requires setting up the launch parameter of API Gateway - apiml.zoweManifest with a path to the Zowe build manifest.json file, which is usually located in the root folder of Zowe build. If the encoding of manifest.json file is different from UTF-8 and IBM-1047 it requires setting up the launch parameter of API Gateway - apiml.zoweManifestEncoding with the correct encoding.

Example of response:

{
    "zowe": {
        "version": "1.8.0",
        "buildNumber": "437",
        "commitHash": "8dd9f512a2723bc07840c193d78e5d5ff5751e92"
    },
    "apiml": {
        "version": "1.3.3-SNAPSHOT",
        "buildNumber": "10",
        "commitHash": "c50d0b5"
    }
}