Skip to content

Commit

Permalink
Minor adjustments to doc and warning
Browse files Browse the repository at this point in the history
  • Loading branch information
gsmet committed Jun 11, 2024
1 parent b8538a9 commit 2686009
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
13 changes: 7 additions & 6 deletions docs/src/main/asciidoc/infinispan-dev-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ quarkus.infinispan-client.conn-2.devservices.enabled=true

Infinispan supports server tracing using OpenTelemetry. Starting from Infinispan 15.0, you need
to configure tracing in the server's settings.
To enable this in Dev Services, you need to add extra settings to the running server using the
To enable tracing in Dev Services, you need to add extra settings using the
`quarkus.infinispan-client.devservices.config-files` property.

[source, yaml]
Expand All @@ -135,10 +135,10 @@ infinispan:
security: false <5>
----
<1> Collector endpoint. Assuming a container service name 'jaeger' is running.
<2> Enables tracing
<2> Enables tracing.
<3> Exporter protocol. OLTP is the OpenTelemetry protocol.
<4> The service name that will be registered in the tracing collector, Jaeger in this case
<5> Enables 'security' category tracing
<4> The service name that will be registered in the tracing collector, Jaeger in this case.
<5> Enables 'security' category tracing.

See below the equivalent in XML and JSON.

Expand Down Expand Up @@ -173,7 +173,8 @@ See below the equivalent in XML and JSON.
}
----

You need name the Jaeger service or get the IP running the following command and configure the exporter endpoint.
You need to name the Jaeger service or get the IP running the following command to configure the exporter endpoint.

[source,bash]
----
docker inspect -f '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' jaeger
Expand Down Expand Up @@ -205,4 +206,4 @@ It looks for a container with the same value, or starts a new one if none can be
The default service name is `infinispan`.

Sharing is enabled by default in dev mode, but disabled in test mode.
You can disable the sharing with `quarkus.infinispan-client.devservices.shared=false`
You can disable the sharing with `quarkus.infinispan-client.devservices.shared=false`
Original file line number Diff line number Diff line change
Expand Up @@ -200,11 +200,11 @@ private RunningDevService startContainer(String clientName, DockerStatusBuildIte

if (!dockerStatusBuildItem.isDockerAvailable()) {
log.warn(
"Please configure 'quarkus.infinispan-client.hosts' or 'quarkus.infinispan-client.uri' or get a working docker instance");
"Please configure 'quarkus.infinispan-client.hosts' or 'quarkus.infinispan-client.uri' or get a working Docker instance");
return null;
}
log.infof("Starting Dev Service for connection %s", clientName);
log.infof("Apply Dev Services config %s", devServicesConfig);
log.infof("Starting Dev Services for connection %s", clientName);
log.infof("Applying Dev Services config %s", devServicesConfig);

Supplier<RunningDevService> infinispanServerSupplier = () -> {
QuarkusInfinispanContainer infinispanContainer = new QuarkusInfinispanContainer(clientName, devServicesConfig,
Expand Down Expand Up @@ -283,11 +283,11 @@ public QuarkusInfinispanContainer(String clientName, InfinispanDevServicesConfig
return " -c " + userConfigFile;
}).collect(Collectors.joining())).orElse("");

if (config.tracing.isPresent()) {
if (config.tracing.orElse(false)) {
log.warn(
"Starting with Infinispan 15.0, Infinispan support for instrumentation of the server via OpenTelemetry has evolved. Enabling tracing setting `quarkus.infinispan-client.devservices.tracing.enabled` to true won't work.\n"
"Starting with Infinispan 15.0, Infinispan support for instrumentation of the server via OpenTelemetry has evolved. Enabling tracing by setting `quarkus.infinispan-client.devservices.tracing.enabled=true` doesn't work anymore.\n"
+
"You need to use the `quarkus.infinispan-client.devservices.tracing.enabled` property and provide a JSON, XML or YAML file as follows. Check xref:infinispan-dev-services.adoc[Infinispan Dev Services guide]");
"You need to use the `quarkus.infinispan-client.devservices.tracing.enabled` property and provide a JSON, XML or YAML file as follows. Check https://quarkus.io/guides/infinispan-dev-services for more information");
log.warn("infinispan:\n" +
" cacheContainer:\n" +
" tracing:\n" +
Expand Down

0 comments on commit 2686009

Please sign in to comment.