Management API Reference for subsystem=microprofile-metrics-smallrye

WildFly Extension for MicroProfile Metrics With SmallRye

Provided Capabilities (2)

Name	Dynamic	Other provider points
org.wildfly.extension.metrics.scan	false	none
org.wildfly.extension.metrics.http-context.security-enabled	false	none

Attributes (3)

exposed-subsystems - The names of the WildFly subsystems that exposes their metrics (or '*' to expose any subsystem metrics).

Type	LIST
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The names of the WildFly subsystems that exposes their metrics (or '*' to expose any subsystem metrics).", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

prefix - Prefix prepended to the name of the WildFly metrics exposed by the HTTP endpoints.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Prefix prepended to the name of the WildFly metrics exposed by the HTTP endpoints.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

security-enabled - True if authentication is required to access the HTTP endpoint on the HTTP management interface.This attribute overrides the value specified in the security-enabled attribute of the /subsystem=metrics resource.

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "True if authentication is required to access the HTTP endpoint on the HTTP management interface.This attribute overrides the value specified in the security-enabled attribute of the /subsystem=metrics resource.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

Operations (4)

add - Add the subsystem

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
exposed-subsystems	LIST	false	false		The names of the WildFly subsystems that exposes their metrics (or '*' to expose any subsystem metrics).
prefix	STRING	false	true		Prefix prepended to the name of the WildFly metrics exposed by the HTTP endpoints.
security-enabled	BOOLEAN	false	true	true	True if authentication is required to access the HTTP endpoint on the HTTP management interface.This attribute overrides the value specified in the security-enabled attribute of the /subsystem=metrics resource.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add the subsystem",
    "request-properties" : {
        "exposed-subsystems" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The names of the WildFly subsystems that exposes their metrics (or '*' to expose any subsystem metrics).",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "prefix" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Prefix prepended to the name of the WildFly metrics exposed by the HTTP endpoints.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "security-enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "True if authentication is required to access the HTTP endpoint on the HTTP management interface.This attribute overrides the value specified in the security-enabled attribute of the /subsystem=metrics resource.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

describe-migration - Describe all the steps to remove legacy MicroProfile Metrics subsystem resources.

Reply properties

Type

OBJECT

Value Type


{
    "migration-warnings" => {
        "type" => LIST,
        "description" => "Any warnings about resources that could not be migrated.",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "min-length" => 0,
        "max-length" => 2147483647,
        "stability" => "default",
        "value-type" => STRING
    },
    "migration-error" => {
        "type" => OBJECT,
        "description" => "The error that occurred during migration.",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "stability" => "default",
        "value-type" => OBJECT
    }
}

Raw DMR model


{
    "operation-name" : "describe-migration",
    "description" : "Describe all the steps to remove legacy MicroProfile Metrics subsystem resources.",
    "request-properties" : {},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "OBJECT"
        },
        "value-type" : {
            "migration-warnings" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "LIST"
                },
                "description" : "Any warnings about resources that could not be migrated.",
                "expressions-allowed" : false,
                "required" : false,
                "nillable" : true,
                "min-length" : 0,
                "max-length" : 2147483647,
                "stability" : "default",
                "value-type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                }
            },
            "migration-error" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "OBJECT"
                },
                "description" : "The error that occurred during migration.",
                "expressions-allowed" : false,
                "required" : false,
                "nillable" : true,
                "stability" : "default",
                "value-type" : {
                    "TYPE_MODEL_VALUE" : "OBJECT"
                }
            }
        }
    },
    "access-constraints" : {"sensitive" : {"read-whole-config" : {"type" : "core"}}},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : false
}

migrate - Remove the legacy MicroProfile metrics subsystem.

Reply properties

Type

OBJECT

Value Type


{
    "migration-warnings" => {
        "type" => LIST,
        "description" => "Any warnings about resources that could not be migrated.",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "min-length" => 0,
        "max-length" => 2147483647,
        "stability" => "default",
        "value-type" => STRING
    },
    "migration-error" => {
        "type" => OBJECT,
        "description" => "The error that occurred during migration.",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "stability" => "default",
        "value-type" => OBJECT
    }
}

Raw DMR model


{
    "operation-name" : "migrate",
    "description" : "Remove the legacy MicroProfile metrics subsystem.",
    "request-properties" : {},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "OBJECT"
        },
        "value-type" : {
            "migration-warnings" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "LIST"
                },
                "description" : "Any warnings about resources that could not be migrated.",
                "expressions-allowed" : false,
                "required" : false,
                "nillable" : true,
                "min-length" : 0,
                "max-length" : 2147483647,
                "stability" : "default",
                "value-type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                }
            },
            "migration-error" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "OBJECT"
                },
                "description" : "The error that occurred during migration.",
                "expressions-allowed" : false,
                "required" : false,
                "nillable" : true,
                "stability" : "default",
                "value-type" : {
                    "TYPE_MODEL_VALUE" : "OBJECT"
                }
            }
        }
    },
    "access-constraints" : {"sensitive" : {"read-whole-config" : {"type" : "core"}}},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove the subsystem

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove the subsystem",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.microprofile-metrics-smallrye

        
<feature spec="subsystem.microprofile-metrics-smallrye">
  <param name="exposed-subsystems" value="{value}"/>
  <param name="prefix" value="{value}"/>
  <param name="security-enabled" value="{value}"/>
<feature/>