OpenTelemetry Gözlemlenebilirliği (@vicacha-devs/strapi-plugin-opentelemetry)
Package:
@vicacha-devs/strapi-plugin-opentelemetry· Plugin ID:opentelemetry· Category:Observability· Version:1.0.1· Routes:0
Sağlayıcıdan bağımsız OpenTelemetry hata izleme ve APM: OTLP/HTTP izleri ve metrikleri, Document Service alt span’ları, strapi.log.error yakalama, eklenti bazlı atıf ve gizli bilgi/kişisel veri maskeleme.
pnpm add @vicacha-devs/strapi-plugin-opentelemetry1. Temel Yetenekler ve Mimari Özellikler
Section titled “1. Temel Yetenekler ve Mimari Özellikler”- İçerik Türü Varlıkları ve Kullanım Senaryolarını İnceleyin (Diyagramlarla)
- Geliştirici Kılavuzu ve Admin UI Turunu İnceleyin
2. İçerik Türü Varlıkları, Konumları ve Şemaları (strapi.documents)
Section titled “2. İçerik Türü Varlıkları, Konumları ve Şemaları (strapi.documents)”Registers no Content-Types, routes, or admin pages. When enabled, the server register() lifecycle validates the config, starts the OpenTelemetry Node SDK (OTLP/HTTP traces and metrics plus auto-instrumentations), hooks strapi.log.error, adds a request middleware (HTTP spans, the http.server.request.duration histogram, and the http.server.errors counter), and, when captureDocumentService is true, wraps Document Service calls in child spans named strapi.document.<action> <uid>. bootstrap() logs the active exporter and destroy() flushes buffered spans and metrics. All exported error text passes through built-in secret and PII redaction.
Strapi v5 İçinde İçerik Türü Varlıkları Nerede Bulunur?
Section titled “Strapi v5 İçinde İçerik Türü Varlıkları Nerede Bulunur?”- Strapi Boot Log:
[opentelemetry] Active for service ...is logged frombootstrap()with the service name and the exporter target (otlpEndpoint,console, orno-exporter). - Your OTLP Backend: traces and metrics arrive at
<otlpEndpoint>/v1/tracesand<otlpEndpoint>/v1/metricsin SigNoz, Grafana, Sentry OTLP ingest, or any OTLP/HTTP collector. - Strapi Config:
config/plugins.ts->opentelemetry.config, validated at boot byvalidateOtelConfig. - No Admin UI or Content-Types: this plugin creates no entities, routes, settings page, or database tables.
Bu eklenti, doğrudan mevcut Strapi içerik türü varlıkları (api::* ve plugin::*) üzerinde çalışır.
Strapi v5 İçerik Yöneticisi (Content Manager) Entegrasyonu (/admin/content-manager)
Section titled “Strapi v5 İçerik Yöneticisi (Content Manager) Entegrasyonu (/admin/content-manager)”İçerik Yöneticisi Kenar Çubuğu Grubu:
No Content Manager panel; instruments the Document Service calls that Content Manager actions trigger
İçerik Yöneticisi Varlıkları ve Bileşenleri
Section titled “İçerik Yöneticisi Varlıkları ve Bileşenleri”- Document Service calls (
strapi.documents(...)) made when editors create, update, publish, or delete entries in/admin/content-manager, recorded asstrapi.document.<action> <uid>child spans - No Content-Type, route, or database table is created by this plugin
Bu Eklenti Neden Content Manager Varlıkları Oluşturur?
Section titled “Bu Eklenti Neden Content Manager Varlıkları Oluşturur?”@vicacha-devs/strapi-plugin-opentelemetry adds no Content Manager UI. Every create, update, publish, or delete an editor performs becomes a traced Document Service operation, so slow or failing saves can be tied to a specific content type and plugin in your observability backend.
- Per-Content-Type Visibility: spans carry
strapi.document.uid,strapi.document.action, andstrapi.plugin(forplugin::*UIDs). - Opt-Out per Environment: set
captureDocumentService: falseto stop wrapping Document Service calls without disabling HTTP tracing. - Safe by Default: payloads and user identity beyond
enduser.idare never attached to spans, and error text is redacted before export.
Strapi Content Manager İçinde Nasıl Kullanılır? (Adım Adım)
Section titled “Strapi Content Manager İçinde Nasıl Kullanılır? (Adım Adım)”- Enable the Plugin: add
opentelemetrytoconfig/plugins.tsand setOTEL_EXPORTER_OTLP_ENDPOINT(orOTEL_CONSOLE_EXPORTER=truelocally). - Work Normally in Content Manager: save or publish entries in
/admin/content-manager. - Inspect the Traces: search your backend for
strapi.document.update(orcreate,publish,delete) spans filtered bystrapi.document.uid.
Content Manager ve Eklenti Çalışma Alanı Senkronizasyonu
Section titled “Content Manager ve Eklenti Çalışma Alanı Senkronizasyonu”Content Manager Kullanım Senaryoları ve Editöryal İş Akışları
Section titled “Content Manager Kullanım Senaryoları ve Editöryal İş Akışları”Content Manager Use Case 1 — Diagnosing Slow Publishes
Section titled “Content Manager Use Case 1 — Diagnosing Slow Publishes”- Amacı ve Neden Kullanıldığı: Identify which content type and plugin make publishing slow, without logging any entry content.
- Content Manager İçinde Uygulama Adımları: Publish an entry in
/admin/content-manager, then find thestrapi.document.publish <uid>span under the request trace and compare its duration with other content types.
3. Uçtan Uca Kullanım Senaryoları ve İş Akışları
Section titled “3. Uçtan Uca Kullanım Senaryoları ve İş Akışları”Use Case 1 — Tracing Slow or Failing Requests Across Plugins
Section titled “Use Case 1 — Tracing Slow or Failing Requests Across Plugins”- What it is for: Find which plugin makes an endpoint slow or failing, using the
strapi.pluginattribute derived fromplugin::<name>.<model>UIDs and plugin route paths (for example/api/bookings/...->bookings). - How it works: Point
otlpEndpointat your collector; each request produces an HTTP span withhttp.route,http.response.status_code, andstrapi.plugin, andhttp.server.request.durationis recorded by method, route, and status.
Use Case 2 — Capturing Caught Errors from Plugins and Background Jobs
Section titled “Use Case 2 — Capturing Caught Errors from Plugins and Background Jobs”- What it is for: Surface errors that plugins, email lifecycles, or background jobs catch and only log, which would otherwise never reach an error tracker.
- How it works: The plugin hooks
strapi.log.error, records each call as anexceptionspan event, and counts it instrapi.log.errors; unhandled request errors also logtrace_id,span_id,method,path, andpluginfor log-trace correlation.
Use Case 3 — Shipping Telemetry Without Leaking Secrets or PII
Section titled “Use Case 3 — Shipping Telemetry Without Leaking Secrets or PII”- What it is for: Send traces to a third-party backend while keeping credentials and personal data out of them.
- How it works: Request bodies,
Authorization,Cookie, and user emails or names are never attached to spans. Error text is redacted forBearer/Basictokens, URL credentials, sensitive query parameters, and email addresses, and is length-bounded before redaction so pathological input cannot stall the sanitizer.
4. REST API Uç Noktaları (content-api ve admin)
Section titled “4. REST API Uç Noktaları (content-api ve admin)”| Metot | Uç Nokta Yolu | Kapsam | Denetleyici (Handler) | Kimlik Doğrulama |
|---|