OpenTelemetry

Status200 OpenTelemetry Protocol (OTLP) के ज़रिए लॉग, मेट्रिक्स और ट्रेस लेता है। किसी भी OpenTelemetry SDK या OpenTelemetry Collector को इंजेशन कुंजी के साथ Status200 की ओर करें, और आपका डेटा लॉग, ट्रेस, मेट्रिक्स और अपवाद में दिखने लगता है। यह पेज कुछ ही मिनटों में किसी सेवा से डेटा भेजना शुरू करवाता है, फिर वे एंडपॉइंट, सीमाएं और त्रुटियां बताता है जो प्रोडक्शन में चाहिए।

यह कैसे काम करता है#

आपका एप्लिकेशन OTLP सीधे Status200 को, या उसे आगे भेजने वाले OpenTelemetry Collector को एक्सपोर्ट करता है। हर अनुरोध x-status200-token हेडर में आपकी इंजेशन कुंजी लेकर जाता है, और Status200 उस कुंजी से आपका प्रोजेक्ट ढूंढता है।

• सेवाएं आपके लिए अपने आप बनती हैं। रिसोर्स एट्रिब्यूट service.name (OTEL_SERVICE_NAME से सेट) उस सेवा का नाम तय करता है जिसका आपका डेटा है। Status200 पहली बार डेटा आने पर सेवा बनाता है और उसे उत्पाद → सेवाएं में दिखाता है।
• त्रुटियां अपवाद बन जाती हैं। स्पैन पर अपवाद इवेंट और लॉग में दर्ज अपवाद अपवाद में इश्यू के रूप में समूहित होते हैं — देखें लॉग से अपवाद।
• नियम डेटा के आते ही उस पर लागू होते हैं। ड्रॉप फ़िल्टर और स्क्रब नियम वह छोड़ देते हैं या छिपा देते हैं जिसे आप कभी सहेजना नहीं चाहते, और डेटा प्रतिधारण तय करता है कि बाकी कितने समय तक रखा जाए।

शुरू करने से पहले#

• एक Status200 प्रोजेक्ट जिसमें आप इंजेशन कुंजियां बना सकें: प्रोजेक्ट के स्वामी और व्यवस्थापक बना सकते हैं, और Create Telemetry Ingestion Key अनुमति वाला कोई भी व्यक्ति भी।
• एक एप्लिकेशन जिसमें आप OpenTelemetry SDK जोड़ सकें, या एक OpenTelemetry Collector।
• आपके एप्लिकेशन या collector से status200.ru या आपके अपने Status200 होस्ट तक आउटबाउंड HTTPS (पोर्ट 443)।

क्विकस्टार्ट#

1. एक इंजेशन कुंजी बनाएं#

   1. उत्पाद → प्रोजेक्ट सेटिंग्स पर जाएं।
   2. साइड मेन्यू में टेलीमेट्री और APM खोलें और इंजेशन कुंजियाँ चुनें।
   3. इन्जेशन कुंजी बनाएँ पर क्लिक करें। डायलॉग एक नाम भर देता है और सर्वर कुंजी प्रकार चुनता है, जिससे कोई एप्लिकेशन या collector डेटा भेजता है। चाहें तो नाम बदलें, फिर इन्जेशन कुंजी बनाएँ पर क्लिक करें।

   

   नई कुंजी अपने पेज पर खुलती है। उसकी सीक्रेट कुंजी कॉपी करें — यही वह टोकन है जिसे आप x-status200-token के रूप में भेजते हैं।

   

2. OpenTelemetry एनवायरनमेंट वेरिएबल सेट करें#

   हर OpenTelemetry SDK वही मानक एनवायरनमेंट वेरिएबल पढ़ता है, इसलिए यह चरण हर भाषा में एक जैसा है।

   एनवायरनमेंट वेरिएबल	मान	यह क्या करता है
   OTEL_EXPORTER_OTLP_ENDPOINT	https://status200.ru/otlp	कहां भेजना है। SDK /v1/traces, /v1/metrics और /v1/logs खुद जोड़ता है।
   OTEL_EXPORTER_OTLP_HEADERS	x-status200-token=YOUR_STATUS200_INGESTION_KEY	हर अनुरोध के साथ आपकी इंजेशन कुंजी भेजता है।
   OTEL_EXPORTER_OTLP_PROTOCOL	http/protobuf	HTTP पर OTLP। कुछ SDK डिफ़ॉल्ट रूप से gRPC इस्तेमाल करते हैं, जो दूसरा एंडपॉइंट इस्तेमाल करता है।
   OTEL_SERVICE_NAME	my-service	वह सेवा जिसके तहत आपका डेटा Status200 में दिखता है।

   Bash

   export OTEL_EXPORTER_OTLP_ENDPOINT="https://status200.ru/otlp"
   export OTEL_EXPORTER_OTLP_HEADERS="x-status200-token=YOUR_STATUS200_INGESTION_KEY"
   export OTEL_EXPORTER_OTLP_PROTOCOL="http/protobuf"
   export OTEL_SERVICE_NAME="my-service"

   सेल्फ़-होस्ट कर रहे हैं? https://status200.ru की जगह अपने Status200 इंस्टेंस का URL लिखें, जैसे https://status200.example.com/otlp। अपवादों पर परिवेश का टैग लगाने के लिए OTEL_RESOURCE_ATTRIBUTES को भी deployment.environment=production पर सेट करें।

3. अपने ऐप में OpenTelemetry जोड़ें#

   अपनी भाषा चुनें। हर सेटअप ऊपर के एनवायरनमेंट वेरिएबल पढ़ता है, इसलिए आपके कोड में न कोई एंडपॉइंट होता है न कोई कुंजी।

   Node.jsPythonGoJava.NET

   Node.js

   SDK, ऑटोमैटिक इंस्ट्रुमेंटेशन और OTLP/HTTP एक्सपोर्टर इंस्टॉल करें:

   Bash

   npm install @opentelemetry/sdk-node @opentelemetry/auto-instrumentations-node \
     @opentelemetry/exporter-trace-otlp-proto @opentelemetry/exporter-metrics-otlp-proto \
     @opentelemetry/exporter-logs-otlp-proto @opentelemetry/sdk-metrics @opentelemetry/sdk-logs

   SDK को उसकी अपनी फ़ाइल में बनाएं:

   instrumentation.jsJavaScript

   const { NodeSDK } = require("@opentelemetry/sdk-node");
   const { getNodeAutoInstrumentations } = require("@opentelemetry/auto-instrumentations-node");
   const { OTLPTraceExporter } = require("@opentelemetry/exporter-trace-otlp-proto");
   const { OTLPMetricExporter } = require("@opentelemetry/exporter-metrics-otlp-proto");
   const { OTLPLogExporter } = require("@opentelemetry/exporter-logs-otlp-proto");
   const { PeriodicExportingMetricReader } = require("@opentelemetry/sdk-metrics");
   const { BatchLogRecordProcessor } = require("@opentelemetry/sdk-logs");
   
   // The exporters read OTEL_EXPORTER_OTLP_ENDPOINT and OTEL_EXPORTER_OTLP_HEADERS.
   const sdk = new NodeSDK({
     traceExporter: new OTLPTraceExporter(),
     metricReader: new PeriodicExportingMetricReader({
       exporter: new OTLPMetricExporter(),
     }),
     logRecordProcessors: [new BatchLogRecordProcessor(new OTLPLogExporter())],
     instrumentations: [getNodeAutoInstrumentations()],
   });
   
   sdk.start();

   इसे अपने एप्लिकेशन कोड से पहले लोड करें:

   Bash

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

   Python

   OpenTelemetry डिस्ट्रीब्यूशन और एक्सपोर्टर इंस्टॉल करें, फिर उन लाइब्रेरी के इंस्ट्रुमेंटेशन जो आपका ऐप इस्तेमाल करता है:

   Bash

   pip install opentelemetry-distro opentelemetry-exporter-otlp
   opentelemetry-bootstrap -a install

   अपना ऐप opentelemetry-instrument के ज़रिए शुरू करें। यह ट्रेस, मेट्रिक्स और लॉग एक्सपोर्ट करता है; लॉगिंग वेरिएबल Python के logging मॉड्यूल से लिखे रिकॉर्ड भी भेजता है:

   Bash

   OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED=true opentelemetry-instrument python app.py

   Go

   SDK और OTLP/HTTP एक्सपोर्टर जोड़ें:

   Bash

   go get go.opentelemetry.io/otel go.opentelemetry.io/otel/sdk go.opentelemetry.io/otel/sdk/metric \
     go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp \
     go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp

   प्रोग्राम शुरू होने पर tracer और meter प्रोवाइडर बनाएं:

   main.goGo

   package main
   
   import (
       "context"
       "log"
   
       "go.opentelemetry.io/otel"
       "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp"
       "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp"
       sdkmetric "go.opentelemetry.io/otel/sdk/metric"
       sdktrace "go.opentelemetry.io/otel/sdk/trace"
   )
   
   func main() {
       ctx := context.Background()
   
       // Both exporters read OTEL_EXPORTER_OTLP_ENDPOINT and OTEL_EXPORTER_OTLP_HEADERS.
       traceExporter, err := otlptracehttp.New(ctx)
       if err != nil {
           log.Fatal(err)
       }
       tracerProvider := sdktrace.NewTracerProvider(sdktrace.WithBatcher(traceExporter))
       defer tracerProvider.Shutdown(ctx)
       otel.SetTracerProvider(tracerProvider)
   
       metricExporter, err := otlpmetrichttp.New(ctx)
       if err != nil {
           log.Fatal(err)
       }
       meterProvider := sdkmetric.NewMeterProvider(
           sdkmetric.WithReader(sdkmetric.NewPeriodicReader(metricExporter)),
       )
       defer meterProvider.Shutdown(ctx)
       otel.SetMeterProvider(meterProvider)
   
       // Your application code.
   }

   प्रोवाइडर OTEL_SERVICE_NAME को एनवायरनमेंट से लेते हैं। लॉग के लिए otlploghttp को otelslog जैसे लॉग ब्रिज के साथ जोड़ें; यह भी वही वेरिएबल पढ़ता है।

   Java

   OpenTelemetry Java एजेंट डाउनलोड करें और उसे अपने एप्लिकेशन से जोड़ें। कोड में कोई बदलाव नहीं चाहिए:

   Bash

   curl -L -O https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar
   java -javaagent:opentelemetry-javaagent.jar -jar my-app.jar

   एजेंट आम फ़्रेमवर्क और लाइब्रेरी को इंस्ट्रुमेंट करता है, और ट्रेस, मेट्रिक्स और Logback या Log4j से लिखे लॉग एक्सपोर्ट करता है।

   .NET

   ASP.NET Core के लिए OpenTelemetry पैकेज जोड़ें:

   Bash

   dotnet add package OpenTelemetry.Extensions.Hosting
   dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol
   dotnet add package OpenTelemetry.Instrumentation.AspNetCore
   dotnet add package OpenTelemetry.Instrumentation.Http

   स्टार्टअप पर OpenTelemetry रजिस्टर करें। UseOtlpExporter() ट्रेस, मेट्रिक्स और लॉग भेजता है, और OTEL_EXPORTER_OTLP_* वेरिएबल पढ़ता है:

   Program.csC#

   using OpenTelemetry;
   using OpenTelemetry.Metrics;
   using OpenTelemetry.Trace;
   
   var builder = WebApplication.CreateBuilder(args);
   
   builder.Services.AddOpenTelemetry()
       .WithTracing(tracing => tracing
           .AddAspNetCoreInstrumentation()
           .AddHttpClientInstrumentation())
       .WithMetrics(metrics => metrics
           .AddAspNetCoreInstrumentation()
           .AddHttpClientInstrumentation())
       .WithLogging()
       .UseOtlpExporter();
   
   var app = builder.Build();
   app.Run();

   Serilog इस्तेमाल करते हैं? उसके लॉग Status200 को भेजने के लिए Serilog देखें।

4. जांचें कि डेटा पहुंच रहा है#

   Status200 से पूछें कि क्या वह आपकी कुंजी स्वीकार करता है:

   Bash

   curl -i -H "x-status200-token: YOUR_STATUS200_INGESTION_KEY" \
     https://status200.ru/otlp/v1/validate

   काम करने वाली कुंजी "valid": true के साथ 200 लौटाती है। बाकी सब कुछ 401 लौटाता है, साथ में संदेश होता है कि क्या गलत है — अज्ञात, अक्षम या समाप्त।

   फिर अपना ऐप चलाएं और एक मिनट तक इस्तेमाल करें। उत्पाद → सेवाएं खोलें: आपकी सेवा उस नाम से दिखती है जो आपने OTEL_SERVICE_NAME में सेट किया, उसके लॉग, ट्रेस, मेट्रिक्स और अपवादों के साथ। उत्पाद → लॉग, उत्पाद → ट्रेस और उत्पाद → मेट्रिक्स सभी सेवाओं का वही डेटा दिखाते हैं।

curl -i https://status200.ru/otlp/v1/logs \
  -H "Content-Type: application/json" \
  -H "x-status200-token: YOUR_STATUS200_INGESTION_KEY" \
  -d '{
    "resourceLogs": [{
      "resource": {
        "attributes": [
          { "key": "service.name", "value": { "stringValue": "my-service" } }
        ]
      },
      "scopeLogs": [{
        "logRecords": [{
          "severityNumber": 9,
          "body": { "stringValue": "Hello from curl" }
        }]
      }]
    }]
  }'

OpenTelemetry Collector के ज़रिए भेजें#

Collector तब चलाएं जब आपके पास पहले से एक हो, जब आप डेटा को एक जगह बैच, फ़िल्टर या समृद्ध करना चाहें, या इंजेशन कुंजी को अपने एप्लिकेशन से बाहर रखना चाहें। आपके ऐप collector को एक्सपोर्ट करते हैं, और केवल collector Status200 से बात करता है।

1. Status200 को एक्सपोर्टर के रूप में जोड़ें#

   Status200 की ओर इशारा करने वाला otlphttp एक्सपोर्टर जोड़ें, और हर पाइपलाइन को उससे होकर भेजें:

   otel-collector-config.yamlYAML

   receivers:
     otlp:
       protocols:
         grpc:
           endpoint: 0.0.0.0:4317
         http:
           endpoint: 0.0.0.0:4318
   
   processors:
     batch: {}
   
   exporters:
     otlphttp:
       endpoint: https://status200.ru/otlp
       headers:
         x-status200-token: YOUR_STATUS200_INGESTION_KEY
   
   service:
     pipelines:
       traces:
         receivers: [otlp]
         processors: [batch]
         exporters: [otlphttp]
       metrics:
         receivers: [otlp]
         processors: [batch]
         exporters: [otlphttp]
       logs:
         receivers: [otlp]
         processors: [batch]
         exporters: [otlphttp]

   एक्सपोर्टर की डिफ़ॉल्ट सेटिंग रखें: यह gzip से कंप्रेस किया protobuf भेजता है, और Status200 दोनों स्वीकार करता है। एक्सपोर्टर पर Content-Type हेडर सेट न करें — Status200 उसी हेडर से डिकोडर चुनता है, इसलिए protobuf बाइट्स के आगे JSON कंटेंट टाइप इंजेशन तोड़ देता है।

2. Collector चलाएं#

   DockerLinux

   Docker

   Bash

   docker run -d --name otel-collector \
     -p 4317:4317 -p 4318:4318 \
     -v "$(pwd)/otel-collector-config.yaml:/etc/otelcol-contrib/config.yaml" \
     otel/opentelemetry-collector-contrib:latest

   Linux

   Bash

   otelcol-contrib --config otel-collector-config.yaml

   Collector पोर्ट 4317 (gRPC) और 4318 (HTTP) पर OTLP सुनता है, यही वे पोर्ट हैं जिन पर SDK डिफ़ॉल्ट रूप से भेजते हैं।

3. अपने ऐप को collector की ओर करें#

   अपने एप्लिकेशन में OTEL_EXPORTER_OTLP_ENDPOINT को collector पर सेट करें, जैसे http://localhost:4318, और OTEL_EXPORTER_OTLP_HEADERS हटा दें — कुंजी collector जोड़ता है। हर एप्लिकेशन में OTEL_SERVICE_NAME रखें।

   डेटा Status200 में ठीक क्विकस्टार्ट की तरह पहुंचता है। अगर नहीं पहुंचता, तो collector का अपना लॉग कारण बताता है — देखें समस्या निवारण।

पहले से किसी दूसरे विक्रेता को एक्सपोर्ट कर रहे हैं? मौजूदा एक्सपोर्टर के बगल में otlphttp एक्सपोर्टर जोड़ें और तुलना करते समय दोनों को भेजने के लिए हर पाइपलाइन के exporters में दोनों लिखें। होस्ट मेट्रिक्स और लॉग फ़ाइलें भी इकट्ठा करने के लिए Host OpenTelemetry Collector गाइड देखें।

एंडपॉइंट और सीमाएं#

HTTP पर हर सिग्नल का एंडपॉइंट के नीचे अपना पथ होता है। SDK और collector इसे आपके लिए जोड़ते हैं; इसे खुद तभी सेट करें जब कोई टूल पूरा URL मांगे।

निरंतर प्रोफ़ाइलिंग के लिए ज़्यादातर प्रोफ़ाइलर इसके बजाय Pyroscope-संगत एंडपॉइंट पर भेजते हैं — देखें निरंतर प्रोफ़ाइलिंग। OTLP प्रोफ़ाइल एक्सपोर्ट करने वाले collector को एक्सपोर्टर का profiles_endpoint https://status200.ru/otlp/v1/profiles पर सेट करना होगा, क्योंकि डिफ़ॉल्ट रूप से यह प्रोफ़ाइल एक डेवलपमेंट पथ पर भेजता है जिसे Status200 सर्व नहीं करता।

gRPC पर OTLP#

Status200 वेब ऐप वाले ही होस्ट पर, पोर्ट 443 पर TLS के ज़रिए OTLP/gRPC देता है। OTEL_EXPORTER_OTLP_PROTOCOL को grpc और OTEL_EXPORTER_OTLP_ENDPOINT को https://status200.ru:443 पर सेट करें, और वही x-status200-token हेडर भेजें। Collector में endpoint: status200.ru:443 और वही headers के साथ otlp एक्सपोर्टर इस्तेमाल करें।

सेल्फ़-होस्टेड इंस्टॉलेशन में gRPC केवल HTTPS पर Status200 तक पहुंचता है: सादा-HTTP (h2c) कनेक्शन अस्वीकार हो जाता है। अगर आपका इंस्टेंस सादे HTTP पर चलता है, तो OTLP/HTTP इस्तेमाल करें।

किसी कुंजी की दो सेटिंग केवल OTLP/HTTP पर लागू होती हैं: उसकी Requests Per Minute Limit और उसका Pinned Service Name। gRPC पर भेजा गया डेटा वही service.name रखता है जिसके साथ वह भेजा गया था, और सीमा में नहीं गिना जाता।

प्रतिक्रियाएं#

डेटा कतार में आते ही Status200 एक्सपोर्ट का जवाब देता है, और डेटा कुछ सेकंड बाद दिखता है।

401, 402, 413, 415 और 422 OTLP एक्सपोर्टर के लिए स्थायी त्रुटियां हैं: एक्सपोर्टर फिर कोशिश करने के बजाय बैच छोड़ देता है और त्रुटि लॉग करता है।

रीस्टार्ट और अपग्रेड#

जब Status200 रीस्टार्ट या अपग्रेड हो रहा होता है, तब तैयार होने तक वह एक्सपोर्ट का जवाब 503 और Retry-After: 5 से देता है, और एक्सपोर्टर उन्हें फिर भेजते हैं। Collector का एक्सपोर्टर डिफ़ॉल्ट रूप से पांच मिनट तक फिर कोशिश करता रहता है (retry_on_failure) और जो नहीं भेज सका उसे अपनी sending_queue में रखता है, इसलिए दोनों को चालू रहने दें। जितने समय Status200 डेटा नहीं ले रहा था, वह आपके सर्वर, होस्ट या दूसरे संसाधनों के ख़िलाफ़ कभी नहीं गिना जाता: देखें जब Status200 डेटा नहीं ले रहा हो।

इंजेशन कुंजियां#

प्रोजेक्ट सेटिंग्स → टेलीमेट्री और APM → इंजेशन कुंजियाँ के तहत हर कुंजी के पेज पर ये सेटिंग होती हैं:

कुंजी के पेज पर सीक्रेट कुंजी रीसेट करें सीक्रेट को बदल देता है। पुराने सीक्रेट से भेजने वाला हर एप्लिकेशन और collector तब तक अस्वीकार होता है जब तक आप उसे अपडेट न करें। ब्राउज़र कुंजियों, किसी कुंजी को सुरक्षित रूप से बदलने और हर अस्वीकृति के अर्थ के लिए देखें इंजेशन कुंजियाँ।

सेल्फ़-होस्टेड Status200#

इस पेज की हर बात आपके अपने इंस्टॉलेशन पर भी वैसे ही काम करती है। जहां भी यह पेज https://status200.ru कहता है, वहां अपना Status200 URL इस्तेमाल करें:

• OTEL_EXPORTER_OTLP_ENDPOINT है https://YOUR-ONEUPTIME-HOST/otlp, या http://YOUR-ONEUPTIME-HOST/otlp अगर आप Status200 को सादे HTTP पर चलाते हैं।
• साथ आने वाला ingress /otlp पर 4 MB तक के अनुरोध स्वीकार करता है। Status200 के आगे आप जो प्रॉक्सी चलाते हैं उसकी सीमा कम हो सकती है — ingress-nginx में proxy-body-size डिफ़ॉल्ट रूप से 1 MB है — इसलिए उसे /otlp के लिए भी बढ़ाएं, वरना एक्सपोर्टर को 413 मिलेगा।
• अगर DISABLE_TELEMETRY_INGESTION=true सेट है, तो Status200 हर एक्सपोर्ट स्वीकार करता है और कुछ भी स्टोर नहीं करता। जब कोई सेल्फ़-होस्टेड इंस्टेंस बिल्कुल डेटा न दिखाए, तो सबसे पहले यही जांचें।

लॉग से अपवाद#

Status200 आपके logs में अपवाद ढूंढता है और उन्हें उसी अपवाद व्यू में जोड़ता है जिसमें ट्रेस की त्रुटियां आती हैं। हर लॉग पहले से किसी सेवा या होस्ट का होता है, इसलिए अपवाद उसी को सौंपा जाता है। लॉग और ट्रेस के अपवाद एक ही फ़िंगरप्रिंट समूहीकरण साझा करते हैं, इसलिए जो त्रुटि ट्रेस और लॉग दोनों बताते हैं वह एक ही इश्यू बन जाती है।

कोई लॉग दो तरीकों से अपवाद बनता है:

बॉडी स्कैन सादे-टेक्स्ट लॉग के लिए उपयुक्त है, जैसे कच्चा stdout, journald या syslog जिसे collector पढ़ता है। कई लाइनों वाला स्टैक ट्रेस एक ही लॉग रिकॉर्ड के रूप में आना चाहिए, इसलिए collector में मल्टीलाइन जोड़ना चालू करें — देखें Host OpenTelemetry Collector गाइड।

पहचान डिफ़ॉल्ट रूप से चालू है। सेल्फ़-होस्टेड इंस्टॉलेशन में इसे बंद करने के लिए app सेवा पर TELEMETRY_LOG_EXCEPTION_EXTRACTION_ENABLED=false सेट करें — और अगर आप Helm चार्ट का अलग worker चलाते हैं तो worker पर भी।

समस्या निवारण#

अगले कदम#