Function: Profiling and performance
Every function response includes profiling data with phase-level timing and resource usage.
Profiling
const microlink = require('@microlink/function')
const fn = microlink(({ page }) => page.title())
const result = await fn('https://example.com')
console.log(result.profiling)
// {
// phases: { install: 0, build: 120, spawn: 45, run: 890, total: 1055 },
// cpu: 234,
// memory: 8,
// size: 156
// }| Field | Description |
|---|---|
phases.install | Time spent installing npm dependencies (0 when none are used) |
phases.build | Time spent bundling the function code |
phases.spawn | Time spent starting the isolated process |
phases.run | Time spent executing the function |
phases.total | Wall-clock time from start to finish |
cpu | Peak CPU time in milliseconds |
memory | Peak memory usage in MB |
size | Bundled code size in bytes |
Use profiling to understand where time is spent. If install is high, your dependencies are being installed for the first time — subsequent runs use the cache. If run is high, the function itself is doing heavy work.
Plan limits
The function parameter is available on both free and pro plans:
| Free | Pro | |
|---|---|---|
| Timeout | 5 seconds | Up to 28 seconds |
| Memory | 16 MB | 32 MB |
| Code size | 1024 bytes | Unlimited |
| Concurrency | 1 per IP | Unlimited |
The free plan is enough to prototype workflows and run the examples in this guide. For production workloads that need more time or memory, or parameters such as
headers, proxy, ttl, or staleTtl, use a pro plan.To authenticate, pass your API key:
const microlink = require('@microlink/function')
const fn = microlink(
({ page }) => page.title(),
{},
{ headers: { 'x-api-key': 'YOUR_API_KEY' } }
)
const result = await fn('https://example.com')See the authentication and rate limit docs for endpoint and quota details.
Skip metadata
Most function-only workflows do not need normalized metadata. Set
meta: false to skip it:const microlink = require('@microlink/function')
const fn = microlink(({ page }) => page.title(), { meta: false })
const result = await fn('https://example.com')Disabling metadata is usually the biggest speedup for function requests. If you still need the rendered markup, call
page.content() inside the function.Compress large functions
When using MQL directly, large function bodies can be compressed before sending. The
@microlink/function library handles compression automatically, but if you prefer the raw MQL approach:const { compressToURI } = require('lz-ts')
const mql = require('@microlink/mql')
const code = ({ page }) => page.title()
const { data } = await mql('https://example.com', {
function: `lz#${compressToURI(code.toString())}`,
meta: false
})
console.log(data.function.value)Prefix the compressed payload with the algorithm alias:
lz# for lz-string, br# for brotli, gz# for gzip.Optimization checklist
- Set
meta: falseunless you need normalized metadata — this is usually the biggest win. - Use
page.title()andpage.$eval()instead ofpage.evaluate()when possible — they are faster and easier to debug. - Replace fixed waits like
page.waitForTimeout(3000)withpage.waitForSelector()— they resolve as soon as the element appears. - Check
result.profiling.phasesto find the bottleneck — a high install on first run is normal, but a high run means the function itself needs work. - Minimize dependencies — each
require()adds install and build time. Use only what you need.
See also
- Troubleshooting — error handling, resource errors, and debugging.
- Common caching patterns — reduce cost and improve response speed.
- Function reference — response shape, plan limits, and compression.