Management API Reference for subsystem=microprofile-opentracing-smallrye

WildFly Extension for MicroProfile OpenTracing With SmallRye.

Stability Level: default

Children (1)

jaeger-tracer

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.microprofile.opentracing	false	none

Attributes (1)

default-tracer - Default tracer for the deployments if none is defined.

Type	STRING
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" : "STRING" }, "description" : "Default tracer for the deployments if none is defined.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.microprofile.opentracing.tracer", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

Operations (4)

add - Add the subsystem.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
default-tracer	STRING	false	false		Default tracer for the deployments if none is defined.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add the subsystem.",
    "request-properties" : {"default-tracer" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "Default tracer for the deployments if none is defined.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "capability-reference" : "org.wildfly.microprofile.opentracing.tracer",
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

describe-migration - Describe all the steps to migrate legacy MicroProfile OpenTracing subsystem resources to the new OpenTelemetry 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" => "",
        "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 migrate legacy MicroProfile OpenTracing subsystem resources to the new OpenTelemetry 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" : "",
                "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 - Migrate legacy MicroProfile OpenTracing subsystem resources to the new OpenTelemetry subsystem. Returns true if the subsystem migration has been actually performed and false otherwise.

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" : "Migrate legacy MicroProfile OpenTracing subsystem resources to the new OpenTelemetry subsystem. Returns true if the subsystem migration has been actually performed and false otherwise.",
    "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-opentracing-smallrye

        
<feature spec="subsystem.microprofile-opentracing-smallrye">
  <param name="default-tracer" value="{value}"/>
<feature/>