spotlight
This page explains how to use the spotlight function in APL to compare a selected set of events against a baseline and surface the most significant differences.
Spotlight lets you set up an analysis inside a query. You define a comparison set of events and compare it to the implicit baseline (the rest of the events in scope). Spotlight evaluates every field you pass in, scores differences, and returns the most informative contrasts. You use it when you want fast root-cause analysis, anomaly investigation, or pattern discovery without hand-rolling many ad-hoc aggregations.
Spotlight is useful when you:
- Investigate spikes or dips in a time series and want to know what changed
- Explain why a subset of traces is slow or error-prone
- Find which attributes distinguish suspicious requests from normal traffic
This page explains the Spotlight APL function. For more information about how Spotlight works in the Axiom Console, see Spotlight.
Usage
Syntax
summarize spotlight(SelectionPredicate, Field1, Field2, ..., FieldN)You use spotlight inside summarize. The first argument defines the comparison set. The remaining arguments list the fields to analyze.
Parameters
| Name | Type | Description |
|---|---|---|
SelectionPredicate | Boolean expression | Defines the comparison set (selected cohort). Spotlight compares events where the predicate evaluates to true against the baseline (events where it evaluates to false) within the current query scope. |
Field1 ... FieldN | field references | One or more fields to analyze. Include string or categorical fields (for proportions) and numeric or timespan fields (for distributional differences). Use * as a wildcard to analyze all fields. |
Returns
- Bar charts for categorical fields (strings, Booleans)
- Boxplots for numeric fields (integers, floats, timespans) with many distinct values
Use case examples
Find what distinguishes error responses from normal traffic in the last 15 minutes.
Query
This query keeps the last 15 minutes of traffic in scope and compares error responses to everything else. Spotlight ranks the strongest differences, pointing to endpoints, regions, and latency ranges associated with the errors.
Explain why some spans are slow or erroring in the last 30 minutes.
Query
The query compares spans that ran longer than 500 ms to all other spans in the time window. Spotlight highlights the service, kind, and duration range that most distinguish the selected spans.
Best practices
- Keep the
wherescope broad enough that the baseline remains meaningful. Over-filtering reduces contrast. - Pass only fields that carry signal. Very high-cardinality identifiers can drown out more actionable attributes.
- Include numeric fields like
req_duration_msordurationto let Spotlight detect distribution shifts, not just categorical skews.
List of related functions
- where: Filters events before Spotlight runs. Use it to scope the time window or dataset; use
spotlightto compare selected vs baseline inside that scope. - summarize: Runs aggregations over events.
spotlightis an aggregation you call withinsummarize. - top: Returns the most frequent values. Use
topfor simple frequency counts; usespotlightto contrast a cohort against its baseline with lift and significance. - lookup: Enriches events with reference attributes. Use
lookupto add context before runningspotlightacross enriched fields.