Quickstart
Make a project, copy its ingest key, send a first event and find it in the dashboard.
Lyrelog is a hosted service, in early access by invitation. Ask for access at
lyrelog.com; the invitation link lets you make your account. The dashboard
lives at app.lyrelog.com, and apps send their events to
https://ingest.lyrelog.com.
Name your first project
After you make your account, the dashboard opens on Welcome. Give the project a name and say what sends its events: an iOS or macOS app, a website, a Node, Python or Go service, or anything else over HTTP. Your choice picks the snippet you see next and the project's platform.
Make one project per app. If the app also has a website and a backend, they can all send to the same project (see Platforms). Later projects come from Projects and New project. Only an owner of the organization can make projects.
Copy the ingest key
Right after you make the project, Lyrelog shows its ingest key, lyr_ing_..., and the lines to
paste into your app. Copy the key now: only a hash of it is stored, so it can't be shown again.
If you lose it, make a new one on the project's API keys page.
The ingest key can only send events, never read them, so it is safe to ship inside an app. See Keys. A backend should send with a server key instead (Send events from a server, on the API keys page), whose events are verified.
Send a first event
The SDKs aren't published yet
The SDKs for Swift, Android, React Native, Flutter, JavaScript, Python, Go and the JVM can't be installed yet. For now, send your first event with curl, or from any language over the HTTP API.
In a macOS or Linux terminal (it uses uuidgen and date), replace lyr_ing_... with your key
and run:
curl -X POST https://ingest.lyrelog.com/v1/events:batch \
-H "Authorization: Bearer lyr_ing_..." \
-H "Content-Type: application/x-ndjson" \
--data-binary "{\"event_id\":\"$(uuidgen | tr A-Z a-z)\",\"ts\":\"$(date -u +%Y-%m-%dT%H:%M:%SZ)\",\"message\":\"hello_lyrelog\",\"resource\":{\"environment\":\"production\"}}"Every event needs a new UUID as event_id and the current time as ts. An event whose ts is
older than the project's retention, or more than a day ahead, isn't lost: it is stored at the time
it arrived, and the time it was sent goes in the attribute _lyrelog_ts_clamped. The answer says
how many lines were stored:
{"accepted":1,"rejected":[]}Anything else? See No events arrive.
See it arrive
The Welcome page waits for the first event and says so when it arrives. Open the project from
there: the Events page lists hello_lyrelog. Click it to see the whole event.
Not there?
The dashboard shows one environment at a time and opens on the project's default,
production. The SDKs send development from a build you run in Xcode, from the simulator,
from a page on localhost, and from Node unless NODE_ENV=production is set, so your first
events from an SDK are under development: pick it, or All environments, in the top bar.
The curl above sets "environment":"production"; an event sent without
resource.environment is stored as production too. See
Environments.
Read it from a script (optional)
On the project's API keys page, choose New key, set What it can do to Read events,
and copy the lyr_read_... key. Making a read key asks you to sign in again if your last sign-in
was more than 10 minutes ago. Keep it on a server: it reads every event of the project.
export LYRELOG_READ_KEY=lyr_read_...
curl -s -G https://app.lyrelog.com/v1/events \
-H "Authorization: Bearer $LYRELOG_READ_KEY" \
--data-urlencode "message=hello_lyrelog"See the Read API.
Next
Apps
Web and servers
Anything else
- Learn what makes a good event: Events.
- Something not working: No events arrive.