MicroProfile Metrics (mpMetrics)

Configuration for MicroProfile Metrics.

Name	Type	Default	Description
authentication	boolean	true	Indicates whether or not users should provide user name and password when accessing metrics endpoint.
libraryRef	A reference to top level library element (string).		Identifies User provided Micrometer binaries and dependencies

Name

Type

Default

Description

authentication

boolean

true

Indicates whether or not users should provide user name and password when accessing metrics endpoint.

libraryRef

A reference to top level library element (string).

Identifies User provided Micrometer binaries and dependencies

mpMetrics > library

Identifies User provided Micrometer binaries and dependencies

Name	Type	Default	Description
apiTypeVisibility	string	spec,ibm-api,api,stable	The types of API packages that this class loader supports. This value is a comma-separated list of any combination of the following API packages: spec, ibm-api, api, stable, third-party.
description	string		Description of shared library for administrators
filesetRef	List of references to top level fileset elements (comma-separated string).		Specifies a set of JAR or ZIP files to include in the class path for this library
name	string		Name of shared library for administrators

Name

Type

Default

Description

apiTypeVisibility

string

spec,ibm-api,api,stable

The types of API packages that this class loader supports. This value is a comma-separated list of any combination of the following API packages: spec, ibm-api, api, stable, third-party.

description

string

Description of shared library for administrators

filesetRef

List of references to top level fileset elements (comma-separated string).

Specifies a set of JAR or ZIP files to include in the class path for this library

name

string

Name of shared library for administrators

mpMetrics > library > file

Add a JAR or ZIP file to include in the class path for this library. Classes and resources that are contained in the specified JAR or ZIP are available to load for this library.

Name	Type	Default	Description
id	string		A unique configuration ID.
name	Path to a file Required		The path to a file can be a fully qualified path or a relative path. Relative paths are relative to the value of the ${server.config.dir} property.

mpMetrics > library > fileset

Specifies a set of JAR or ZIP files to include in the class path for this library

Name	Type	Default	Description
caseSensitive	boolean	true	Boolean to indicate whether or not the search should be case sensitive (default: true).
dir	Path to a directory	${server.config.dir}	The base directory to search for files.
excludes	string		The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
id	string		A unique configuration ID.
includes	string	*	The comma or space separated list of file name patterns to include in the search results (default: *).
scanInterval	A period of time with millisecond precision	0	The scanning interval to determine whether files are added or removed from the fileset. The individual files are not scanned. The suffix for the interval of time is h-hour, m-minute, s-second, and ms-millisecond, for example, 2ms or 5s. The scanning interval is disabled by default and is disabled manually by setting the scan interval, scanInterval, to 0. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

mpMetrics > library > folder

Add a folder to include in the class path for this library. Classes and resources that are contained in the specified folder and its subfolders are available to load for this library. JAR and ZIP files that are contained in the specified folder are not added to the class path for this library.

Name	Type	Default	Description
dir	Path to a directory Required		The path to a folder can be a fully qualified path or a relative path. Relative paths are relative to the value of the ${server.config.dir} property.
id	string		A unique configuration ID.

mpMetrics > library > path

Add a JAR file, ZIP file or folder to include in the class path for this library. If the specified path is a JAR or ZIP file, then classes and resources that are contained in the specified JAR or ZIP file are available to load for this library. If the specified path is a folder, then classes and resources that are contained in the specified folder and its subfolders are available to load for this library. JAR and ZIP files contained in the specified folder are not added to the class path for this library.