Skip to content
Skill

configure-nightwatch

by laravel

AI Summary

This skill helps configure Laravel Nightwatch data collection to balance observability, performance, and privacy. Covers sampling strategies, filtering rules, and redaction methods across all event types. The Nightwatch Documentation is the definitive and up-to-date source of information for all Nig

Install

Copy this and paste it into Claude Code, Cursor, or any AI assistant:

I want to install the "configure-nightwatch" skill in my project.

Please run this command in my terminal:
# Install skill into your project (2 files)
mkdir -p .claude/skills/configure-nightwatch && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/configure-nightwatch/SKILL.md "https://raw.githubusercontent.com/laravel/agent-skills/main/laravel-nightwatch/skills/configure-nightwatch/SKILL.md" && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/configure-nightwatch/reference.md "https://raw.githubusercontent.com/laravel/agent-skills/main/laravel-nightwatch/skills/configure-nightwatch/reference.md"

Then restart Claude Code (or reload the window in Cursor) so the skill is picked up.

Description

Configures Laravel Nightwatch data collection, sampling rates, filtering rules, and redaction policies. Use when setting up Nightwatch, managing data volume, protecting sensitive data (PII), or optimizing event collection for production workloads.

Nightwatch Configuration Guide

This skill helps configure Laravel Nightwatch data collection to balance observability, performance, and privacy. Covers sampling strategies, filtering rules, and redaction methods across all event types.

Documentation Reference

The Nightwatch Documentation is the definitive and up-to-date source of information for all Nightwatch configuration options. This skill provides practical guidance and common patterns, but always consult the official documentation as the primary source of truth for specific details, environment variables, and API behavior. The documentation includes comprehensive coverage of: • Filtering and Configuration - Core concepts for sampling, filtering, and redaction • Individual event type pages with specific configuration options: • Requests - Request sampling, header handling, payload capture • Commands - Command sampling and redaction • Queries - Query filtering and redaction • Cache - Cache event filtering by key or pattern • Jobs - Job filtering and sampling decoupling • Mail - Mail event filtering • Notifications - Notification filtering by channel • Exceptions - Exception sampling and throttling • Outgoing Requests - HTTP request filtering • reference.md - Quick lookup table by event type, production presets, and verification checklist

Data Collection Flow

Nightwatch processes events through three stages: • Sampling - Controls which entry points are captured (requests, commands, scheduled tasks) • Filtering - Excludes specific events after sampling (queries, cache, mail, etc.) • Redaction - Modifies captured data to remove/obfuscate sensitive information ` Request/Command/Scheduled Task | v [Sampling?] ----NO----> Drop entire trace | YES v Events generated | v [Filtering?] ----YES---> Drop specific event | NO v [Redaction] ----------> Store modified data ` ---

Sampling Configuration

Sampling determines which entry points (requests, commands, scheduled tasks) trigger full trace collection. When an entry point is sampled, all related events are captured.

Discussion

0/2000
Loading comments...

Health Signals

MaintenanceCommitted 7d ago
Active
Adoption100+ stars on GitHub
576 ★ · Growing
DocsREADME + description
Well-documented

GitHub Signals

Stars576
Forks21
Issues0
Updated7d ago
View on GitHub
No License

My Fox Den

Community Rating

Sign in to rate this booster

Works With

Claude Code