API Metrics: Track Custom Pipeline Metrics

​

Overview

​

Prerequisites

• A connected GitHub or GitLab integration, with the repository you want to track synced to Corelayer
• Node.js 18 or later (the SDK uses the built-in fetch)

​

Onboarding

​

1. Create an API key

1. In your Corelayer dashboard, go to Settings > API Keys
2. Click Create Key
3. Give it a name (for example Production ETL) and choose an expiration — never, 30, 60, or 90 days, or 1 year
4. Click Create
5. Copy the key immediately. It starts with cl_live_ and is shown only once.

​

2. Set the environment variables

export CORELAYER_API_KEY="cl_live_your_api_key_here"
export CORELAYER_BASE_URL="https://api.corelayer.com"

​

3. Install the SDK

npm install @corelayer-ai/sdk

​

4. Create the rule in the dashboard

1. Go to Anomaly Rules and click Add
2. Under Codebases, pick the repository
3. Click Add API metric
4. Fill in the configuration:
   • Anomaly rule name — a human-readable label, for example Daily Order Volume
   • Expected cadence — how often your application sends this metric (hourly, daily, weekly, monthly)
   • Detector — which statistical method scores the metric. Baseline is the default; see Detectors.
   • Minimum data points — how many observations to learn before flagging. Leave blank for the detector default.
5. Copy the Metric ID and the SDK snippet from the page
6. Click Save

​

5. Instrument your code

import { CorelayerClient } from '@corelayer-ai/sdk';

const client = new CorelayerClient({
  apiKey: process.env.CORELAYER_API_KEY,
  baseUrl: process.env.CORELAYER_BASE_URL,
});

client.trackMetric({
  metricId: "<your-metric-id>",
  partitions: [
    { keys: { "region": "us-east-1", "table": "orders" }, value: 1523 },
  ],
  timestamp: "2025-01-15T00:00:00Z",
});

// Call at process exit to flush remaining metrics
await client.shutdown();

• metricId — the UUID from step 4. Identifies which rule this data belongs to.
• partitions — an array of partition entries. Each has keys (an object of key/value pairs identifying the partition) and value (the numeric measurement). Each unique key combination gets its own baseline.
• timestamp — an ISO 8601 timestamp. Optional; defaults to now. Pass it explicitly for batch jobs so reruns bucket correctly.

​

6. Deploy and monitor

1. Collect observations to build a baseline for each partition — the rule shows Collecting
2. Switch to active monitoring once a partition has enough data — it shows Ready
3. Flag observations that fall outside the expected band

​

Client Configuration

​

Environment Variables Reference

​

Viewing Metrics

​

Rule listing

​

Rule detail page

• Stat cards — partitions observed, baselines ready, and anomalies detected in the selected range
• Time range selector — presets scaled to the rule’s cadence (an hourly rule offers 1d/3d/7d, a daily rule 7d/14d/30d, a weekly rule 90d/6mo/1y, a monthly rule 6mo/1y/2y)
• Partition Inspector — a searchable, paginated list of partitions showing mean, min, and max with a sparkline. Select one to load its chart, baseline state, and findings.
• Anomaly findings — findings for the selected partition

​

Anomaly findings

• Severity — Critical, High, Medium, Low, or Info
• Detector — which method produced it
• Observed vs. Expected — the actual value against what the baseline predicted
• Expected range — the bounds that were breached
• Timestamp — when it was detected
• Linked issue — if the finding opened a Corelayer issue, a link to it and whether it is still open

​

Tips

• Use descriptive partition keys — keys like region, pipeline, or table_name make findings easier to diagnose.
• Set explicit timestamps for batch jobs — this keeps data bucketed correctly, even during reruns.
• Call client.shutdown() — always flush before your process exits, or the last batch is lost.
• One rule per logical measurement — keep Order Volume and Payment Processing Time as separate rules rather than mixing them.
• Do not over-partition — every unique key combination needs enough observations of its own to train. Too many partitions means none of them reach Ready.

​

Managing Rules

​

Changing the detector or cadence

​

Deleting rules

​

Rotating API keys

1. Go to Settings > API Keys
2. Click the rotate icon next to the key
3. Copy the new key and update CORELAYER_API_KEY
4. The old key is revoked immediately