Management API Reference for subsystem=opentelemetry

OpenTelemetry subsystem

Provided Capabilities (2)

Name	Dynamic	Other provider points
org.wildfly.extension.opentelemetry.config	false	none
org.wildfly.extension.opentelemetry	false	none

Attributes (10)

batch-delay - The interval, in milliseconds, between two consecutive exports. Default is 5000.

Type	LONG
Default Value	5000
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" : "LONG" }, "description" : "The interval, in milliseconds, between two consecutive exports. Default is 5000.", "attribute-group" : "span-processor", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 5000, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

endpoint - The URL for the exporter endpoint.

Type	STRING
Default Value	http://localhost:4317
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" : "The URL for the exporter endpoint.", "attribute-group" : "exporter", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "http://localhost:4317", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

export-timeout - The maximum allowed time, in milliseconds, to export data.

Type	LONG
Default Value	30000
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" : "LONG" }, "description" : "The maximum allowed time, in milliseconds, to export data.", "attribute-group" : "span-processor", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 30000, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

exporter-type - The name of the exporter to use

Type	STRING
Default Value	otlp
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
Allowed Values	otlp jaeger
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the exporter to use", "attribute-group" : "exporter", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "otlp", "allowed" : [ "jaeger", "otlp" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

max-export-batch-size - The maximum number of traces to be exported in a given batch.

Type	LONG
Default Value	512
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" : "LONG" }, "description" : "The maximum number of traces to be exported in a given batch.", "attribute-group" : "span-processor", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 512, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

max-queue-size - The maximum number of traces in the queue before they are exported.

Type	LONG
Default Value	2048
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" : "LONG" }, "description" : "The maximum number of traces in the queue before they are exported.", "attribute-group" : "span-processor", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 2048, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

ratio - The ratio amount to use for the ratio sampler

Type	DOUBLE
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" : "DOUBLE" }, "description" : "The ratio amount to use for the ratio sampler", "attribute-group" : "sampler", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

sampler-type - The sampling strategy to use

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
Allowed Values	off on ratio
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The sampling strategy to use", "attribute-group" : "sampler", "expressions-allowed" : true, "required" : false, "nillable" : true, "allowed" : [ "on", "off", "ratio" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

service-name - Service name reported to the trace collector

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" : "Service name reported to the trace collector", "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 }`

span-processor-type - The type of processor to use. Valid values are 'simple' and 'batch'.

Type	STRING
Default Value	batch
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
Allowed Values	batch simple
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of processor to use. Valid values are 'simple' and 'batch'.", "attribute-group" : "span-processor", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "batch", "allowed" : [ "batch", "simple" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (2)

add - Operation Adds subsystem

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
service-name	STRING	false	true		Service name reported to the trace collector
endpoint	STRING	false	true	http://localhost:4317	The URL for the exporter endpoint.
exporter-type	STRING	false	true	otlp	The name of the exporter to use
ratio	DOUBLE	false	true		The ratio amount to use for the ratio sampler
sampler-type	STRING	false	true		The sampling strategy to use
batch-delay	LONG	false	true	5000	The interval, in milliseconds, between two consecutive exports. Default is 5000.
export-timeout	LONG	false	true	30000	The maximum allowed time, in milliseconds, to export data.
max-export-batch-size	LONG	false	true	512	The maximum number of traces to be exported in a given batch.
max-queue-size	LONG	false	true	2048	The maximum number of traces in the queue before they are exported.
span-processor-type	STRING	false	true	batch	The type of processor to use. Valid values are 'simple' and 'batch'.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Operation Adds subsystem",
    "request-properties" : {
        "service-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Service name reported to the trace collector",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "endpoint" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The URL for the exporter endpoint.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "http://localhost:4317",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "exporter-type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the exporter to use",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "otlp",
            "allowed" : [
                "jaeger",
                "otlp"
            ],
            "stability" : "default"
        },
        "ratio" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "DOUBLE"
            },
            "description" : "The ratio amount to use for the ratio sampler",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "sampler-type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The sampling strategy to use",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "allowed" : [
                "on",
                "off",
                "ratio"
            ],
            "stability" : "default"
        },
        "batch-delay" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The interval, in milliseconds, between two consecutive exports. Default is 5000.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 5000,
            "stability" : "default"
        },
        "export-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The maximum allowed time, in milliseconds, to export data.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 30000,
            "stability" : "default"
        },
        "max-export-batch-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The maximum number of traces to be exported in a given batch.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 512,
            "stability" : "default"
        },
        "max-queue-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The maximum number of traces in the queue before they are exported.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 2048,
            "stability" : "default"
        },
        "span-processor-type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The type of processor to use. Valid values are 'simple' and 'batch'.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "batch",
            "allowed" : [
                "batch",
                "simple"
            ],
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

remove - Operation Removes subsystem

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Operation Removes 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.opentelemetry

        
<feature spec="subsystem.opentelemetry">
  <param name="batch-delay" value="{value}"/>
  <param name="endpoint" value="{value}"/>
  <param name="export-timeout" value="{value}"/>
  <param name="exporter-type" value="{value}"/>
  <param name="max-export-batch-size" value="{value}"/>
  <param name="max-queue-size" value="{value}"/>
  <param name="ratio" value="{value}"/>
  <param name="sampler-type" value="{value}"/>
  <param name="service-name" value="{value}"/>
  <param name="span-processor-type" value="{value}"/>
<feature/>