Chapter 3. Administer Eclipse MicroProfile in JBoss EAP

3.1. Eclipse MicroProfile OpenTracing administration
复制链接

3.1.1. Enabling MicroProfile Open Tracing
复制链接

Use the following management CLI commands to enable the MicroProfile Open Tracing feature globally for the server instance by adding the subsystem to the server configuration.

Procedure

Enable the microprofile-opentracing-smallrye subsystem using the following management command:
```
/subsystem=microprofile-opentracing-smallrye:add()
```
```
/subsystem=microprofile-opentracing-smallrye:add()
```
Copy to Clipboard Toggle word wrap
Reload the server for the changes to take effect.
```
reload
```
```
reload
```
Copy to Clipboard Toggle word wrap

3.1.2. Removing the microprofile-opentracing-smallrye subsystem
复制链接

The microprofile-opentracing-smallrye subsystem is included in the default JBoss EAP 7.3 configuration. This subsystem provides Eclipse MicroProfile OpenTracing functionality for JBoss EAP 7.3. If you experience system memory or performance degradation with MicroProfile OpenTracing enabled, you might want to disable the microprofile-opentracing-smallrye subsystem.

You can use the remove operation in the management CLI to disable the MicroProfile OpenTracing feature globally for a given server.

Procedure

Remove the subsystem.

/subsystem=microprofile-opentracing-smallrye:remove()

/subsystem=microprofile-opentracing-smallrye:remove()

Copy to Clipboard

Toggle word wrap

Reload the server for the changes to take effect.
```
reload
```
```
reload
```
Copy to Clipboard Toggle word wrap

3.1.3. Adding the microprofile-opentracing-smallrye subsystem
复制链接

You can enable the microprofile-opentracing-smallrye subsystem by adding it to the server configuration. Use the add operation in the management CLI to enable the MicroProfile OpenTracing feature globally for a given the server.

Procedure

Add the subsystem.

/subsystem=microprofile-opentracing-smallrye:add()

/subsystem=microprofile-opentracing-smallrye:add()

Copy to Clipboard

Toggle word wrap

Reload the server for the changes to take effect.
```
reload
```
```
reload
```
Copy to Clipboard Toggle word wrap

3.1.4. Installing Jaeger
复制链接

Install Jaeger using docker.

Prerequisites

docker is installed.

Procedure

Install Jaeger using docker by issuing the following command in CLI:

docker run -d --name jaeger   -p 6831:6831/udp   -p 5778:5778   -p 14268:14268   -p 16686:16686   jaegertracing/all-in-one:1.16

$ docker run -d --name jaeger   -p 6831:6831/udp   -p 5778:5778   -p 14268:14268   -p 16686:16686   jaegertracing/all-in-one:1.16

Copy to Clipboard

Toggle word wrap

3.2. Eclipse MicroProfile Config configuration
复制链接

3.2.1. Adding properties in a ConfigSource management resource
复制链接

You can store properties directly in a config-source subsystem as a management resource.

Procedure

Create a ConfigSource and add a property:

/subsystem=microprofile-config-smallrye/config-source=props:add(properties={"name" = "jim"})

/subsystem=microprofile-config-smallrye/config-source=props:add(properties={"name" = "jim"})

Copy to Clipboard

Toggle word wrap

3.2.2. Configuring directories as ConfigSources
复制链接

When a property is stored in a directory as a file, the file-name is the name of a property and the file content is the value of the property.

Procedure

Create a directory where you want to store the files:
```
mkdir -p ~/config/prop-files/
```
```
$ mkdir -p ~/config/prop-files/
```
Copy to Clipboard Toggle word wrap
Navigate to the directory:
```
cd ~/config/prop-files/
```
```
$ cd ~/config/prop-files/
```
Copy to Clipboard Toggle word wrap
Create a file name to store the value for the property name:
```
touch name
```
```
$ touch name
```
Copy to Clipboard Toggle word wrap
Add the value of the property to the file:
```
echo "jim" > name
```
```
$ echo "jim" > name
```
Copy to Clipboard Toggle word wrap

Create a ConfigSource in which the file name is the property and the file contents the value of the property:

/subsystem=microprofile-config-smallrye/config-source=file-props:add(dir={path=~/config/prop-files})

/subsystem=microprofile-config-smallrye/config-source=file-props:add(dir={path=~/config/prop-files})

Copy to Clipboard

Toggle word wrap

This results in the following XML configuration:

<subsystem xmlns="urn:wildfly:microprofile-config-smallrye:1.0">
    <config-source name="file-props">
        <dir path="/etc/config/prop-files"/>
    </config-source>
</subsystem>

<subsystem xmlns="urn:wildfly:microprofile-config-smallrye:1.0">
    <config-source name="file-props">
        <dir path="/etc/config/prop-files"/>
    </config-source>
</subsystem>

Copy to Clipboard

Toggle word wrap

3.2.3. Obtaining ConfigSource from a ConfigSource class
复制链接

You can create and configure a custom org.eclipse.microprofile.config.spi.ConfigSource implementation class to provide a source for the configuration values.

Procedure

The following management CLI command creates a ConfigSource for the implementation class named org.example.MyConfigSource that is provided by a JBoss module named org.example.

If you want to use a ConfigSource from the org.example module, add the <module name="org.eclipse.microprofile.config.api"/> dependency to the path/to/org/example/main/module.xml file.

/subsystem=microprofile-config-smallrye/config-source=my-config-source:add(class={name=org.example.MyConfigSource, module=org.example})

/subsystem=microprofile-config-smallrye/config-source=my-config-source:add(class={name=org.example.MyConfigSource, module=org.example})

Copy to Clipboard

Toggle word wrap

This command results in the following XML configuration for the microprofile-config-smallrye subsystem.

<subsystem xmlns="urn:wildfly:microprofile-config-smallrye:1.0">
    <config-source name="my-config-source">
        <class name="org.example.MyConfigSource" module="org.example"/>
    </config-source>
</subsystem>

<subsystem xmlns="urn:wildfly:microprofile-config-smallrye:1.0">
    <config-source name="my-config-source">
        <class name="org.example.MyConfigSource" module="org.example"/>
    </config-source>
</subsystem>

Copy to Clipboard

Toggle word wrap

Properties provided by the custom org.eclipse.microprofile.config.spi.ConfigSource implementation class are available to any JBoss EAP deployment.

3.2.4. Obtaining ConfigSource configuration from a ConfigSourceProvider class
复制链接

You can create and configure a custom org.eclipse.microprofile.config.spi.ConfigSourceProvider implementation class that registers implementations for multiple ConfigSource instances.

Procedure

Create a config-source-provider:

/subsystem=microprofile-config-smallrye/config-source-provider=my-config-source-provider:add(class={name=org.example.MyConfigSourceProvider, module=org.example})

/subsystem=microprofile-config-smallrye/config-source-provider=my-config-source-provider:add(class={name=org.example.MyConfigSourceProvider, module=org.example})

Copy to Clipboard

Toggle word wrap

The command creates a config-source-provider for the implementation class named org.example.MyConfigSourceProvider that is provided by a JBoss Module named org.example.

If you want to use a config-source-provider from the org.example module, add the <module name="org.eclipse.microprofile.config.api"/> dependency to the path/to/org/example/main/module.xml file.

This command results in the following XML configuration for the microprofile-config-smallrye subsystem:

<subsystem xmlns="urn:wildfly:microprofile-config-smallrye:1.0">
    <config-source-provider name="my-config-source-provider">
         <class name="org.example.MyConfigSourceProvider" module="org.example"/>
    </config-source-provider>
</subsystem>

<subsystem xmlns="urn:wildfly:microprofile-config-smallrye:1.0">
    <config-source-provider name="my-config-source-provider">
         <class name="org.example.MyConfigSourceProvider" module="org.example"/>
    </config-source-provider>
</subsystem>

Copy to Clipboard

Toggle word wrap

Properties provided by the ConfigSourceProvider implementation are available to any JBoss EAP deployment.

Additional resources

For information about how to add a global module to the JBoss EAP server, see Define Global Modules in the Configuration Guide for JBoss EAP.

3.3. Eclipse MicroProfile Fault Tolerance configuration
复制链接

3.3.1. Adding the MicroProfile Fault Tolerance extension
复制链接

The MicroProfile Fault Tolerance extension is included in standalone-microprofile.xml and standalone-microprofile-ha.xml configurations that are provided as part of JBoss EAP XP.

The extension is not included in the standard standalone.xml configuration. To use the extension, you must manually enable it.

Prerequisites

EAP XP pack is installed.

Procedure

Add the MicroProfile Fault Tolerance extension using the following management CLI command:

/extension=org.wildfly.extension.microprofile.fault-tolerance-smallrye:add

/extension=org.wildfly.extension.microprofile.fault-tolerance-smallrye:add

Copy to Clipboard

Toggle word wrap

Enable the microprofile-fault-tolerance-smallrye subsystem using the following managenent command:
```
/subsystem=microprofile-fault-tolerance-smallrye:add
```
```
/subsystem=microprofile-fault-tolerance-smallrye:add
```
Copy to Clipboard Toggle word wrap
Reload the server with the following management command:
```
reload
```
```
reload
```
Copy to Clipboard Toggle word wrap

3.4. Eclipse MicroProfile Health configuration
复制链接

3.4.1. Examining health using the management CLI
复制链接

You can check system health using the management CLI.

Procedure

Examine health:

/subsystem=microprofile-health-smallrye:check
{
    "outcome" => "success",
    "result" => {
        "status" => "UP",
        "checks" => []
    }
}

/subsystem=microprofile-health-smallrye:check
{
    "outcome" => "success",
    "result" => {
        "status" => "UP",
        "checks" => []
    }
}

Copy to Clipboard

Toggle word wrap

3.4.2. Examining health using the management console
复制链接

You can check system health using the management console.

A check runtime operation shows the health checks and the global outcome as boolean value.

Procedure

Navigate to the Runtime tab and select the server.
In the Monitor column, click MicroProfile Health View.

3.4.3. Examining health using the HTTP endpoint
复制链接

Health check is automatically deployed to the health context on JBoss EAP, so you can obtain the current health using the HTTP endpoint.

The default address for the /health endpoint, accessible from the management interface, is http://127.0.0.1:9990/health.

Procedure

To obtain the current health of the server using the HTTP endpoint, use the following URL:.
```
http://HOST:PORT/health
```
```
http://HOST:PORT/health
```
Copy to Clipboard Toggle word wrap
Accessing this context displays the health check in JSON format, indicating if the server is healthy.

3.4.4. Enabling authentication for Eclipse MicroProfile Health
复制链接

You can configure the health context to require authentication for access.

Procedure

Set the security-enabled attribute to true on the microprofile-health-smallrye subsystem.

/subsystem=microprofile-health-smallrye:write-attribute(name=security-enabled,value=true)

/subsystem=microprofile-health-smallrye:write-attribute(name=security-enabled,value=true)

Copy to Clipboard

Toggle word wrap

Reload the server for the changes to take effect.
```
reload
```
```
reload
```
Copy to Clipboard Toggle word wrap

Any subsequent attempt to access the /health endpoint triggers an authentication prompt.

3.4.5. Global status when probes are not defined
复制链接

The :empty-readiness-checks-status and :empty-liveness-checks-status management attributes specify the global status when no readiness or liveness probes are defined.

These attributes allow applications to report ‘DOWN’ until their probes verify that the application is ready or live. By default, applications report ‘UP’.

The :empty-readiness-checks-status attribute specifies the global status for readiness probes if no readiness probes have been defined:

/subsystem=microprofile-health-smallrye:read-attribute(name=empty-readiness-checks-status)
{
    "outcome" => "success",
    "result" => expression "${env.MP_HEALTH_EMPTY_READINESS_CHECKS_STATUS:UP}"
}

/subsystem=microprofile-health-smallrye:read-attribute(name=empty-readiness-checks-status)
{
    "outcome" => "success",
    "result" => expression "${env.MP_HEALTH_EMPTY_READINESS_CHECKS_STATUS:UP}"
}

Copy to Clipboard

Toggle word wrap

The :empty-liveness-checks-status attribute specifies the global status for liveness probes if no liveness probes have been defined:

/subsystem=microprofile-health-smallrye:read-attribute(name=empty-liveness-checks-status)
{
    "outcome" => "success",
    "result" => expression "${env.MP_HEALTH_EMPTY_LIVENESS_CHECKS_STATUS:UP}"
}

/subsystem=microprofile-health-smallrye:read-attribute(name=empty-liveness-checks-status)
{
    "outcome" => "success",
    "result" => expression "${env.MP_HEALTH_EMPTY_LIVENESS_CHECKS_STATUS:UP}"
}

Copy to Clipboard

Toggle word wrap

The /health HTTP endpoint and the :check operation that check both readiness and liveness probes also take into account these attributes.

You can also modify these attributes as shown in the following example:

/subsystem=microprofile-health-smallrye:write-attribute(name=empty-readiness-checks-status,value=DOWN)
{
    "outcome" => "success",
    "response-headers" => {
        "operation-requires-reload" => true,
        "process-state" => "reload-required"
    }
}

/subsystem=microprofile-health-smallrye:write-attribute(name=empty-readiness-checks-status,value=DOWN)
{
    "outcome" => "success",
    "response-headers" => {
        "operation-requires-reload" => true,
        "process-state" => "reload-required"
    }
}

Copy to Clipboard

Toggle word wrap

3.5. Eclipse MicroProfile JWT configuration
复制链接

3.5.1. Enabling microprofile-jwt-smallrye subsystem
复制链接

The Eclipse MicroProfile JWT integration is provided by the microprofile-jwt-smallrye subsystem and is included in the default configuration. If the subsystem is not present in the default configuration, you can add it as follows.

Prerequisites

EAP XP is installed.

Procedure

Enable the MicroProfile JWT smallrye extension in JBoss EAP:

/extension=org.wildfly.extension.microprofile.jwt-smallrye:add

/extension=org.wildfly.extension.microprofile.jwt-smallrye:add

Copy to Clipboard

Toggle word wrap

Enable the microprofile-jwt-smallrye subsystem:
```
/subsystem=microprofile-jwt-smallrye:add
```
```
/subsystem=microprofile-jwt-smallrye:add
```
Copy to Clipboard Toggle word wrap
Reload the server:
```
reload
```
```
reload
```
Copy to Clipboard Toggle word wrap

The microprofile-jwt-smallrye subsystem is enabled.

3.6. Eclipse MicroProfile Metrics administration
复制链接

3.6.1. Metrics available on the management interface
复制链接

The JBoss EAP subsystem metrics are exposed in Prometheus format.

Metrics are automatically available on the JBoss EAP management interface, with the following contexts:

/metrics/ - Contains metrics specified in the MicroProfile 3.0 specification.
/metrics/vendor - Contains vendor-specific metrics, such as memory pools.
/metrics/application - Contains metrics from deployed applications and subsystems that use the MicroProfile Metrics API.

The metric names are based on subsystem and attribute names. For example, the subsystem undertow exposes a metric attribute request-count for every servlet in an application deployment. The name of this metric is jboss_undertow_request_count. The prefix jboss identifies JBoss EAP as the source of the metrics.

3.6.2. Examining metrics using the HTTP endpoint
复制链接

Examine the metrics that are available on the JBoss EAP management interface using the HTTP endpoint.

Procedure

Use the curl command:

curl -v http://localhost:9990/metrics | grep -i type

$ curl -v http://localhost:9990/metrics | grep -i type

Copy to Clipboard

Toggle word wrap

3.6.3. Enabling Authentication for the Eclipse MicroProfile Metrics HTTP Endpoint
复制链接

Configure the metrics context to require users to be authorized to access the context. This configuration extends to all the subcontexts of the metrics context.

Procedure

Set the security-enabled attribute to true on the microprofile-metrics-smallrye subsystem.

/subsystem=microprofile-metrics-smallrye:write-attribute(name=security-enabled,value=true)

/subsystem=microprofile-metrics-smallrye:write-attribute(name=security-enabled,value=true)

Copy to Clipboard

Toggle word wrap

Reload the server for the changes to take effect.
```
reload
```
```
reload
```
Copy to Clipboard Toggle word wrap

Any subsequent attempt to access the metrics endpoint results in an authentication prompt.

3.6.4. Obtaining the request count for a web service
复制链接

Obtain the request count for a web service that exposes its request count metric.

The following procedure uses helloworld-rs quickstart as the web service for obtaining request count. The quickstart is available at Download the quickstart from: jboss-eap-quickstarts.

Prerequsites

The web service exposes request count.

Procedure

Enable statistics for the undertow subsystem:
- Start the standalone server with statistics enabled:
  $ ./standalone.sh -Dwildfly.statistics-enabled=true
  Copy to Clipboard Toggle word wrap
- For an already running server, enable the statistics for the undertow subsystem:
  /subsystem=undertow:write-attribute(name=statistics-enabled,value=true)
  Copy to Clipboard Toggle word wrap
Deploy the helloworld-rs quickstart:
- In the root directory of the quickstart, deploy the web application using Maven:
  $ mvn clean install wildfly:deploy
  Copy to Clipboard Toggle word wrap

Query the HTTP endpoint in the CLI using the curl command and filter for request_count:

curl -v http://localhost:9990/metrics |  grep request_count

$ curl -v http://localhost:9990/metrics |  grep request_count

Copy to Clipboard

Toggle word wrap

Expected output:

jboss_undertow_request_count_total{server="default-server",http_listener="default",} 0.0

jboss_undertow_request_count_total{server="default-server",http_listener="default",} 0.0

Copy to Clipboard

Toggle word wrap

The attribute value returned is 0.0.

Access the quickstart, located at http://localhost:8080/helloworld-rs/, in a web browser and click any of the links.

Query the HTTP endpoint from the CLI again:

curl -v http://localhost:9990/metrics |  grep request_count

$ curl -v http://localhost:9990/metrics |  grep request_count

Copy to Clipboard

Toggle word wrap

Expected output:

jboss_undertow_request_count_total{server="default-server",http_listener="default",} 1.0

jboss_undertow_request_count_total{server="default-server",http_listener="default",} 1.0

Copy to Clipboard

Toggle word wrap

The value is updated to 1.0.

Repeat the last two steps to verify that the request count is updated.

3.7. Eclipse MicroProfile OpenAPI administration
复制链接

3.7.1. Enabling Eclipse MicroProfile OpenAPI
复制链接

The microprofile-openapi-smallrye subsystem is provided in the standalone-microprofile.xml configuration. However, JBoss EAP XP uses the standalone.xml by default. You must include the subsystem in standalone.xml to use it.

Alternatively, you can follow the procedure Updating standalone configurations with Eclipse MicroProfile subsystems and extensions to update the standalone.xml configuration file.

Procedure

Enable the MicroProfile OpenAPI smallrye extension in JBoss EAP:

/extension=org.wildfly.extension.microprofile.openapi-smallrye:add()

/extension=org.wildfly.extension.microprofile.openapi-smallrye:add()

Copy to Clipboard

Toggle word wrap

Enable the microprofile-openapi-smallrye subsystem using the following management command:
```
/subsystem=microprofile-openapi-smallrye:add()
```
```
/subsystem=microprofile-openapi-smallrye:add()
```
Copy to Clipboard Toggle word wrap
Reload the server.
```
reload
```
```
reload
```
Copy to Clipboard Toggle word wrap

The microprofile-openapi-smallrye subsystem is enabled.

3.7.2. Requesting an Eclipse MicroProfile OpenAPI document using Accept HTTP header
复制链接

Request an Eclipse MicroProfile OpenAPI document, in the JSON format, from a deployment using an Accept HTTP header.

By default, the OpenAPI endpoint returns a YAML document.

Prerequisites

The deployment being queried is configured to return an Eclipse MicroProfile OpenAPI document.

Procedure

Issue the following curl command to query the /openapi endpoint of the deployment:
```
curl -v -H'Accept: application/json' http://localhost:8080/openapi
```
```
$ curl -v -H'Accept: application/json' http://localhost:8080/openapi
< HTTP/1.1 200 OK
...
{"openapi": "3.0.1" ... }
```
Copy to Clipboard Toggle word wrap
Replace http://localhost:8080 with the URL and port of the deployment.
The Accept header indicates that the JSON document is to be returned using the application/json string.

3.7.3. Requesting an Eclipse MicroProfile OpenAPI document using an HTTP parameter
复制链接

Request an Eclipse MicroProfile OpenAPI document, in the JSON format, from a deployment using a query parameter in an HTTP request.

By default, the OpenAPI endpoint returns a YAML document.

Prerequisites

The deployment being queried is configured to return an Eclipse MicroProfile OpenAPI document.

Procedure

Issue the following curl command to query the /openapi endpoint of the deployment:
```
curl -v http://localhost:8080/openapi?format=JSON
```
```
$ curl -v http://localhost:8080/openapi?format=JSON
< HTTP/1.1 200 OK
...
```
Copy to Clipboard Toggle word wrap
Replace http://localhost:8080 with the URL and port of the deployment.
The HTTP parameter format=JSON indicates that JSON document is to be returned.

3.7.4. Configuring JBoss EAP to serve a static OpenAPI document
复制链接

Configure JBoss EAP to serve a static OpenAPI document that describes the REST services for the host.

When JBoss EAP is configured to serve a static OpenAPI document, the static OpenAPI document is processed before any JAX-RS and MicroProfile OpenAPI annotations.

In a production environment, disable annotation processing when serving a static document. Disabling annotation processing ensures that an immutable and versioned API contract is available for clients.

Procedure

Create a directory in the application source tree:
```
mkdir APPLICATION_ROOT/src/main/webapp/META-INF
```
```
$ mkdir APPLICATION_ROOT/src/main/webapp/META-INF
```
Copy to Clipboard Toggle word wrap
APPLICATION_ROOT is the directory containing the pom.xml configuration file for the application.
Query the OpenAPI endpoint, redirecting the output to a file:
```
curl http://localhost:8080/openapi?format=JSON > src/main/webapp/META-INF/openapi.json
```
```
$ curl http://localhost:8080/openapi?format=JSON > src/main/webapp/META-INF/openapi.json
```
Copy to Clipboard Toggle word wrap
By default, the endpoint serves a YAML document, format=JSON specifies that a JSON document is returned.

Configure the application to skip annotation scanning when processing the OpenAPI document model:

echo "mp.openapi.scan.disable=true" > APPLICATION_ROOT/src/main/webapp/META-INF/microprofile-config.properties

$ echo "mp.openapi.scan.disable=true" > APPLICATION_ROOT/src/main/webapp/META-INF/microprofile-config.properties

Copy to Clipboard

Toggle word wrap

Rebuild the application:
```
mvn clean install
```
```
$ mvn clean install
```
Copy to Clipboard Toggle word wrap
Deploy the application again using the following management CLI commands:
1. Undeploy the application:
  undeploy microprofile-openapi.war
  Copy to Clipboard Toggle word wrap
2. Deploy the application:
  deploy APPLICATION_ROOT/target/microprofile-openapi.war
  Copy to Clipboard Toggle word wrap

JBoss EAP now serves a static OpenAPI document at the OpenAPI endpoint.

3.7.5. Disabling microprofile-openapi-smallrye
复制链接

You can disable the microprofile-openapi-smallrye subsystem in JBoss EAP XP using the management CLI.

Procedure

Disable the microprofile-openapi-smallrye subsystem:
```
/subsystem=microprofile-openapi-smallrye:remove()
```
```
/subsystem=microprofile-openapi-smallrye:remove()
```
Copy to Clipboard Toggle word wrap

3.8. Standalone server configuration
复制链接

3.8.1. Standalone server configuration files
复制链接

The JBoss EAP XP includes additional standalone server configuration files, standalone-microprofile.xml and standalone-microprofile-ha.xml.

Standard configuration files that are included with JBoss EAP remain unchanged. Note that JBoss EAP XP 1.0.0 does not support the use of domain.xml files or domain mode.

Expand

Table 3.1. Standalone configuration files available in JBoss EAP XP
Configuration File	Purpose	Included capabilities	Excluded capabilities
`standalone.xml`	This is the default configuration that is used when you start your standalone server.	Includes information about the server, including subsystems, networking, deployments, socket bindings, and other configurable details.	Excludes subsystems necessary for messaging or high availability.
`standalone-microprofile.xml`	This configuration file supports applications that use Eclipse MicroProfile.	Includes information about the server, including subsystems, networking, deployments, socket bindings, and other configurable details.	Excludes the following capabilities: EJB Messaging Java Batch JavaServer Faces EJB Timers
`standalone-ha.xml`		Includes default subsystems and adds the `modcluster` and `jgroups` subsystems for high availability.	Excludes subsystems necessary for messaging.
`standalone-microprofile-ha.xml`	This standalone file supports applications that use Eclipse MicroProfile.	Includes the `modcluster` and `jgroups` subsystems for high availability in addition to default subsystems.	Excludes subsystems necessary for messaging.
`standalone-full.xml`		Includes the `messaging-activemq` and `iiop-openjdk` subsystems in addition to default subsystems.
`standalone-full-ha.xml`	Support for every possible subsystem.	Includes subsystems for messaging and high availability in addition to default subsystems.
`standalone-load-balancer.xml`	Support for the minimum subsystems necessary to use the built-in mod_cluster front-end load balancer to load balance other JBoss EAP instances.

By default, starting JBoss EAP as a standalone server uses the standalone.xml file. To start JBoss EAP with a standalone Eclipse MicroProfile configuration, use the -c argument. For example,

EAP_HOME/bin/standalone.sh -c=standalone-microprofile.xml

$ EAP_HOME/bin/standalone.sh -c=standalone-microprofile.xml

Copy to Clipboard

Toggle word wrap

Additional Resources

3.8.2. Updating standalone configurations with Eclipse MicroProfile subsystems and extensions
复制链接

You can update standard standalone server configuration files with Eclipse MicroProfile subsystems and extensions using the docs/examples/enable-microprofile.cli script. The enable-microprofile.cli script is intended as an example script for updating standard standalone server configuration files, not custom configurations.

The enable-microprofile.cli script modifies the existing standalone server configuration and adds the following Eclipse MicroProfile subsystems and extensions if they do not exist in the standalone configuration file:

microprofile-openapi-smallrye
microprofile-jwt-smallrye
microprofile-fault-tolerance-smallrye

The enable-microprofile.cli script outputs a high-level description of the modifications. The configuration is secured using the elytron subsystem. The security subsystem, if present, is removed from the configuration.

Prerequisites

JBoss EAP XP is installed.

Procedure

Run the following CLI script to update the default standalone.xml server configuration file:
```
EAP_HOME/bin/jboss-cli.sh --file=docs/examples/enable-microprofile.cli
```
```
$ EAP_HOME/bin/jboss-cli.sh --file=docs/examples/enable-microprofile.cli
```
Copy to Clipboard Toggle word wrap

Select a standalone server configuration other than the default standalone.xml server configuration file using the following command:

EAP_HOME/bin/jboss-cli.sh --file=docs/examples/enable-microprofile.cli -Dconfig=<standalone-full.xml|standalone-ha.xml|standalone-full-ha.xml>

$ EAP_HOME/bin/jboss-cli.sh --file=docs/examples/enable-microprofile.cli -Dconfig=<standalone-full.xml|standalone-ha.xml|standalone-full-ha.xml>

Copy to Clipboard

Toggle word wrap

The specified configuration file now includes Eclipse MicroProfile subsystems and extensions.

此内容没有您所选择的语言版本。

3.1. Eclipse MicroProfile OpenTracing administration复制链接链接已复制到粘贴板!

3.1.1. Enabling MicroProfile Open Tracing复制链接链接已复制到粘贴板!

3.1.2. Removing the microprofile-opentracing-smallrye subsystem复制链接链接已复制到粘贴板!

3.1.3. Adding the microprofile-opentracing-smallrye subsystem复制链接链接已复制到粘贴板!

3.1.4. Installing Jaeger复制链接链接已复制到粘贴板!

3.2. Eclipse MicroProfile Config configuration复制链接链接已复制到粘贴板!

3.2.1. Adding properties in a ConfigSource management resource复制链接链接已复制到粘贴板!

3.2.2. Configuring directories as ConfigSources复制链接链接已复制到粘贴板!

3.2.3. Obtaining ConfigSource from a ConfigSource class复制链接链接已复制到粘贴板!

3.2.4. Obtaining ConfigSource configuration from a ConfigSourceProvider class复制链接链接已复制到粘贴板!

3.3. Eclipse MicroProfile Fault Tolerance configuration复制链接链接已复制到粘贴板!

3.3.1. Adding the MicroProfile Fault Tolerance extension复制链接链接已复制到粘贴板!

3.4. Eclipse MicroProfile Health configuration复制链接链接已复制到粘贴板!

3.4.1. Examining health using the management CLI复制链接链接已复制到粘贴板!

3.4.2. Examining health using the management console复制链接链接已复制到粘贴板!

3.4.3. Examining health using the HTTP endpoint复制链接链接已复制到粘贴板!

3.4.4. Enabling authentication for Eclipse MicroProfile Health复制链接链接已复制到粘贴板!

3.4.5. Global status when probes are not defined复制链接链接已复制到粘贴板!

3.5. Eclipse MicroProfile JWT configuration复制链接链接已复制到粘贴板!

3.5.1. Enabling microprofile-jwt-smallrye subsystem复制链接链接已复制到粘贴板!

3.6. Eclipse MicroProfile Metrics administration复制链接链接已复制到粘贴板!

3.6.1. Metrics available on the management interface复制链接链接已复制到粘贴板!

3.6.2. Examining metrics using the HTTP endpoint复制链接链接已复制到粘贴板!

3.6.3. Enabling Authentication for the Eclipse MicroProfile Metrics HTTP Endpoint复制链接链接已复制到粘贴板!

3.6.4. Obtaining the request count for a web service复制链接链接已复制到粘贴板!

3.7. Eclipse MicroProfile OpenAPI administration复制链接链接已复制到粘贴板!

3.7.1. Enabling Eclipse MicroProfile OpenAPI复制链接链接已复制到粘贴板!

3.7.2. Requesting an Eclipse MicroProfile OpenAPI document using Accept HTTP header复制链接链接已复制到粘贴板!

3.7.3. Requesting an Eclipse MicroProfile OpenAPI document using an HTTP parameter复制链接链接已复制到粘贴板!

3.7.4. Configuring JBoss EAP to serve a static OpenAPI document复制链接链接已复制到粘贴板!

3.7.5. Disabling microprofile-openapi-smallrye复制链接链接已复制到粘贴板!

3.8. Standalone server configuration复制链接链接已复制到粘贴板!

3.8.1. Standalone server configuration files复制链接链接已复制到粘贴板!

3.8.2. Updating standalone configurations with Eclipse MicroProfile subsystems and extensions复制链接链接已复制到粘贴板!

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

3.1. Eclipse MicroProfile OpenTracing administration
复制链接

3.1.1. Enabling MicroProfile Open Tracing
复制链接

3.1.2. Removing the microprofile-opentracing-smallrye subsystem
复制链接

3.1.3. Adding the microprofile-opentracing-smallrye subsystem
复制链接

3.1.4. Installing Jaeger
复制链接

3.2. Eclipse MicroProfile Config configuration
复制链接

3.2.1. Adding properties in a ConfigSource management resource
复制链接

3.2.2. Configuring directories as ConfigSources
复制链接

3.2.3. Obtaining ConfigSource from a ConfigSource class
复制链接

3.2.4. Obtaining ConfigSource configuration from a ConfigSourceProvider class
复制链接

3.3. Eclipse MicroProfile Fault Tolerance configuration
复制链接

3.3.1. Adding the MicroProfile Fault Tolerance extension
复制链接

3.4. Eclipse MicroProfile Health configuration
复制链接

3.4.1. Examining health using the management CLI
复制链接

3.4.2. Examining health using the management console
复制链接

3.4.3. Examining health using the HTTP endpoint
复制链接

3.4.4. Enabling authentication for Eclipse MicroProfile Health
复制链接

3.4.5. Global status when probes are not defined
复制链接

3.5. Eclipse MicroProfile JWT configuration
复制链接

3.5.1. Enabling microprofile-jwt-smallrye subsystem
复制链接

3.6. Eclipse MicroProfile Metrics administration
复制链接

3.6.1. Metrics available on the management interface
复制链接

3.6.2. Examining metrics using the HTTP endpoint
复制链接

3.6.3. Enabling Authentication for the Eclipse MicroProfile Metrics HTTP Endpoint
复制链接

3.6.4. Obtaining the request count for a web service
复制链接

3.7. Eclipse MicroProfile OpenAPI administration
复制链接

3.7.1. Enabling Eclipse MicroProfile OpenAPI
复制链接

3.7.2. Requesting an Eclipse MicroProfile OpenAPI document using Accept HTTP header
复制链接

3.7.3. Requesting an Eclipse MicroProfile OpenAPI document using an HTTP parameter
复制链接

3.7.4. Configuring JBoss EAP to serve a static OpenAPI document
复制链接

3.7.5. Disabling microprofile-openapi-smallrye
复制链接

3.8. Standalone server configuration
复制链接

3.8.1. Standalone server configuration files
复制链接

3.8.2. Updating standalone configurations with Eclipse MicroProfile subsystems and extensions
复制链接