# Documentation

- [FAQ](/docs/faq): Answers to common questions about installing, configuring, and running Eventum.
- [Glossary](/docs/glossary): Definitions of key terms and concepts used throughout the Eventum documentation.
- [Getting started](/docs): Learn how Eventum works and generate your first events in minutes.
- [Overview](/docs/api): Eventum API reference
- [Overview](/docs/core): A map of the Core documentation — from installation to mastery.
- [What's Next](/docs/core/whats-next): You've covered the core of Eventum — here's where to go from here depending on what you want to do next.
- [🎉 2.0.0](/docs/changelog/2.0.0): Eventum 2.0 release notes — a complete rewrite with new plugins, a web UI, batch processing, and structured logging.
- [🛠️ 2.0.1](/docs/changelog/2.0.1): Eventum 2.0.1 patch release — CLI params fix, pydantic validation fix, expanded test coverage, and CI improvements.
- [🛠️ 2.0.2](/docs/changelog/2.0.2): Eventum 2.0.2 patch release — fix for reading generator configs with placeholders via API.
- [🚩 2.1.0](/docs/changelog/2.1.0): Eventum 2.1.0 minor release — performance boost, named sample access, placeholder support in Studio, and bug fixes.
- [🚩 2.2.0](/docs/changelog/2.2.0): Eventum 2.2.0 minor release — systemd service management, weighted sampling, per-template variables, and new random distributions.
- [🚩 2.3.0](/docs/changelog/2.3.0): Eventum 2.3.0 minor release — Kafka, TCP, and UDP output plugins, free-threaded Python 3.14t, multithreaded architecture.
- [🛠️ 2.3.1](/docs/changelog/2.3.1): Eventum 2.3.1 patch release — fix Docker image failing to start.
- [🚩 2.4.0](/docs/changelog/2.4.0): Eventum 2.4.0 — Scenarios, instance metrics, Home page, State management.
- [🚩 2.5.0](/docs/changelog/2.5.0): Eventum 2.5.0 — Template dispatch API, random IPv4 in CIDR subnet.
- [🚩 2.6.0](/docs/changelog/2.6.0): Eventum 2.6.0 — MCP server for AI agents, new template randomization helpers, sample filtering.
- [Formatters](/docs/plugins/formatters): Formatter reference — how output plugins serialize events before delivery, with all available formats, parameters, and examples.
- [Overview](/docs/plugins): Plugin reference for Eventum — the full list of input, event, and output plugins with links to their parameter documentation.
- [Eventum Studio](/docs/studio): The built-in web interface for managing generators, editing configs, debugging events, and monitoring performance — all from your browser.
- [Instances](/docs/studio/instances): Managing generator instances in Studio — the instance table, lifecycle controls, metrics dialog, and log viewer.
- [Monitoring](/docs/studio/monitoring): Real-time system monitoring — resource gauges, event flow statistics, throughput charts, and instance status.
- [Overview](/docs/studio/overview): The Studio home screen — quick access to projects, instances, scenarios, and the Eventum Hub.
- [Projects](/docs/studio/projects): Generator projects in Studio — the project list, the visual plugin editor with input preview, event debugger, output formatter testing, and file management.
- [Scenarios](/docs/studio/scenarios): Group generator instances into named scenarios for coordinated lifecycle control, global state management, and data flow visualization.
- [Settings and management](/docs/studio/settings): Application settings, secrets management, and server lifecycle controls in Eventum Studio.
- [E-Commerce Transactions → CSV](/docs/tutorials/csv-dataset): Generate a shaped CSV dataset of purchases, refunds, and chargebacks for analytics, database seeding, or ML training.
- [Tutorials](/docs/tutorials): Step-by-step walkthroughs that build complete Eventum projects from scratch — covering real-world use cases, every plugin type, and production patterns.
- [IoT Sensor Telemetry](/docs/tutorials/iot-telemetry): Stream continuous sensor readings with realistic drift and noise as NDJSON — no server setup required.
- [API Load Testing](/docs/tutorials/load-testing): Stress-test a REST API with diverse, realistic request payloads at maximum throughput using sample mode.
- [SIEM: Windows Security Events → OpenSearch](/docs/tutorials/siem-events): Generate realistic Windows Security Event Log data and index it into OpenSearch for SIEM rule development and detection testing.
- [Scheduled Telegram Alerts](/docs/tutorials/telegram-alerts): Simulate a monitoring system that sends alert notifications to a Telegram chat on a cron schedule.
- [Web Clickstream → ClickHouse](/docs/tutorials/web-clickstream): Model user browsing sessions with a finite state machine and stream page views into ClickHouse for funnel analysis.
- [Connect your agent](/docs/mcp/connect): How to connect any MCP client to Eventum, for local authoring or live management.
- [How it works](/docs/mcp/how-it-works): How the agent builds a generator and checks it works on Eventum, where the server runs, and what keeps it safe.
- [Overview](/docs/mcp): Connect an AI agent to Eventum over the Model Context Protocol, and have it build and run synthetic-data generators from a plain-language description.
- [Usage scenarios](/docs/mcp/scenarios): Worked examples of using the Eventum MCP server — build a generator from a description, manage live generators, and diagnose a failing run.
- [Tools & resources](/docs/mcp/tools): Every tool the agent can call, every resource it can read, and the guided prompts it can run.
- [List Generator Dirs](/docs/api/generator-configs/get): undefined
- [List Generators](/docs/api/generators/get): undefined
- [List Scenarios](/docs/api/scenarios/get): undefined
- [Get Generators In Startup](/docs/api/startup/get): undefined
- [List Secret Names](/docs/api/secrets/get): undefined
- [$ eventum generate](/docs/core/cli/eventum-generate): Run a single generator from the command line — all options, verbosity levels, signal handling, and exit codes.
- [$ eventum-keyring](/docs/core/cli/eventum-keyring): Manage encrypted secrets — set, get, and remove credentials stored in the keyring cryptfile.
- [$ eventum mcp](/docs/core/cli/eventum-mcp): Run Eventum as a Model Context Protocol server over stdio so an AI agent can build, validate, and preview generators.
- [$ eventum run](/docs/core/cli/eventum-run): Run Eventum as a full application — web server, REST API, multiple generators, and hot reload.
- [$ eventum service](/docs/core/cli/eventum-service): Install, uninstall, and check status of Eventum as a systemd service.
- [eventum.yml](/docs/core/config/eventum-yml): Full schema reference for the main application configuration file — server, logging, paths, and default generation parameters.
- [generator.yml](/docs/core/config/generator-yml): Schema reference for the generator configuration file — the three-stage pipeline structure, variable substitution, and available plugins.
- [Parameters](/docs/core/config/parameters): How to pass runtime values into generator configs via startup.yml entries to keep configurations reusable across environments.
- [Project structure](/docs/core/config/project-structure): How Eventum projects are organized — application-level files, generator directories, and the relationship between them.
- [Secrets](/docs/core/config/secrets): How to store and use encrypted credentials in generator configs — the eventum-keyring CLI, the cryptfile, and the ${secrets.*} substitution syntax.
- [startup.yml](/docs/core/config/startup-yml): Full schema reference for the startup configuration file — generator entries, per-generator parameter overrides, and the parameter cascade from eventum.yml.
- [Generator](/docs/core/concepts/generator): The central building block of Eventum — a self-contained pipeline that turns timestamps into events and delivers them to one or more destinations.
- [Outputting events](/docs/core/concepts/output): How output plugins deliver events — formatters, concurrent writes, fan-out delivery, and error tracking.
- [Plugins](/docs/core/concepts/plugins): The plugin system that powers every stage of the generator pipeline — types, configuration, lifecycle, and how to choose the right plugin for each job.
- [Producing events](/docs/core/concepts/producing): How event plugins turn timestamps into event strings — the template context, picking modes, state management, and practical examples.
- [Scheduling](/docs/core/concepts/scheduling): How timestamps flow from input plugins through the pipeline — merging, batching, wall-clock alignment, and practical scheduling patterns.
- [Features](/docs/core/introduction/features): An overview of what Eventum can do — from Jinja2 templates and flexible scheduling to multiple outputs and a built-in web UI.
- [First run](/docs/core/introduction/first-run): Run your first generator from the command line, then launch the full application with API and web UI.
- [Installation](/docs/core/introduction/installation): Install Eventum as a Python package, run it with Docker, or build from source.
- [Requirements](/docs/core/introduction/requirements): Supported platforms, Python version, and resource usage for running Eventum.
- [replay](/docs/plugins/event/replay): Event plugin that replays events from an existing log file, optionally replacing timestamps.
- [script](/docs/plugins/event/script): Event plugin that runs a Python function to produce events with full programmatic control.
- [cron](/docs/plugins/input/cron): Input plugin that generates timestamps on a cron schedule with second-level precision.
- [http](/docs/plugins/input/http): Input plugin that opens an HTTP endpoint for on-demand timestamp generation.
- [linspace](/docs/plugins/input/linspace): Input plugin that distributes timestamps evenly across a time range.
- [static](/docs/plugins/input/static): Input plugin that emits a fixed number of timestamps all at once.
- [time_patterns](/docs/plugins/input/time-patterns): Input plugin that generates timestamps using statistical distributions and oscillators to mimic real traffic patterns.
- [timer](/docs/plugins/input/timer): Input plugin that generates timestamps at a fixed interval.
- [timestamps](/docs/plugins/input/timestamps): Input plugin that emits timestamps from a predefined list or a file.
- [clickhouse](/docs/plugins/output/clickhouse): Output plugin that inserts events into a ClickHouse table via the HTTP interface.
- [file](/docs/plugins/output/file): Output plugin that writes events to a local file with auto-reopen and rotation support.
- [http](/docs/plugins/output/http): Output plugin that sends events to any HTTP endpoint with batching, TLS, and proxy support.
- [kafka](/docs/plugins/output/kafka): Output plugin that produces events to Apache Kafka topics.
- [opensearch](/docs/plugins/output/opensearch): Output plugin that indexes events into an OpenSearch cluster using the bulk API.
- [stdout](/docs/plugins/output/stdout): Output plugin that writes events to the console or stderr.
- [tcp](/docs/plugins/output/tcp): Output plugin that sends events over a raw TCP socket connection with optional TLS support.
- [udp](/docs/plugins/output/udp): Output plugin that sends events as UDP datagrams to a remote host.
- [Login](/docs/api/auth/login/post): undefined
- [Get Current User](/docs/api/auth/me/get): undefined
- [Logout](/docs/api/auth/logout/post): undefined
- [Delete Generator Config](/docs/api/generator-configs/name/delete): undefined
- [Get Generator Config](/docs/api/generator-configs/name/get): undefined
- [Create Generator Config](/docs/api/generator-configs/name/post): undefined
- [Update Generator Config](/docs/api/generator-configs/name/put): undefined
- [Delete Generator](/docs/api/generators/id/delete): undefined
- [Get Generator](/docs/api/generators/id/get): undefined
- [Add Generator](/docs/api/generators/id/post): undefined
- [Update Generator](/docs/api/generators/id/put): undefined
- [Get Info](/docs/api/instance/info/get): undefined
- [Restart](/docs/api/instance/restart/post): undefined
- [Get Settings](/docs/api/instance/settings/get): undefined
- [Update Settings](/docs/api/instance/settings/put): undefined
- [Stop](/docs/api/instance/stop/post): undefined
- [Delete Scenario](/docs/api/scenarios/name/delete): undefined
- [Get Scenario](/docs/api/scenarios/name/get): undefined
- [Delete Generator From Startup](/docs/api/startup/id/delete): undefined
- [Get Generator From Startup](/docs/api/startup/id/get): undefined
- [Add Generator To Startup](/docs/api/startup/id/post): undefined
- [Update Generator In Startup](/docs/api/startup/id/put): undefined
- [Delete Secret Value](/docs/api/secrets/name/delete): undefined
- [Get Secret Value](/docs/api/secrets/name/get): undefined
- [Set Secret Value](/docs/api/secrets/name/put): undefined
- [Dispatch](/docs/plugins/event/template/dispatch): Control whether an event is produced, skipped, or generation is stopped.
- [Examples](/docs/plugins/event/template/examples): Complete template plugin configuration examples — vars reuse, samples, state, and cross-template correlation.
- [FSM](/docs/plugins/event/template/fsm): Finite state machine transitions, conditions, logic operators, and complete examples.
- [template](/docs/plugins/event/template): Event plugin that renders Jinja2 templates with Faker, Mimesis, random helpers, state management, and multiple picking modes.
- [Modes](/docs/plugins/event/template/modes): Template picking modes — all, any, chance, spin, chain, and fsm.
- [Modules](/docs/plugins/event/template/modules): Data-generation libraries available in Jinja2 templates — rand, faker, mimesis, and any Python module.
- [Samples](/docs/plugins/event/template/samples): Named datasets (items, CSV, JSON) loaded at startup and accessible in Jinja2 templates.
- [State](/docs/plugins/event/template/state): Persistent state scopes (locals, shared, globals) in Jinja2 templates.
- [Subprocess](/docs/plugins/event/template/subprocess): Execute shell commands from Jinja2 templates.
- [Copy Generator File](/docs/api/generator-configs/name/file-copy/post): undefined
- [Move Generator File](/docs/api/generator-configs/name/file-move/post): undefined
- [Get Generator File Tree](/docs/api/generator-configs/name/file-tree/get): undefined
- [Get Generator Config Path](/docs/api/generator-configs/name/path/get): undefined
- [Start Generator](/docs/api/generators/id/start/post): undefined
- [Get Generator Stats](/docs/api/generators/id/stats/get): undefined
- [Get Generator Status](/docs/api/generators/id/status/get): undefined
- [Stop Generator](/docs/api/generators/id/stop/post): undefined
- [Bulk Delete Generators](/docs/api/generators/group-actions/bulk-delete/post): undefined
- [Bulk Start Generators](/docs/api/generators/group-actions/bulk-start/post): undefined
- [Get Running Generators Stats](/docs/api/generators/group-actions/stats-running/get): undefined
- [Bulk Stop Generators](/docs/api/generators/group-actions/bulk-stop/post): undefined
- [Release Event Plugin](/docs/api/preview/name/event-plugin/delete): undefined
- [Initialize Event Plugin](/docs/api/preview/name/event-plugin/post): undefined
- [Clear Scenario Global State](/docs/api/scenarios/name/globals/delete): undefined
- [Get Scenario Global State](/docs/api/scenarios/name/globals/get): undefined
- [Update Scenario Global State](/docs/api/scenarios/name/globals/patch): undefined
- [Bulk Delete Generators From Startup](/docs/api/startup/group-actions/bulk-delete/post): undefined
- [Delete Generator File](/docs/api/generator-configs/name/file/filepath/delete): undefined
- [Get Generator File](/docs/api/generator-configs/name/file/filepath/get): undefined
- [Upload Generator File](/docs/api/generator-configs/name/file/filepath/post): undefined
- [Put Generator File](/docs/api/generator-configs/name/file/filepath/put): undefined
- [Create Generator Directory](/docs/api/generator-configs/name/file-makedir/filepath/post): undefined
- [Produce Events](/docs/api/preview/name/event-plugin/produce/post): undefined
- [Generate Timestamps](/docs/api/preview/name/input-plugins/generate/post): undefined
- [Format Events](/docs/api/preview/name/formatter/format/post): undefined
- [Normalize Versatile Datetime](/docs/api/preview/name/versatile-datetime/normalize/post): undefined
- [Remove Generator From Scenario](/docs/api/scenarios/name/generators/generator_id/delete): undefined
- [Add Generator To Scenario](/docs/api/scenarios/name/generators/generator_id/post): undefined
- [Delete Scenario Global State Key](/docs/api/scenarios/name/globals/key/delete): undefined
- [Get Scenario Global State Key](/docs/api/scenarios/name/globals/key/get): undefined
- [Get globals usage for a generator in a scenario](/docs/api/scenarios/name/generators/generator_name/globals-usage/get): undefined
- [Clear Template Event Plugin Global State](/docs/api/preview/name/event-plugin/template/state/global/delete): undefined
- [Get Template Event Plugin Global State](/docs/api/preview/name/event-plugin/template/state/global/get): undefined
- [Update Template Event Plugin Global State](/docs/api/preview/name/event-plugin/template/state/global/patch): undefined
- [Clear Template Event Plugin Shared State](/docs/api/preview/name/event-plugin/template/state/shared/delete): undefined
- [Get Template Event Plugin Shared State](/docs/api/preview/name/event-plugin/template/state/shared/get): undefined
- [Update Template Event Plugin Shared State](/docs/api/preview/name/event-plugin/template/state/shared/patch): undefined
- [Clear Template Event Plugin Local State](/docs/api/preview/name/event-plugin/template/state/local/alias/delete): undefined
- [Get Template Event Plugin Local State](/docs/api/preview/name/event-plugin/template/state/local/alias/get): undefined
- [Update Template Event Plugin Local State](/docs/api/preview/name/event-plugin/template/state/local/alias/patch): undefined
- [Delete Template Event Plugin Global State Key](/docs/api/preview/name/event-plugin/template/state/global/key/delete): undefined
- [Delete Template Event Plugin Shared State Key](/docs/api/preview/name/event-plugin/template/state/shared/key/delete): undefined
- [Delete Template Event Plugin Local State Key](/docs/api/preview/name/event-plugin/template/state/local/alias/key/delete): undefined