Nodejs Instrumentation (Running on Kubernetes)

this document explains how to instrument the node js application with kloudmate, using opentelemetry this instrumentation can be done using the opentelemetry operator, which supports injecting and configuring auto instrumentation libraries for net, java, node js, python, and go service pre requisites running a kubernetes cluster the https //cert manager io/docs/installation/ must be installed if you use the helm chart, there is an option to generate a self signed cert instead step 1 first, install the https //github com/open telemetry/opentelemetry operator into your cluster you can do this with the https //github com/open telemetry/opentelemetry operator#getting started , the https //github com/open telemetry/opentelemetry helm charts/tree/main/charts/opentelemetry operator#opentelemetry operator helm chart , or with https //operatorhub io/operator/opentelemetry operator bash kubectl apply f https //github com/open telemetry/opentelemetry operator/releases/latest/download/opentelemetry operator yaml step 2 create an opentelemetry collector to send telemetry from containers to a collector instead of directly to a backend for example, here is a demo collector used kubectl apply f <\<eof apiversion opentelemetry io/v1alpha1 kind opentelemetrycollector metadata name demo namespace kloudmate backend #change namespace spec config | receivers otlp protocols grpc endpoint 0 0 0 0 4317 http endpoint 0 0 0 0 4318 processors memory limiter check interval 1s limit percentage 75 spike limit percentage 15 batch send batch size 10000 timeout 10s exporters debug otlphttp endpoint 'https //otel kloudmate com 4318' headers authorization kloudmate api key &#x9; service pipelines traces receivers \[otlp] processors \[memory limiter, batch] exporters \[debug, otlphttp] metrics receivers \[otlp] processors \[memory limiter, batch] exporters \[debug, otlphttp] logs receivers \[otlp] processors \[memory limiter, batch] exporters \[debug, otlphttp] eof change your kloudmate organization api key to configure the collector to export data to kloudmate step 3 configure automatic instrumentation to be able to manage automatic instrumentation, the operator needs to be configured to know what pods to instrument and which automatic instrumentation to use for those pods this is done via the https //github com/open telemetry/opentelemetry operator/blob/main/docs/api/instrumentations md for our example, we used node js sdk auto instrumentation the following command creates a basic instrumentation resource that is configured for instrumenting node js services kubectl apply f <\<eof apiversion opentelemetry io/v1alpha1 kind instrumentation metadata name demo instrumentation namespace kloudmate backend #change namespace spec exporter endpoint http //demo collector 4317 propagators \ tracecontext \ baggage sampler type parentbased traceidratio argument "1" eof the endpoint used under exporter must be the same as the service name of the collector created in step 2 step 4 now to opt in your services to automatic instrumentation this is done by updating your service’s spec template metadata annotations spec template metadata annotations to include a language specific annotation node js instrumentation opentelemetry io/inject nodejs "true" "true" to patch your existing node js application with the necessary annotation use the below command bash kubectl patch deployment otlp http deployment n kloudmate backend p '{"spec" {"template" {"metadata" {"annotations" {"instrumentation opentelemetry io/inject nodejs" "true"}}}}}' following the above steps, you can get the necessary telemetry data on kloudmate node js runtime metrics name description unit nodejs eventloop delay min event loop minimum delay seconds nodejs eventloop delay max event loop maximum delay seconds nodejs eventloop delay mean event loop mean delay seconds nodejs eventloop delay stddev event loop standard deviation delay seconds nodejs eventloop delay p50 event loop 50 percentile delay seconds nodejs eventloop delay p90 event loop 90 percentile delay seconds nodejs eventloop delay p99 event loop 99 percentile delay seconds nodejs eventloop utilization event loop utilization one nodejs eventloop time cumulative duration of time the event loop has been in each state seconds