Files
spigot-event-producer/design/user-stories/us-001-configure-event-producer.md
dmg c76ea5b434
CI / build (push) Successful in 3m35s
Release / release (push) Successful in 4m6s
docs(design): add user story knowledge bundle
2026-08-08 12:31:15 -04:00

25 lines
1.2 KiB
Markdown

---
type: User Story
title: "US-001: Configure the event producer"
description: Allow a server operator to identify a Minecraft server and tune event capture and delivery safely.
status: done
---
# US-001: Configure the event producer
As a **Minecraft server operator**, I want to configure the producer for my server and ingest service so that emitted events are identifiable and fit my operating limits.
## Acceptance criteria
- [x] A human-readable server name and stable server UUID can be configured.
- [x] When no server UUID is supplied, the plugin generates one and persists it for later starts.
- [x] The ingest URL, send interval, snapshot interval, HTTP timeout, batch limits, dispatch thresholds, statistic chunk size, and per-tick statistic budget are configurable.
- [x] Blank required values, non-positive limits, overlong server names, invalid UUIDs, and statistic chunks without sufficient batch headroom prevent initialization.
- [x] Initialization errors are logged and leave the plugin disabled rather than partially running.
## Related
- [US-002: Produce standard CloudEvents](us-002-produce-standard-cloud-events.md)
- [US-005: Deliver events durably](us-005-deliver-events-durably.md)
- [Configuration reference](../../README.md#configuration)