With Cisco FSO Platform, metrics will be reported immediately from the code. Not like utilizing any form of auto-instrumentation characteristic, that is helpful when a service proprietor is aware of what must be reported. A typical use case could be enabling reporting of area particular metrics – like variety of gadgets within the catalogue for e-shops, variety of unfinished orders, SQL queries to particular desk, and so forth. Principally, something which could be fascinating to look at for some time frame, or in contrast amongst totally different implementation variations.
Arms-on steering on the best way to set this up
Open Telemetry has a really helpful means of how the metric reporting must be routed to any software program. The service which will likely be reporting the information 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 information to the FSO Platform tenant.
The very first thing that it’s good to safe is a FSO Platform tenant, to which the information will circulate. I occur to have one prepared, however I have to 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:
That must be all I have to configure my Open Telemetry collector.
Open Telemetric Collector configuration
Subsequent, I used Docker picture otel/opentelemetry-collector-contrib:newest, since that’s the best means for me to run the collector. All I have to 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:
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 gives a fairly in depth listing of SDK libraries for any fashionable languages and runtimes. The Java SDK appears to be essentially the most mature one on that listing. This doesn’t imply that Java is the one selection. Realistically, there may be already assist for reporting Open Telemetry knowledge from any actively used language. And if not, there may be all the time an choice to report knowledge utilizing totally different receivers. For instance, you should utilize Prometheus or Zipkin assist which your programming or runtime atmosphere already has.
Metric Information Supply
Since I don’t have any software prepared for this experiment, I selected to do the guide instrumentation (it should more than likely be extra enjoyable anyway).
After organising a mission and a dependency on the newest SDK model accessible (1.29.0), I put collectively the next class package deal com.cisco.fso:
Let’s undergo some necessary elements 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.identify and service.occasion.id — which is a de-facto commonplace, described as a part of the Open Telemetry semantic conventions.
When you discover that area extra, you’ll discover numerous different conventions, defining which useful resource attributes must be reported for numerous parts, like container, pod, service operating deployed on some cloud supplier and lots of extra. By utilizing service.identify and service.occasion.id, we’re reporting a service. On FSO Platform that is mapped to the kind apm:service_instance.
One other half value mentioning is the metric initialization. You’ll be able to see that I named my metric “my.first.metric”, set the kind 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 notice new logs reported by the Open Telemetry Collector we began earlier than:
Exploring ingested metrics utilizing FSO Platform
It is a good signal that the information arrived from my Java program to the collector. Additionally, the collector incorporates additional logs which counsel that it was in a position to report the information 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.
Apparently my service was registered by the platform, however there will not be a lot knowledge reported. And, any metrics that are displayed by default, will not be populated. Why is that occuring?
All of the metrics that are there are derived from spans and traces which might be reported by any commonplace 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 could be utilizing. After placing some load to your service, you’d see these. However that’s not what we need to do at this time. We need to see our essential “my.first.metric” knowledge factors.
For that, we might want to use Question Builder, a System Software of FSO Platform, which lets you question saved knowledge immediately utilizing Unified Question Language.
FETCH metrics(dynamicmetrics:my.first.metric) FROM entities(apm:service_instance)[attributes(service.name)='manualService']
This specific 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 reveals them on the output. The dynamicmetrics string represents a particular namespace for metrics, which had been ingested however will not be outlined in any of the options which the present tenant is at present subscribed to.
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 current functions, infrastructure, cloud suppliers and something you possibly can mannequin.
Able to strive? Get acknowledged with Cisco FSO Platform
Associated assets
Share:
