Skicka data

Instatus tar emot loggar, traces och mätvärden via OpenTelemetry (OTLP över HTTPS). Det finns två sätt att ansluta en app. Välj ett.

Alternativ 1: Kopiera en prompt

Det snabbaste sättet om du använder en kodagent som Claude Code, Cursor eller Copilot.

  1. Öppna Observability på din statussida.
  2. Under Inkludera markerar du vad du vill skicka: Loggar, Traces, Mätvärden. Markera även Startpanel om du senare vill ha färdiga instrumentpaneler för dina tjänster.
  3. Klicka på Kopiera prompt.
  4. Klistra in den i din kodagent, i appens projekt.
  5. Lägg din API-nyckel i miljövariabeln INSTATUS_API_KEY och kör testet som agenten föreslår.
Inställningskortet med loggar, traces och mätvärden att ta med och en knapp för att kopiera prompten

Prompten ber agenten använda den officiella OpenTelemetry-SDK:n för ditt språk, behålla ditt nuvarande loggbibliotek, läsa nyckeln från en miljövariabel och aldrig committa den. Ditt sid-ID finns redan med.

Alternativ 2: Konfigurera manuellt

  1. Öppna Observability på din statussida.
  2. Klicka på Konfigurera manuellt.
  3. Välj språk: Node.js, Python, Go, Java, .NET, Ruby, PHP eller OpenTelemetry Collector.
  4. Kopiera kommandot under Installera och kör det, och kopiera sedan koden under Konfigurera till din app.
  5. Sätt miljövariabeln INSTATUS_API_KEY till din API-nyckel och starta appen.
Manuell konfiguration med Node.js valt, med installationskommandot och konfigurationskoden

Koden i instrumentpanelen har redan ditt sid-ID ifyllt. Samma exempel finns nedan om du hellre kopierar härifrån.

Det här behöver varje förfrågan

VadVärde
Slutpunkthttps://otel.instatus.com. Loggar går till /v1/logs, traces till /v1/traces, mätvärden till /v1/metrics.
AuthorizationBearer <API_KEY>, med nyckeln för en ägare, administratör eller redaktör för sidan.
X-Instatus-Site-IdID:t för statussidan som datan hör till.
ProtokollOTLP över HTTP, som protobuf eller JSON. Använder din SDK gRPC som standard, byt till HTTP.

Din API-nyckel ger åtkomst till hela ditt konto. Förvara den på dina servrar, i en miljövariabel. Lägg den aldrig i en webbläsare, en mobilapp eller ett offentligt repository.

Hitta din API-nyckel

Öppna menyn under din avatar, välj Användarinställningar och sedan Utvecklare, eller gå direkt till utvecklarinställningar. Klicka på Kopiera bredvid nyckeln.

API-nyckeln i utvecklarinställningar med en knapp för att kopiera den

Hitta ditt sid-ID

Det behövs sällan: prompten och koden i instrumentpanelen innehåller det redan. Vill du kopiera det själv högerklickar du på projektnamnet högst upp i instrumentpanelen och väljer Copy Project ID.

Copy Project ID i menyn för projektnamnet

Skicka en testlogg

En förfrågan från en terminal räcker för att kontrollera nyckeln och sid-ID:t:

curl -X POST https://otel.instatus.com/v1/logs \
-H "Authorization: Bearer $INSTATUS_API_KEY" \
-H "X-Instatus-Site-Id: $INSTATUS_PAGE_ID" \
-H "Content-Type: application/json" \
-d '{
"resourceLogs": [{
"resource": {
"attributes": [
{ "key": "service.name", "value": { "stringValue": "api" } }
]
},
"scopeLogs": [{
"logRecords": [{
"timeUnixNano": "'$(date +%s)'000000000",
"severityText": "INFO",
"body": { "stringValue": "Hello from Instatus" }
}]
}]
}]
}'

Ett 200-svar betyder att loggen togs emot. Öppna Observability → Loggar så finns den där inom några sekunder.

Alla språk, utan kodändringar

Alla OpenTelemetry-SDK:er läser samma miljövariabler. Med dem skickar autoinstrumentering traces, mätvärden och loggar utan att du rör koden:

export OTEL_SERVICE_NAME="api"
export OTEL_EXPORTER_OTLP_ENDPOINT="https://otel.instatus.com"
export OTEL_EXPORTER_OTLP_PROTOCOL="http/protobuf"
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer%20${INSTATUS_API_KEY},X-Instatus-Site-Id=${INSTATUS_PAGE_ID}"
export OTEL_TRACES_EXPORTER="otlp"
export OTEL_METRICS_EXPORTER="otlp"
export OTEL_LOGS_EXPORTER="otlp"

Mellanslaget efter Bearer skrivs som %20, eftersom header-variabeln är URL-kodad. Starta sedan appen med autoinstrumenteringen för dess språk:

# Node.js
npm install @opentelemetry/api @opentelemetry/auto-instrumentations-node
node --require @opentelemetry/auto-instrumentations-node/register app.js
# Python
pip install opentelemetry-distro opentelemetry-exporter-otlp
opentelemetry-bootstrap -a install
OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED=true opentelemetry-instrument python app.py

Java, .NET, Go, Ruby och PHP har egen autoinstrumentering och läser samma variabler. Se OpenTelemetrys zero-code-guider.

Node.js

För att skicka loggar från koden installerar du logg-SDK:n:

npm install @opentelemetry/api-logs @opentelemetry/sdk-logs \
@opentelemetry/exporter-logs-otlp-http @opentelemetry/resources

Konfigurera den en gång när appen startar:

import { SeverityNumber } from '@opentelemetry/api-logs'
import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-http'
import { resourceFromAttributes } from '@opentelemetry/resources'
import { BatchLogRecordProcessor, LoggerProvider } from '@opentelemetry/sdk-logs'
const provider = new LoggerProvider({
resource: resourceFromAttributes({ 'service.name': 'api' }),
processors: [
new BatchLogRecordProcessor(
new OTLPLogExporter({
url: 'https://otel.instatus.com/v1/logs',
headers: {
Authorization: `Bearer ${process.env.INSTATUS_API_KEY}`,
'X-Instatus-Site-Id': process.env.INSTATUS_PAGE_ID
}
})
)
]
})
const logger = provider.getLogger('api')
logger.emit({
severityNumber: SeverityNumber.ERROR,
severityText: 'ERROR',
body: 'Payment failed: card declined',
attributes: { 'customer.id': 'cus_123', route: '/v2/charges' }
})
process.on('beforeExit', () => provider.shutdown())

Loggar du redan med pino eller winston? Behåll dem. pino-opentelemetry-transport och @opentelemetry/winston-transport skickar varje befintlig loggrad som den är.

Python

pip install opentelemetry-sdk opentelemetry-exporter-otlp-proto-http

SDK:n kopplar in sig i Pythons logging-modul, så dina befintliga logging-anrop skickas som de är:

import logging
import os
from opentelemetry._logs import set_logger_provider
from opentelemetry.exporter.otlp.proto.http._log_exporter import OTLPLogExporter
from opentelemetry.sdk._logs import LoggerProvider, LoggingHandler
from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
from opentelemetry.sdk.resources import Resource
provider = LoggerProvider(resource=Resource.create({"service.name": "worker"}))
provider.add_log_record_processor(
BatchLogRecordProcessor(
OTLPLogExporter(
endpoint="https://otel.instatus.com/v1/logs",
headers={
"Authorization": f"Bearer {os.environ['INSTATUS_API_KEY']}",
"X-Instatus-Site-Id": os.environ["INSTATUS_PAGE_ID"],
},
)
)
)
set_logger_provider(provider)
logging.getLogger().addHandler(LoggingHandler(level=logging.INFO, logger_provider=provider))
logging.getLogger().setLevel(logging.INFO)
logging.warning("Card declined for customer %s", "cus_123")

OpenTelemetry Collector

Kör du redan OpenTelemetry Collector? Lägg till Instatus som exporter och låt apparna vara som de är:

exporters:
otlphttp/instatus:
endpoint: https://otel.instatus.com
headers:
Authorization: Bearer ${env:INSTATUS_API_KEY}
X-Instatus-Site-Id: ${env:INSTATUS_PAGE_ID}
service:
pipelines:
logs:
receivers: [otlp]
processors: [batch]
exporters: [otlphttp/instatus]
traces:
receivers: [otlp]
processors: [batch]
exporters: [otlphttp/instatus]
metrics:
receivers: [otlp]
processors: [batch]
exporters: [otlphttp/instatus]

Exportern lägger själv till /v1/logs, /v1/traces och /v1/metrics, så slutpunkten är bara värden. För att skicka loggfiler lägger du till en filelog-receiver i logg-pipelinen.

Vad du skickar

Instatus läser de här fälten. Allt annat sparas som ett attribut som du kan söka och filtrera på.

FältAnvänds till
service.name (resurs)Kolumnen och filtret Tjänst. Sätt det i varje app, worker och jobb.
bodyLoggmeddelandet, som fritextsökningen söker i.
severityText eller severityNumberNivån: fatal, error, warn, info, debug eller trace.
traceId och spanIdKopplar en logg till dess trace så att du kan hoppa mellan dem.
AttributAllt du lägger till, till exempel customer.id eller http.route. Varje attribut blir ett filter.

Attribut som börjar med instatus. är reserverade och ersätts när datan kommer in.

Felsökning

Du serLösning
401Kontrollera nyckeln och headern X-Instatus-Site-Id. Nyckelns ägare måste vara ägare, administratör eller redaktör för sidan.
400Innehållet är inte giltig OTLP. Kontrollera Content-Type och JSON-strukturen i testloggen.
429Månadens datamängd är slut. Se abonnemang och gränser.
200, men inget synsVänta några sekunder och kontrollera sedan tidsintervallet. En logg med en tidsstämpel bakåt i tiden syns bara när intervallet täcker den.
Ingenting allsSDK:er skickar i omgångar. Se till att appen tömmer eller stänger providern innan den avslutas.

När du genererar en ny API-nyckel i utvecklarinställningar slutar den gamla fungera direkt, så uppdatera först alla appar som använder den.