Skip to content

Commit

Permalink
updated documentation - added tracing configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
SravanThotakura05 committed Mar 14, 2024
1 parent a57a4c0 commit f262c6f
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,20 @@ Timeout in milliseconds to wait for messages to finish processing before shutdow
--|long
|`10000`

a| [[quarkus-solace_quarkus.client.tracing-enabled]]`link:#quarkus-solace_quarkus.client.tracing-enabled[client.tracing-enabled]`


[.description]
--
Whether to enable or disable tracing for consumer or producer.

// ifdef::add-copy-button-to-env-var[]
// Environment variable: env_var_with_copy_button:+++QUARKUS_SOLACE_DEVSERVICES_ENABLED+++[]
// endif::add-copy-button-to-env-var[]
// ifndef::add-copy-button-to-env-var[]
// Environment variable: `+++QUARKUS_SOLACE_DEVSERVICES_ENABLED+++`
// endif::add-copy-button-to-env-var[]
--|boolean
|`false`

|===
28 changes: 25 additions & 3 deletions docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -311,8 +311,8 @@ quarkus.solace.vpn=default
quarkus.solace.authentication.basic.username=basic
quarkus.solace.authentication.basic.password=basic
mp.messaging.incoming.temperatures-out.connector=quarkus-solace
mp.messaging.incoming.temperatures-out.producer.topic=temperatures
mp.messaging.outgoing.temperatures-out.connector=quarkus-solace
mp.messaging.outgoing.temperatures-out.producer.topic=temperatures
----

1. When running in dev mode or tests dev services will automatically start a Solace PubSub+ broker and if broker configuration details are not provided the extension automatically picks up the details of broker started by dev services.
Expand Down Expand Up @@ -469,6 +469,28 @@ public class TemperaturesProcessor {
}
----

[[open-telemetry-tracing]]
== Open Telemetry Tracing

Extension supports generating trace messages for th messages consumed and published by the extension. To enabling tracing for consumers and producers use the below configuration.
[source,yaml]
----
quarkus.solace.host=tcp://localhost:55555
quarkus.solace.vpn=default
quarkus.solace.authentication.basic.username=test
quarkus.solace.authentication.basic.password=test
mp.messaging.incoming.temperatures.connector=quarkus-solace
mp.messaging.incoming.temperatures.consumer.queue.name=temperatures
mp.messaging.incoming.temperatures.client.tracing-enabled=true
mp.messaging.outgoing.temperatures-out.connector=quarkus-solace
mp.messaging.outgoing.temperatures-out.producer.topic=temperatures
mp.messaging.outgoing.temperatures-out.client.tracing-enabled=true
----

NOTE: Context Propagation is not fully supported in current version.

[[health-checks]]
== Health Checks

Expand All @@ -485,7 +507,7 @@ The liveness check captures any unrecoverable failure happening during the commu
The readiness check verifies that the Quarkus Solace Messaging Connector is ready to consume/produce messages to the configured Solace queues/topics.

[[dev-services]]
Dev Services
== Dev Services

Solace Dev Services for Quarkus will spin up latest version of Solace PubSub standard with label `solace` when running tests or in dev mode. Solace Dev Services are enabled by default and will check for any existing containers with same label to reuse. If none is present a new container is started.

Expand Down

0 comments on commit f262c6f

Please sign in to comment.