Apache Karaf Decanter 2.3.0, new Prometheus appender

As said in my previous post, Apache Karaf Decanter 2.3.0 is a major new release bringing fixes, improvements and new features.

We saw the new alerting service. In this blog post, we see another new feature: the Prometheus Appender.

Prometheus ?

Prometheus (https://prometheus.io/) is a popular metrics toolkit, especially for cloud ecosystem. It’s open-source and it’s part of the Cloud Native Computing Foundation.

If Karaf Decanter provides similar collecting and alerting features, it makes sense to use Decanter as collector that Prometheus can request. Then, the visualization and search can be performed on Prometheus.

Decanter Prometheus Appender

The preferred approach with Prometheus is to “expose” a HTTP endpoint providing metrics that the Prometheus platform can retrieve.

It’s what the Decanter Prometheus Appender is doing:

  • bind a Prometheus servlet that Prometheus can “poll”
  • get the incoming data from the Decanter Collectors
  • detects the numbers in the event data
  • creates Prometheus metrics and expose in the servlet

You just have to install the decanter-appender-prometheus feature:

karaf@root()> feature:install decanter-appender-prometheus

And that’s it ! By default, Decanter Prometheus appender is expose on /decanter/prometheus:

karaf@root()> http:listID │ Servlet        │ Servlet-Name   │ State       │ Alias                │ Url───┼────────────────┼────────────────┼─────────────┼──────────────────────┼─────────────────────────51 │ MetricsServlet │ ServletModel-2 │ Deployed    │ /decanter/prometheus │ [/decanter/prometheus/*]

Now, you can add collectors (like the JMX one) and you will have the metrics on /decanter/prometheus, ready to be polled by Prometheus. Here’s what we can see in a browser accessing http://localhost:8181/decanter/prometheus:

Adding metrics in your bundles

Another interesting feature provided by the Decanter Prometheus appender is easy way to add and expose your own metrics from your bundles.

Actually, the Decanter Prometheus appender exports the io.prometheus* packages. So, in your bundles, you just have to import the prometheus packages and your metrics will be automatically exposes in the Decanter Prometheus servlet.

For instance, your bundle MANIFEST.MF just has to contain:

...Import-Package: io.prometheus.client;version="[0.8,1)"...

Then in your bundle code, you can directly use the Prometheus client like this:

...private static final Gauge gauge = Gauge.build().name("mygauge").help("mygauge").register();...gauge.set(200);...

Then, when your bundle is running, you can see the metric exposed in the Decanter Prometheus HTTP servlet (on http://localhost:8181/decanter/prometheus):

Summary

We can see here why Apache Karaf is the perfect runtime for the cloud: it can integrate smoothly with cloud ecosystem.
Thanks to Apache Karaf, you have a flexible runtime for on prem and cloud without effort.

Comments

Post a Comment

Popular posts from this blog

Quarkus and "meta" extension

Quarkus is a great Java framework with a large ecosystem thanks to the extensions . Basically, if using Maven, your pom.xml contains the list of the extensions you want to use, meaning something like this: ... <dependency> <groupId>io.quarkus</groupId> <artifactId>quarkus-grpc</artifactId> </dependency> <dependency> <groupId>io.quarkus</groupId> <artifactId>quarkus-opentelemetry</artifactId> </dependency> ... It can quickly become large, and sometime you can have "conflict" between extensions (for example if you mix in the same dependencies set reactive and non reactive extensions). Quarkus "meta" extension To simplify the dependencies for the extensions you want to use (especially if it's basically the same extensions in all your services), you can create your own "meta" extension. This extension doesn't contain actual code, it "wraps" other exten
Read more

Getting started with Apache Karaf Minho

Image
Apache Karaf Minho Apache Karaf Minho is a new runtime, completely created from scratch. The objectives are: super easy to use and run ligtning fast, including GraalVM support Kubernetes compliant to be easily used on the cloud helping to optimize cloud costs by supporting applications colocation providing turnkey services allowing you to create Minho applications in a minute Minho is composed by: minho-boot is the core of Minho. It contains the runtime launcher and the core services (service registry, lifecycle service, configuration service, ...). minho-* services provided additional functionnalities in the runtime. You can use these services to create your own services, it's also where you will find the services managing sepcific kind of applications, allowing colocation. minho-tooling optionally provide convenient tools to create your own runtime. It includes minho-maven-plugin for instance. In this blog post, we will take a quick tour on A
Read more

Apache Karaf Minho and OpenTelemetry

Image
Telemetry is an important part of a software stack, especially on distributed system (where services call each others). OpenTelemetry is a CNCF project coming from OpenTracing and OpenCensus. It provides API to easily instrument your code and tools to collect and export telemetry data (metrics, logs and traces). Before going into how to use OpenTelemetry with Minho, we have to understand some key concepts: Span is a single building block representing an operation or some unit of work that you want to capture. They are capable of standing on their own, referencing (or following) from other spans, storing metadata, tags, etc. Trace is a visualisation of the life of a request (or series of other operations) that is made up of one or more spans. This collection of spans work together to paint a picture of the overall request, allowing you to easily reconstruct what happened within each span, etc. SpanContext is a wrapper of key values pairs that associates a trace to one or mor
Read more