// Do not edit directly!
// This file was generated by camel-quarkus-maven-plugin:update-extension-doc-page
[id="extensions-observability-services"]
= Observability Services
:linkattrs:
:cq-artifact-id: camel-quarkus-observability-services
:cq-native-supported: true
:cq-status: Stable
:cq-status-deprecation: Stable
:cq-description: Camel Observability Services
:cq-deprecated: false
:cq-jvm-since: 3.19.0
:cq-native-since: 3.19.0

ifeval::[{doc-show-badges} == true]
[.badges]
[.badge-key]##JVM since##[.badge-supported]##3.19.0## [.badge-key]##Native since##[.badge-supported]##3.19.0##
endif::[]

Camel Observability Services

[id="extensions-observability-services-whats-inside"]
== What's inside

* xref:{cq-camel-components}:others:observability-services.adoc[Observability Services]

Please refer to the above link for usage and configuration details.

[id="extensions-observability-services-maven-coordinates"]
== Maven coordinates

https://{link-quarkus-code-generator}/?extension-search=camel-quarkus-observability-services[Create a new project with this extension on {link-quarkus-code-generator}, window="_blank"]

Or add the coordinates to your existing project:

[source,xml]
----
<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-observability-services</artifactId>
</dependency>
----
ifeval::[{doc-show-user-guide-link} == true]
Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications.
endif::[]

[id="extensions-observability-services-usage"]
== Usage
This extension provides a set of opinionated components and configuration to simplify operations such as observability on cloud environments.
Although the extension is mainly targeted for cloud, it can be used in any other environment.

By adding the `camel-quarkus-observability-services` extension to your application, each observability component (described below) will be configured with their individual default settings.
No additional configuration is required.

HTTP endpoints will be exposed under the context path `/observe/<service>` by default. Further details about this are described below.

If you need to customize any component provided by this extension, then you can specify any of their related configuration options in `application.properties`, as it would be done normally when you work with the individual component extension(s).

[id="extensions-observability-services-usage-components"]
== Components

This extension automatically provides the following Camel Quarkus component extensions:

* xref:reference/extensions/microprofile-health.adoc[Camel Quarkus MicroProfile Health] - for health checks
* xref:reference/extensions/management.adoc[Camel Quarkus Management] - for JMX
* xref:reference/extensions/micrometer.adoc[Camel Quarkus Micrometer] - for Camel Micrometer metrics
* xref:reference/extensions/opentelemetry2.adoc[Camel Quarkus OpenTelemetry2] - for tracing Camel messages (events/spans)
* https://quarkus.io/guides/telemetry-micrometer#micrometer-and-monitoring-system-extensions[Quarkus Micrometer Registry Prometheus] - for exporting metrics in Prometheus format

[id="extensions-observability-services-usage-list-of-known-endpoints"]
=== List of known endpoints

The presence of this extension will expose the following endpoints:

|====
|Endpoint | Description

| `/observe/health` | Accumulation of all health check procedures in the application
| `/observe/health/live` | Liveness probe endpoint
| `/observe/health/ready` | Readiness probe endpoint
| `/observe/health/started` | Application started probe endpoint
| `/observe/metrics` | Metrics exposed from the Micrometer Prometheus registry

|====

By default, these endpoints are exposed on the management port (`9876`). This value can be changed as any other configuration (in this case, via `quarkus.management.port` application property). You can also disable it (`quarkus.management.enabled=false`) if you want to expose those endpoints in the regular service port (default, `8080`).

NOTE: You can configure the endpoints as you'd do normally within each extension configuration.

[id="extensions-observability-services-usage-opentelemetry-configuration"]
== OpenTelemetry configuration

The presence of this extension will provide the required instrumentation to enable the collection of OpenTelemetry metrics.
The Camel Quarkus OpenTelemetry extension instruments your application and periodically attempts to export traces to the configured collector.
This is disabled by default in order to prevent the application exporting traces when no telemetry server is available.

In order to enable instrumentation, you need to add the following configuration to `application.properties`.

[source,properties]
----
quarkus.otel.sdk.disabled=false
----

To configure any aspect of OpenTelemetry, you can add the following configuration to `application.properties`. For example to customize the server endpoint where traces should be exported (default, `http://localhost:4317`).

[source,properties]
----
quarkus.otel.exporter.otlp.traces.endpoint=http://my-otel-collector.svc:4317
----

The full set of configuration options are documented in the xref:reference/extensions/opentelemetry.adoc[Camel Quarkus OpenTelemetry] and https://quarkus.io/guides/opentelemetry[Quarkus OpenTelemetry] documentation.

NOTE: Quarkus trace exporting defaults to the gRPC protocol on port 4317.

[id="extensions-observability-services-usage-jmx-configuration"]
== JMX configuration

The presence of this extension implies the presence of the `camel-quarkus-management` extension.
This exposes Camel JMX MBeans to provide insights and management of the running application.

If you prefer to disable Camel JMX instrumentation, you can add the following configuration to `application.properties`.

[source,properties]
----
camel.main.jmxEnabled=false
----

The full set of configuration options are documented in the xref:reference/extensions/management.adoc[Camel Quarkus Management] documentation.

