Getting started with Open Liberty

 1// tag::copyright[]
 2/*******************************************************************************
 3 * Copyright (c) 2018, 2022 IBM Corporation and others.
 4 * All rights reserved. This program and the accompanying materials
 5 * are made available under the terms of the Eclipse Public License 2.0
 6 * which accompanies this distribution, and is available at
 7 * http://www.eclipse.org/legal/epl-2.0/
 8 *
 9 * SPDX-License-Identifier: EPL-2.0
10 *******************************************************************************/
11// end::copyright[]
12package io.openliberty.sample.system;
13
14import jakarta.enterprise.context.ApplicationScoped;
15
16import jakarta.inject.Inject;
17import jakarta.inject.Provider;
18
19import org.eclipse.microprofile.config.inject.ConfigProperty;
20import org.eclipse.microprofile.health.Readiness;
21import org.eclipse.microprofile.health.HealthCheck;
22import org.eclipse.microprofile.health.HealthCheckResponse;
23
24@Readiness
25@ApplicationScoped
26// tag::systemReadinessCheck[]
27public class SystemReadinessCheck implements HealthCheck {
28
29    private static final String READINESS_CHECK = SystemResource.class.getSimpleName()
30                                                 + " Readiness Check";
31
32    @Inject
33    @ConfigProperty(name = "io_openliberty_guides_system_inMaintenance")
34    Provider<String> inMaintenance;
35
36    @Override
37    public HealthCheckResponse call() {
38        if (inMaintenance != null && inMaintenance.get().equalsIgnoreCase("true")) {
39            return HealthCheckResponse.down(READINESS_CHECK);
40        }
41        return HealthCheckResponse.up(READINESS_CHECK);
42    }
43
44}
45// end::systemReadinessCheck[]

 1// tag::copyright[]
 2/*******************************************************************************
 3 * Copyright (c) 2019, 2022 IBM Corporation and others.
 4 * All rights reserved. This program and the accompanying materials
 5 * are made available under the terms of the Eclipse Public License 2.0
 6 * which accompanies this distribution, and is available at
 7 * http://www.eclipse.org/legal/epl-2.0/
 8 *
 9 * SPDX-License-Identifier: EPL-2.0
10 *******************************************************************************/
11// end::copyright[]
12package io.openliberty.sample.system;
13
14import jakarta.enterprise.context.ApplicationScoped;
15
16import java.lang.management.MemoryMXBean;
17import java.lang.management.ManagementFactory;
18
19import org.eclipse.microprofile.health.Liveness;
20import org.eclipse.microprofile.health.HealthCheck;
21import org.eclipse.microprofile.health.HealthCheckResponse;
22
23@Liveness
24@ApplicationScoped
25// tag::systemLivenessCheck[]
26public class SystemLivenessCheck implements HealthCheck {
27
28    @Override
29    public HealthCheckResponse call() {
30        MemoryMXBean memBean = ManagementFactory.getMemoryMXBean();
31        long memUsed = memBean.getHeapMemoryUsage().getUsed();
32        long memMax = memBean.getHeapMemoryUsage().getMax();
33
34        return HealthCheckResponse.named(
35            SystemResource.class.getSimpleName() + " Liveness Check")
36                                  .status(memUsed < memMax * 0.9).build();
37    }
38
39}
40// end::systemLivenessCheck[]

  1// tag::copyright[]
  2/*******************************************************************************
  3* Copyright (c) 2018, 2021 IBM Corporation and others.
  4* All rights reserved. This program and the accompanying materials
  5* are made available under the terms of the Eclipse Public License 2.0
  6* which accompanies this distribution, and is available at
  7* http://www.eclipse.org/legal/epl-2.0/
  8*
  9*     IBM Corporation - initial API and implementation
 10*******************************************************************************/
 11// end::copyright[]
 12function displayMetrics() {
 13    getSystemMetrics();
 14}
 15
 16function getSystemMetrics() {
 17    var url = "http://localhost:9080/metrics";
 18    var req = new XMLHttpRequest();
 19
 20    var metricToDisplay = {};
 21    var SRgetPropertiesTime = "io_openliberty_sample_system_SystemResource_getPropertiesTime";
 22    metricToDisplay["getProperties_total{mp_scope=\"application\",}"] = "Request Count";
 23    metricToDisplay[SRgetPropertiesTime + "_seconds{mp_scope=\"application\",quantile=\"0.999\",}"] = "Request Time (ms) at Quantile 0.999";
 24    metricToDisplay[SRgetPropertiesTime + "_seconds{mp_scope=\"application\",quantile=\"0.5\",}"] = "Request Time (ms) at Quantile 0.5";
 25    metricToDisplay[SRgetPropertiesTime + "_seconds_max{mp_scope=\"application\",}"] = "Max Request Time (ms)";
 26    metricToDisplay["cpu_processCpuLoad_percent{mp_scope=\"base\",}"] = "System CPU Usage (%)";
 27    metricToDisplay["memory_usedHeap_bytes{mp_scope=\"base\",}"] = "System Heap Usage (MB)";
 28
 29    var metricToMatch = "^(";
 30    for (var metricKey in metricToDisplay) {
 31        metricToMatch += metricKey + "|"
 32    }
 33    // remove the last |
 34    metricToMatch = metricToMatch.substring(0, metricToMatch.length-1);
 35    metricToMatch += ")\\s*(\\S*)$"
 36
 37    req.onreadystatechange = function() {
 38        if (req.readyState != 4) return; // Not there yet
 39        if (req.status != 200) {
 40            document.getElementById("metricsText").innerHTML = req.statusText;
 41            return;
 42        }
 43
 44        var resp = req.responseText;
 45        var regexpToMatch = new RegExp(metricToMatch, "gm");
 46        var matchMetrics = resp.match(regexpToMatch);
 47
 48        var keyValPairs = {};
 49        for (var metricKey in metricToDisplay) {
 50            matchMetrics.forEach(function(line) {
 51                var keyToMatch = metricKey + " (.*)";
 52                var keyVal = line.match(new RegExp(keyToMatch));
 53                if (keyVal) {
 54                    var val = keyVal[1];
 55                    if (metricKey.indexOf("application_io_openliberty_sample_system_SystemResource_getPropertiesTime") === 0) {
 56                        val = val * 1000;
 57                    } else if (metricKey.indexOf("base_memory_usedHeap_bytes") === 0) {
 58                        val = val / 1000000;
 59                    }
 60                    keyValPairs[metricToDisplay[metricKey]] = val;
 61                }
 62            })
 63        }
 64
 65        var table = document.getElementById("metricsTableBody");
 66        for (key in keyValPairs) {
 67            var row = document.createElement("tr");
 68            var keyData = document.createElement("td");
 69            keyData.innerText = key;
 70            var valueData = document.createElement("td");
 71            valueData.innerText = keyValPairs[key];
 72            row.appendChild(keyData);
 73            row.appendChild(valueData);
 74            table.appendChild(row);
 75        }
 76
 77        addSourceRow(table, url);
 78    };
 79
 80    req.open("GET", url, true);
 81    req.send();
 82}
 83
 84function displaySystemProperties() {
 85    getSystemPropertiesRequest();
 86}
 87
 88// tag::getSystemPropertiesRequest[]
 89function getSystemPropertiesRequest() {
 90// end::getSystemPropertiesRequest[]
 91    var propToDisplay = ["java.vendor", "java.version", "user.name",
 92                         "os.name", "wlp.install.dir", "wlp.server.name" ];
 93    // tag::jsUrl[]
 94    var url = "http://localhost:9080/dev/system/properties";
 95    // end::jsUrl[]
 96    var req = new XMLHttpRequest();
 97    var table = document.getElementById("systemPropertiesTable");
 98    // Create the callback:
 99    req.onreadystatechange = function () {
100        if (req.readyState != 4) return; // Not there yet
101        displayMetrics();
102        if (req.status != 200) {
103            table.innerHTML = "";
104            var row = document.createElement("tr");
105            var th = document.createElement("th");
106            th.innerText = req.statusText;
107            row.appendChild(th);
108            table.appendChild(row);
109
110            addSourceRow(table, url);
111            return;
112        }
113        // Request successful, read the response
114        var resp = JSON.parse(req.responseText);
115        for (var i = 0; i < propToDisplay.length; i++) {
116            var key = propToDisplay[i];
117            if (resp.hasOwnProperty(key)) {
118                var row = document.createElement("tr");
119                var keyData = document.createElement("td");
120                keyData.innerText = key;
121                var valueData = document.createElement("td");
122                valueData.innerText = resp[key];
123                row.appendChild(keyData);
124                row.appendChild(valueData);
125                table.appendChild(row);
126            }
127        }
128
129        addSourceRow(table, url);
130    };
131    req.open("GET", url, true);
132    req.send();
133}
134
135function displayHealth() {
136    getHealth();
137}
138
139function getHealth() {
140    var url = "http://localhost:9080/health";
141    var req = new XMLHttpRequest();
142
143    var healthBox = document.getElementById("healthBox");
144    var serviceName = document.getElementById("serviceName");
145    var healthStatus = document.getElementById("serviceStatus");
146    var healthIcon = document.getElementById("healthStatusIconImage");
147
148    req.onreadystatechange = function () {
149        if (req.readyState != 4) return; // Not there yet
150
151        // Request successful, read the response
152        if (req.responseText) {
153            var resp = JSON.parse(req.responseText);
154            var service = resp.checks[0]; //TODO: use for loop for multiple services
155
156            resp.checks.forEach(function (service) {
157                serviceName.innerText = service.name;
158                healthStatus.innerText = service.status;
159
160                if (service.status === "UP") {
161                    healthBox.style.backgroundColor = "#f0f7e1";
162                    healthIcon.setAttribute("src", "img/systemUp.svg");
163                } else {
164                    healthBox.style.backgroundColor = "#fef7f2";
165                    healthIcon.setAttribute("src", "img/systemDown.svg");
166                }
167            });
168        }
169        var table = document.getElementById("healthTable");
170
171        addSourceRow(table, url);
172    };
173    req.open("GET", url, true);
174    req.send();
175}
176
177function displayConfigProperties() {
178    getConfigPropertiesRequest();
179}
180
181function getConfigPropertiesRequest() {
182    var url = "http://localhost:9080/config";
183    var req = new XMLHttpRequest();
184
185    var configToDisplay = {};
186    configToDisplay["io_openliberty_sample_system_inMaintenance"] = "System In Maintenance";
187    configToDisplay["io_openliberty_sample_testConfigOverwrite"] = "Test Config Overwrite";
188    configToDisplay["io_openliberty_sample_port_number"] = "Port Number";
189    // Create the callback:
190    req.onreadystatechange = function () {
191        if (req.readyState != 4) return; // Not there yet
192        if (req.status != 200) {
193            return;
194        }
195
196        // Request successful, read the response
197        var resp = JSON.parse(req.responseText);
198        var configProps = resp["ConfigProperties"];
199        var table = document.getElementById("configTableBody");
200        for (key in configProps) {
201            var row = document.createElement("tr");
202            var keyData = document.createElement("td");
203            keyData.innerText = configToDisplay[key];
204            var valueData = document.createElement("td");
205            valueData.innerText = configProps[key];
206            row.appendChild(keyData);
207            row.appendChild(valueData);
208            table.appendChild(row);
209        }
210
211        addSourceRow(table, url);
212    }
213    req.open("GET", url, true);
214    req.send();
215}
216
217function toggle(e) {
218    var callerElement;
219    if (!e) {
220        if (window.event) {
221            e = window.event;
222            callerElement = e.currentTarget;
223        } else {
224            callerElement = window.toggle.caller.arguments[0].currentTarget; // for firefox
225        }
226    }
227
228    var classes = callerElement.parentElement.classList;
229    var collapsed = classes.contains("collapsed");
230    var caretImg = callerElement.getElementsByClassName("caret")[0];
231    var caretImgSrc = caretImg.getAttribute("src");
232    if (collapsed) { // expand the section
233        classes.replace("collapsed", "expanded");
234        caretImg.setAttribute("src", caretImgSrc.replace("down", "up"));
235    } else { // collapse the section
236        classes.replace("expanded", "collapsed");
237        caretImg.setAttribute("src", caretImgSrc.replace("up", "down"));
238    }
239}
240
241function addSourceRow(table, url) {
242    var sourceRow = document.createElement("tr");
243    sourceRow.classList.add("sourceRow");
244    var sourceText = document.createElement("td");
245    sourceText.setAttribute("colspan", "100%");
246    sourceText.innerHTML = "API Source\: <a href='"+url+"'>"+url+"</a>";
247    sourceRow.appendChild(sourceText);
248    table.appendChild(sourceRow);
249}

  1<?xml version='1.0' encoding='utf-8'?>
  2<project xmlns="http://maven.apache.org/POM/4.0.0"
  3         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5    <modelVersion>4.0.0</modelVersion>
  6
  7    <groupId>io.openliberty.guides</groupId>
  8    <artifactId>guide-getting-started</artifactId>
  9    <version>1.0-SNAPSHOT</version>
 10    <packaging>war</packaging>
 11
 12    <properties>
 13        <maven.compiler.source>11</maven.compiler.source>
 14        <maven.compiler.target>11</maven.compiler.target>
 15        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 16        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
 17        <!-- Liberty configuration -->
 18        <liberty.var.http.port>9080</liberty.var.http.port>
 19        <liberty.var.https.port>9443</liberty.var.https.port>
 20    </properties>
 21
 22    <dependencies>
 23        <!-- Provided dependencies -->
 24        <dependency>
 25            <groupId>jakarta.platform</groupId>
 26            <artifactId>jakarta.jakartaee-api</artifactId>
 27            <version>10.0.0</version>
 28            <scope>provided</scope>
 29        </dependency>
 30        <dependency>
 31            <groupId>org.eclipse.microprofile</groupId>
 32            <artifactId>microprofile</artifactId>
 33            <version>6.1</version>
 34            <type>pom</type>
 35            <scope>provided</scope>
 36        </dependency>
 37        <!-- For tests -->
 38        <dependency>
 39            <groupId>org.junit.jupiter</groupId>
 40            <artifactId>junit-jupiter</artifactId>
 41            <version>5.11.3</version>
 42            <scope>test</scope>
 43        </dependency>
 44        <dependency>
 45            <groupId>org.jboss.resteasy</groupId>
 46            <artifactId>resteasy-client</artifactId>
 47            <version>6.2.11.Final</version>
 48            <scope>test</scope>
 49        </dependency>
 50        <dependency>
 51            <groupId>org.jboss.resteasy</groupId>
 52            <artifactId>resteasy-json-binding-provider</artifactId>
 53            <version>6.2.11.Final</version>
 54            <scope>test</scope>
 55        </dependency>
 56        <dependency>
 57            <groupId>org.glassfish</groupId>
 58            <artifactId>jakarta.json</artifactId>
 59            <version>2.0.1</version>
 60            <scope>test</scope>
 61        </dependency>
 62    </dependencies>
 63
 64    <build>
 65        <finalName>${project.artifactId}</finalName>
 66        <plugins>
 67            <!-- Enable liberty-maven plugin -->
 68            <!-- tag::libertyMavenPlugin[] -->
 69            <plugin>
 70                <groupId>io.openliberty.tools</groupId>
 71                <artifactId>liberty-maven-plugin</artifactId>
 72                <version>3.11.1</version>
 73            </plugin>
 74            <!-- end::libertyMavenPlugin[] -->
 75            <plugin>
 76                <groupId>org.apache.maven.plugins</groupId>
 77                <artifactId>maven-war-plugin</artifactId>
 78                <version>3.4.0</version>
 79            </plugin>
 80            <plugin>
 81                <groupId>org.apache.maven.plugins</groupId>
 82                <artifactId>maven-surefire-plugin</artifactId>
 83                <version>3.5.2</version>
 84            </plugin>
 85            <!-- Plugin to run functional tests -->
 86            <!-- tag::maven-failsafe-plugin[] -->
 87            <plugin>
 88                <groupId>org.apache.maven.plugins</groupId>
 89                <artifactId>maven-failsafe-plugin</artifactId>
 90                <version>3.5.2</version>
 91                <configuration>
 92                    <systemPropertyVariables>
 93                        <http.port>${liberty.var.http.port}</http.port>
 94                        <!-- tag::contextRoot[] -->
 95                        <context.root>/dev</context.root>
 96                        <!-- end::contextRoot[] -->
 97                    </systemPropertyVariables>
 98                </configuration>
 99            </plugin>
100            <!-- end::maven-failsafe-plugin[] -->
101        </plugins>
102    </build>
103</project>