Odeslat data

Instatus přijímá logy, trasy a metriky přes OpenTelemetry (OTLP přes HTTPS). Aplikaci lze připojit dvěma způsoby. Vyberte si jeden.

Způsob 1: Zkopírujte prompt

Nejrychlejší cesta, pokud používáte programovacího agenta, například Claude Code, Cursor nebo Copilot.

  1. Otevřete Observability na své stavové stránce.
  2. V části Zahrnout zaškrtněte, co chcete posílat: Logy, Trasy, Metriky. Zaškrtněte i Úvodní dashboard, pokud chcete později hotové dashboardy pro své služby.
  3. Klikněte na Kopírovat prompt.
  4. Vložte ho do programovacího agenta v projektu své aplikace.
  5. Uložte svůj klíč API do proměnné prostředí INSTATUS_API_KEY a spusťte test, který agent navrhne.
Karta nastavení s logy, trasami a metrikami k zahrnutí a tlačítkem pro zkopírování promptu

Prompt agentovi říká, aby použil oficiální OpenTelemetry SDK pro váš jazyk, ponechal stávající knihovnu pro logování, četl klíč z proměnné prostředí a nikdy ho necommitoval. ID vaší stránky už v něm je.

Způsob 2: Nastavte ručně

  1. Otevřete Observability na své stavové stránce.
  2. Klikněte na Nastavit ručně.
  3. Vyberte jazyk: Node.js, Python, Go, Java, .NET, Ruby, PHP nebo OpenTelemetry Collector.
  4. Zkopírujte příkaz z části Instalace a spusťte ho, pak zkopírujte kód z části Konfigurace do své aplikace.
  5. Nastavte proměnnou prostředí INSTATUS_API_KEY na svůj klíč API a spusťte aplikaci.
Ruční nastavení s vybraným Node.js, s instalačním příkazem a konfiguračním kódem

Kód v dashboardu už má ID vaší stránky vyplněné. Stejné příklady najdete níže, pokud je chcete kopírovat odsud.

Co potřebuje každý požadavek

CoHodnota
Endpointhttps://otel.instatus.com. Logy jdou na /v1/logs, trasy na /v1/traces, metriky na /v1/metrics.
AuthorizationBearer <API_KEY>, s klíčem vlastníka, správce nebo editora stránky.
X-Instatus-Site-IdID stavové stránky, ke které data patří.
ProtokolOTLP přes HTTP, jako protobuf nebo JSON. Pokud vaše SDK ve výchozím stavu používá gRPC, přepněte ho na HTTP.

Váš klíč API dává přístup k celému účtu. Uchovávejte ho na svých serverech, v proměnné prostředí. Nikdy ho nevkládejte do prohlížeče, mobilní aplikace ani veřejného repozitáře.

Najděte svůj klíč API

Otevřete nabídku pod avatarem, zvolte Nastavení uživatele a pak Vývojář, nebo přejděte rovnou do nastavení pro vývojáře. Klikněte na Kopírovat vedle klíče.

Klíč API v nastavení pro vývojáře s tlačítkem pro kopírování

Najděte ID své stránky

Málokdy je potřeba: prompt i kód v dashboardu ho už obsahují. Pokud ho chcete zkopírovat sami, klikněte pravým tlačítkem na název projektu nahoře v dashboardu a zvolte Copy Project ID.

Copy Project ID v nabídce názvu projektu

Pošlete testovací log

Ke kontrole klíče a ID stránky stačí jeden požadavek z terminálu:

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

Odpověď 200 znamená, že log byl přijat. Otevřete Observability → Logy a během pár sekund ho uvidíte.

Jakýkoli jazyk, bez změn kódu

Každé OpenTelemetry SDK čte stejné proměnné prostředí. Díky nim automatická instrumentace posílá trasy, metriky a logy bez zásahu do kódu:

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"

Mezera za Bearer se zapisuje jako %20, protože proměnná hlaviček je kódovaná jako URL. Pak spusťte aplikaci s automatickou instrumentací pro její jazyk:

# 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 a PHP mají vlastní automatickou instrumentaci a čtou stejné proměnné. Viz návody OpenTelemetry bez kódu.

Node.js

Chcete-li posílat logy z kódu, nainstalujte SDK pro logy:

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

Nastavte ho jednou při spuštění aplikace:

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

Už logujete přes pino nebo winston? Ponechte je. pino-opentelemetry-transport a @opentelemetry/winston-transport pošlou každý stávající řádek logu beze změny.

Python

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

SDK se napojí na modul logging v Pythonu, takže vaše stávající volání logging se pošlou beze změny:

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

Už provozujete OpenTelemetry Collector? Přidejte Instatus jako exportér a aplikace nechte, jak jsou:

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]

Exportér sám přidá /v1/logs, /v1/traces a /v1/metrics, takže endpoint je jen hostitel. Chcete-li posílat soubory logů, přidejte do pipeline logů receiver filelog.

Co posílat

Instatus čte tato pole. Vše ostatní se uloží jako atribut, podle kterého můžete vyhledávat a filtrovat.

PoleK čemu slouží
service.name (prostředek)Sloupec a filtr Služba. Nastavte ho v každé aplikaci, workeru a úloze.
bodyZpráva logu, kterou prohledává fulltextové vyhledávání.
severityText nebo severityNumberÚroveň: fatal, error, warn, info, debug nebo trace.
traceId a spanIdPropojí log s jeho trasou, abyste mezi nimi mohli přecházet.
AtributyCokoli přidáte, například customer.id nebo http.route. Každý se stane filtrem.

Atributy začínající na instatus. jsou vyhrazené a při příchodu dat se nahradí.

Řešení problémů

VidíteŘešení
401Zkontrolujte klíč a hlavičku X-Instatus-Site-Id. Majitel klíče musí být vlastník, správce nebo editor stránky.
400Tělo není platné OTLP. Zkontrolujte Content-Type a strukturu JSON v testovacím logu.
429Objem dat pro tento měsíc je vyčerpaný. Viz tarify a limity.
200, ale nic se nezobrazíPočkejte pár sekund a pak zkontrolujte časový rozsah. Log s časovým razítkem v minulosti se zobrazí, jen když ho rozsah pokrývá.
Vůbec nicSDK posílají data po dávkách. Ujistěte se, že aplikace před ukončením vyprázdní nebo vypne providera.

Vygenerováním nového klíče API v nastavení pro vývojáře přestane starý okamžitě fungovat, proto nejdřív aktualizujte každou aplikaci, která ho používá.