Skip to content

Commit 52d9bfe

Browse files
committed
Sync documentation of main branch
1 parent 5dbe914 commit 52d9bfe

File tree

26 files changed

+2138
-182
lines changed

26 files changed

+2138
-182
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[{"configDocKey":{"type":"java.lang.Boolean","key":".enabled","additionalKeys":[],"configDoc":"Enable metrics with OpenTelemetry.\n\nThis property is not available in the Open Telemetry SDK. It's Quarkus specific.\n\nSupport for metrics will be enabled if OpenTelemetry support is enabled and either this value is true, or this value is unset.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".exporter","additionalKeys":[],"configDoc":"The Metrics exporter to use.","withinAMap":false,"defaultValue":"cdi","javaDocSiteLink":"","docMapKey":"exporter","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_EXPORTER","enum":false}}]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[{"configDocKey":{"type":"java.time.Duration","key":".export.interval","additionalKeys":[],"configDoc":"The interval, between the start of two metric export attempts.\n\nDefault is 1min.","withinAMap":false,"defaultValue":"60S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"export-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_EXPORT_INTERVAL","enum":false}}]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[{"configDocKey":{"type":"string","key":".endpoint","additionalKeys":[],"configDoc":"OTLP Exporter specific. Will override `otel.exporter.otlp.endpoint`, if set.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.exporter.otlp.endpoint<` or defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`.","withinAMap":false,"defaultValue":"http://localhost:4317/","javaDocSiteLink":"","docMapKey":"endpoint","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENDPOINT","enum":false}},{"configDocKey":{"type":"string","key":".headers","additionalKeys":[],"configDoc":"Key-value pairs to be used as headers associated with gRPC requests. The format is similar to the `OTEL_EXPORTER_OTLP_HEADERS` environment variable, a list of key-value pairs separated by the \"=\" character. i.e.: key1=value1,key2=value2","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"headers","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HEADERS","enum":false}},{"configDocKey":{"type":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.CompressionType","key":".compression","additionalKeys":[],"configDoc":"Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression","configPhase":"BUILD_TIME","acceptedValues":["`gzip`","`none`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_COMPRESSION","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".timeout","additionalKeys":[],"configDoc":"Sets the maximum time to wait for the collector to process an exported batch of spans. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_TIMEOUT_SECS`s.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":".protocol","additionalKeys":[],"configDoc":"OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different.\n\nCurrently, only `grpc` and `http/protobuf` are allowed.","withinAMap":false,"defaultValue":"grpc","javaDocSiteLink":"","docMapKey":"protocol","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROTOCOL","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".key-cert","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterConfig.KeyCert","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".key-cert.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_CERT_KEYS","enum":false}},{"configDocKey":{"type":"string","key":".key-cert.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_CERT_CERTS","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".trust-cert","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterConfig.TrustCert","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".trust-cert.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_CERT_CERTS","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls.<name>.++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_CONFIGURATION_NAME","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".proxy-options","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterConfig.ProxyConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".proxy-options.enabled","additionalKeys":[],"configDoc":"If proxy connection must be used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".proxy-options.username","additionalKeys":[],"configDoc":"Set proxy username.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":".proxy-options.password","additionalKeys":[],"configDoc":"Set proxy password.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_PASSWORD","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".proxy-options.port","additionalKeys":[],"configDoc":"Set proxy port.","withinAMap":false,"defaultValue":"3128","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_PORT","enum":false}},{"configDocKey":{"type":"string","key":".proxy-options.host","additionalKeys":[],"configDoc":"Set proxy host.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_HOST","enum":false}}],"anchorPrefix":null}}]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[{"configDocKey":{"type":"string","key":".endpoint","additionalKeys":[],"configDoc":"OTLP Exporter specific. Will override `otel.exporter.otlp.endpoint`, if set.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.exporter.otlp.endpoint<` or defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`.","withinAMap":false,"defaultValue":"http://localhost:4317/","javaDocSiteLink":"","docMapKey":"endpoint","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENDPOINT","enum":false}},{"configDocKey":{"type":"string","key":".headers","additionalKeys":[],"configDoc":"Key-value pairs to be used as headers associated with gRPC requests. The format is similar to the `OTEL_EXPORTER_OTLP_HEADERS` environment variable, a list of key-value pairs separated by the \"=\" character. i.e.: key1=value1,key2=value2","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"headers","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_HEADERS","enum":false}},{"configDocKey":{"type":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.CompressionType","key":".compression","additionalKeys":[],"configDoc":"Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression","configPhase":"BUILD_TIME","acceptedValues":["`gzip`","`none`"],"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_COMPRESSION","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".timeout","additionalKeys":[],"configDoc":"Sets the maximum time to wait for the collector to process an exported batch of spans. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_TIMEOUT_SECS`s.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TIMEOUT","enum":false}},{"configDocKey":{"type":"string","key":".protocol","additionalKeys":[],"configDoc":"OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different.\n\nCurrently, only `grpc` and `http/protobuf` are allowed.","withinAMap":false,"defaultValue":"grpc","javaDocSiteLink":"","docMapKey":"protocol","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROTOCOL","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".key-cert","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterConfig.KeyCert","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".key-cert.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_CERT_KEYS","enum":false}},{"configDocKey":{"type":"string","key":".key-cert.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_CERT_CERTS","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".trust-cert","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterConfig.TrustCert","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".trust-cert.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_CERT_CERTS","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls.<name>.++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TLS_CONFIGURATION_NAME","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".proxy-options","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterConfig.ProxyConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".proxy-options.enabled","additionalKeys":[],"configDoc":"If proxy connection must be used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_ENABLED","enum":false}},{"configDocKey":{"type":"string","key":".proxy-options.username","additionalKeys":[],"configDoc":"Set proxy username.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_USERNAME","enum":false}},{"configDocKey":{"type":"string","key":".proxy-options.password","additionalKeys":[],"configDoc":"Set proxy password.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_PASSWORD","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".proxy-options.port","additionalKeys":[],"configDoc":"Set proxy port.","withinAMap":false,"defaultValue":"3128","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_PORT","enum":false}},{"configDocKey":{"type":"string","key":".proxy-options.host","additionalKeys":[],"configDoc":"Set proxy host.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PROXY_OPTIONS_HOST","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".temporality-preference","additionalKeys":[],"configDoc":"The preferred output aggregation temporality. Options include DELTA, LOWMEMORY, and CUMULATIVE.\n\nIf CUMULATIVE, all instruments will have cumulative temporality. If DELTA, counter (sync and async) and histograms will be delta, up down counters (sync and async) will be cumulative. If LOWMEMORY, sync counter and histograms will be delta, async counter and up down counters (sync and async) will be cumulative.\n\nDefault is CUMULATIVE.","withinAMap":false,"defaultValue":"cumulative","javaDocSiteLink":"","docMapKey":"temporality-preference","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TEMPORALITY_PREFERENCE","enum":false}},{"configDocKey":{"type":"string","key":".default-histogram-aggregation","additionalKeys":[],"configDoc":"The preferred default histogram aggregation.\n\nOptions include BASE2_EXPONENTIAL_BUCKET_HISTOGRAM and EXPLICIT_BUCKET_HISTOGRAM.\n\nDefault is EXPLICIT_BUCKET_HISTOGRAM.","withinAMap":false,"defaultValue":"explicit_bucket_histogram","javaDocSiteLink":"","docMapKey":"default-histogram-aggregation","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_DEFAULT_HISTOGRAM_AGGREGATION","enum":false}}]

0 commit comments

Comments
 (0)