Send data

Instatus mottar logger, traces og metrikker via OpenTelemetry (OTLP over HTTPS). Det finnes to måter å koble til en app på. Velg én.

Alternativ 1: Kopier en prompt

Den raskeste veien hvis du bruker en kodeagent som Claude Code, Cursor eller Copilot.

  1. Åpne Observability på statussiden din.
  2. Under Ta med krysser du av for det du vil sende: Logger, Traces, Metrikker. Kryss også av for Startdashbord hvis du senere vil ha ferdige dashbord for tjenestene dine.
  3. Klikk Kopier prompt.
  4. Lim den inn i kodeagenten din, i appens prosjekt.
  5. Legg API-nøkkelen i miljøvariabelen INSTATUS_API_KEY, og kjør testen agenten foreslår.
Oppsettkortet med logger, traces og metrikker å ta med og en knapp for å kopiere prompten

Prompten ber agenten bruke det offisielle OpenTelemetry-SDK-et for språket ditt, beholde det nåværende loggebiblioteket, lese nøkkelen fra en miljøvariabel og aldri committe den. Side-ID-en din står allerede i den.

Alternativ 2: Sett opp manuelt

  1. Åpne Observability på statussiden din.
  2. Klikk Sett opp manuelt.
  3. Velg språk: Node.js, Python, Go, Java, .NET, Ruby, PHP eller OpenTelemetry Collector.
  4. Kopier kommandoen under Installer og kjør den, og kopier så koden under Konfigurer inn i appen.
  5. Sett miljøvariabelen INSTATUS_API_KEY til API-nøkkelen din, og start appen.
Manuelt oppsett med Node.js valgt, med installasjonskommandoen og konfigurasjonskoden

Koden i dashbordet har allerede side-ID-en din fylt inn. De samme eksemplene står nedenfor hvis du heller vil kopiere herfra.

Dette trenger hver forespørsel

HvaVerdi
Endepunkthttps://otel.instatus.com. Logger går til /v1/logs, traces til /v1/traces, metrikker til /v1/metrics.
AuthorizationBearer <API_KEY>, med nøkkelen til en eier, administrator eller redaktør av siden.
X-Instatus-Site-IdID-en til statussiden dataene hører til.
ProtokollOTLP over HTTP, som protobuf eller JSON. Bruker SDK-et gRPC som standard, bytt det til HTTP.

API-nøkkelen gir tilgang til hele kontoen din. Oppbevar den på serverne dine, i en miljøvariabel. Legg den aldri i en nettleser, en mobilapp eller et offentlig repository.

Finn API-nøkkelen din

Åpne menyen under avataren, velg Brukerinnstillinger og deretter Utvikler, eller gå rett til utviklerinnstillinger. Klikk Kopier ved siden av nøkkelen.

API-nøkkelen i utviklerinnstillinger med en knapp for å kopiere den

Finn side-ID-en din

Det trengs sjelden: prompten og koden i dashbordet inneholder den allerede. Vil du kopiere den selv, høyreklikker du på prosjektnavnet øverst i dashbordet og velger Copy Project ID.

Copy Project ID i menyen for prosjektnavnet

Send en testlogg

Én forespørsel fra en terminal holder for å sjekke nøkkelen og side-ID-en:

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" }
}]
}]
}]
}'

Et 200-svar betyr at loggen ble godtatt. Åpne Observability → Logger, så er den der i løpet av noen sekunder.

Alle språk, uten kodeendringer

Alle OpenTelemetry-SDK-er leser de samme miljøvariablene. Med dem sender auto-instrumentering traces, metrikker og logger uten at du rører 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"

Mellomrommet etter Bearer skrives som %20, fordi header-variabelen er URL-kodet. Start så appen med auto-instrumenteringen for språket:

# 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 og PHP har egen auto-instrumentering og leser de samme variablene. Se OpenTelemetrys zero-code-veiledninger.

Node.js

For å sende logger fra koden installerer du logg-SDK-et:

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

Sett det opp én gang når appen starter:

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())

Logger du allerede med pino eller winston? Behold dem. pino-opentelemetry-transport og @opentelemetry/winston-transport sender hver eksisterende logglinje som den er.

Python

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

SDK-et kobler seg på Pythons logging-modul, så de eksisterende logging-kallene dine sendes som de er:

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

Kjører du allerede OpenTelemetry Collector? Legg til Instatus som exporter, og la appene være som de er:

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]

Exporteren legger selv til /v1/logs, /v1/traces og /v1/metrics, så endepunktet er bare verten. For å sende loggfiler legger du til en filelog-receiver i logg-pipelinen.

Hva du sender

Instatus leser disse feltene. Alt annet lagres som et attributt du kan søke og filtrere på.

FeltBrukes til
service.name (ressurs)Kolonnen og filteret Tjeneste. Sett det i hver app, worker og jobb.
bodyLoggmeldingen, som fritekstsøk søker i.
severityText eller severityNumberNivået: fatal, error, warn, info, debug eller trace.
traceId og spanIdKobler en logg til tilhørende trace, så du kan hoppe mellom dem.
AttributterAlt du legger til, for eksempel customer.id eller http.route. Hvert blir et filter.

Attributter som starter med instatus., er reservert og erstattes når dataene kommer inn.

Feilsøking

Du serLøsning
401Sjekk nøkkelen og headeren X-Instatus-Site-Id. Eieren av nøkkelen må være eier, administrator eller redaktør av siden.
400Innholdet er ikke gyldig OTLP. Sjekk Content-Type og JSON-strukturen i testloggen.
429Månedens datamengde er brukt opp. Se abonnementer og grenser.
200, men ingenting visesVent noen sekunder, og sjekk så tidsrommet. En logg med et tidsstempel i fortiden vises bare når tidsrommet dekker det.
Ingenting i det hele tattSDK-er sender i bunker. Sørg for at appen tømmer eller lukker provideren før den avslutter.

Når du lager en ny API-nøkkel i utviklerinnstillinger, slutter den gamle å virke med en gang, så oppdater først alle apper som bruker den.