Reporting Customized Metrics to FSO Platform Utilizing the OpenTelemetry SDK

[ad_1]

With Cisco FSO Platform, metrics might be reported instantly from the code. In contrast to utilizing any sort of auto-instrumentation characteristic, that is helpful when a service proprietor is aware of what must be reported. A typical use case can be enabling reporting of area particular metrics – like variety of objects within the catalogue for e-shops, variety of unfinished orders, SQL queries to particular desk, and so forth. Principally, something which may be fascinating to watch for some time period, or in contrast amongst totally different implementation variations.

Palms-on steerage on find out how to set this up

Open Telemetry has a advisable approach of how the metric reporting must be routed to any software program. The service which will probably be reporting the info goes to ship them to the open telemetry collector, which is a fairly handy common receiver, processor and exported of (not solely) open telemetry formatted knowledge. Open Telemetry collector will then be configured to relay all the info to the FSO Platform tenant.

The very first thing that it’s good to safe is a FSO Platform tenant, to which the info will circulation. I occur to have one prepared, however I must get the principal and clientId and clientSecret used to export knowledge. After logging in, I opened a “Configuration” tab, then chosen “Kubernetes and APM,” named my configuration, and adopted the knowledge offered to me:

FSO Platform - Getting Agent Principal — *FSO Platform – Getting Agent Principal*

That must be all I must configure my Open Telemetry collector.

Open Telemetric Collector configuration

Subsequent, I used Docker picture otel/opentelemetry-collector-contrib:newest, since that’s the best approach for me to run the collector. All I must do is to supply the appropriate configuration, which is completed by supplying –config parameter.

After some quick analysis, I made a decision to make use of the next configuration:

OTEL Collector configuration — *Click on picture to entry the gist in Github*

Then the one factor left to do is to start out the collector:

% docker run --rm -t -v $PWD/otel-config.yaml:/and so forth/otel-collector-config.yaml 

-p 4317:4317 otel/opentelemetry-collector-contrib:newest --config=/and so forth/otel-collector-config.yaml

The collector begins actually shortly, I solely verified that each one the extensions I added are initialised, no errors printed out.

My go-to language is Java, so lets strive that first. Open Telemetry offers a fairly intensive record of SDK libraries for any trendy languages and runtimes. The Java SDK appears to be probably the most mature one on that record. This doesn’t imply that Java is the one selection. Realistically, there may be already help for reporting Open Telemetry knowledge from any actively used language. And if not, there may be at all times an choice to report knowledge utilizing totally different receivers. For instance, you should utilize Prometheus or Zipkin help which your programming or runtime setting already has.

Metric Information Supply

Since I don’t have any software prepared for this experiment, I selected to do the guide instrumentation (it can more than likely be extra enjoyable anyway).

After organising a challenge and a dependency on the newest SDK model out there (1.29.0), I put collectively the next class package deal com.cisco.fso:

Java Class reporting OTEL Metric — *Click on picture to entry the gist in Github*

Let’s undergo some vital components of this code snippet.

First one is the Useful resource declaration. In Open Telemetry, each knowledge level must be reported within the context of a useful resource, together with metrics. Right here I’m declaring my useful resource as one thing with the attributes service.title and service.occasion.id — which is a de-facto customary, described as a part of the Open Telemetry semantic conventions.

Should you discover that house extra, you’ll discover plenty of different conventions, defining which useful resource attributes must be reported for varied elements, like container, pod, service working deployed on some cloud supplier and plenty of extra. Through the use of service.title and service.occasion.id, we’re reporting a service. On FSO Platform that is mapped to the sort apm:service_instance.

One other half price mentioning is the metric initialization. You’ll be able to see that I named my metric “my.first.metric”, set the sort to gauge, declared that it is going to be reporting lengthy values, and registered a callback, which does return random lengthy values. Not very helpful, however must be ok to get some knowledge in.

After executing this system, you will note new logs reported by the Open Telemetry Collector we began earlier than:

OTEL Collector log — *Click on picture to entry the gist in Github*

Exploring ingested metrics utilizing FSO Platform

This can be a good signal that the info arrived from my Java program to the collector. Additionally, the collector incorporates additional logs which counsel that it was capable of report the info to the platform. So, let’s get again to the browser and take a look at whether or not we are able to see reported knowledge.

FSO Platform Entity Centric Service view — *FSO Platform – Cloud Native Utility Observability – Service Entity view*

Apparently my service was registered by the platform, however there usually are not a lot knowledge reported. And, any metrics that are displayed by default, usually are not populated. Why is that taking place?

All of the metrics that are there are derived from spans and traces which might be reported by any customary APM Service and even any framework which you’d be utilizing. The Open Telemetry SDK has good auto-discoverable options for Spring, Micronaut, and different instruments you may be utilizing. After placing some load to your service, you’d see these. However that’s not what we wish to do at this time. We wish to see our essential “my.first.metric” knowledge factors.

For that, we might want to use Question Builder, a System Utility of FSO Platform, which lets you question saved knowledge instantly utilizing Unified Question Language.

FETCH metrics(dynamicmetrics:my.first.metric)
FROM entities(apm:service_instance)[attributes(service.name)='manualService']

This explicit question fetches the reported metric for the apm:service_instance, which was mapped from the useful resource reported utilizing the Java snippet above. It retrieves values of a metric my.first.metric and exhibits them on the output. The dynamicmetrics string represents a particular namespace for metrics, which have been ingested however usually are not outlined in any of the options which the present tenant is presently subscribed to.

FSO Platform - Query Builder — FSO Platform – Question Builder

Clearly, that is solely the start and most of you wouldn’t be solely reporting customized metrics by hand, you’d be instrumenting code of your present functions, infrastructure, cloud suppliers and something you possibly can mannequin.

Able to strive? Get acknowledged with Cisco FSO Platform