Forem: Talha Namaldı

Node.js Projelerinde OpenTelemetry ile Default Olarak Toplanmayan Verilerin OpenTelemetrye Eklenmesi

Talha Namaldı — Mon, 29 Jul 2024 11:39:03 +0000

Giriş

Bu yazıda OpenTelemetry uygulamasının izlediği verilerin yanında farklı bir veri izlemek istersek bunu OpenTelemetrye yeni bir span olarak nasıl ekleyebileceğimizi ele alacağım.

Adımlar

Oluşturduğum yapı projenin her yerinden OpenTelemetrye izlemek istediğimiz veriyi göndermeye olanak sağlar.

1. Yeni Bir Dosya Oluşturun

OpenTelemetrye projenin herhangi bir yerinden veri göndermek için span.js adlı bir dosya oluşturun.

Bu dosyanın içine aşağıdaki kodu kopyalayıp yapıştırın.

const { context, trace } = require("@opentelemetry/api");

const addSpanAttribute = (req, res, next) => {
  res.addSpanData = (spanName,data) => {
    const currentSpan = trace.getSpan(context.active());
    if (currentSpan) {
      currentSpan.setAttribute(spanName, JSON.stringify(data));
    }
  };
  next();
};

module.exports = addSpanAttribute;

Bu kod parçası OpenTelemetrynin context ve trace modüllerini kullanır. context aktif olan izleme bağlamını yönetmek için kullanılır trace ise izleme spanleri ile etkileşime geçmek için kullanılır.

addSpanAttribute fonksiyonu ile HTTP isteklerini işleyeceğiz.

Sonrasında response objesine addSpanData adında yeni bir fonksiyon tanımladım. Bu fonksiyon spana izlemek istediğimiz veriyi ekler. res.addSpanData fonksiyonu ile izlemek istediğimiz datayı istediğimiz isimle yeni bir span olarak OpenTelemtrye ekleyebiliriz.

2. App.js Dosyasını Düzenleyin

Öncelikle yeni eklediğimiz fonksiyonu require edin.

const addSpanAttribute = require("./app/spans/span");

Ardından app.use ile kullanıma açın.

app.use(addSpanAttribute);

3. Respons Objesine Eklenen Foksiyonun Kullanımı

İlk 2 adımı tamaladıktan sonra OpenTelemetrye veri göndermek son derece kolay.

Projenizin herhangi bir yerinden res.addSpanData('span_ismi',data)

şeklinde kullanabilirsiniz.

Örnek kullanım:

Kendi projemde http post fonkiyonuna gelen body verisini ve post fonsiyonunun sonucunda izlemek istediğim ifadeleri içeren datayı hazırlayıp res.addSpanData fonksiyonu ile OpenTelemetrye gönderdim.

Http post fonksiyonuna gelen bodyi OpenTelemetrye gönderdim:
res.addSpanData(req.body,'http.request.body')

Post işlemini tamamladıktan sonra ise takip etmek istediğim datayı hazırlayıp OpenTelemetrye gönderdim.

const formattedResponse = {
  userId: user.user_id,
  userName: user.name
};
res.addSpanData(formattedResponse,'http.response.post');

Bu örnek kullanım ile hazırladığımız datayı OpenTelemetrye gönderip izleyebiliriz.

Node.js Projelerine OpenTelemetry Entegrasyonu

Talha Namaldı — Thu, 25 Jul 2024 13:22:55 +0000

Giriş

Bu yazı Node.js projelerine OpenTelemetry engtegrasyonunu projede minimum değişikilik ile nasıl yapıldığını gösterecek.

Adımlar

1. Gerekli Kütüphaneleri İndirin

OpenTelemetry'nin çalışması için gerekli kütüphaneleri npm install ile indirin.

npm install @opentelemetry/sdk-node \
  @opentelemetry/api \
  @opentelemetry/auto-instrumentations-node \
  @opentelemetry/sdk-metrics \
  @opentelemetry/sdk-trace-node

2. Instrumentation Dosyasını Oluşturun

Projenizin en dış kısmına instrumentation.js adlı bir dosya oluşturun ve içine aşağıdaki kodu kopyalayıp yapıştırın.

const { NodeSDK } = require('@opentelemetry/sdk-node');
const { ConsoleSpanExporter } = require('@opentelemetry/sdk-trace-node');
const { getNodeAutoInstrumentations,} = require('@opentelemetry/auto-instrumentations-node');
const { PeriodicExportingMetricReader, ConsoleMetricExporter,} = require('@opentelemetry/sdk-metrics');

const sdk = new NodeSDK({
  traceExporter: new ConsoleSpanExporter(),
  metricReader: new PeriodicExportingMetricReader({
    exporter: new ConsoleMetricExporter(),
  }),
  instrumentations: [getNodeAutoInstrumentations()],
});

sdk.start();

Eğer OpenTelemetry çıktısını consola bastırmak yerine başka bir uygulmaya göndermek isterseniz instrumentation.js şu şekilde güncelleyiniz:

const { NodeSDK } = require('@opentelemetry/sdk-node');
const { ConsoleSpanExporter } = require('@opentelemetry/sdk-trace-node');
const { getNodeAutoInstrumentations,} = require('@opentelemetry/auto-instrumentations-node');
const { PeriodicExportingMetricReader, ConsoleMetricExporter,} = require('@opentelemetry/sdk-metrics');

const sdk = new NodeSDK({
    traceExporter: new OTLPTraceExporter({
    url: "http://0.0.0.0:0000/v1/traces", //göndermek istediğiniz uygulmanın ip adresi ve port numarasını buraya yazın
    serviceName: "nodeJSAPI",
  }),
  metricReader: new PeriodicExportingMetricReader({
    exporter: new ConsoleMetricExporter(),
  }),
  instrumentations: [getNodeAutoInstrumentations()],
});

sdk.start();

Eğer servis isminiz yukardaki kodda serviceName kısmına yazdığınız halde değişmezse adımları takip edin.

1. Resource kütüphanesini ekleyin

const { Resource } = require('@opentelemetry/resources');

2.

Kodun instrumentations:[getNodeAutoInstrumentations()], satırının altına yeni bir resource tanımlayın resource: new Resource({ [SEMRESATTRS_SERVICE_NAME]: 'servis_isminiz',}).

3. Projenizi instrumentation.js Dosyası ile Çalıştırın

Projenizi çalıştırmak için aşağıdaki komutu kullanın. Komutta en son kısımda yer alan dosya ismini(app.js) kendinize göre değiştirebilirsiniz.

node --require ./instrumentation.js app.js

Bu komutu sürekli olarak yazmak zor olacağından komutu projenizdeki package.json dosyasının içindeki scripts kısmına start komutu olarak ekleyebilirsiniz.

  "scripts": {
    "start": "node --require ./instrumentation.js app.js"
  }

Komutu package.json dosyasına ekledikten sonra npm start yazarak prejenizi OpenTelemetry kullanarak başlatabilirsiniz.