## Provided Capabilities (1)

Name | Dynamic | Other provider points
--- | --- | ---
org.wildfly.microprofile.opentracing.tracer | true | none

## Attributes (14)

- propagation - List of formats to use for propagating the trace context.

  Type | LIST
  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" : "LIST"
          },
          "description" : "List of formats to use for propagating the trace context.",
          "attribute-group" : "codec-configuration",
          "expressions-allowed" : true,
          "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
      }

- reporter-flush-interval - The flush interval when reporting spans remotely.

  Type | INT
  Unit | MILLISECONDS
  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" : "INT"
          },
          "description" : "The flush interval when reporting spans remotely.",
          "attribute-group" : "reporter-configuration",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "unit" : "MILLISECONDS",
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

- reporter-log-spans - Whether the reporter should log the spans.

  Type | BOOLEAN
  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" : "Whether the reporter should log the spans.",
          "attribute-group" : "reporter-configuration",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

- reporter-max-queue-size - The maximum queue size for use when reporting spans remotely.

  Type | INT
  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" : "INT"
          },
          "description" : "The maximum queue size for use when reporting spans remotely.",
          "attribute-group" : "reporter-configuration",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

- sampler-manager-host-port - The Jaeger sampler host port.

  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" : "The Jaeger sampler host port.",
          "attribute-group" : "sampler-configuration",
          "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
      }

- sampler-param - The Jaeger sampler parameter. For a 'Constant' sampler 0 means no trace and 1 means all traces. For a 'probabilistic' sample this is the probability of sampling. For a 'Rate Limiting' sampler this define the number of traces per second.

  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 Jaeger sampler parameter. For a 'Constant' sampler 0 means no trace and 1 means all traces. For a 'probabilistic' sample this is the probability of sampling. For a 'Rate Limiting' sampler this define the number of traces per second.",
          "attribute-group" : "sampler-configuration",
          "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 Jaeger sampler type. There are 4 supported type: 'const', 'probabilistic', 'ratelimiting' and 'remote'.

  Type | STRING
  Default Value | remote
  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 | ratelimiting const probabilistic remote
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The Jaeger sampler type. There are 4 supported type: 'const', 'probabilistic', 'ratelimiting' and 'remote'.",
          "attribute-group" : "sampler-configuration",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : "remote",
          "allowed" : [
              "const",
              "probabilistic",
              "ratelimiting",
              "remote"
          ],
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

- sender-auth-password - The Basic Auth password to be added on Authorization headers for requests sent to the endpoint.

  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" : "The Basic Auth password to be added on Authorization headers for requests sent to the endpoint.",
          "attribute-group" : "sender-configuration",
          "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
      }

- sender-auth-token - The Auth Token to be added as "Bearer" on Authorization headers for requests sent to the endpoint.

  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" : "The Auth Token to be added as \"Bearer\" on Authorization headers for requests sent to the endpoint.",
          "attribute-group" : "sender-configuration",
          "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
      }

- sender-auth-user - The Basic Auth username to be added on Authorization headers for requests sent to the endpoint.

  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" : "The Basic Auth username to be added on Authorization headers for requests sent to the endpoint.",
          "attribute-group" : "sender-configuration",
          "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
      }

- sender-binding - The outbound binding used to connect to the agent.

  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" : "The outbound binding used to connect to the agent.",
          "attribute-group" : "sender-configuration",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "capability-reference" : "org.wildfly.network.outbound-socket-binding",
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-constraints" : {"sensitive" : {"socket-binding-ref" : {"type" : "core"}}},
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services"
      }

- sender-endpoint - The full URL to the traces endpoint, like https://jaeger-collector:14268/api/traces

  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" : "The full URL to the traces endpoint, like https://jaeger-collector:14268/api/traces",
          "attribute-group" : "sender-configuration",
          "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
      }

- tags - The tracer level tags.

  Type | OBJECT
  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" : "OBJECT"
          },
          "description" : "The tracer level tags.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "stability" : "default",
          "value-type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

- tracer_id_128bit - Opt-in to use 128 bit traceIds. By default, uses 64 bits.

  Type | BOOLEAN
  Default Value | false
  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" : "Opt-in to use 128 bit traceIds. By default, uses 64 bits.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : false,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

## Operations (2)

- add - Add the configuration of the jaeger tracer.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  tags | OBJECT | false | true |  | The tracer level tags.
  tracer_id_128bit | BOOLEAN | false | true | false | Opt-in to use 128 bit traceIds. By default, uses 64 bits.
  propagation | LIST | false | true |  | List of formats to use for propagating the trace context.
  reporter-flush-interval | INT | false | true |  | The flush interval when reporting spans remotely.
  reporter-log-spans | BOOLEAN | false | true |  | Whether the reporter should log the spans.
  reporter-max-queue-size | INT | false | true |  | The maximum queue size for use when reporting spans remotely.
  sampler-manager-host-port | STRING | false | true |  | The Jaeger sampler host port.
  sampler-param | DOUBLE | false | true |  | The Jaeger sampler parameter. For a 'Constant' sampler 0 means no trace and 1 means all traces. For a 'probabilistic' sample this is the probability of sampling. For a 'Rate Limiting' sampler this define the number of traces per second.
  sampler-type | STRING | false | true | remote | The Jaeger sampler type. There are 4 supported type: 'const', 'probabilistic', 'ratelimiting' and 'remote'.
  sender-auth-password | STRING | false | true |  | The Basic Auth password to be added on Authorization headers for requests sent to the endpoint.
  sender-auth-token | STRING | false | true |  | The Auth Token to be added as "Bearer" on Authorization headers for requests sent to the endpoint.
  sender-auth-user | STRING | false | true |  | The Basic Auth username to be added on Authorization headers for requests sent to the endpoint.
  sender-binding | STRING | false | false |  | The outbound binding used to connect to the agent.
  sender-endpoint | STRING | false | true |  | The full URL to the traces endpoint, like https://jaeger-collector:14268/api/traces

  Raw DMR model |
      {
          "operation-name" : "add",
          "description" : "Add the configuration of the jaeger tracer.",
          "request-properties" : {
              "tags" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "OBJECT"
                  },
                  "description" : "The tracer level tags.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "stability" : "default",
                  "value-type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  }
              },
              "tracer_id_128bit" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "BOOLEAN"
                  },
                  "description" : "Opt-in to use 128 bit traceIds. By default, uses 64 bits.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : false,
                  "stability" : "default"
              },
              "propagation" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LIST"
                  },
                  "description" : "List of formats to use for propagating the trace context.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 0,
                  "max-length" : 2147483647,
                  "stability" : "default",
                  "value-type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  }
              },
              "reporter-flush-interval" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "INT"
                  },
                  "description" : "The flush interval when reporting spans remotely.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "unit" : "MILLISECONDS",
                  "stability" : "default"
              },
              "reporter-log-spans" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "BOOLEAN"
                  },
                  "description" : "Whether the reporter should log the spans.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "stability" : "default"
              },
              "reporter-max-queue-size" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "INT"
                  },
                  "description" : "The maximum queue size for use when reporting spans remotely.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "stability" : "default"
              },
              "sampler-manager-host-port" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The Jaeger sampler host port.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "sampler-param" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "DOUBLE"
                  },
                  "description" : "The Jaeger sampler parameter. For a 'Constant' sampler 0 means no trace and 1 means all traces. For a 'probabilistic' sample this is the probability of sampling. For a 'Rate Limiting' sampler this define the number of traces per second.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "stability" : "default"
              },
              "sampler-type" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The Jaeger sampler type. There are 4 supported type: 'const', 'probabilistic', 'ratelimiting' and 'remote'.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : "remote",
                  "allowed" : [
                      "const",
                      "probabilistic",
                      "ratelimiting",
                      "remote"
                  ],
                  "stability" : "default"
              },
              "sender-auth-password" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The Basic Auth password to be added on Authorization headers for requests sent to the endpoint.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "sender-auth-token" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The Auth Token to be added as \"Bearer\" on Authorization headers for requests sent to the endpoint.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "sender-auth-user" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The Basic Auth username to be added on Authorization headers for requests sent to the endpoint.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "sender-binding" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The outbound binding used to connect to the agent.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "capability-reference" : "org.wildfly.network.outbound-socket-binding",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "sender-endpoint" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The full URL to the traces endpoint, like https://jaeger-collector:14268/api/traces",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              }
          },
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : false
      }

- remove - Remove the configuration of the jaeger tracer.

  Raw DMR model |
      {
          "operation-name" : "remove",
          "description" : "Remove the configuration of the jaeger tracer.",
          "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.jaeger-tracer

      <feature spec="subsystem.microprofile-opentracing-smallrye.jaeger-tracer">
        <param name="jaeger-tracer" value="{resource name}"/>
        <param name="propagation" value="{value}"/>
        <param name="reporter-flush-interval" value="{value}"/>
        <param name="reporter-log-spans" value="{value}"/>
        <param name="reporter-max-queue-size" value="{value}"/>
        <param name="sampler-manager-host-port" value="{value}"/>
        <param name="sampler-param" value="{value}"/>
        <param name="sampler-type" value="{value}"/>
        <param name="sender-auth-password" value="{value}"/>
        <param name="sender-auth-token" value="{value}"/>
        <param name="sender-auth-user" value="{value}"/>
        <param name="sender-binding" value="{value}"/>
        <param name="sender-endpoint" value="{value}"/>
        <param name="tags" value="{value}"/>
        <param name="tracer_id_128bit" value="{value}"/>
      <feature/>