Quickstart

Set up your workspace, monitored standards, a project, an API key and the SDK, in that order.

This quickstart takes you from a new account to live request data in Nolax. Most teams finish it in under an hour.

Do the steps in this order:

Create your account and company workspace
Configure monitored standards
Create a project
Provision and secure the project API key
Register APIs and environments
Start monitoring, reporting, and alert workflows

Note

Complete monitored standards setup before generating reports or schedules.

Create account and company workspace

Start with one engineering owner and one operations or compliance owner.

For detailed team setup guidance, see Account and Team Setup.

Select monitored standards first

Go to Settings → Monitored Standards and enable the standards your team is accountable to.

Warning

Until you enable a standard, compliance reports and the posture score are limited.

See Monitored Standards for how plans affect this setting.

Create your first project

Go to Projects → New Project. A project should map to one team's ownership boundary. Then register APIs with an environment label.

Provision and secure the project API key

A project key is a production credential. Keep it in a secret manager, pass it to the service as an environment variable, and rotate it on a schedule.

See API Keys and Rotation.

In each project, register your most important APIs and label each one production, staging or development. Alerts and insights use the label to separate production incidents from test noise.

Instrument your services with the SDK

Install the SDK for your stack:


npm install @nolax/sdk

Then add the middleware or filter, reading the key from NOLAX_API_KEY:


import express from 'express'
import { nolax } from '@nolax/sdk'

const app = express()

app.use(nolax({ apiKey: process.env.NOLAX_API_KEY, environment: 'production' }))

Run monitoring workflows

Check that data is arriving, create an alert rule and generate a compliance report. The First Hour Checklist lists each task.

Metadata captured by the SDK

The SDK records these fields for each request:

Field	Description
`method`	HTTP method (`GET`, `POST`)
`path`	Route template or raw path
`statusCode`	Response status code
`responseTime`	Latency in ms
`payloadSize`	Response `Content-Length` in bytes
`ip`	Client IP (if available)
`userAgent`	`User-Agent` header
`timestamp`	ISO 8601 timestamp

Note

The SDK never captures request or response bodies.

Next steps

1
First Hour Checklist
Use this once your workspace and first project are in place.
2
Account and Team Setup
Set up ownership, invites, and day-one roles.
3
Monitored Standards
Confirm which standards and checks matter to your team.
4
Projects and API Registration
Learn the project boundary and API registration flow.
5
API Keys and Rotation
Set up key rotation for ongoing credential security.