External-Mirrors/keycloak
2
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-01-09 23:12:06 -03:30
Code Issues Packages Projects Releases Wiki Activity

Enable opentelemetry feature by default (#35756)

Browse Source 
Closes #35753

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
This commit is contained in:
Martin Bartoš 2024-12-11 17:53:14 +01:00 committed by GitHub
parent 9993e17346
commit 8f2c825835
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
17 changed files with 170 additions and 134 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
common/src/main/java/org/keycloak/common/Profile.java
View File

@ -116,7 +116,7 @@ public class Profile {
OID4VC_VCI("Support for the OID4VCI protocol as part of OID4VC.", Type.EXPERIMENTAL),
OPENTELEMETRY("OpenTelemetry Tracing", Type.PREVIEW),
OPENTELEMETRY("OpenTelemetry Tracing", Type.DEFAULT),
DECLARATIVE_UI("declarative ui spi", Type.EXPERIMENTAL),

15
docs/documentation/release_notes/topics/26_1_0.adoc
View File

@ -114,6 +114,21 @@ The key providers that allow to import externally generated keys (`rsa` and `jav
The default `generated` key providers generate a certificate valid for 10 years (the types that have or can have an associated certificate). Because of the long validity and the recommendation to rotate keys frequently, the generated providers do not perform this check.
= OpenTelemetry Tracing supported
In the previous release, the OpenTelemetry Tracing feature was preview and is *fully supported* now.
It means the `opentelemetry` feature is enabled by default.
There were made multiple improvements to the tracing capabilities in {project_name} such as:
* *Custom spans* for:
** Incoming/outgoing HTTP requests including Identity Providers brokerage
** Database operations and connections
** LDAP requests
** Time-consuming operations (passwords hashing, persistent sessions operations, ...)
For more information, see the link:{tracingguide_link}[{tracingguide_name}] guide.
= Sign out all active sessions in admin console now effectively removes all sessions
In previous versions, clicking on *Sign out all active sessions* in the admin console resulted in the removal of regular sessions only. Offline sessions would still be displayed despite being effectively invalidated.

9
docs/guides/observability/tracing.adoc
View File

@ -5,7 +5,6 @@
<#import "/templates/profile.adoc" as profile>
<@tmpl.guide title="Enabling Tracing"
preview="true"
summary="Learn how to enable distributed tracing in {project_name}"
includedOptions="tracing-* log-*-include-trace">
@ -17,9 +16,9 @@ It also provides valuable insights into performance bottlenecks and can help opt
== Enable tracing
It is possible to enable exposing traces using the build time option `tracing-enabled`, and enabling `opentelemetry` feature as follows:
It is possible to enable exposing traces using the build time option `tracing-enabled` as follows:
<@kc.start parameters="--tracing-enabled=true --features=opentelemetry"/>
<@kc.start parameters="--tracing-enabled=true"/>
By default, the trace exporters send out data in batches, using the `gRPC` protocol and endpoint `+http://localhost:4317+`.
@ -27,6 +26,8 @@ The default service name is `keycloak`, specified via the `tracing-service-name`
For more information about resource attributes that can be provided via the `tracing-resource-attributes` property, see the https://quarkus.io/guides/opentelemetry#resource[Quarkus OpenTelemetry Resource] guide.
NOTE: Tracing can be enabled only when the `opentelemetry` feature is *enabled* (by default).
For more tracing settings, see all possible configurations below.
== Development setup
@ -117,7 +118,7 @@ The format of the log records may start as follows:
You can hide trace IDs in specific log handlers by specifying their associated {project_name} option `log-<handler-name>-include-trace`, where `<handler-name>` is the name of the log handler.
For instance, to disable trace info in the `console` log, you can turn it off as follows:
<@kc.start parameters="--tracing-enabled=true --features=opentelemetry --log=console --log-console-include-trace=false"/>
<@kc.start parameters="--tracing-enabled=true --log=console --log-console-include-trace=false"/>
NOTE: When you explicitly override the log format for the particular log handlers, the `*-include-trace` options do not have any effect, and no tracing is included.

2
quarkus/config-api/src/main/java/org/keycloak/config/OptionCategory.java
View File

@ -15,7 +15,7 @@ public enum OptionCategory {
PROXY("Proxy", 90, ConfigSupportLevel.SUPPORTED),
VAULT("Vault", 100, ConfigSupportLevel.SUPPORTED),
LOGGING("Logging", 110, ConfigSupportLevel.SUPPORTED),
TRACING("Tracing", 111, ConfigSupportLevel.PREVIEW),
TRACING("Tracing", 111, ConfigSupportLevel.SUPPORTED),
EVENTS("Events", 112, ConfigSupportLevel.PREVIEW),
TRUSTSTORE("Truststore", 115, ConfigSupportLevel.SUPPORTED),
SECURITY("Security", 120, ConfigSupportLevel.SUPPORTED),

2
quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/TracingPropertyMappers.java
View File

@ -40,7 +40,7 @@ import static org.keycloak.quarkus.runtime.configuration.mappers.PropertyMapper.
public class TracingPropertyMappers {
private static final String OTEL_FEATURE_ENABLED_MSG = "'opentelemetry' feature is enabled";
private static final String TRACING_ENABLED_MSG = "'opentelemetry' feature and Tracing is enabled";
private static final String TRACING_ENABLED_MSG = "Tracing is enabled";
private TracingPropertyMappers() {
}

12
quarkus/tests/integration/src/test/java/org/keycloak/it/cli/dist/TracingDistTest.java vendored
View File

@ -35,7 +35,6 @@ public class TracingDistTest {
private void assertTracingEnabled(CLIResult result) {
result.assertMessage("opentelemetry");
result.assertMessage("service.name=\"keycloak\"");
result.assertMessage("Preview features enabled: opentelemetry");
}
private void assertTracingDisabled(CLIResult result) {
@ -43,7 +42,6 @@ public class TracingDistTest {
result.assertNoMessage("service.name=\"keycloak\"");
result.assertNoMessage("Failed to export spans.");
result.assertNoMessage("Connection refused: localhost/127.0.0.1:4317");
result.assertNoMessage("Preview features enabled: opentelemetry");
}
@Test
@ -62,12 +60,12 @@ public class TracingDistTest {
void disabledOption(LaunchResult result) {
CLIResult cliResult = (CLIResult) result;
cliResult.assertError("Disabled option: '--tracing-service-name'. Available only when 'opentelemetry' feature and Tracing is enabled");
cliResult.assertError("Disabled option: '--tracing-service-name'. Available only when Tracing is enabled");
}
@Test
@Order(3)
@Launch({"start-dev", "--tracing-enabled=true"})
@Launch({"start-dev", "--features-disabled=opentelemetry", "--tracing-enabled=true"})
void disabledFeature(LaunchResult result) {
CLIResult cliResult = (CLIResult) result;
@ -76,16 +74,16 @@ public class TracingDistTest {
@Test
@Order(4)
@Launch({"start-dev", "--features=opentelemetry", "--tracing-enabled=false", "--tracing-endpoint=something"})
@Launch({"start-dev", "--tracing-enabled=false", "--tracing-endpoint=something"})
void disabledTracing(LaunchResult result) {
CLIResult cliResult = (CLIResult) result;
cliResult.assertError("Disabled option: '--tracing-endpoint'. Available only when 'opentelemetry' feature and Tracing is enabled");
cliResult.assertError("Disabled option: '--tracing-endpoint'. Available only when Tracing is enabled");
}
@Test
@Order(5)
@Launch({"build", "--tracing-enabled=true", "--features=opentelemetry"})
@Launch({"build", "--tracing-enabled=true"})
void buildTracingEnabled(LaunchResult result) {
CLIResult cliResult = (CLIResult) result;

6
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testBuildHelp.approved.txt vendored
View File

@ -78,6 +78,12 @@ Vault:
--vault <provider> Enables a vault provider. Possible values are: file, keystore.
Tracing:
--tracing-enabled <true|false>
Enables the OpenTelemetry tracing. Default: false. Available only when
'opentelemetry' feature is enabled.
Security:
--fips-mode <mode> Sets the FIPS mode. If 'non-strict' is set, FIPS is enabled but on

6
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testExportHelp.approved.txt vendored
View File

@ -147,6 +147,12 @@ Logging:
Possible values are (case insensitive): off, fatal, error, warn, info,
debug, trace, all.
Tracing:
--tracing-enabled <true|false>
Enables the OpenTelemetry tracing. Default: false. Available only when
'opentelemetry' feature is enabled.
Truststore:
--tls-hostname-verifier <tls-hostname-verifier>

49
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testExportHelpAll.approved.txt vendored
View File

@ -207,43 +207,42 @@ Logging:
Set the Syslog type used to format the sent message. Possible values are:
rfc5424, rfc3164. Default: rfc5424. Available only when Syslog is activated.
Tracing (Preview):
Tracing:
--tracing-compression <method>
Preview: OpenTelemetry compression method used to compress payloads. If unset,
OpenTelemetry compression method used to compress payloads. If unset,
compression is disabled. Possible values are: gzip, none. Default: none.
Available only when 'opentelemetry' feature and Tracing is enabled.
Available only when Tracing is enabled.
--tracing-enabled <true|false>
Preview: Enables the OpenTelemetry tracing. Default: false. Available only
when 'opentelemetry' feature is enabled.
Enables the OpenTelemetry tracing. Default: false. Available only when
'opentelemetry' feature is enabled.
--tracing-endpoint <url>
Preview: OpenTelemetry endpoint to connect to. Default: http://localhost:4317.
Available only when 'opentelemetry' feature and Tracing is enabled.
OpenTelemetry endpoint to connect to. Default: http://localhost:4317.
Available only when Tracing is enabled.
--tracing-jdbc-enabled <true|false>
Preview: Enables the OpenTelemetry JDBC tracing. Default: true. Available only
when 'opentelemetry' feature and Tracing is enabled.
Enables the OpenTelemetry JDBC tracing. Default: true. Available only when
Tracing is enabled.
--tracing-protocol <protocol>
Preview: OpenTelemetry protocol used for the telemetry data. Possible values
are: grpc, http/protobuf. Default: grpc. Available only when 'opentelemetry'
feature and Tracing is enabled.
OpenTelemetry protocol used for the telemetry data. Possible values are: grpc,
http/protobuf. Default: grpc. Available only when Tracing is enabled.
--tracing-resource-attributes <attributes>
Preview: OpenTelemetry resource attributes present in the exported trace to
OpenTelemetry resource attributes present in the exported trace to
characterize the telemetry producer. Values in format 'key1=val1,key2=val2'.
For more information, check the Tracing guide. Available only when
'opentelemetry' feature and Tracing is enabled.
For more information, check the Tracing guide. Available only when Tracing
is enabled.
--tracing-sampler-ratio <ratio>
Preview: OpenTelemetry sampler ratio. Probability that a span will be sampled.
Expected double value in interval <0,1). Default: 1.0. Available only when
'opentelemetry' feature and Tracing is enabled.
OpenTelemetry sampler ratio. Probability that a span will be sampled. Expected
double value in interval <0,1). Default: 1.0. Available only when Tracing is
enabled.
--tracing-sampler-type <type>
Preview: OpenTelemetry sampler to use for tracing. Possible values are:
always_on, always_off, traceidratio, parentbased_always_on,
parentbased_always_off, parentbased_traceidratio. Default: traceidratio.
Available only when 'opentelemetry' feature and Tracing is enabled.
OpenTelemetry sampler to use for tracing. Possible values are: always_on,
always_off, traceidratio, parentbased_always_on, parentbased_always_off,
parentbased_traceidratio. Default: traceidratio. Available only when Tracing
is enabled.
--tracing-service-name <name>
Preview: OpenTelemetry service name. Takes precedence over 'service.name'
defined in the 'tracing-resource-attributes' property. Default: keycloak.
Available only when 'opentelemetry' feature and Tracing is enabled.
OpenTelemetry service name. Takes precedence over 'service.name' defined in
the 'tracing-resource-attributes' property. Default: keycloak. Available
only when Tracing is enabled.
Events (Preview):

6
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testImportHelp.approved.txt vendored
View File

@ -147,6 +147,12 @@ Logging:
Possible values are (case insensitive): off, fatal, error, warn, info,
debug, trace, all.
Tracing:
--tracing-enabled <true|false>
Enables the OpenTelemetry tracing. Default: false. Available only when
'opentelemetry' feature is enabled.
Truststore:
--tls-hostname-verifier <tls-hostname-verifier>

49
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testImportHelpAll.approved.txt vendored
View File

@ -207,43 +207,42 @@ Logging:
Set the Syslog type used to format the sent message. Possible values are:
rfc5424, rfc3164. Default: rfc5424. Available only when Syslog is activated.
Tracing (Preview):
Tracing:
--tracing-compression <method>
Preview: OpenTelemetry compression method used to compress payloads. If unset,
OpenTelemetry compression method used to compress payloads. If unset,
compression is disabled. Possible values are: gzip, none. Default: none.
Available only when 'opentelemetry' feature and Tracing is enabled.
Available only when Tracing is enabled.
--tracing-enabled <true|false>
Preview: Enables the OpenTelemetry tracing. Default: false. Available only
when 'opentelemetry' feature is enabled.
Enables the OpenTelemetry tracing. Default: false. Available only when
'opentelemetry' feature is enabled.
--tracing-endpoint <url>
Preview: OpenTelemetry endpoint to connect to. Default: http://localhost:4317.
Available only when 'opentelemetry' feature and Tracing is enabled.
OpenTelemetry endpoint to connect to. Default: http://localhost:4317.
Available only when Tracing is enabled.
--tracing-jdbc-enabled <true|false>
Preview: Enables the OpenTelemetry JDBC tracing. Default: true. Available only
when 'opentelemetry' feature and Tracing is enabled.
Enables the OpenTelemetry JDBC tracing. Default: true. Available only when
Tracing is enabled.
--tracing-protocol <protocol>
Preview: OpenTelemetry protocol used for the telemetry data. Possible values
are: grpc, http/protobuf. Default: grpc. Available only when 'opentelemetry'
feature and Tracing is enabled.
OpenTelemetry protocol used for the telemetry data. Possible values are: grpc,
http/protobuf. Default: grpc. Available only when Tracing is enabled.
--tracing-resource-attributes <attributes>
Preview: OpenTelemetry resource attributes present in the exported trace to
OpenTelemetry resource attributes present in the exported trace to
characterize the telemetry producer. Values in format 'key1=val1,key2=val2'.
For more information, check the Tracing guide. Available only when
'opentelemetry' feature and Tracing is enabled.
For more information, check the Tracing guide. Available only when Tracing
is enabled.
--tracing-sampler-ratio <ratio>
Preview: OpenTelemetry sampler ratio. Probability that a span will be sampled.
Expected double value in interval <0,1). Default: 1.0. Available only when
'opentelemetry' feature and Tracing is enabled.
OpenTelemetry sampler ratio. Probability that a span will be sampled. Expected
double value in interval <0,1). Default: 1.0. Available only when Tracing is
enabled.
--tracing-sampler-type <type>
Preview: OpenTelemetry sampler to use for tracing. Possible values are:
always_on, always_off, traceidratio, parentbased_always_on,
parentbased_always_off, parentbased_traceidratio. Default: traceidratio.
Available only when 'opentelemetry' feature and Tracing is enabled.
OpenTelemetry sampler to use for tracing. Possible values are: always_on,
always_off, traceidratio, parentbased_always_on, parentbased_always_off,
parentbased_traceidratio. Default: traceidratio. Available only when Tracing
is enabled.
--tracing-service-name <name>
Preview: OpenTelemetry service name. Takes precedence over 'service.name'
defined in the 'tracing-resource-attributes' property. Default: keycloak.
Available only when 'opentelemetry' feature and Tracing is enabled.
OpenTelemetry service name. Takes precedence over 'service.name' defined in
the 'tracing-resource-attributes' property. Default: keycloak. Available
only when Tracing is enabled.
Events (Preview):

6
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelp.approved.txt vendored
View File

@ -313,6 +313,12 @@ Logging:
Possible values are (case insensitive): off, fatal, error, warn, info,
debug, trace, all.
Tracing:
--tracing-enabled <true|false>
Enables the OpenTelemetry tracing. Default: false. Available only when
'opentelemetry' feature is enabled.
Truststore:
--tls-hostname-verifier <tls-hostname-verifier>

49
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.approved.txt vendored
View File

@ -408,43 +408,42 @@ Logging:
Set the Syslog type used to format the sent message. Possible values are:
rfc5424, rfc3164. Default: rfc5424. Available only when Syslog is activated.
Tracing (Preview):
Tracing:
--tracing-compression <method>
Preview: OpenTelemetry compression method used to compress payloads. If unset,
OpenTelemetry compression method used to compress payloads. If unset,
compression is disabled. Possible values are: gzip, none. Default: none.
Available only when 'opentelemetry' feature and Tracing is enabled.
Available only when Tracing is enabled.
--tracing-enabled <true|false>
Preview: Enables the OpenTelemetry tracing. Default: false. Available only
when 'opentelemetry' feature is enabled.
Enables the OpenTelemetry tracing. Default: false. Available only when
'opentelemetry' feature is enabled.
--tracing-endpoint <url>
Preview: OpenTelemetry endpoint to connect to. Default: http://localhost:4317.
Available only when 'opentelemetry' feature and Tracing is enabled.
OpenTelemetry endpoint to connect to. Default: http://localhost:4317.
Available only when Tracing is enabled.
--tracing-jdbc-enabled <true|false>
Preview: Enables the OpenTelemetry JDBC tracing. Default: true. Available only
when 'opentelemetry' feature and Tracing is enabled.
Enables the OpenTelemetry JDBC tracing. Default: true. Available only when
Tracing is enabled.
--tracing-protocol <protocol>
Preview: OpenTelemetry protocol used for the telemetry data. Possible values
are: grpc, http/protobuf. Default: grpc. Available only when 'opentelemetry'
feature and Tracing is enabled.
OpenTelemetry protocol used for the telemetry data. Possible values are: grpc,
http/protobuf. Default: grpc. Available only when Tracing is enabled.
--tracing-resource-attributes <attributes>
Preview: OpenTelemetry resource attributes present in the exported trace to
OpenTelemetry resource attributes present in the exported trace to
characterize the telemetry producer. Values in format 'key1=val1,key2=val2'.
For more information, check the Tracing guide. Available only when
'opentelemetry' feature and Tracing is enabled.
For more information, check the Tracing guide. Available only when Tracing
is enabled.
--tracing-sampler-ratio <ratio>
Preview: OpenTelemetry sampler ratio. Probability that a span will be sampled.
Expected double value in interval <0,1). Default: 1.0. Available only when
'opentelemetry' feature and Tracing is enabled.
OpenTelemetry sampler ratio. Probability that a span will be sampled. Expected
double value in interval <0,1). Default: 1.0. Available only when Tracing is
enabled.
--tracing-sampler-type <type>
Preview: OpenTelemetry sampler to use for tracing. Possible values are:
always_on, always_off, traceidratio, parentbased_always_on,
parentbased_always_off, parentbased_traceidratio. Default: traceidratio.
Available only when 'opentelemetry' feature and Tracing is enabled.
OpenTelemetry sampler to use for tracing. Possible values are: always_on,
always_off, traceidratio, parentbased_always_on, parentbased_always_off,
parentbased_traceidratio. Default: traceidratio. Available only when Tracing
is enabled.
--tracing-service-name <name>
Preview: OpenTelemetry service name. Takes precedence over 'service.name'
defined in the 'tracing-resource-attributes' property. Default: keycloak.
Available only when 'opentelemetry' feature and Tracing is enabled.
OpenTelemetry service name. Takes precedence over 'service.name' defined in
the 'tracing-resource-attributes' property. Default: keycloak. Available
only when Tracing is enabled.
Events (Preview):

6
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelp.approved.txt vendored
View File

@ -320,6 +320,12 @@ Logging:
Possible values are (case insensitive): off, fatal, error, warn, info,
debug, trace, all.
Tracing:
--tracing-enabled <true|false>
Enables the OpenTelemetry tracing. Default: false. Available only when
'opentelemetry' feature is enabled.
Truststore:
--tls-hostname-verifier <tls-hostname-verifier>

49
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.approved.txt vendored
View File

@ -409,43 +409,42 @@ Logging:
Set the Syslog type used to format the sent message. Possible values are:
rfc5424, rfc3164. Default: rfc5424. Available only when Syslog is activated.
Tracing (Preview):
Tracing:
--tracing-compression <method>
Preview: OpenTelemetry compression method used to compress payloads. If unset,
OpenTelemetry compression method used to compress payloads. If unset,
compression is disabled. Possible values are: gzip, none. Default: none.
Available only when 'opentelemetry' feature and Tracing is enabled.
Available only when Tracing is enabled.
--tracing-enabled <true|false>
Preview: Enables the OpenTelemetry tracing. Default: false. Available only
when 'opentelemetry' feature is enabled.
Enables the OpenTelemetry tracing. Default: false. Available only when
'opentelemetry' feature is enabled.
--tracing-endpoint <url>
Preview: OpenTelemetry endpoint to connect to. Default: http://localhost:4317.
Available only when 'opentelemetry' feature and Tracing is enabled.
OpenTelemetry endpoint to connect to. Default: http://localhost:4317.
Available only when Tracing is enabled.
--tracing-jdbc-enabled <true|false>
Preview: Enables the OpenTelemetry JDBC tracing. Default: true. Available only
when 'opentelemetry' feature and Tracing is enabled.
Enables the OpenTelemetry JDBC tracing. Default: true. Available only when
Tracing is enabled.
--tracing-protocol <protocol>
Preview: OpenTelemetry protocol used for the telemetry data. Possible values
are: grpc, http/protobuf. Default: grpc. Available only when 'opentelemetry'
feature and Tracing is enabled.
OpenTelemetry protocol used for the telemetry data. Possible values are: grpc,
http/protobuf. Default: grpc. Available only when Tracing is enabled.
--tracing-resource-attributes <attributes>
Preview: OpenTelemetry resource attributes present in the exported trace to
OpenTelemetry resource attributes present in the exported trace to
characterize the telemetry producer. Values in format 'key1=val1,key2=val2'.
For more information, check the Tracing guide. Available only when
'opentelemetry' feature and Tracing is enabled.
For more information, check the Tracing guide. Available only when Tracing
is enabled.
--tracing-sampler-ratio <ratio>
Preview: OpenTelemetry sampler ratio. Probability that a span will be sampled.
Expected double value in interval <0,1). Default: 1.0. Available only when
'opentelemetry' feature and Tracing is enabled.
OpenTelemetry sampler ratio. Probability that a span will be sampled. Expected
double value in interval <0,1). Default: 1.0. Available only when Tracing is
enabled.
--tracing-sampler-type <type>
Preview: OpenTelemetry sampler to use for tracing. Possible values are:
always_on, always_off, traceidratio, parentbased_always_on,
parentbased_always_off, parentbased_traceidratio. Default: traceidratio.
Available only when 'opentelemetry' feature and Tracing is enabled.
OpenTelemetry sampler to use for tracing. Possible values are: always_on,
always_off, traceidratio, parentbased_always_on, parentbased_always_off,
parentbased_traceidratio. Default: traceidratio. Available only when Tracing
is enabled.
--tracing-service-name <name>
Preview: OpenTelemetry service name. Takes precedence over 'service.name'
defined in the 'tracing-resource-attributes' property. Default: keycloak.
Available only when 'opentelemetry' feature and Tracing is enabled.
OpenTelemetry service name. Takes precedence over 'service.name' defined in
the 'tracing-resource-attributes' property. Default: keycloak. Available
only when Tracing is enabled.
Events (Preview):

33
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelpAll.approved.txt vendored
View File

@ -360,32 +360,31 @@ Logging:
Set the Syslog type used to format the sent message. Possible values are:
rfc5424, rfc3164. Default: rfc5424. Available only when Syslog is activated.
Tracing (Preview):
Tracing:
--tracing-compression <method>
Preview: OpenTelemetry compression method used to compress payloads. If unset,
OpenTelemetry compression method used to compress payloads. If unset,
compression is disabled. Possible values are: gzip, none. Default: none.
Available only when 'opentelemetry' feature and Tracing is enabled.
Available only when Tracing is enabled.
--tracing-endpoint <url>
Preview: OpenTelemetry endpoint to connect to. Default: http://localhost:4317.
Available only when 'opentelemetry' feature and Tracing is enabled.
OpenTelemetry endpoint to connect to. Default: http://localhost:4317.
Available only when Tracing is enabled.
--tracing-protocol <protocol>
Preview: OpenTelemetry protocol used for the telemetry data. Possible values
are: grpc, http/protobuf. Default: grpc. Available only when 'opentelemetry'
feature and Tracing is enabled.
OpenTelemetry protocol used for the telemetry data. Possible values are: grpc,
http/protobuf. Default: grpc. Available only when Tracing is enabled.
--tracing-resource-attributes <attributes>
Preview: OpenTelemetry resource attributes present in the exported trace to
OpenTelemetry resource attributes present in the exported trace to
characterize the telemetry producer. Values in format 'key1=val1,key2=val2'.
For more information, check the Tracing guide. Available only when
'opentelemetry' feature and Tracing is enabled.
For more information, check the Tracing guide. Available only when Tracing
is enabled.
--tracing-sampler-ratio <ratio>
Preview: OpenTelemetry sampler ratio. Probability that a span will be sampled.
Expected double value in interval <0,1). Default: 1.0. Available only when
'opentelemetry' feature and Tracing is enabled.
OpenTelemetry sampler ratio. Probability that a span will be sampled. Expected
double value in interval <0,1). Default: 1.0. Available only when Tracing is
enabled.
--tracing-service-name <name>
Preview: OpenTelemetry service name. Takes precedence over 'service.name'
defined in the 'tracing-resource-attributes' property. Default: keycloak.
Available only when 'opentelemetry' feature and Tracing is enabled.
OpenTelemetry service name. Takes precedence over 'service.name' defined in
the 'tracing-resource-attributes' property. Default: keycloak. Available
only when Tracing is enabled.
Events (Preview):

3
testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/tracing/OTelTracingProviderTest.java
View File

@ -32,11 +32,9 @@ import org.junit.Before;
import org.junit.FixMethodOrder;
import org.junit.Test;
import org.junit.runners.MethodSorters;
import org.keycloak.common.Profile;
import org.keycloak.representations.idm.RealmRepresentation;
import org.keycloak.testsuite.AbstractTestRealmKeycloakTest;
import org.keycloak.testsuite.arquillian.annotation.AuthServerContainerExclude;
import org.keycloak.testsuite.arquillian.annotation.EnableFeature;
import org.keycloak.testsuite.arquillian.containers.AbstractQuarkusDeployableContainer;
import org.keycloak.tracing.NoopTracingProvider;
import org.keycloak.tracing.TracingProvider;
@ -52,7 +50,6 @@ import static org.hamcrest.Matchers.not;
import static org.hamcrest.Matchers.notNullValue;
@AuthServerContainerExclude(value = AuthServerContainerExclude.AuthServer.UNDERTOW)
@EnableFeature(value = Profile.Feature.OPENTELEMETRY, skipRestart = true)
@FixMethodOrder(MethodSorters.NAME_ASCENDING)
public class OTelTracingProviderTest extends AbstractTestRealmKeycloakTest {