REST API voor applicatielogboeken: maak van een SQL-query een eindpunt

REST API · Applicatielogboeken naar een eindpunt

Draai een Toepassingslogboeken SQL-query in een REST API eindpunt

Sla een query op in de querybuilder door te klikken. Nieuw eindpunt, and you have a URL at api.querystreams.com with its own key. The SQL runs read-only on the Agent that already reads your Application Logs file; the caller gets JSON or CSV and never sees the SQL, the schema or a password. Nothing to host, no port to open. About 90 seconds from a saved query, and the Free plan covers your first endpoint.

Ongeveer 90 seconden na een opgeslagen zoekopdracht Geen server om te hosten Het bestand blijft op zijn plaats. Eén sleutel per beller, op elk moment intrekbaar.

Wat je uiteindelijk overhoudt

Een URL op api.querystreams.com Hiermee worden de rijen van uw opgeslagen App Logs-query als JSON of CSV teruggestuurd naar iedereen die een sleutel heeft. Deze functie is getest vanuit de console in het portaal voordat u deze deelt. Bijvoorbeeld zo:

{
  "niveau": "Seattle"
}

curl -X POST "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19" \ -H "X-API-Key: qsapi_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"level": "Seattle"}'

{
  "kolommen": [ { "naam": "event_time", "type": "geheel getal" }, { "naam": "app", "type": "snaar" }, { "naam": "niveau", "type": "snaar" } ],
  "rijen": [
    { "event_time": 1042, "app": "Northwind Traders", "niveau": "Seattle" },
    { "event_time": 1057, "app": "Alpine Outfitters", "niveau": "Denver" },
    { "event_time": 1063, "app": "Harbour Foods", "niveau": "Halifax" }
  ],
  "meta": { "rij_aantal": 3, "agent_duration_ms": 41, "verzoek_id": "req_7Hq2mKd9" }
}

Application Logs bewaart uw gegevens in bestanden op een computer die u beheert. Iemand anders wil een deel van die gegevens gebruiken in zijn of haar app, dashboard of script, en de gebruikelijke oplossingen leveren te veel gegevens op: een database-login die het project overleeft, een dagelijkse export die 's ochtends alweer verouderd is, of een kleine API-server die iemand anders moet beheren en patchen. Query Streams maakt van het eindpunt een opgeslagen query plus een sleutel. De agent die al bij uw applicatielogbestanden staat, voert de query uit, api.querystreams.com controleert de sleutel en de limiet voor het aantal aanvragen, en de aanroeper ontvangt de rijen. De SQL, het schema en de inloggegevens verlaten uw account nooit.

Wat je nodig hebt

Een Query Streams-account

Elk abonnement bevat de REST API. Met het gratis abonnement krijg je één endpoint, twee sleutels en 250 rijen per aanroep, wat voldoende is om deze handleiding te maken. Meld je aan via mijn.querystreams.nl.

The Agent with your Application Logs file added as a connection

Nog niet klaar? Voeg het toe onder Gegevens → Gegevensagenten; dat duurt ongeveer tien minuten.

Een opgeslagen query in Query Builder

Het eindpunt omvat precies één opgeslagen query. Schrijf de SELECT-query, voer deze eenmaal uit en sla hem op. Voeg een dynamisch filter toe (een @variable (in de WHERE-clausule) als bellers moeten kunnen filteren.

Stel het in vier stappen in.

1. Sla de zoekopdracht op.

   In Querybouwer Kies je App Logs-verbinding, schrijf de SELECT-query die je wilt publiceren en voer deze eenmaal uit om de rijen te bekijken. Beperk je tot de kolommen die de aanroeper nodig heeft; het eindpunt retourneert precies wat de query retourneert.

   Opgeslagen query · fileset.events

   SELECT event_time, app, level, logger, message VAN fileset.events VOLGORDE DOOR event_time DESC LIMIET 100

   Als bellers moeten kunnen filteren, voeg dan bijvoorbeeld een dynamisch filter toe. WAAR niveau = @niveau. Elk @variable wordt een API-parameter in stap 3. Klik Sla en geef de query een naam; die naam wordt de weergavenaam van het eindpunt.

2. Maak het eindpunt aan.

   Open API klik in de bovenste balk Nieuw eindpuntDe tovenaar heeft vier stappen. Selecteer zoekopdracht, Configureren, Vergrendelingsparameters en Delen. Op Selecteer zoekopdrachtKlik op de query die u zojuist hebt opgeslagen; queries waarvan de agent offline is, worden grijs weergegeven. Klik Volgende.

   Open API

   Snelkoppeling. Vanuit de querybuilder kunt u de geopende query direct weergeven; de wizard start dan bij Configureren waarbij de zoekopdracht al is gekozen.

3. Parameters configureren en vergrendelen

   Op Configureren De standaardinstellingen zijn correct voor een eerste eindpunt: Weergavenaam ingevuld op basis van de zoekopdracht, Levensduur Permanent (kies Verloopt (voor een tijdelijk aandeel), Reactiemodus Statisch (één JSON-antwoord; selecteer Streaming voor resultaten die de statische rijlimiet van uw plan overschrijden). Binnenindeling JSON. De responsmodus en -indeling worden vastgelegd zodra de respons is aangemaakt, dus bepaal ze hier. Klik Volgende.

   Op Vergrendelingsparameters Alle dynamische filters in de query worden weergegeven. Laat de filters die bellers kunnen instellen ongewijzigd. Oproepbaar en geef elk een Naam van de queryreeks; vinkje Vereist Als een oproep zonder deze waarde zou mislukken, stel dan een waarde in die de beller niet mag wijzigen. Vergrendeld, of een datumscenario zoals Begin van de maand. Verborgen behoudt de standaardwaarde van de query zelf en weigert elke poging om deze in te stellen. Klik Volgende.

4. Deel en ontvang je sleutel

   Op Delen je kunt uitnodigen Mensen via e-mail of voeg een toe Servicesleutel voor een server of een automatiseringstool, of sla beide voorlopig over. Klik Maak mijn sleutel aan en ontvang deze.Het succesenscherm toont de endpoint-URL en uw sleutel: een tekenreeks van 49 tekens die begint met qsapi_Kopieer het. Je kunt het later weer weergeven via het eindpunt. Delen tab, zodat het niet verloren gaat als je het scherm sluit.

   Klik op Versturen in de console om de eerste oproep vanuit het portaal zelf te doen. Het antwoordvenster toont Status, Tijd en Maat, de Lichaam Het tabblad toont de JSON en de oproep verschijnt op de Activiteit tab een paar seconden later.

Bel het vanaf elke locatie

Vervang de endpoint-ID door die van jou uit de adresbalk van de console en qsapi_UW_SLEUTEL met uw sleutel. Aanroepbare parameters worden in de queryreeks van een GET-verzoek geplaatst; hier wordt de opgeslagen query weergegeven. niveau:

curl "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19?level=Seattle" \ -H "X-API-Key: qsapi_YOUR_KEY"

{
  "kolommen": [ { "naam": "event_time", "type": "geheel getal" }, { "naam": "app", "type": "snaar" }, { "naam": "niveau", "type": "snaar" } ],
  "rijen": [
    { "event_time": 1042, "app": "Northwind Traders", "niveau": "Seattle" },
    { "event_time": 1057, "app": "Alpine Outfitters", "niveau": "Denver" },
    { "event_time": 1063, "app": "Harbour Foods", "niveau": "Halifax" }
  ],
  "meta": { "rij_aantal": 3, "agent_duration_ms": 41, "verzoek_id": "req_7Hq2mKd9" }
}

De rijen worden geretourneerd als objecten, gesleuteld op kolomnaam, met de kolomlijst en een meta Een blok dat aangeeft hoeveel rijen er zijn, of het resultaat is afgekapt en de aanvraag-ID die je kunt gebruiken ter ondersteuning. Dezelfde aanroep als een POST-verzoek plaatst de parameters in een JSON-body, wat de juiste keuze is voor lange lijsten met waarden:

curl -X POST "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19" \ -H "X-API-Key: qsapi_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"params": {"level": "Seattle"}}'

?format=csv

CSV in plaats van JSON, inclusief kopregel. Accepteren: tekst/csv doet hetzelfde. Streaming-eindpunten retourneren NDJSON (één JSON-object per regel) met een eindpunt {"_summary": true, "row_count": N} regel; controleer die laatste regel.

?sample=true

Maximaal vijf rijen, niet gefactureerd. Handig voor het aansluiten van een klant.

compressie=lz4

Een LZ4-frame behuizing voor apparaten met een hoog belvolume en een decoder; Code Het tabblad bevat het decoderfragment per taal. Standaard gzip wordt automatisch toegepast wanneer uw client een bericht verzendt. Accept-Encoding: gzip.

Autorisatie: Drager qsapi_…

Geaccepteerd als alias voor X-API-sleutelGebruik het vanuit de browsercode.

Waar het aangesloten wordt

Wat de plannen toestaan

Elke aanroep heeft een vaste time-out van 60 seconden voor de query en een maximale responsgrootte van 8 MiB. De geretourneerde bytes tellen mee voor je maandelijkse datalimiet, dezelfde limiet die de Excel- en Google Sheets-invoegtoepassingen gebruiken. De gratis versie heeft één eindpunt en 5 MB per maand, wat ruim voldoende is voor een kleine tabel die meerdere keren per dag wordt opgevraagd. Bekijk de prijspagina. voor de vergoedingen per plan.

Het veilig bewaren

Als iets niet werkt

Elk foutlichaam heeft de vorm {"error": {"code": "…", "message": "…"}} en elk antwoord bevat een X-QS-Request-Id koptekst. Vermeld het ID tussen aanhalingstekens wanneer u contact opneemt met de supportafdeling.

Vragen die mensen stellen

Gerelateerde handleidingen

• Verbind toepassingslogboeken met Claude via MCP
• Database REST API: maak van elke SQL-query een eindpunt
• Microsoft SQL Server REST API
• PostgreSQL REST API
• MySQL REST API
• Snowflake REST API