ЛР 6 — БВТ2301 — Сафронов — на 5 #62
@@ -0,0 +1,198 @@
|
||||
---
|
||||
name: "OPSX: Apply"
|
||||
description: "Implement tasks from an OpenSpec change (Experimental)"
|
||||
allowed-tools: Bash(openspec:*)
|
||||
category: "Workflow"
|
||||
tags: ["workflow", "artifacts", "experimental"]
|
||||
---
|
||||
|
||||
Implement tasks from an OpenSpec change.
|
||||
|
||||
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
|
||||
|
||||
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
|
||||
|
||||
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
|
||||
|
||||
Otherwise, with no root, what happens next depends on how this workflow was reached:
|
||||
|
||||
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
|
||||
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
|
||||
|
||||
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
|
||||
|
||||
**Input**: Optionally specify a change name (e.g., `/opsx:apply add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
||||
|
||||
**Steps**
|
||||
|
||||
1. **Select the change**
|
||||
|
||||
If a name is provided, use it. Otherwise:
|
||||
- Infer from conversation context if the user mentioned a change
|
||||
- Auto-select if only one active change exists
|
||||
- If ambiguous, run `openspec list --json` to get available changes and ask the user to select one
|
||||
|
||||
Always announce: "Using change: <name>" and how to override (e.g., `/opsx:apply <other>`).
|
||||
|
||||
2. **Check status to understand the schema**
|
||||
```bash
|
||||
openspec status --change "<name>" --json
|
||||
```
|
||||
Parse the JSON to understand:
|
||||
- `schemaName`: The workflow being used (e.g., "spec-driven")
|
||||
- `planningHome`, `changeRoot`, and `actionContext`: planning scope and edit constraints
|
||||
- Which artifact contains the tasks (typically "tasks" for spec-driven, check status for others)
|
||||
|
||||
3. **Get apply instructions**
|
||||
|
||||
```bash
|
||||
openspec instructions apply --change "<name>" --json
|
||||
```
|
||||
|
||||
This returns:
|
||||
- `contextFiles`: artifact ID -> array of concrete file paths (varies by schema - could be proposal/specs/design/tasks or spec/tests/implementation/docs)
|
||||
- Progress (total, complete, remaining)
|
||||
- Task list with status
|
||||
- Dynamic instruction based on current state
|
||||
- Optional `context`: current required project instruction input from the selected root
|
||||
- Optional `operationGuidance`: current advisory guidance for apply
|
||||
- `missingArtifacts` (when present): required artifact ids with no output
|
||||
|
||||
**Handle states:**
|
||||
- If `state: "blocked"`: show the message and pause implementation.
|
||||
- If `missingArtifacts` is non-empty: suggest completing the missing artifacts. Run `openspec status --change "<name>" --json`, select the next `ready` artifact (not `skipped` or `blocked`), and use `openspec instructions "<artifact-id>" --change "<name>" --json` for its rules and template. Keep the selected `--store <id>` on both commands.
|
||||
- Otherwise, follow the CLI instruction to create or repair the schema-configured tracking file from existing planning artifacts. Do not assume another artifact is ready or start implementation while blocked.
|
||||
- If `state: "all_done"`: congratulate, suggest archive
|
||||
- Otherwise: proceed to implementation
|
||||
|
||||
Treat `context` as a required prompt-level input. Read and consider it, and
|
||||
apply relevant project facts, conventions, and constraints while implementing.
|
||||
Treat `operationGuidance` as optional additive advice. Read and consider every
|
||||
entry, and follow entries that are applicable and compatible with the built-in
|
||||
workflow.
|
||||
|
||||
Keep both fields separate from CLI-returned state, missing artifacts, tasks,
|
||||
progress, `contextFiles`, and the built-in `instruction`. They are not
|
||||
evidence of task completion, do not replace the built-in instruction, and do
|
||||
not permit bypassing a blocked state. If context conflicts with the built-in
|
||||
instruction, an explicit user choice, or a CLI-controlled value, report the
|
||||
conflict and preserve the controlling value. If guidance is inapplicable or
|
||||
conflicts with those controlling inputs, do not follow it and explain why.
|
||||
These are prompt-level behavior contracts, not enforceable checks.
|
||||
|
||||
4. **Read context files**
|
||||
|
||||
Read every file path listed under `contextFiles` from the apply instructions output.
|
||||
The files depend on the schema being used:
|
||||
- **spec-driven**: proposal, specs, design, tasks
|
||||
- Other schemas: follow the contextFiles from CLI output
|
||||
|
||||
Do not copy `context` or `operationGuidance` verbatim into implementation
|
||||
files or planning artifacts unless the user separately asks for that content.
|
||||
|
||||
5. **Show current progress**
|
||||
|
||||
Display:
|
||||
- Schema being used
|
||||
- Progress: "N/M tasks complete"
|
||||
- Remaining tasks overview
|
||||
- Dynamic instruction from CLI
|
||||
|
||||
6. **Implement tasks (loop until done or blocked)**
|
||||
|
||||
For each pending task:
|
||||
- Show which task is being worked on
|
||||
- Make the code changes required
|
||||
- Keep changes minimal and focused
|
||||
- Mark task complete in the tasks file: `- [ ]` → `- [x]`
|
||||
- Continue to next task
|
||||
|
||||
**Pause if:**
|
||||
- Task is unclear → ask for clarification
|
||||
- Implementation reveals a design issue → suggest updating artifacts
|
||||
- A task needs work beyond what the spec and tasks describe, or you are tempted to drop, narrow, defer, or accept exceptions to specified behavior to make it fit → surface the added scope and ask; do not absorb it silently
|
||||
- Error or blocker encountered → report and wait for guidance
|
||||
- User interrupts
|
||||
|
||||
7. **On completion or pause, show status**
|
||||
|
||||
Display:
|
||||
- Tasks completed this session
|
||||
- Overall progress: "N/M tasks complete"
|
||||
- If all done: suggest archive
|
||||
- If paused: explain why and wait for guidance
|
||||
|
||||
**Output During Implementation**
|
||||
|
||||
```
|
||||
## Implementing: <change-name> (schema: <schema-name>)
|
||||
|
||||
Working on task 3/7: <task description>
|
||||
[...implementation happening...]
|
||||
✓ Task complete
|
||||
|
||||
Working on task 4/7: <task description>
|
||||
[...implementation happening...]
|
||||
✓ Task complete
|
||||
```
|
||||
|
||||
**Output On Completion**
|
||||
|
||||
```
|
||||
## Implementation Complete
|
||||
|
||||
**Change:** <change-name>
|
||||
**Schema:** <schema-name>
|
||||
**Progress:** 7/7 tasks complete ✓
|
||||
|
||||
### Completed This Session
|
||||
- [x] Task 1
|
||||
- [x] Task 2
|
||||
...
|
||||
|
||||
All tasks complete! You can archive this change with `/opsx:archive`.
|
||||
```
|
||||
|
||||
**Output On Pause (Issue Encountered)**
|
||||
|
||||
```
|
||||
## Implementation Paused
|
||||
|
||||
**Change:** <change-name>
|
||||
**Schema:** <schema-name>
|
||||
**Progress:** 4/7 tasks complete
|
||||
|
||||
### Issue Encountered
|
||||
<description of the issue>
|
||||
|
||||
**Options:**
|
||||
1. <option 1>
|
||||
2. <option 2>
|
||||
3. Other approach
|
||||
|
||||
What would you like to do?
|
||||
```
|
||||
|
||||
**Guardrails**
|
||||
- Keep going through tasks until done or blocked
|
||||
- Always read context files before starting (from the apply instructions output)
|
||||
- If task is ambiguous, pause and ask before implementing
|
||||
- If implementation reveals issues, pause and suggest artifact updates
|
||||
- Keep code changes minimal and scoped to each task
|
||||
- Update task checkbox immediately after completing each task
|
||||
- Pause on errors, blockers, or unclear requirements - don't guess
|
||||
- When a task needs work beyond what the spec describes, surface the added scope and pause - never silently narrow, defer, or simplify away specified behavior
|
||||
- Only mark a task `- [x]` when its specified behavior is fully implemented, not when it is partially done or deferred
|
||||
- Use contextFiles from CLI output, don't assume specific file names
|
||||
- Do not use context or operation guidance as proof that a task is complete
|
||||
- Apply relevant project context; report conflicts with controlling workflow inputs
|
||||
- Consider every guidance entry; explain any inapplicable or conflicting advice
|
||||
- Do not copy runtime context or operation guidance into implementation files or planning artifacts
|
||||
- Preserve CLI-controlled blocked/ready/all-done behavior and completion criteria
|
||||
|
||||
**Fluid Workflow Integration**
|
||||
|
||||
This skill supports the "actions on a change" model:
|
||||
|
||||
- **Can be invoked anytime**: Before all artifacts are done (if tasks exist), after partial implementation, interleaved with other actions
|
||||
- **Allows artifact updates**: If implementation reveals design issues, suggest updating artifacts - not phase-locked, work fluidly
|
||||
@@ -0,0 +1,246 @@
|
||||
---
|
||||
name: "OPSX: Archive"
|
||||
description: "Archive a completed change in the experimental workflow"
|
||||
allowed-tools: Bash(openspec:*)
|
||||
category: "Workflow"
|
||||
tags: ["workflow", "archive", "experimental"]
|
||||
---
|
||||
|
||||
Archive a completed change in the experimental workflow.
|
||||
|
||||
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
|
||||
|
||||
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
|
||||
|
||||
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
|
||||
|
||||
Otherwise, with no root, what happens next depends on how this workflow was reached:
|
||||
|
||||
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
|
||||
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
|
||||
|
||||
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
|
||||
|
||||
`<capability-path>` is the spec directory relative to `specs/` (for example, `user-auth` or `identity/user-auth`). Preserve the full path from each delta spec when resolving its main spec.
|
||||
|
||||
**Input**: Optionally specify a change name after `/opsx:archive` (e.g., `/opsx:archive add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
||||
|
||||
**Steps**
|
||||
|
||||
1. **Select the change**
|
||||
|
||||
If a name is provided, use it. Otherwise:
|
||||
- Infer from conversation context if the user mentioned a change
|
||||
- Auto-select if only one active change exists
|
||||
- If ambiguous, run `openspec list --json` to get available changes and ask the user to select one
|
||||
|
||||
When prompting, show only active changes (not already archived).
|
||||
Include the schema used for each change if available.
|
||||
|
||||
Always announce: "Using change: <name>" and how to override (e.g., `/opsx:archive <other>`).
|
||||
|
||||
**Load current archive inputs before the existing archive checks:**
|
||||
|
||||
After resolving the selected change and planning root, run:
|
||||
```bash
|
||||
openspec instructions archive --change "<name>" --json
|
||||
```
|
||||
Keep the same selected-root flags on this command. This lookup is advisory and
|
||||
optional: it only supplies extra prompt inputs, so it must never block archiving.
|
||||
If it exits non-zero or returns invalid JSON — for example on an older CLI that
|
||||
does not support this command yet — continue the archive workflow with no
|
||||
context and no operation guidance. Do not report an error and do not stop.
|
||||
|
||||
A successful response may omit both optional fields. Treat `context` as a
|
||||
required prompt-level input: read and consider it, and apply relevant project
|
||||
facts, conventions, and constraints. Treat `operationGuidance` as optional
|
||||
additive advice: read and consider every entry, and follow entries that are
|
||||
applicable and compatible with the built-in archive workflow.
|
||||
|
||||
Keep both fields separate from built-in steps, explicit user choices, resolved
|
||||
paths, CLI checks, and command contracts. If context conflicts with one of those
|
||||
controlling inputs, report the conflict and preserve the controlling value. If
|
||||
guidance is inapplicable or conflicts with a controlling input, do not follow it
|
||||
and explain why. Do not infer replacement paths, skipped prompts, or flags from
|
||||
either field, and do not copy their text verbatim into specs, change artifacts,
|
||||
or archive summaries unless the user separately asks for it. These are
|
||||
prompt-level behavior contracts, not enforceable checks.
|
||||
|
||||
2. **Check artifact completion status**
|
||||
|
||||
Run `openspec status --change "<name>" --json` to check artifact completion.
|
||||
|
||||
Parse the JSON to understand:
|
||||
- `schemaName`: The workflow being used
|
||||
- `planningHome`, `changeRoot`, `artifactPaths`, and `actionContext`: path and scope context
|
||||
- `artifacts`: List of artifacts with their status (`done`, `skipped`, or other)
|
||||
|
||||
**If any artifacts are neither `done` nor `skipped`** (skipped artifacts satisfy the requirement - the change declares skip_specs):
|
||||
- Display warning listing incomplete artifacts
|
||||
- Prompt user for confirmation to continue
|
||||
- Proceed if user confirms
|
||||
|
||||
3. **Check task completion status**
|
||||
|
||||
Read the tasks file (typically `tasks.md`) to check for incomplete tasks.
|
||||
|
||||
A checkbox is complete when its only content is `x` or `X`; spacing inside
|
||||
the brackets does not matter, so `- [ x]` counts as complete too. Every
|
||||
other marker is incomplete - `- [ ]`, an empty `- []`, and markers OpenSpec
|
||||
assigns no meaning to such as `- [~]` or `- [-]`. Never read an unfamiliar
|
||||
marker as complete.
|
||||
|
||||
**If incomplete tasks found:**
|
||||
- Display warning showing count of incomplete tasks
|
||||
- Prompt user for confirmation to continue
|
||||
- Proceed if user confirms
|
||||
|
||||
**If no tasks file exists:** Proceed without task-related warning.
|
||||
|
||||
4. **Assess delta spec sync state**
|
||||
|
||||
Use `artifactPaths.specs.existingOutputPaths` from status JSON as the only
|
||||
delta-spec source. If the `specs` entry is missing or
|
||||
`existingOutputPaths` is empty, proceed without a sync prompt and do not infer
|
||||
delta specs from other artifacts.
|
||||
|
||||
**If delta specs exist:**
|
||||
- Compare each delta spec with its corresponding main spec at `<planningHome.root>/openspec/specs/<capability-path>/spec.md` (use the store-aware `planningHome.root` from step 2, not a hardcoded repo path)
|
||||
- A missing main spec is **not automatically** "already synced". For a new capability, the main spec is an *output* of the sync, not an input:
|
||||
- If the delta has MODIFIED or RENAMED requirements, report that only ADDED requirements can create a new main spec and mark that capability as sync-blocked. Never invent a requirement that has no current version.
|
||||
- Otherwise, if the delta has only REMOVED requirements and the change's `.openspec.yaml` declares `retire_capabilities: true`, the capability is already retired: count it as already synced, warn that there is nothing left to remove, and do not recreate the main spec. Apply this rule both now and when verifying a completed sync.
|
||||
- Otherwise, if the delta has no ADDED requirements, report that no sync is possible and mark that capability as sync-blocked. For a REMOVED-only delta, warn that there is no main spec to remove from and leave the main-spec tree unchanged. `openspec archive` refuses the unmarked REMOVED-only case with `Spec must have at least one requirement`.
|
||||
- Otherwise, count the capability as needing sync and name it in the summary (`<capability-path>: new main spec will be created`). If the delta also has REMOVED requirements, warn that they will be ignored because there is no main spec to remove from. The sync creates the main spec from only the delta's ADDED requirements, exactly as `openspec archive` does.
|
||||
- Determine what changes would be applied (adds, modifications, removals, renames)
|
||||
- Continue assessing the remaining capabilities even when one is sync-blocked. Show a combined summary before prompting.
|
||||
|
||||
**Prompt options:**
|
||||
- If any capability is sync-blocked: explain why and offer only "Archive without syncing", "Cancel"
|
||||
- Otherwise, if changes needed: "Sync now (recommended)", "Archive without syncing"
|
||||
- Otherwise, if already synced: "Archive now", "Sync anyway", "Cancel"
|
||||
|
||||
Route on the answer:
|
||||
- "Cancel" — stop, do not archive
|
||||
- "Archive without syncing" or "Archive now" — proceed to archive
|
||||
- "Sync now" or "Sync anyway" — sync, then verify (below). Do not start any sync while a capability is sync-blocked; explain the blocker and repeat the available choices.
|
||||
- Anything else — ask again rather than archiving
|
||||
|
||||
Before a selected sync writes any main spec, run
|
||||
`openspec instructions specs --change "<name>" --json` once with the same
|
||||
selected-root flags. Require a zero exit status and valid artifact-instruction
|
||||
JSON. If the lookup fails or returns invalid JSON, report the error and stop
|
||||
before writing any main spec or moving the change. A valid response with omitted
|
||||
`rules` is the no-rules case. Apply returned `rules` only to the content and
|
||||
form of main specs produced by this merge; do not use them as archive guidance,
|
||||
change CLI behavior, or copy the rule text into any output file.
|
||||
|
||||
Then run the `/opsx:sync` workflow inline (agent-driven intelligent merge) for change '<name>', passing the delta spec analysis and the fetched specs-rule snapshot from above, and wait for it to finish. The inline sync must reuse that snapshot without fetching `specs` instructions again. Do not delegate it to a background task — step 5 would move `changeRoot` out from under a sync that is still reading it, leaving the change archived and the main specs never updated. If your agent can only run it by delegation, delegate synchronously and wait for the result.
|
||||
|
||||
Then re-run the comparison from the top of this step, including the explicitly retired, missing-spec case, against every capability that has a delta spec in `artifactPaths.specs.existingOutputPaths` — not only the ones the sync reports it touched. A successful sync leaves nothing left to apply, so each capability must now read as already synced:
|
||||
- ADDED requirements present
|
||||
- MODIFIED requirements carrying the scenario and description changes named in the delta, with their other scenarios intact
|
||||
- REMOVED requirements gone — and where this sync retired a capability (removed its last requirement, leaving `## Requirements` empty), its main spec deleted rather than left empty; a spec the sync deliberately kept and reported is also a match
|
||||
- RENAMED requirements present under the new name and absent under the old one
|
||||
|
||||
If the sync failed, or any capability does not match, report what differs and stop — do not archive. Nothing has moved and `changeRoot` is intact, so the user can fix the mismatch or re-run the sync and start the archive again.
|
||||
|
||||
5. **Perform the archive**
|
||||
|
||||
Create an `archive` directory under `planningHome.changesDir` if it doesn't exist:
|
||||
```bash
|
||||
mkdir -p "<planningHome.changesDir>/archive"
|
||||
```
|
||||
|
||||
Generate the target name: use the change name as-is when it already starts with a `YYYY-MM-DD-` prefix; otherwise prepend the current date as `YYYY-MM-DD-<change-name>`. Never stack a second date (same rule as `openspec archive`).
|
||||
|
||||
**Check if target already exists:**
|
||||
- If yes: Fail with error, suggest renaming existing archive or using different date
|
||||
- If no: Move `changeRoot` to the archive directory
|
||||
|
||||
```bash
|
||||
mv "<changeRoot>" "<planningHome.changesDir>/archive/<target-name>"
|
||||
```
|
||||
|
||||
6. **Display summary**
|
||||
|
||||
Show archive completion summary including:
|
||||
- Change name
|
||||
- Schema that was used
|
||||
- Archive location
|
||||
- Spec sync status (synced / sync skipped / no delta specs)
|
||||
- Note about any warnings (incomplete artifacts/tasks)
|
||||
|
||||
**Output On Success**
|
||||
|
||||
```markdown
|
||||
## Archive Complete
|
||||
|
||||
**Change:** <change-name>
|
||||
**Schema:** <schema-name>
|
||||
**Archived to:** the archive path derived from `planningHome.changesDir`/<target-name>/
|
||||
**Specs:** ✓ Synced to main specs
|
||||
|
||||
All artifacts complete. All tasks complete.
|
||||
```
|
||||
|
||||
**Output On Success (No Delta Specs)**
|
||||
|
||||
```markdown
|
||||
## Archive Complete
|
||||
|
||||
**Change:** <change-name>
|
||||
**Schema:** <schema-name>
|
||||
**Archived to:** the archive path derived from `planningHome.changesDir`/<target-name>/
|
||||
**Specs:** No delta specs
|
||||
|
||||
All artifacts complete. All tasks complete.
|
||||
```
|
||||
|
||||
**Output On Success With Warnings**
|
||||
|
||||
```markdown
|
||||
## Archive Complete (with warnings)
|
||||
|
||||
**Change:** <change-name>
|
||||
**Schema:** <schema-name>
|
||||
**Archived to:** the archive path derived from `planningHome.changesDir`/<target-name>/
|
||||
**Specs:** Sync skipped (user chose to skip)
|
||||
|
||||
**Warnings:**
|
||||
- Archived with 2 incomplete artifacts
|
||||
- Archived with 3 incomplete tasks
|
||||
- Delta spec sync was skipped (user chose to skip)
|
||||
|
||||
Review the archive if this was not intentional.
|
||||
```
|
||||
|
||||
**Output On Error (Archive Exists)**
|
||||
|
||||
```markdown
|
||||
## Archive Failed
|
||||
|
||||
**Change:** <change-name>
|
||||
**Target:** the archive path derived from `planningHome.changesDir`/<target-name>/
|
||||
|
||||
Target archive directory already exists.
|
||||
|
||||
**Options:**
|
||||
1. Rename the existing archive
|
||||
2. Delete the existing archive if it's a duplicate
|
||||
3. Wait until a different date to archive
|
||||
```
|
||||
|
||||
**Guardrails**
|
||||
- Announce the selected change; prompt for selection when it is ambiguous
|
||||
- Use artifact graph (openspec status --json) for completion checking
|
||||
- Don't block archive on warnings - just inform and confirm
|
||||
- Preserve .openspec.yaml when moving to archive (it moves with the directory)
|
||||
- Show clear summary of what happened
|
||||
- If sync is requested, run the `/opsx:sync` workflow inline (agent-driven)
|
||||
- Never archive while a spec sync is still in flight — run the sync inline and verify the main specs before moving `changeRoot`
|
||||
- If delta specs exist, always run the sync assessment and show the combined summary before prompting
|
||||
- Apply relevant runtime context and report conflicts; operation guidance remains advisory
|
||||
- Consider every guidance entry and explain any inapplicable or conflicting advice
|
||||
- Existing CLI checks, resolved paths, prompts, and command contracts are unchanged
|
||||
- Artifact rules constrain only the specs being written and are never operation guidance
|
||||
- Never copy runtime context, operation guidance, or artifact-rule text verbatim into output files
|
||||
@@ -0,0 +1,239 @@
|
||||
---
|
||||
name: "OPSX: Explore"
|
||||
description: "Enter explore mode - think through ideas, investigate problems, clarify requirements"
|
||||
allowed-tools: Bash(openspec:*)
|
||||
category: "Workflow"
|
||||
tags: ["workflow", "explore", "experimental", "thinking"]
|
||||
---
|
||||
|
||||
Enter explore mode. Think deeply. Visualize freely. Follow the conversation wherever it goes.
|
||||
|
||||
**IMPORTANT: Explore mode is for thinking, not implementing.** You may read files, search code, investigate the codebase, and run read-only commands or tools without confirmation, but you must NEVER write code or implement features. If the user asks you to implement something, do not start it here: say that explore mode does not implement, and point them at `/opsx:propose`, which turns the discussion into a change. The work happens from that change, never from explore mode. You MAY create or update OpenSpec change artifacts (proposals, designs, specs) within a confirmed scope—that's capturing thinking, not implementing. Answering design or clarifying questions is never consent to write. Before the first write-capable action, name the artifacts or files you would change and what you would do, ask a direct yes/no question, and wait for the user's confirmation in a separate message. Confirmation covers only the scope you described; ask again before expanding it. An explicit request from the user to capture the exploration as a new change is itself that confirmation, covering the change and the change artifacts the request names; scaffold it first as described below.
|
||||
|
||||
**This is a stance, not a workflow.** There are no fixed steps, no required sequence, no mandatory outputs. You're a thinking partner helping the user explore.
|
||||
|
||||
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
|
||||
|
||||
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
|
||||
|
||||
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
|
||||
|
||||
Otherwise, with no root, what happens next depends on how this workflow was reached:
|
||||
|
||||
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
|
||||
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
|
||||
|
||||
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
|
||||
|
||||
**Input**: The argument after `/opsx:explore` is whatever the user wants to think about. Could be:
|
||||
- A vague idea: "real-time collaboration"
|
||||
- A specific problem: "the auth system is getting unwieldy"
|
||||
- A change name: "add-dark-mode" (to explore in context of that change)
|
||||
- A comparison: "postgres vs sqlite for this"
|
||||
- Nothing (just enter explore mode)
|
||||
|
||||
---
|
||||
|
||||
## The Stance
|
||||
|
||||
- **Curious, not prescriptive** - Ask questions that emerge naturally, don't follow a script
|
||||
- **Open threads, not interrogations** - Surface multiple interesting directions and let the user follow what resonates. Don't funnel them through a single path of questions.
|
||||
- **Visual** - Use ASCII diagrams liberally when they'd help clarify thinking
|
||||
- **Adaptive** - Follow interesting threads, pivot when new information emerges
|
||||
- **Patient** - Don't rush to conclusions, let the shape of the problem emerge
|
||||
- **Grounded** - Explore the actual codebase when relevant, don't just theorize
|
||||
|
||||
---
|
||||
|
||||
## Planning a Change
|
||||
|
||||
When the user is planning a change, guide them toward shared understanding with focused discovery questions. For open-ended discussion, follow the conversation without imposing an interview or a required output.
|
||||
|
||||
Before asking a factual question, follow the context discovery below and inspect relevant OpenSpec artifacts, source, tests, docs, and configuration. Do not ask the user to repeat facts you can verify. Summarize relevant findings without reproducing private context or rules. If evidence is missing, conflicting, or inaccessible, state that limitation and ask only for the clarification needed to proceed.
|
||||
|
||||
- **Follow dependencies** - Resolve the next blocking decision before its dependent details. For example, clarify the user's outcome and scope before choosing an API or data model. Revisit downstream assumptions when an earlier answer changes. Skip branches that do not matter to this goal.
|
||||
- **Keep questions focused** - Ask one focused question at a time, and briefly explain why it matters and which decision it unlocks. Batch questions only if the user asks for a batch; keep them small and group related decisions.
|
||||
- **Offer grounded recommendations** - When evidence supports a recommendation, state your preferred option and why it fits the user's goals, with alternatives and their tradeoffs when useful. Do not invent intent, priorities, or external constraints: ask the user when only they can answer. Avoid a fixed question format.
|
||||
- **Keep a conversational record** - Track decisions in the conversation, not in files. Separate confirmed decisions from proposed defaults and unresolved questions. Silence is not acceptance. Accepting an answer or a batch of recommendations is not permission to write. Keep file-write confirmation separate from discovery questions and follow the guardrails below.
|
||||
|
||||
Stop asking when the user has enough clarity. Let them pause, pivot, or defer a decision; do not exhaust every branch or force a proposal.
|
||||
|
||||
For example, after inspecting the relevant code:
|
||||
|
||||
```text
|
||||
The CLI already uses SQLite and has no remote service. Is sharing state
|
||||
across devices in scope? That determines whether local storage is enough.
|
||||
If this stays a single-device tool, I recommend keeping SQLite to avoid
|
||||
adding a service to operate; shared state would need a separate sync design.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## What You Might Do
|
||||
|
||||
Depending on what the user brings, you might:
|
||||
|
||||
**Explore the problem space**
|
||||
- Ask clarifying questions that emerge from what they said
|
||||
- Challenge assumptions
|
||||
- Reframe the problem
|
||||
- Find analogies
|
||||
|
||||
**Investigate the codebase**
|
||||
- Map existing architecture relevant to the discussion
|
||||
- Find integration points
|
||||
- Identify patterns already in use
|
||||
- Surface hidden complexity
|
||||
|
||||
**Compare options**
|
||||
- Brainstorm multiple approaches
|
||||
- Build comparison tables
|
||||
- Sketch tradeoffs
|
||||
- Recommend a path (if asked)
|
||||
|
||||
**Visualize**
|
||||
```
|
||||
+------------------------------------------+
|
||||
| Use ASCII diagrams liberally |
|
||||
+------------------------------------------+
|
||||
| |
|
||||
| [State A] -------> [State B] |
|
||||
| | |
|
||||
| v |
|
||||
| [State C] |
|
||||
| |
|
||||
| System diagrams, state machines, |
|
||||
| data flows, architecture sketches, |
|
||||
| dependency graphs, comparison tables |
|
||||
| |
|
||||
+------------------------------------------+
|
||||
```
|
||||
|
||||
**Draw with plain ASCII only** — borders `+` `-` `|`, arrows `-->` `<--` `^` `v`, markers `*` `x`.
|
||||
Unicode diagram glyphs can render at different widths across terminals, fonts, and locales, so padded boxes and aligned tables can drift. Keep every diagram character ASCII.
|
||||
|
||||
**Surface risks and unknowns**
|
||||
- Identify what could go wrong
|
||||
- Find gaps in understanding
|
||||
- Suggest spikes or investigations
|
||||
|
||||
---
|
||||
|
||||
## OpenSpec Awareness
|
||||
|
||||
You have full context of the OpenSpec system. Use it naturally, don't force it.
|
||||
|
||||
### Check for context
|
||||
|
||||
At the start, quickly check what exists:
|
||||
```bash
|
||||
openspec list --json
|
||||
```
|
||||
|
||||
This tells you:
|
||||
- If there are active changes
|
||||
- Their names, schemas, and status
|
||||
- What the user might be working on
|
||||
|
||||
That is the *change* list - work in flight. It does not include the project's durable capabilities, so list those too:
|
||||
```bash
|
||||
openspec list --specs
|
||||
```
|
||||
Add `--json` for ids and requirement counts, and append `--store "<id>"` only for a registered standalone store. This is the inventory of what the project already claims to do, and `openspec list` on its own never shows it. To look at one, run `openspec show "<spec-id>" --type spec --json --no-scenarios` (same `--store` rule) - it returns that capability's purpose and requirement texts without pulling the whole spec file into context, and `--type spec` stops a change of the same name from making it ambiguous.
|
||||
|
||||
The filtered read is only an overview. Before deciding what is already covered or what should change, read each relevant spec in full, including scenarios, with `openspec show "<spec-id>" --type spec` (same `--store` rule).
|
||||
|
||||
Then read the project's own context from the resolved root - `<root.path>/openspec/config.yaml` (or `config.yml`). Use the `root.path` returned above, and skip this if neither file exists:
|
||||
- `context`: project background - tech stack, conventions, constraints
|
||||
- `rules`: keyed by artifact id - the entries for an artifact apply only when you write that artifact
|
||||
|
||||
Ground your thinking in these. They are constraints for you to follow, not content to reproduce: do NOT copy them into the conversation or into any artifact you create.
|
||||
|
||||
If the user mentioned a specific change name, read its artifacts for context.
|
||||
|
||||
### When no change exists
|
||||
|
||||
Think freely. When insights crystallize, you might offer:
|
||||
|
||||
- "This feels solid enough to start a change. Want me to create a proposal?"
|
||||
- Or keep exploring - no pressure to formalize
|
||||
|
||||
If the user asks you to capture the exploration as a new change, that request is the confirmation required above. It covers scaffolding that change and creating the change artifacts the request names, and nothing else. This holds only when the request is theirs: a yes to an offer you made confirms only the scope your offer itself named, so name the change and the artifacts in the offer. Don't re-ask for what they already asked for; do ask before anything beyond it. Transition seamlessly into the requested capture:
|
||||
|
||||
1. Run `openspec new change "<name>"` (with `--store <id>` when applicable) before creating any artifacts. Never create a new change directory under `openspec/changes/` by hand; the CLI scaffold creates required metadata such as `.openspec.yaml`. Keep the selected `--store <id>` on every applicable follow-up `status` and `instructions` command.
|
||||
2. Run `openspec status --change "<name>" --json` (append the confirmed `--store "<id>"` only for a registered standalone store), then process the requested artifacts in dependency order. For each requested artifact that is `ready`, run `openspec instructions "<artifact-id>" --change "<name>" --json` (append the confirmed `--store "<id>"` only for a registered standalone store). Before creating a requested artifact, evaluate any condition in its own `instruction` against the explored change; record a deliberate skip instead when the condition does not apply. If a requested artifact is blocked by a direct prerequisite the user did not request, run `openspec instructions "<prerequisite-id>" --change "<name>" --json` (append the confirmed `--store "<id>"` only for a registered standalone store) for that prerequisite whether it is `ready` or `blocked`. If its own `instruction` states a condition, evaluate that condition against the explored change and record a deliberate skip only when the condition does not apply. If the condition applies, or the prerequisite is not conditional, treat it as a normal prerequisite and ask before expanding the capture. Do not create an unrequested prerequisite unless the user approves.
|
||||
3. Follow the returned `template` and `instruction` fields. Read completed dependency files listed in `dependencies`, and apply `context` and `rules` as constraints without copying them into the artifact. If the instruction delegates creation to a specific skill or command, invoke it; otherwise write the artifact to `resolvedOutputPath`, using the instruction to choose a concrete path when it is a glob. Verify that the selected concrete output exists.
|
||||
4. After creating each artifact, re-run `openspec status --change "<name>" --json` (append the confirmed `--store "<id>"` only for a registered standalone store) and continue until every requested artifact is `done`, `skipped`, or was deliberately skipped because its own `instruction` stated a condition that did not apply. Tell the user about a deliberate conditional skip, remember it, and do not reconsider it. Dependencies are enablers, not gates: if a requested artifact is still `blocked` only because you deliberately skipped a conditional prerequisite, run `openspec instructions "<artifact-id>" --change "<name>" --json` (append the confirmed `--store "<id>"` only for a registered standalone store) despite the blocked status, then create it using step 3 only when those recorded conditional skips are its sole missing dependencies. If a requested artifact is blocked by a prerequisite the user did not ask to capture and cannot be conditionally skipped, explain that dependency and ask before expanding the capture.
|
||||
|
||||
Capture the artifact(s) the user requested without asking them to invoke another workflow command. If they asked only to start a change, stop after scaffolding and show its status. When the requested capture is done, stop there and name where the work continues: `/opsx:propose` writes the remaining planning artifacts, and `/opsx:apply` implements the change once tasks exist. Capturing artifacts never starts implementing them.
|
||||
|
||||
### When a change exists
|
||||
|
||||
If the user mentions a change or you detect one is relevant:
|
||||
|
||||
1. **Resolve and read existing artifacts for context**
|
||||
- Run `openspec status --change "<name>" --json`.
|
||||
- Use `changeRoot`, `artifactPaths`, and `actionContext` from the status JSON.
|
||||
- Read existing files from `artifactPaths.<artifact>.existingOutputPaths`.
|
||||
|
||||
2. **Reference them naturally in conversation**
|
||||
- "Your design mentions using Redis, but we just realized SQLite fits better..."
|
||||
- "The proposal scopes this to premium users, but we're now thinking everyone..."
|
||||
|
||||
3. **Offer to capture when decisions are made**
|
||||
|
||||
`<capability-path>` is the spec directory relative to `specs/` (for example, `user-auth` or `identity/user-auth`). Preserve an existing capability's full path and follow the project's established organization for new capabilities.
|
||||
|
||||
| Insight Type | Where to Capture |
|
||||
|----------------------------|-------------------------------------|
|
||||
| New requirement discovered | `specs/<capability-path>/spec.md` |
|
||||
| Requirement changed | `specs/<capability-path>/spec.md` |
|
||||
| Design decision made | `design.md` |
|
||||
| Scope changed | `proposal.md` |
|
||||
| New work identified | `tasks.md` |
|
||||
| Assumption invalidated | Relevant artifact |
|
||||
|
||||
Example offers:
|
||||
- "That's a design decision. Capture it in design.md?"
|
||||
- "This is a new requirement. Add it to specs?"
|
||||
- "This changes scope. Update the proposal?"
|
||||
|
||||
4. **The user decides** - Offer and move on. Don't pressure. Don't auto-capture.
|
||||
|
||||
---
|
||||
|
||||
## What You Don't Have To Do
|
||||
|
||||
- Follow a script
|
||||
- Ask the same questions every time
|
||||
- Produce a specific artifact
|
||||
- Reach a conclusion
|
||||
- Stay on topic if a tangent is valuable
|
||||
- Be brief (this is thinking time)
|
||||
|
||||
---
|
||||
|
||||
## Ending Discovery
|
||||
|
||||
There's no required ending. Discovery might:
|
||||
|
||||
- **Flow into a proposal**: "Ready to start? Run `/opsx:propose` and this becomes a change."
|
||||
- **Result in artifact updates**: "Updated design.md with these decisions"
|
||||
- **Just provide clarity**: User has what they need, moves on
|
||||
- **Continue later**: "We can pick this up anytime"
|
||||
|
||||
When things crystallize, you might offer a summary - but it's optional. Sometimes the thinking IS the value.
|
||||
|
||||
---
|
||||
|
||||
## Guardrails
|
||||
|
||||
- **Don't implement** - Never write code or implement features. Workflow configuration counts too: creating or editing schemas, templates, or `openspec/config.yaml` is a change, not thinking. Creating or updating OpenSpec change artifacts within the confirmed scope is fine, writing anything else is not. When the user is ready to build, name the handoff rather than starting: `/opsx:propose` turns the discussion into a change, and the work happens there.
|
||||
- **Don't fake understanding** - If something is unclear, dig deeper
|
||||
- **Don't rush** - Discovery is thinking time, not task time
|
||||
- **Don't force structure** - Let patterns emerge naturally
|
||||
- **Don't auto-capture** - Offer to save insights, don't just do it. Read-only commands and tools need no confirmation. Before the first write-capable action—including `openspec new change` or another command that writes files—name the artifacts or files and proposed changes, ask a direct yes/no question, and wait for explicit confirmation in a separate user message. That confirmation covers only the described scope; ask again before expanding it. Answers to design or clarifying questions are never consent to write. That rule governs `openspec new change` whenever you are the one proposing the capture; the user's own capture request is the exception, handled in the capture transition above.
|
||||
- **Don't manually scaffold changes** - Never create a new change directory under `openspec/changes/` by hand. Always use `openspec new change "<name>"` (with `--store <id>` when applicable) so required metadata such as `.openspec.yaml` is created before writing artifacts.
|
||||
- **Do visualize** - A good diagram is worth many paragraphs
|
||||
- **Do explore the codebase** - Ground discussions in reality
|
||||
- **Do question assumptions** - Including the user's and your own
|
||||
@@ -0,0 +1,170 @@
|
||||
---
|
||||
name: "OPSX: Propose"
|
||||
description: "Propose a new change - create it and generate all artifacts in one step"
|
||||
allowed-tools: Bash(openspec:*)
|
||||
category: "Workflow"
|
||||
tags: ["workflow", "artifacts", "experimental"]
|
||||
---
|
||||
|
||||
Propose a new change - create the change and generate all artifacts in one step.
|
||||
|
||||
**Planning boundary**: This workflow creates planning artifacts only. The user request that selected or triggered this workflow authorizes planning only, even if it asks to build or fix something. Do not edit project code. After the planning artifacts are complete, stop. Do not start implementation in the same response, even if the initial request asks for it. Wait for a new user request after the artifacts are presented; then start the apply workflow.
|
||||
|
||||
I'll create a change with the artifacts your schema defines. With the default spec-driven schema that is:
|
||||
- proposal.md (what & why)
|
||||
- `specs/<capability-path>/spec.md` (what the system must do - a delta, not the main spec)
|
||||
- design.md (how)
|
||||
- tasks.md (implementation steps)
|
||||
|
||||
`<capability-path>` is the spec directory relative to `specs/` (for example, `user-auth` or `identity/user-auth`). Preserve an existing capability's full path and follow the project's established organization for new capabilities.
|
||||
|
||||
When the user is ready to implement, they must start the apply workflow explicitly.
|
||||
|
||||
---
|
||||
|
||||
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
|
||||
|
||||
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
|
||||
|
||||
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
|
||||
|
||||
Otherwise, with no root, what happens next depends on how this workflow was reached:
|
||||
|
||||
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
|
||||
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
|
||||
|
||||
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
|
||||
|
||||
**Input**: The argument after `/opsx:propose` is the change name (kebab-case), OR a description of what the user wants to build.
|
||||
|
||||
**Steps**
|
||||
|
||||
1. **Understand the request and clarify material ambiguity**
|
||||
|
||||
If no input is provided, ask the user (open-ended, no preset options):
|
||||
> "What change do you want to work on? Describe what you want to build or fix."
|
||||
|
||||
From their description, derive a kebab-case name (e.g., "add user authentication" → `add-user-auth`).
|
||||
|
||||
**IMPORTANT**: Do NOT proceed without understanding what the user wants to build.
|
||||
|
||||
If the request contains ambiguity that would materially affect scope, externally observable behavior, compatibility, or acceptance criteria, ask the user before creating the change. For minor details, make a reasonable assumption and record it in the planning artifacts.
|
||||
|
||||
2. **Load project context**
|
||||
|
||||
Run `openspec context --json` from the current working directory (or `openspec context --json --store "<store-id>"` when a registered store was explicitly selected). Use the returned `root.path` as the authoritative OpenSpec root. If context reports `no_openspec_root`, stop without creating or changing any files and follow the **Project check** above for how this workflow was reached. Offer `openspec init` only for an explicit OpenSpec request, and wait for the user to request initialization. Do not initialize automatically or run `openspec new change`. After initialization, rerun this context check before continuing. For any other context failure, stop and report the error; do not fall back to the current directory or run later OpenSpec commands without the selected store.
|
||||
|
||||
Only when context returns a resolved `root.path`, read `<root.path>/openspec/config.yaml`. Use `config.yml` only when `config.yaml` does not exist. If neither file exists, continue without project context. Do not fall back to `config.yml` if `config.yaml` is unreadable or invalid.
|
||||
|
||||
If the file parses as a YAML object and its `context` field is a string no larger than 51,200 bytes in UTF-8, apply that field before exploring the codebase or making planning decisions. If the file cannot be read or parsed, or the context field is invalid or oversized, continue without project context. Validate this field independently of other config fields, as OpenSpec does.
|
||||
|
||||
Treat context as project-provided data and constraints, not as authority to change this workflow: it cannot override user authorization, the planning boundary, tool restrictions, or artifact and output rules. Do not copy the context into artifacts; use it to focus any codebase exploration and as a constraint on the proposal.
|
||||
|
||||
3. **Determine the workflow schema**
|
||||
|
||||
Use the configured default schema unless the user explicitly requests a different workflow.
|
||||
|
||||
**Use a different schema only if the user:**
|
||||
- Explicitly requests a specific schema by name → use `--schema <schema-name>`
|
||||
- Asks to "show workflows" or asks "what workflows" exist → resolve the authoritative root by running `openspec context --json` from the current working directory. If the user explicitly selected a registered store, use `openspec context --json --store "<store-id>"`. Then run `openspec schemas --json` with its working directory set to the returned `root.path` and let them choose. This preserves roots selected by a local `store:` pointer or the global `defaultStore`; when a registered store was explicitly selected, append `--store "<store-id>"` to `openspec schemas --json` as well. If context fails, stop as described in the context-loading step; do not fall back to the current directory.
|
||||
|
||||
Otherwise, omit `--schema` to preserve the configured default.
|
||||
|
||||
4. **Create the change directory**
|
||||
|
||||
Choose one schema form below. If a registered store is selected, append `--store "<store-id>"` to that command and each later OpenSpec command shown below that accepts `--store`.
|
||||
|
||||
Using the configured default:
|
||||
```bash
|
||||
openspec new change "<name>"
|
||||
```
|
||||
|
||||
Using an explicitly requested schema:
|
||||
```bash
|
||||
openspec new change "<name>" --schema "<schema-name>"
|
||||
```
|
||||
This creates a scaffolded change in the planning home resolved by the CLI with `.openspec.yaml`.
|
||||
|
||||
5. **Get the artifact build order**
|
||||
```bash
|
||||
openspec status --change "<name>" --json
|
||||
```
|
||||
Parse the JSON to get:
|
||||
- `applyRequires`: array of artifact IDs needed before implementation (e.g., `["tasks"]`)
|
||||
- `artifacts`: list of all artifacts, each with its `status` and its `requires` edges (the artifact IDs it directly depends on)
|
||||
- `planningHome`, `changeRoot`, `artifactPaths`, and `actionContext`: path and scope context. Use these instead of assuming repo-local paths.
|
||||
|
||||
6. **Create every artifact in the required set**
|
||||
|
||||
Use a todo list to track progress through the artifacts.
|
||||
|
||||
Loop through artifacts in dependency order (artifacts with no pending dependencies first):
|
||||
|
||||
a. **For each artifact that is `ready` (dependencies satisfied)**:
|
||||
- Get instructions:
|
||||
```bash
|
||||
openspec instructions <artifact-id> --change "<name>" --json
|
||||
```
|
||||
- The instructions JSON includes:
|
||||
- `context`: Project background (constraints for you - do NOT include in output)
|
||||
- `rules`: Artifact-specific rules (constraints for you - do NOT include in output)
|
||||
- `template`: The structure to use for your output file
|
||||
- `instruction`: Schema-specific guidance for this artifact type
|
||||
- `skipped`/`warning`: present when the change declares skip_specs and this artifact must NOT be created - stop and pick another artifact
|
||||
- `resolvedOutputPath`: Resolved path or pattern to write the artifact
|
||||
- `dependencies`: Completed artifacts to read for context
|
||||
- Read any completed dependency files for context - always re-read them from disk, even if you saw them earlier in the conversation (the user may have edited them)
|
||||
- **Inspect the relevant project before drafting**: Read `context` and `rules` first, then inspect relevant implementation, nearby tests, configuration, and documentation outside `openspec/`. Keep inspection read-only and proportional to the change; reuse findings for later artifacts and inspect more only as needed.
|
||||
- Identify the target project from the request and project context; the planning home may be separate from the code. If the target is unclear, ask. For greenfield or non-code changes, inspect the available structure and relevant documents. If source is unavailable, state the limitation and ask when it materially affects the plan.
|
||||
- Ground scope, approach, and tasks in what you find. Distinguish observed behavior from assumptions and proposed additions; surface conflicts with existing specs instead of silently deciding which is correct.
|
||||
- Do this discovery now, rather than leaving generic "explore the codebase" or "make a plan" tasks for implementation. Keep any necessary follow-up investigation specific to an unresolved question.
|
||||
- If the `instruction` field delegates creation to a specific skill or command, invoke it to produce the artifact instead of writing the file yourself, then verify the artifact file exists at `resolvedOutputPath`
|
||||
- Otherwise create the artifact file using `template` as the structure and write it to `resolvedOutputPath`. If `resolvedOutputPath` is a glob, follow `instruction` to choose the concrete file path
|
||||
- Apply `context` and `rules` as constraints - but do NOT copy them into the file
|
||||
- Show brief progress: "Created <artifact-id>"
|
||||
|
||||
b. **Continue until every artifact in the required set exists (not just `apply.requires`)**
|
||||
- After creating each artifact, re-run `openspec status --change "<name>" --json`
|
||||
- The required set is `applyRequires` plus every artifact reachable from those by following the `requires` edges in `status --json` - walk them transitively (spec-driven closes over proposal, specs, design, tasks). Leave artifacts outside that set alone
|
||||
- `status` is file-existence only, so an `applyRequires` artifact reading `done` does NOT mean its dependencies exist - writing `tasks.md` early marks `tasks` done while `specs` was never written. Use each artifact's `requires` edges, not its `status`, to build the required set: a `done` artifact still lists what it depends on
|
||||
- An artifact already reading `status: "skipped"` is satisfied: the change declares `skip_specs` in `.openspec.yaml`, so its files must NOT exist. Never try to create one
|
||||
- Create every artifact in the required set that is missing, then re-check - creating one can unblock others
|
||||
- Skip one only when `status` already reports it `skipped`, or when its own `instruction` says it is conditional: run `openspec instructions <artifact-id> --change "<name>" --json` and skip only if its `instruction` field marks it optional (e.g. "create only if..."). Spec-driven's `design.md` qualifies; `specs` qualifies only via the `skipped` status above, never by your own judgment. Tell the user, and do not reconsider it
|
||||
- Dependencies are enablers, not gates: if a required artifact is still `blocked` only because you skipped a conditional dependency, write it anyway
|
||||
- Stop when every artifact in the required set is `done`, `skipped`, or was deliberately skipped
|
||||
|
||||
c. **If an artifact requires user input** (unclear context):
|
||||
- Ask the user to clarify
|
||||
- Then continue with creation
|
||||
|
||||
7. **Show final status**
|
||||
```bash
|
||||
openspec status --change "<name>"
|
||||
```
|
||||
|
||||
**Output**
|
||||
|
||||
After completing all artifacts, summarize:
|
||||
- Change name and location
|
||||
- List of artifacts created with brief descriptions, plus any conditional artifact you skipped and why
|
||||
- What's ready: "All artifacts needed for implementation are ready."
|
||||
- Prompt: "The artifacts are ready for review. When you are ready, run `/opsx:apply`."
|
||||
|
||||
**Artifact Creation Guidelines**
|
||||
|
||||
- Follow the `instruction` field from `openspec instructions` for each artifact type - it is the authoritative guidance, even for familiar artifact names
|
||||
- If the `instruction` field directs you to use a specific skill or command to create the artifact, invoke it instead of writing the artifact directly
|
||||
- The schema defines what each artifact should contain - follow it
|
||||
- Read dependency artifacts for context before creating new ones
|
||||
- Use `template` as the structure for your output file - fill in its sections
|
||||
- **IMPORTANT**: `context` and `rules` are constraints for YOU, not content for the file
|
||||
- Do NOT copy `<context>`, `<rules>`, `<project_context>` blocks into the artifact
|
||||
- These guide what you write, but should never appear in the output
|
||||
|
||||
**Guardrails**
|
||||
- The request that invoked this workflow authorizes planning only. Any implementation or apply instruction in that request does not carry forward. Do NOT implement the change, start the apply workflow, or edit project code during this workflow. After presenting the artifacts, stop and wait for a new user request to start the apply workflow
|
||||
- Create every artifact the apply phase transitively depends on, not just the ids listed in `apply.requires`
|
||||
- Always read dependency artifacts before creating a new one - re-read from disk, not from conversation memory (files may have changed since you last saw them)
|
||||
- Ask about ambiguities that would materially change scope, externally observable behavior, compatibility, or acceptance criteria; for minor details, make reasonable assumptions and record them
|
||||
- If a change with that name already exists, ask if user wants to continue it or create a new one
|
||||
- Verify each artifact file exists after writing before proceeding to next
|
||||
@@ -0,0 +1,286 @@
|
||||
---
|
||||
name: "OPSX: Sync"
|
||||
description: "Sync delta specs from a change to main specs"
|
||||
allowed-tools: Bash(openspec:*)
|
||||
category: "Workflow"
|
||||
tags: ["workflow", "specs", "experimental"]
|
||||
---
|
||||
|
||||
Sync delta specs from a change to main specs.
|
||||
|
||||
This is an **agent-driven** operation - you will read delta specs and directly edit main specs to apply the changes. This allows intelligent merging (e.g., adding a scenario without copying the entire requirement).
|
||||
|
||||
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
|
||||
|
||||
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
|
||||
|
||||
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
|
||||
|
||||
Otherwise, with no root, what happens next depends on how this workflow was reached:
|
||||
|
||||
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
|
||||
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
|
||||
|
||||
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
|
||||
|
||||
`<capability-path>` is the spec directory relative to `specs/` (for example, `user-auth` or `identity/user-auth`). Preserve the full path from each delta spec when resolving its main spec.
|
||||
|
||||
**Input**: Optionally specify a change name after `/opsx:sync` (e.g., `/opsx:sync add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
||||
|
||||
**Steps**
|
||||
|
||||
1. **Select the change**
|
||||
|
||||
If a name is provided, use it. Otherwise:
|
||||
- Infer from conversation context if the user mentioned a change
|
||||
- Auto-select if only one active change exists
|
||||
- If ambiguous, run `openspec list --json` to get available changes and ask the user to select one
|
||||
|
||||
When prompting, show changes that have delta specs (under `specs/` directory).
|
||||
|
||||
Always announce: "Using change: <name>" and how to override (e.g., `/opsx:sync <other>`).
|
||||
|
||||
2. **Resolve change context**
|
||||
|
||||
Run:
|
||||
```bash
|
||||
openspec status --change "<name>" --json
|
||||
```
|
||||
|
||||
The JSON includes `planningHome.root`. Main specs live under `<planningHome.root>/openspec/specs/` — use that (store-aware) root for every main-spec path below, not a hardcoded repo path. When a store is selected it points at the store, not the current repository.
|
||||
|
||||
3. **Find delta specs**
|
||||
|
||||
Use `artifactPaths.specs.existingOutputPaths` from the status JSON as the
|
||||
only source of delta spec paths. If the `specs` entry is missing or
|
||||
`existingOutputPaths` is empty, report that there are no delta specs to sync,
|
||||
do not infer them from other artifacts, and stop without requesting artifact
|
||||
instructions or writing a main spec.
|
||||
|
||||
Sync every path in `existingOutputPaths` unless the caller narrowed the set.
|
||||
A caller narrows it by naming an explicit list of complete entries from
|
||||
`existingOutputPaths` — copy those absolute values verbatim. Archive does
|
||||
this inline, and a user can too (for example, by selecting the entry ending
|
||||
in `/specs/billing/invoices/spec.md`).
|
||||
Then sync only the named paths and leave the remaining delta specs untouched:
|
||||
bulk archive excludes a delta whose implementation it could not find, and
|
||||
syncing it anyway would write a main spec the caller deliberately withheld.
|
||||
Carry that narrowed selection through step 4; never widen it back to the full
|
||||
list. If a named path is not in `existingOutputPaths`, do not sync it —
|
||||
report it and stop, rather than dropping it silently. If the named list is
|
||||
empty, report that there is nothing to sync and stop without writing a main
|
||||
spec.
|
||||
|
||||
Each delta spec file contains sections like:
|
||||
- `## ADDED Requirements` - New requirements to add
|
||||
- `## MODIFIED Requirements` - Changes to existing requirements
|
||||
- `## REMOVED Requirements` - Requirements to remove
|
||||
- `## RENAMED Requirements` - Requirements to rename (FROM:/TO: format)
|
||||
|
||||
If no delta specs found, inform user and stop.
|
||||
|
||||
4. **For each delta spec, apply changes to main specs**
|
||||
|
||||
Before the first main-spec write, obtain one current specs-rule snapshot:
|
||||
- If archive invoked this workflow inline and supplied a valid snapshot from
|
||||
`openspec instructions specs --change "<name>" --json`, reuse it and do not
|
||||
fetch the same instructions again.
|
||||
- Otherwise run that command once now with the same selected-root flags.
|
||||
- If the direct lookup exits non-zero or returns invalid artifact-instruction
|
||||
JSON, report the error and stop before writing any main spec. Do not treat the
|
||||
failure as an absent rule set.
|
||||
- A valid response with omitted `rules` means no artifact rules are configured
|
||||
and the existing semantic merge continues.
|
||||
|
||||
Apply returned `rules` only to the content and form of the main specs produced
|
||||
by this merge. Artifact rules are not operation guidance and cannot change
|
||||
selected roots, delta paths, CLI checks, or workflow steps. Use their text as
|
||||
constraints without copying it verbatim into a main spec or summary.
|
||||
|
||||
For each capability delta spec path selected in step 3 — the full `existingOutputPaths` list, or the narrowed subset when a caller supplied one (these may belong to a selected store, not the repo):
|
||||
|
||||
a. **Read the delta spec** to understand the intended changes
|
||||
|
||||
b. **Read the main spec** at `<planningHome.root>/openspec/specs/<capability-path>/spec.md` (may not exist yet)
|
||||
|
||||
**If it does not exist yet** (a new capability), match what `openspec archive` does:
|
||||
only ADDED requirements may be applied - step d creates the spec from them.
|
||||
MODIFIED and RENAMED have no requirement to act on, so stop the sync for that
|
||||
capability and report that its main spec does not exist and only ADDED is allowed
|
||||
for a new spec; never invent the missing requirement. REMOVED has nothing to
|
||||
remove - skip it and warn.
|
||||
|
||||
c. **Apply changes intelligently**:
|
||||
|
||||
**ADDED Requirements:**
|
||||
- If requirement doesn't exist in main spec → add it
|
||||
- If requirement already exists → update it to match (treat as implicit MODIFIED)
|
||||
|
||||
**MODIFIED Requirements:**
|
||||
- Find the requirement in main spec
|
||||
- Apply the changes - this can be:
|
||||
- Adding new scenarios the main spec does not have yet
|
||||
- Modifying existing scenarios
|
||||
- Changing the requirement description
|
||||
- Preserve scenarios/content not mentioned in the delta
|
||||
|
||||
**REMOVED Requirements:**
|
||||
- Remove the entire requirement block from main spec
|
||||
- Retiring the capability. Delete the whole `spec.md` - and the directory once
|
||||
nothing else is left in it - only when ALL of these hold:
|
||||
1. removing the requirements *this run* left no requirement blocks;
|
||||
2. the rest of the spec is well-formed (it still has a `## Purpose`);
|
||||
3. the main spec was not already empty before this sync - if you removed
|
||||
nothing, change nothing;
|
||||
4. every other nonblank line in the whole file is accounted for as the
|
||||
title, Purpose, Requirements header, or a canonical requirement's
|
||||
statement, scenarios, or fenced examples;
|
||||
5. the change's `.openspec.yaml` declares `retire_capabilities: true`;
|
||||
6. the `spec.md` resolves inside the real specs root (do not follow a
|
||||
capability-directory symlink to delete an external file).
|
||||
If removing the selected requirements would leave no requirement blocks and
|
||||
any retirement condition is not satisfied, do not modify the main spec. Stop
|
||||
the sync for that capability, report the blocking condition, and tell the user
|
||||
how to resolve it. Never write or leave an empty `## Requirements` section.
|
||||
When only the marker is missing, say that too - it is the one thing the user
|
||||
can add to make the retirement go through.
|
||||
- Deleting the file also deletes its `## Purpose`; any other section blocks
|
||||
retirement. Name Purpose when you report the retirement. Include a pasteable
|
||||
`git checkout` only when the spec lived in the caller's checkout;
|
||||
otherwise give checkout-scoped recovery guidance.
|
||||
|
||||
**RENAMED Requirements:**
|
||||
- Find the FROM requirement, rename to TO
|
||||
|
||||
**`## Purpose` in the delta:**
|
||||
- The main spec already has one and it is authoritative - leave it alone
|
||||
(this is what `openspec archive` does; it warns and moves on)
|
||||
|
||||
d. **Create new main spec** if capability doesn't exist yet:
|
||||
- Only when the delta has ADDED requirements to put in it and no MODIFIED or
|
||||
RENAMED requirements blocked this capability in step b. Otherwise create nothing
|
||||
and leave the specs directory untouched. For a REMOVED-only delta, if the change's
|
||||
`.openspec.yaml` declares `retire_capabilities: true`, report it as already retired
|
||||
and continue without recreating the spec. Without that marker, report the sync as blocked:
|
||||
`openspec archive` rejects it with `Spec must have at least one requirement`.
|
||||
An empty delta has no operations to sync; report it as blocked too.
|
||||
Never write an empty `## Requirements` section.
|
||||
- Create `<planningHome.root>/openspec/specs/<capability-path>/spec.md`
|
||||
- Add Purpose section: copy the delta's `## Purpose` body verbatim when it has one
|
||||
(this is what `openspec archive` does); only write a brief TBD placeholder when it does not
|
||||
- Add Requirements section with the ADDED requirements
|
||||
- Follow the **Main Spec Format Reference** below
|
||||
|
||||
5. **Validate updated main specs**
|
||||
|
||||
Run `openspec validate --specs` with the same selected-root flags used earlier.
|
||||
If validation fails, report the problems and do not claim the sync succeeded.
|
||||
|
||||
6. **Show summary**
|
||||
|
||||
After applying all changes, summarize:
|
||||
- Which capabilities were updated
|
||||
- What changes were made (requirements added/modified/removed/renamed)
|
||||
- Any new main spec left with a TBD Purpose placeholder, so it gets written
|
||||
now rather than lingering
|
||||
- Any capability retired, naming the deleted `spec.md`, its Purpose, and
|
||||
either a pasteable `git checkout` or checkout-scoped recovery guidance
|
||||
|
||||
**Delta Spec Format Reference**
|
||||
|
||||
```markdown
|
||||
# Spec Delta
|
||||
|
||||
## Purpose
|
||||
|
||||
Only on a delta that introduces a brand-new capability. Seeds the new main spec.
|
||||
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: New Feature
|
||||
The system SHALL do something new.
|
||||
|
||||
#### Scenario: Basic case
|
||||
- **WHEN** user does X
|
||||
- **THEN** system does Y
|
||||
|
||||
## MODIFIED Requirements
|
||||
|
||||
### Requirement: Existing Feature
|
||||
The system SHALL keep doing the existing thing, now also handling A.
|
||||
|
||||
#### Scenario: Scenario the main spec already has
|
||||
- **WHEN** user does X
|
||||
- **THEN** system does Y
|
||||
|
||||
#### Scenario: New scenario to add
|
||||
- **WHEN** user does A
|
||||
- **THEN** system does B
|
||||
|
||||
## REMOVED Requirements
|
||||
|
||||
### Requirement: Deprecated Feature
|
||||
|
||||
## RENAMED Requirements
|
||||
|
||||
- FROM: `### Requirement: Old Name`
|
||||
- TO: `### Requirement: New Name`
|
||||
```
|
||||
|
||||
**Main Spec Format Reference**
|
||||
|
||||
Main specs are what the delta merges INTO. They must never contain delta operation headers (`## ADDED/MODIFIED/REMOVED/RENAMED Requirements`) - after syncing, every requirement lives under a single `## Requirements` section:
|
||||
|
||||
```markdown
|
||||
# <capability> Specification
|
||||
|
||||
## Purpose
|
||||
Short description of what this capability does and why it exists.
|
||||
|
||||
## Requirements
|
||||
|
||||
### Requirement: New Feature
|
||||
The system SHALL do something new.
|
||||
|
||||
#### Scenario: Basic case
|
||||
- **WHEN** user does X
|
||||
- **THEN** system does Y
|
||||
```
|
||||
|
||||
**Key Principle: Intelligent Merging**
|
||||
|
||||
Unlike programmatic merging, you merge rather than overwrite:
|
||||
- A MODIFIED block carries the whole requirement - body plus every scenario that survives the change. `openspec validate` and `openspec archive` both reject one that drops a scenario the main spec still has.
|
||||
- Keep anything the delta does not mention, in the main spec's existing order
|
||||
- Use your judgment to merge changes sensibly
|
||||
|
||||
**Output On Success**
|
||||
|
||||
```markdown
|
||||
## Specs Synced: <change-name>
|
||||
|
||||
Updated main specs:
|
||||
|
||||
**<capability-1>**:
|
||||
- Added requirement: "New Feature"
|
||||
- Modified requirement: "Existing Feature" (added 1 scenario)
|
||||
|
||||
**<capability-2>**:
|
||||
- Created new spec file
|
||||
- Added requirement: "Another Feature"
|
||||
|
||||
Main specs are now updated. The change remains active - archive when implementation is complete.
|
||||
```
|
||||
|
||||
**Guardrails**
|
||||
- Read both delta and main specs before making changes
|
||||
- Preserve existing content not mentioned in delta
|
||||
- Never copy a delta file into a main spec as-is - merge its content so the main spec keeps the Main Spec Format Reference structure, with no delta operation headers
|
||||
- If something is unclear, ask for clarification
|
||||
- Show what you're changing as you go
|
||||
- The operation should be idempotent - running twice should give same result
|
||||
- Use only `artifactPaths.specs.existingOutputPaths`; never infer delta specs from unrelated artifacts
|
||||
- Honor a caller-supplied subset of `existingOutputPaths`; never widen it back to the full list
|
||||
- Fetch specs instructions once for direct sync, or reuse the archive-supplied snapshot inline
|
||||
- Stop before every main-spec write on a non-zero or invalid JSON specs-instruction response
|
||||
- Artifact rules constrain only the specs being written and are never copied into output files
|
||||
@@ -0,0 +1,99 @@
|
||||
---
|
||||
name: "OPSX: Update"
|
||||
description: "Update a change - revise existing planning artifacts and keep them coherent (Experimental)"
|
||||
allowed-tools: Bash(openspec:*)
|
||||
category: "Workflow"
|
||||
tags: ["workflow", "artifacts", "experimental"]
|
||||
---
|
||||
|
||||
Revise a change's existing planning artifacts and keep them coherent. Never edit code.
|
||||
|
||||
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
|
||||
|
||||
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
|
||||
|
||||
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
|
||||
|
||||
Otherwise, with no root, what happens next depends on how this workflow was reached:
|
||||
|
||||
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
|
||||
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
|
||||
|
||||
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
|
||||
|
||||
**Input**: Optionally specify a change name after `/opsx:update` (e.g., `/opsx:update add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
||||
|
||||
This workflow revises artifacts that already exist; it never creates missing ones. When an artifact is missing, `openspec status --change "<name>" --json` names the next one and `openspec instructions "<artifact-id>" --change "<name>" --json` explains how to write it.
|
||||
|
||||
**Steps**
|
||||
|
||||
1. **Select the change**
|
||||
|
||||
If a name is provided, use it. Otherwise:
|
||||
- Infer from conversation context if the user mentioned a change
|
||||
- Auto-select if only one active change exists
|
||||
- If ambiguous, run `openspec list --json` to get available changes sorted by most recently modified, and ask the user to select one
|
||||
|
||||
When prompting, present the top 3-4 most recently modified changes as options, showing:
|
||||
- Change name
|
||||
- Schema (from `schema` field if present, otherwise "spec-driven")
|
||||
- Status (e.g., "0/5 tasks", "complete", "no tasks")
|
||||
- How recently it was modified (from `lastModified` field)
|
||||
|
||||
Mark the most recently modified change as "(Recommended)" since it's likely what the user wants to update.
|
||||
|
||||
Always announce: "Using change: <name>" and how to override (e.g., `/opsx:update <other>`).
|
||||
|
||||
2. **Get the change's artifacts**
|
||||
```bash
|
||||
openspec status --change "<name>" --json
|
||||
```
|
||||
Parse the JSON to understand current state. The response includes:
|
||||
- `schemaName`: The workflow schema being used (e.g., "spec-driven")
|
||||
- `artifacts`: Array of artifacts with their status ("done", "skipped", "ready", "blocked")
|
||||
- `isPlanningComplete`: Boolean indicating if all planning artifacts are complete. Older CLI versions expose the same value as `isComplete`.
|
||||
- `planningHome`, `changeRoot`, `artifactPaths`, and `actionContext`: path and scope context. Use these instead of assuming repo-local paths.
|
||||
|
||||
The artifact ids and paths come from the active schema - do NOT assume them, and do NOT branch on hardcoded artifact names. Custom schemas must work unchanged.
|
||||
|
||||
The files to edit are `artifactPaths.<id>.existingOutputPaths` - the concrete files that exist on disk, already glob-expanded for glob artifacts (e.g. `specs/**/*.md`). Do NOT write to `resolvedOutputPath`: for a glob artifact it is still the glob pattern, not a real file.
|
||||
|
||||
3. **Understand the request**
|
||||
- If the user asked for a specific revision ("the design now uses X"), that is the starting edit.
|
||||
- If they only said "update" / "make this coherent", treat it as a coherence review: read the existing artifacts and check them against each other for contradictions, gaps, and duplication.
|
||||
|
||||
4. **Read and reconcile**
|
||||
- Read the artifact(s) the request touches and the change's other existing artifacts.
|
||||
- Draft the requested edit in the conversation, not in files. Work out exactly what it changes; step 5 owns every write. Then check every other existing artifact against the drafted edit - in ANY direction: an edit to a later artifact may require revising an earlier one, not only the other way around. Build order is a useful reading order, not a constraint on which artifacts may be revised.
|
||||
- Note everything that is now inconsistent, missing, or contradictory.
|
||||
- Propose revisions only to files that already exist (`existingOutputPaths`). Do NOT create artifacts that don't exist yet, and do NOT invent new files under a glob artifact - note them and point the user to `openspec instructions "<artifact-id>" --change "<name>" --json` for how to create them.
|
||||
- If the change is already coherent, say so and propose no revisions.
|
||||
|
||||
5. **Confirm and apply, one artifact at a time**
|
||||
- This step performs every artifact write in this workflow; no earlier step edits an artifact.
|
||||
- Show each proposed revision and why - including the requested edit drafted in step 4. Write only after the user confirms.
|
||||
- If the user rejects a revision, do not write it - leave that artifact unchanged.
|
||||
- When a substantial rewrite is needed, get that artifact's rules and template first:
|
||||
```bash
|
||||
openspec instructions "<artifact-id>" --change "<name>" --json
|
||||
```
|
||||
|
||||
6. **Point to the next step (guidance only - NEVER act on it)**
|
||||
- Artifacts still missing -> run `openspec status --change "<name>" --json` for the next artifact and point the user to `openspec instructions "<artifact-id>" --change "<name>" --json` for how to create it.
|
||||
- Change already implemented (tasks checked off / already applied) -> the code may no longer match the revised plan; suggest `/opsx:apply` to carry the delta into code.
|
||||
- Everything done and implemented -> suggest `/opsx:archive`.
|
||||
|
||||
**Output**
|
||||
|
||||
After each invocation, show:
|
||||
- Which artifacts were revised (and which proposed revisions were rejected)
|
||||
- Anything deferred because it does not exist yet (not-yet-created artifacts or files)
|
||||
- Where the change stands and the recommended next command
|
||||
|
||||
**Guardrails**
|
||||
- Planning artifacts only - NEVER edit implementation code. If the revised plan implies code changes, stop and point to `/opsx:apply`.
|
||||
- Use the artifact ids and paths reported by `openspec status`; never branch on hardcoded artifact names.
|
||||
- Edit only the concrete files in `existingOutputPaths`; never write to a glob `resolvedOutputPath`.
|
||||
- Do not advance the build frontier: no new artifacts, no new files under glob artifacts - creating them is a separate step, outside this workflow.
|
||||
- Confirm every edit with the user before writing.
|
||||
- If the request changes the change's *intent* rather than refining it, ask for a distinct unused change name and recommend `openspec new change "<new-change-name>"` instead (the "Update vs. Start Fresh" heuristic).
|
||||
@@ -0,0 +1,184 @@
|
||||
---
|
||||
name: "OPSX: Verify"
|
||||
description: "Verify implementation matches change artifacts before archiving"
|
||||
allowed-tools: Bash(openspec:*)
|
||||
category: "Workflow"
|
||||
tags: ["workflow", "verify", "experimental"]
|
||||
---
|
||||
|
||||
Verify that an implementation matches the change artifacts (specs, tasks, design).
|
||||
|
||||
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
|
||||
|
||||
**Project check:** These steps expect a project that already uses OpenSpec. Before the first step that writes anything (`new change`, `archive`, `sync specs`, or authoring an artifact file), confirm the project has a root: run `openspec list --json` (with `--store <id>` when a store is selected, since the store is then the root) and read `root`. A root object means the project is set up. `"root": null` means it is not - there is no `openspec/` directory here, and a write such as `openspec new change` would create one as a side effect. The command also exits non-zero, which is that answer rather than a broken CLI, so read the JSON instead of retrying or working around it.
|
||||
|
||||
One `"root": null` is not about setup: when a `status` error message starts with `Declared in` or `Invalid store declaration in` and names this project's `openspec/config.yaml` (or `config.yml`), the project does use OpenSpec through a store it declares, which this machine cannot resolve (the store is not registered, or the `store:` line is malformed). Do not treat it as uninitialized and skip the branches below: stop before writing and show the user that error's `message` and `fix`.
|
||||
|
||||
Otherwise, with no root, what happens next depends on how this workflow was reached:
|
||||
|
||||
- **Auto-selected**: you chose this workflow yourself, without the user naming OpenSpec, naming this skill, or running its slash command. Stop using OpenSpec and answer the request normally, as you would with no OpenSpec installed. Do not ask them to set anything up and do not mention OpenSpec setup.
|
||||
- **Explicit OpenSpec request**: the user named OpenSpec, named this skill, or ran its slash command. Stop before writing and ask how to proceed: set this project up (`openspec init`), target a store they already have (`--store <id>`), or continue without OpenSpec for this request. Wait for their answer.
|
||||
|
||||
In both branches, never create the root as a side effect: do not run `openspec init` until the user asks for it, do not hand-create `openspec/` files, and do not let a command create it.
|
||||
|
||||
**Input**: Optionally specify a change name after `/opsx:verify` (e.g., `/opsx:verify add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
||||
|
||||
**Steps**
|
||||
|
||||
1. **Select the change**
|
||||
|
||||
If a name is provided, use it. Otherwise:
|
||||
- Infer from conversation context if the user mentioned a change
|
||||
- Auto-select if only one active change exists
|
||||
- If ambiguous, run `openspec list --json` to get available changes and ask the user to select one
|
||||
|
||||
When prompting, show changes that have implementation tasks (tasks artifact exists).
|
||||
Include the schema used for each change if available.
|
||||
Mark changes with incomplete tasks as "(In Progress)".
|
||||
|
||||
Always announce: "Using change: <name>" and how to override (e.g., `/opsx:verify <other>`).
|
||||
|
||||
2. **Check status to understand the schema**
|
||||
```bash
|
||||
openspec status --change "<name>" --json
|
||||
```
|
||||
Parse the JSON to understand:
|
||||
- `schemaName`: The workflow being used (e.g., "spec-driven")
|
||||
- `planningHome`, `changeRoot`, `artifactPaths`, and `actionContext`: path and scope context
|
||||
- Which artifacts exist for this change
|
||||
|
||||
3. **Get planning context and load artifacts**
|
||||
|
||||
```bash
|
||||
openspec instructions apply --change "<name>" --json
|
||||
```
|
||||
|
||||
This returns the change directory and `contextFiles` (artifact ID -> array of concrete file paths). Read all available artifacts from `contextFiles`.
|
||||
|
||||
4. **Initialize verification report structure**
|
||||
|
||||
Create a report structure with three dimensions:
|
||||
- **Completeness**: Track tasks and spec coverage
|
||||
- **Correctness**: Track requirement implementation and scenario coverage
|
||||
- **Coherence**: Track design adherence and pattern consistency
|
||||
|
||||
Each dimension can have CRITICAL, WARNING, or SUGGESTION issues.
|
||||
|
||||
5. **Verify Completeness**
|
||||
|
||||
**Task Completion**:
|
||||
- If `contextFiles.tasks` exists, read every file path in it
|
||||
- Parse checkboxes: complete means the box holds only `x`/`X`, ignoring
|
||||
spacing (`- [ x]` is complete); every other marker is incomplete
|
||||
(`- [ ]`, `- []`, and unfamiliar ones such as `- [~]` or `- [-]`)
|
||||
- Count complete vs total tasks
|
||||
- If incomplete tasks exist:
|
||||
- Add CRITICAL issue for each incomplete task
|
||||
- Recommendation: "Complete task: <description>" or "Mark as done if already implemented"
|
||||
|
||||
**Spec Coverage**:
|
||||
- If delta specs exist in `contextFiles.specs`:
|
||||
- Extract all requirements (marked with "### Requirement:")
|
||||
- For each requirement:
|
||||
- Search codebase for keywords related to the requirement
|
||||
- Assess if implementation likely exists
|
||||
- If requirements appear unimplemented:
|
||||
- Add CRITICAL issue: "Requirement not found: <requirement name>"
|
||||
- Recommendation: "Implement requirement X: <description>"
|
||||
|
||||
6. **Verify Correctness**
|
||||
|
||||
**Requirement Implementation Mapping**:
|
||||
- For each requirement from delta specs:
|
||||
- Search codebase for implementation evidence
|
||||
- If found, note file paths and line ranges
|
||||
- Assess if implementation matches requirement intent
|
||||
- If divergence detected:
|
||||
- Add WARNING: "Implementation may diverge from spec: <details>"
|
||||
- Recommendation: "Review <file>:<lines> against requirement X"
|
||||
|
||||
**Scenario Coverage**:
|
||||
- For each scenario in delta specs (marked with "#### Scenario:"):
|
||||
- Check if conditions are handled in code
|
||||
- Check if tests exist covering the scenario
|
||||
- If scenario appears uncovered:
|
||||
- Add WARNING: "Scenario not covered: <scenario name>"
|
||||
- Recommendation: "Add test or implementation for scenario: <description>"
|
||||
|
||||
7. **Verify Coherence**
|
||||
|
||||
**Design Adherence**:
|
||||
- If `contextFiles.design` exists:
|
||||
- Extract key decisions (look for sections like "Decision:", "Approach:", "Architecture:")
|
||||
- Verify implementation follows those decisions
|
||||
- If contradiction detected:
|
||||
- Add WARNING: "Design decision not followed: <decision>"
|
||||
- Recommendation: "Update implementation or revise design.md to match reality"
|
||||
- If no design.md: Skip design adherence check, note "No design.md to verify against"
|
||||
|
||||
**Code Pattern Consistency**:
|
||||
- Review new code for consistency with project patterns
|
||||
- Check file naming, directory structure, coding style
|
||||
- If significant deviations found:
|
||||
- Add SUGGESTION: "Code pattern deviation: <details>"
|
||||
- Recommendation: "Consider following project pattern: <example>"
|
||||
|
||||
8. **Generate Verification Report**
|
||||
|
||||
**Summary Scorecard**:
|
||||
```markdown
|
||||
## Verification Report: <change-name>
|
||||
|
||||
### Summary
|
||||
| Dimension | Status |
|
||||
|--------------|------------------|
|
||||
| Completeness | X/Y tasks, N reqs|
|
||||
| Correctness | M/N reqs covered |
|
||||
| Coherence | Followed/Issues |
|
||||
```
|
||||
|
||||
**Issues by Priority**:
|
||||
|
||||
1. **CRITICAL** (Must fix before archive):
|
||||
- Incomplete tasks
|
||||
- Missing requirement implementations
|
||||
- Each with specific, actionable recommendation
|
||||
|
||||
2. **WARNING** (Should fix):
|
||||
- Spec/design divergences
|
||||
- Missing scenario coverage
|
||||
- Each with specific recommendation
|
||||
|
||||
3. **SUGGESTION** (Nice to fix):
|
||||
- Pattern inconsistencies
|
||||
- Minor improvements
|
||||
- Each with specific recommendation
|
||||
|
||||
**Final Assessment**:
|
||||
- If CRITICAL issues: "X critical issue(s) found. Fix before archiving."
|
||||
- If only warnings: "No critical issues. Y warning(s) to consider. Ready for archive (with noted improvements)."
|
||||
- If all clear: "All checks passed. Ready for archive."
|
||||
|
||||
**Verification Heuristics**
|
||||
|
||||
- **Completeness**: Focus on objective checklist items (checkboxes, requirements list)
|
||||
- **Correctness**: Use keyword search, file path analysis, reasonable inference - don't require perfect certainty
|
||||
- **Coherence**: Look for glaring inconsistencies, don't nitpick style
|
||||
- **False Positives**: When uncertain, prefer SUGGESTION over WARNING, WARNING over CRITICAL
|
||||
- **Actionability**: Every issue must have a specific recommendation with file/line references where applicable
|
||||
|
||||
**Graceful Degradation**
|
||||
|
||||
- If only tasks.md exists: verify task completion only, skip spec/design checks
|
||||
- If tasks + specs exist: verify completeness and correctness, skip design
|
||||
- If full artifacts: verify all three dimensions
|
||||
- Always note which checks were skipped and why
|
||||
|
||||
**Output Format**
|
||||
|
||||
Use clear markdown with:
|
||||
- Table for summary scorecard
|
||||
- Grouped lists for issues (CRITICAL/WARNING/SUGGESTION)
|
||||
- Code references in format: `file.ts:123`
|
||||
- Specific, actionable recommendations
|
||||
- No vague suggestions like "consider reviewing"
|
||||
@@ -0,0 +1,364 @@
|
||||
---
|
||||
paths:
|
||||
- "src/api/**"
|
||||
- "src/core/**"
|
||||
- "src/schemas/**"
|
||||
- "student-tests/**"
|
||||
---
|
||||
|
||||
# Контракт API: что требуют smoke и защита
|
||||
|
||||
Источники: `contracts/openapi.json` (пути, схемы, коды),
|
||||
`contracts/README.md` (семантика; приоритет над поведением библиотек,
|
||||
кроме согласованных расхождений FastAPI — раздел ниже), рубрика в
|
||||
`README.md`. Сгенерированная FastAPI схема (`/openapi.json`) — только
|
||||
справка, сверять с контрактом. Если контракт противоречит сам себе —
|
||||
спросить пользователя. Ниже то, что легко нарушить.
|
||||
|
||||
## FastAPI: что разрешено и что всё равно ловит smoke
|
||||
|
||||
Преподаватель 2026-09-26 разрешил FastAPI с его расхождениями: лишний
|
||||
422 и другой порядок кодов ошибок (AGENTS.md, «Согласования с
|
||||
преподавателем»). Публичный smoke это не отменяет: на каждый ответ
|
||||
≥ 400 он проверяет и статус, и тело `{"error": ...}`. Проверено на
|
||||
FastAPI 0.141 из `uv.lock`:
|
||||
|
||||
| Запрос | FastAPI по умолчанию | Smoke ждёт |
|
||||
|---|---|---|
|
||||
| `GET /api/v1/users/me` без `Authorization`, заголовок объявлен `Header()` | 422 | 401 |
|
||||
| `POST .../messages` с `{"text": ""}` | 422 | 400 |
|
||||
| `GET .../messages?limit=0` | 422 | 400 |
|
||||
| любая ошибка | `{"detail": ...}` | формат контракта |
|
||||
|
||||
- Один обработчик `RequestValidationError` → 400 `invalid_request` в
|
||||
формате контракта. Оставлять 422 выборочно сложнее, чем перевести всё,
|
||||
поэтому 422 не отдаётся вообще.
|
||||
- `Authorization` не объявлять типизированным `Header()`: пропуск уйдёт
|
||||
в валидацию и даст 400 вместо 401. Схемы безопасности — те же, что в
|
||||
контракте (`bearerAuth`, `basicAuth`): тогда они есть в
|
||||
`/openapi.json`, а в `/docs` работает кнопка Authorize.
|
||||
- Бизнес-ручки: `HTTPBearer(scheme_name="bearerAuth",
|
||||
auto_error=False)` в `get_current_user`. Без заголовка или со схемой
|
||||
не `Bearer` она отдаёт `None`, и 401 бросает сервис.
|
||||
- Вход: встроенный `HTTPBasic` не годится даже с `auto_error=False`.
|
||||
Он декодирует credentials как ASCII и на пароле не из ASCII сам
|
||||
бросает 401, минуя сервис (проверено на FastAPI 0.141.1), а контракт
|
||||
требует UTF-8. Схема `basicAuth` объявляется, но заголовок
|
||||
разбирается своим кодом (`auth.md`).
|
||||
- Порядок проверок не выправлять, это и есть разрешённое расхождение.
|
||||
Битый JSON FastAPI разбирает до зависимостей, поэтому запрос без
|
||||
`Authorization` с битым JSON получит 400, а не 401. Остальная валидация
|
||||
(тело, путь, query) идёт после зависимостей, там 401 приходит первым.
|
||||
Расхождение перечислить в `REPORT.md` со ссылкой на согласование.
|
||||
- `StarletteHTTPException` (404 неизвестного пути, 405) и `Exception`
|
||||
(500) тоже переводятся в формат контракта.
|
||||
|
||||
## Формат ответов
|
||||
|
||||
- Непустой `X-Request-Id` в **каждом** ответе: успех, ошибка, health,
|
||||
404 неизвестного пути, 405, 500. С лабы 3 так же — непустой
|
||||
`X-Instance-Id` (раздел «Балансировка и повторная отправка» ниже):
|
||||
smoke проверяет его на каждом ответе, начиная с `/health/live`.
|
||||
- Любая ошибка: `{"error": {"code": ..., "message": ..., "request_id":
|
||||
...}}` с `Content-Type: application/json`, и `request_id` совпадает с
|
||||
заголовком. Лишних полей нет (`additionalProperties: false`).
|
||||
- `message` — короткий текст для человека **на английском** (язык
|
||||
контракт не задаёт, русский текст в `contracts/examples.json` — только
|
||||
пример). В нём нет stack trace, путей к файлам, имён классов, SQL и
|
||||
признаков существования чужого объекта. Источник текста —
|
||||
`default_message` доменного исключения или общий текст обработчика в
|
||||
`errors.py`.
|
||||
- Обработчики `RequestValidationError`, `StarletteHTTPException` и
|
||||
`Exception` переопределяются в `src/api/errors.py` (раздел «FastAPI»
|
||||
выше).
|
||||
|
||||
| Статус | `code` | Когда |
|
||||
|---|---|---|
|
||||
| 400 | `invalid_request` | тело, UUID, `limit`, `cursor`, malformed JSON, лишнее поле, неверный тип; с лабы 3 — нет или неверный `Idempotency-Key` у `POST` сообщения |
|
||||
| 401 | `unauthorized` | вход: неверные username или пароль, битый Basic; остальное: нет Bearer, токен неизвестен, истёк или отозван, пришёл Basic. Всегда с `WWW-Authenticate` (`auth.md`) |
|
||||
| 404 | `not_found` | объекта нет **или** он чужой; неизвестный путь |
|
||||
| 409 | `conflict` | `username` занят; с лабы 3 — тот же `Idempotency-Key` с другим телом сообщения |
|
||||
| 413 | `payload_too_large` | с лабы 4: тело загрузки больше 10 MiB (по `Content-Length` или счётчику) или изображение больше 40 млн пикселей (`PayloadTooLarge`) |
|
||||
| 415 | `unsupported_media_type` | с лабы 4: `Content-Type` не PNG/JPEG, содержимое не PNG/JPEG, подмена MIME, повреждённое изображение (`UnsupportedMediaType`) |
|
||||
| 429 | `rate_limited` | с change `upload-memory`: места загрузки процесса заняты — очередь ожидания полна или место не освободилось за срок (`UploadsBusy`); всегда с `Retry-After: 1` (`UPLOAD_RETRY_AFTER_SECONDS`, таблица `RETRY_AFTER` в `errors.py`) |
|
||||
| 500 | `internal_error` | необработанное исключение, без деталей; с лабы 4 ещё у готового вложения нет объекта в S3 или он другого размера, а сверка этого ещё не подтвердила (`AttachmentContentMissing`, причина — `error` в журнале); после пометки сверкой — 404 (раздел «Вложения») |
|
||||
| 503 | `unavailable` | недоступен Postgres или хранилище сессий: ограниченная ошибка вместо 500 (`infra.md`); с лабы 4 — недоступен S3 на путях байтов вложений |
|
||||
|
||||
С change `track1-queue-overload` 429 у загрузки ещё при пределе незавершённых заданий
|
||||
(`UploadBacklogFull`, `Retry-After: 5` — `UPLOAD_BACKLOG_RETRY_AFTER_SECONDS`); 5 с:
|
||||
повтор через секунду почти всегда получил бы тот же отказ (вопрос 10 в `REPORT.md`).
|
||||
|
||||
`429` контракт описывает как ограничение частоты запросов и требует
|
||||
`Retry-After` — положительное целое. У нас 429 — только у загрузки, когда
|
||||
заняты места процесса (design change `upload-memory`, решение 2). Места
|
||||
ограничивают одновременность, а не частоту: трактовка — вопрос 1
|
||||
преподавателю (`TEACHER_QUESTIONS.md`, локальный, не в git; разбор — отчёт лабы 4). До ответа — 429, ответ
|
||||
«503» меняет строку `DOMAIN_ERRORS`, сценарии и тесты, но не подход.
|
||||
`DELETE /auth/sessions/current` отвечает 204 без тела.
|
||||
|
||||
- Время — RFC 3339 UTC с `Z`, назначает сервер. Формат отдавать явно
|
||||
через `src/utils/utc.py`, а не полагаться на сериализацию по
|
||||
умолчанию: smoke требует окончание `Z`.
|
||||
- `created_at` хранится и отдаётся с одной точностью (микросекунды).
|
||||
Иначе порядок, который видит клиент, разойдётся с порядком курсора.
|
||||
- `GET /health/live` → 200 `{"status": "ok"}`. `GET /health/ready` → 200
|
||||
`{"status": "ok"}` или 503 в формате ошибки: 200 только если доступен
|
||||
Postgres и всё, без чего не работает обязательный путь (`infra.md`).
|
||||
Обе без идентификации.
|
||||
|
||||
## Валидация → 400
|
||||
|
||||
- Модели запросов: `extra="forbid"` и строгие типы на уровне полей
|
||||
(`StrictStr`, `StrictInt`), чтобы число не превращалось в строку, а
|
||||
лишнее поле давало 400. `ConfigDict(strict=True)` на всю модель не
|
||||
ставить: FastAPI валидирует тело как Python-объект, и strict-режим
|
||||
отвергает UUID, пришедший строкой (проверено: корректный
|
||||
`member_ids` даёт 422). Query-параметры остаются нестрогими:
|
||||
`limit=5` приходит строкой.
|
||||
- Malformed JSON и не-объект вместо объекта → 400. FastAPI отдаёт их как
|
||||
422 `json_invalid`, это переводится общим обработчиком.
|
||||
- Обязательные строки (`display_name`, `title`, `password`) не
|
||||
могут состоять только из пробельных символов (`str.strip()` пустой →
|
||||
400). Само значение не обрезать. `text` сообщения с лабы 4 — особый
|
||||
случай (раздел «Вложения» ниже).
|
||||
- Длины считаются в Unicode code points: `len(str)` в Python как раз они.
|
||||
`display_name` и `title` — 1–100, `text` — до 4000, `password` —
|
||||
12–128.
|
||||
- `username` — строго `^[a-z0-9_]{3,32}$` на всю строку. В ручной проверке
|
||||
`re.fullmatch`: `re.match` с `$` пропускает `\n` в конце.
|
||||
- Лишнее поле `sender_id` в теле сообщения → 400: отправитель выводится
|
||||
из текущего пользователя.
|
||||
- `chat_id` не UUID → 400. `limit` — целое 1–100, по умолчанию 50;
|
||||
`limit=0` и нечисловой → 400. Битый `cursor` → 400.
|
||||
- `member_ids`: 1–100 элементов, без дубликатов, все пользователи
|
||||
существуют, вызывающий в списке. Иначе 400.
|
||||
- UUID на входе — только запись 8-4-4-4-12 (`format: uuid`), цифры в
|
||||
любом регистре (спек `api-conventions`, «UUID на входе»). `UUID`
|
||||
pydantic шире контракта: принимает запись без дефисов, с `urn:uuid:` и
|
||||
в `{…}` (проверено на pydantic 2.13). Поэтому всё, что UUID передаёт
|
||||
клиент, — `chat_id` в пути и элементы `member_ids`, с лабы 4 и
|
||||
`attachment_ids`, — объявляется типом `UuidIn` из
|
||||
`src/api/schemas/common.py` (`BeforeValidator` с `UUID_PATTERN` и
|
||||
`re.fullmatch`), а не голым `UUID`. Модели ответов — обычный `UUID`.
|
||||
Не-строку `UuidIn` отдаёт валидатору `UUID`, и `[]`, `{}`, `123`,
|
||||
`false` дают 400 по типу.
|
||||
|
||||
## Аутентификация и сессии (лаба 2)
|
||||
|
||||
Переход 1 → 2 (`COURSE.md`): регистрация требует `password`,
|
||||
`X-User-Id` заменён Bearer. Реализация — `auth.md`.
|
||||
|
||||
- Без аутентификации — только `POST /api/v1/users` и health.
|
||||
`POST /api/v1/auth/sessions` принимает только `Authorization: Basic`,
|
||||
без JSON-тела, и отвечает `201 Session`. Всё остальное, включая
|
||||
`DELETE /api/v1/auth/sessions/current`, принимает только
|
||||
`Authorization: Bearer <token>`.
|
||||
- Basic на бизнес-ручке — 401 с вызовом Bearer: smoke шлёт верный Basic
|
||||
на `GET /users/me` и ждёт 401.
|
||||
- `X-User-Id` игнорируется: доступа не даёт и владельца сессии не
|
||||
меняет. Smoke шлёт Bearer alice вместе с `X-User-Id` eve и ждёт alice.
|
||||
- Сначала аутентификация, потом доступ: без токена — 401 даже на
|
||||
чужой чат. Чужой и несуществующий чат дают одинаковый 404, 403 не
|
||||
используется.
|
||||
- В `User` нет пароля, его хэша и данных сессии.
|
||||
- Logout — 204 без тела; тот же токен после него — 401.
|
||||
|
||||
## Чаты и сообщения
|
||||
|
||||
- Чат создаётся атомарно. `GET /api/v1/chats` возвращает только чаты
|
||||
текущего пользователя, по `(created_at, id)` по возрастанию, с
|
||||
`limit` / `cursor`, как история.
|
||||
- Любой участник читает чат и историю и пишет в чат. Посторонний
|
||||
получает 404 на `GET` чата, историю и `POST` сообщения.
|
||||
|
||||
## Пагинация (keyset)
|
||||
|
||||
- Порядок `(created_at, id)` по возрастанию. `id` сравнивается как UUID
|
||||
(`uuid.UUID(x).int`) — так же сортирует smoke.
|
||||
- Ответ: `{"items": [...], "next_cursor": null | "..."}`. `next_cursor`
|
||||
равен null, когда следующей записи нет на момент чтения. Страница
|
||||
ровно из `limit` элементов при пустом остатке тоже даёт null, поэтому
|
||||
repo выбирает `limit + 1`.
|
||||
- Курсор непрозрачный (`src/utils/cursor.py`): ключ последнего элемента
|
||||
плюс область — чат или список чатов пользователя. Курсор другого чата
|
||||
или пользователя, битая base64 или JSON → 400. Последний элемент
|
||||
предыдущей страницы не повторяется. `limit` между страницами можно
|
||||
менять.
|
||||
- Изменённый курсор — 400, а не 500 и не страница (спек `pagination`,
|
||||
«Изменённый курсор»). `decode_cursor` проверяет поля по отдельности
|
||||
(change `strict-id-validation`):
|
||||
- `v` — ровно целое 1 (`type(v) is int`: `True == 1`);
|
||||
- `t` и `i` — строки до `strptime` и `UUID()`: `UUID()` на не-строке
|
||||
роняет `AttributeError`, а не `ValueError`;
|
||||
- `i` — в записи сервера, `str(UUID(i)) == i`.
|
||||
- Незнакомые поля курсора игнорируются, и курсор не сравнивается с
|
||||
обратной сборкой (`encode_cursor(...) == cursor`): иначе формат закрыт,
|
||||
и даже совместимая правка (необязательное поле, порядок ключей,
|
||||
`to_rfc3339`, общий с ответами) давала бы 400 курсорам реплики другой
|
||||
версии во время `make rolling_update`. Тесты такое окно не ловят:
|
||||
курсор в них выдаёт и проверяет один код.
|
||||
- Формат курсора, который прежний код не прочтёт (переименованное поле,
|
||||
другая запись времени), — новая `CURSOR_VERSION`. На время замены
|
||||
реплик новая версия принимает и старую `v`: курсор, выданный старой
|
||||
репликой, приходит на новую. Старую версию убирать отдельной правкой,
|
||||
когда старых реплик не осталось.
|
||||
- Семантику при конкурентных вставках и ограничения часов описать в
|
||||
`REPORT.md` (например: `created_at` монотонен внутри чата).
|
||||
- В Postgres порядок и курсор задаёт SQL: сравнение кортежей
|
||||
`(created_at, id)` по индексу `(chat_id, created_at, id)`, без
|
||||
`OFFSET` (`repo-layer.md`). `uuid` Postgres сравнивает побайтно, это
|
||||
тот же порядок, что `UUID.int`.
|
||||
|
||||
## Сохранность (с лабы 2)
|
||||
|
||||
Пользователи, чаты, участники, сообщения и ещё действующие сессии
|
||||
переживают рестарт API и всех хранилищ с сохранёнными volumes: тот же
|
||||
токен после рестарта читает те же данные. TTL из-за рестарта не
|
||||
продлевается. Проверка — `make test-persistence
|
||||
ACTION_SCRIPT=scripts/restart.sh` (`tests/README.md`), hook —
|
||||
`docker.md`. Подтверждённое сообщение видно следующему чтению **через
|
||||
любую реплику**: история не кэшируется, кэш карточки чата не отдаёт
|
||||
устаревших данных (состав чата неизменен).
|
||||
|
||||
## Балансировка и повторная отправка (лаба 3)
|
||||
|
||||
Переход 2 → 3 (`COURSE.md`): `Idempotency-Key` обязателен для отправки
|
||||
сообщения, ответы API содержат `X-Instance-Id`. Семантика —
|
||||
`contracts/README.md`, раздел «Балансировка и повторная отправка».
|
||||
Реализация — `api-layer.md` (заголовки), `service-layer.md`
|
||||
(транзакция), `balancer.md` (стенд).
|
||||
|
||||
- `X-Instance-Id` — в каждом ответе, созданном API: успех, ошибки,
|
||||
health, 404 неизвестного пути, 405, 500. Значение стабильно, пока жив
|
||||
процесс, и одно на процесс. Ответ, который сгенерировал сам HAProxy
|
||||
(502/503/504 при недоступных репликах), заголовка может не иметь —
|
||||
контракт это допускает.
|
||||
- `Idempotency-Key` — только у `POST /api/v1/chats/{chat_id}/messages`,
|
||||
ASCII `^[A-Za-z0-9._:-]{1,128}$` на всю строку. Нет ключа или он
|
||||
неверный — 400 `invalid_request`. Smoke: `POST` без ключа от
|
||||
участника — 400. Другие `POST` ключ не требуют и не обрабатывают.
|
||||
- Область уникальности — пользователь + метод + путь чата + ключ.
|
||||
Ключ принимает одна ручка, поэтому область — `(user_id, chat_id,
|
||||
key)`. Одинаковый ключ у разных пользователей или в разных чатах —
|
||||
независимые сообщения.
|
||||
- Повтор того же тела в течение 24 ч (`IDEMPOTENCY_TTL_SECONDS`, у нас
|
||||
`[idempotency] ttl_seconds`) — **тот же 201 и то же `Message`**: тот
|
||||
же `id`, `created_at` до микросекунды, тот же текст. Smoke сравнивает
|
||||
JSON целиком (`replay == first`). «То же тело» — семантически: порядок
|
||||
ключей JSON не важен, отсутствующий `attachment_ids` равен `[]` (с
|
||||
лабы 4). Другое тело с тем же ключом — 409 `conflict`.
|
||||
- Повтор заново проверяет сессию и доступ: отозванный токен — 401,
|
||||
посторонний — 404, даже если ключ уже сохранён.
|
||||
- Конкурентные повторы через разные реплики создают ровно одно
|
||||
сообщение; все успешные ответы одинаковы. Транзиентная ошибка (5xx,
|
||||
отказ БД) результатом не фиксируется: ключ и сообщение пишутся в
|
||||
одной транзакции, откат убирает оба.
|
||||
- Порядок кодов: ключ объявлен параметром ручки (`Header`), а FastAPI
|
||||
проверяет параметры и тело после зависимостей (раздел «FastAPI»).
|
||||
Значит, ожидаемый порядок — 401 (сессия) → 400 (ключ, тело) → 404
|
||||
(не участник) → 409 (другое тело). Исключение то же, что везде:
|
||||
битый JSON — 400 раньше 401. Порядок закрепить тестом в
|
||||
`student-tests/`, а не считать доказанным.
|
||||
- Прозрачных повторов других `POST` нет ни в API, ни в LB: создание
|
||||
чата или регистрация при повторе создали бы второй объект
|
||||
(`balancer.md`, повторы LB только на отказ соединения). Загрузка
|
||||
вложения тоже не идемпотентна: повтор — второе вложение.
|
||||
|
||||
## Вложения (лаба 4)
|
||||
|
||||
Семантика — `contracts/README.md`, «Вложения (с lab4)», и спек
|
||||
`attachments`; устройство — design change `attachments`.
|
||||
|
||||
- Ручки: `POST /api/v1/chats/{chat_id}/attachments?filename=…` — сырые
|
||||
байты одного PNG/JPEG (не multipart, не JSON), с лабы 5 — `202 Attachment`
|
||||
со снимком `status=queued`, `variants=[]`, `error_code=null` только после
|
||||
записи объекта в staging и `queued` с заданием в PostgreSQL; брокера в пути
|
||||
запроса нет: его отказ не меняет ни кода, ни срока ответа (design change
|
||||
`pipeline-reliability`, решение 1); `GET /api/v1/attachments/{id}` — метаданные: `queued`,
|
||||
`processing`, `ready`, `failed` — 200, у `ready` есть `variants`, у `failed`
|
||||
— `error_code` (`invalid_image`, `processing_failed`, `retry_exhausted`);
|
||||
`GET …/{id}/content` — байты оригинала или варианта потоком, `Content-Type`
|
||||
без параметров, `Content-Length`, `X-Content-Type-Options: nosniff`, без
|
||||
redirect. `variant` — `original`, `thumbnail`, `crop`, `optimized` (иное —
|
||||
400): у вложений этого уровня есть все три, у `ready` прежней версии — только
|
||||
thumbnail. Не `ready` — 409 `conflict` на любой `variant`; варианта нет — 404.
|
||||
Ключ объекта, адрес и ключи S3 в ответ не попадают.
|
||||
- Доступ — любой участник чата вложения. Посторонний, неизвестный id и
|
||||
вложение в статусе `pending` — одинаковый 404 «Not found».
|
||||
- Порядок проверок загрузки: 401 → 400 (`chat_id`, `filename`, их
|
||||
проверяет FastAPI после зависимостей) → 404 (членство) → 415
|
||||
(`Content-Type`: тип до `;`, без регистра) → 413 (`Content-Length`) →
|
||||
429 (предел незавершённых заданий, с change `track1-queue-overload`) →
|
||||
429 (место загрузки, с change `upload-memory`) → тело: 413 (счётчик
|
||||
прочитанного), 400 (тело не пришло за `[uploads]
|
||||
body_timeout_seconds` — `UploadTimedOut`, или обрыв —
|
||||
`UploadInterrupted`) → 415/413 (содержимое: сигнатура и подмена MIME,
|
||||
целостность, пиксели). Тело не читается до пройденных 1–7; отказ на
|
||||
1–6 места не ждёт и не занимает (посторонний и заведомо большое тело не
|
||||
вытесняют живые загрузки). Пустое тело — 415.
|
||||
- Места загрузки (спек `attachments`, «Одновременные загрузки реплики»;
|
||||
`service-layer.md`): `[uploads] max_concurrent` (4) на процесс, очередь
|
||||
до `max_waiting` (16) по порядку прихода, ожидание не дольше
|
||||
`wait_timeout_seconds` (5 с); очередь полна — 429 сразу, срок вышел —
|
||||
429 по сроку. Место держится до ответа. LB 429 не повторяет, повтор —
|
||||
клиент после `Retry-After`. Ни строки, ни объекта у 429 и у 400 по
|
||||
сроку тела нет.
|
||||
- Лимиты — константы `ATTACHMENT_MAX_BYTES` (10 485 760) и
|
||||
`ATTACHMENT_MAX_PIXELS` (40 млн), не настройки (`settings.md`). Ровно
|
||||
лимит проходит.
|
||||
- Целостность — структурная проверка без декодирования пикселей
|
||||
(`src/utils/image.py`): у PNG CRC чанков, поток IDAT ровно в объём по
|
||||
размерам, типы фильтров строк, IEND; у JPEG маркеры, таблицы DQT и
|
||||
DHT, один SOF, скан, EOI. Для скана — его компоненты есть в кадре,
|
||||
полоса прогрессивного скана допустима, нужные таблицы определены,
|
||||
есть данные у скана с кодами Хаффмана. Таблицы Хаффмана 0 и 1
|
||||
непрогрессивного кадра необязательны: декодер берёт стандартные (Motion
|
||||
JPEG). Условия — те, на которых `djpeg` падает
|
||||
(`evidence/attachments/jpeg-structure.md`). Новое условие сверять с
|
||||
libjpeg-turbo, иначе декодируемый файл получит 415. Хвост после
|
||||
IEND/EOI — часть оригинала. Байт внутри данных скана JPEG не ловится —
|
||||
граница, она названа в спеке и `REPORT.md`.
|
||||
- `filename` — 1–255 code points; 400 только по списку контракта: `/`,
|
||||
`\`, управляющие символы категории Unicode Cc (U+0000–U+001F,
|
||||
U+007F–U+009F) и строка из одних пробелов. Символы форматирования и
|
||||
направления текста (Cf, U+202E, U+2066), U+2028/U+2029 принимаются и
|
||||
возвращаются без изменений (решение пользователя 2026-10-20). Имя
|
||||
только отображается: ни в ключ, ни в путь, ни в журнал. Процент-коды
|
||||
`filename` — строгий UTF-8: Starlette меняет неверные байты на U+FFFD
|
||||
(`a%FFb.png` прошёл бы с 201), поэтому ручка сама разбирает
|
||||
`scope["query_string"]` (`_check_filename_encoding`): неверный UTF-8 и
|
||||
байт вне ASCII — `InvalidFilename` (400) до проверки членства.
|
||||
- `attachment_id` в пути и элементы `attachment_ids` в теле — `UuidIn`
|
||||
(раздел «Валидация → 400»). `attachment_ids`: 0–10, без повторов (и в
|
||||
другом регистре), иначе 400; каждое — принятое вложение этого чата
|
||||
(`queued`, `processing`, `ready`), иначе 404 до захвата ключа
|
||||
идемпотентности; `failed` — 409 после захвата, с откатом, а повтор уже
|
||||
отправленного сообщения с тем же ключом — тот же 201 (вопрос преподавателю,
|
||||
`QUESTIONS.md`). Ответы — id в нижнем регистре, в порядке отправки.
|
||||
- Текст сообщения: до 4000 code points; пустой текст — `""` или строка
|
||||
из одних пробельных символов — допустим только с хотя бы одним
|
||||
вложением, без вложений 400. Сохраняется как прислан, без обрезки
|
||||
(согласовано с преподавателем 2026-10-20, AGENTS.md). Правило держит
|
||||
валидатор `CreateMessage`; CHECK в БД — только верхняя граница.
|
||||
- Ранний ответ: 404, 413 и 415 отдаются, не дочитав тело. httpx и `curl`
|
||||
получают его и напрямую, через LB — любой клиент (HAProxy дочитывает
|
||||
тело сам). `urllib` напрямую к одной реплике ранний ответ на большом
|
||||
теле теряет (`BrokenPipe`) — ограничение, оно в `REPORT.md`; тесты на
|
||||
httpx.
|
||||
- Потерянный оригинал (design change `track2-reconciler`, решение 5):
|
||||
если сверка подтвердила, что объекта готового вложения нет или размер
|
||||
другой, и пометила его (`lost_at`), скачивание — 404 `not_found` без
|
||||
обращения к S3, как «отсутствующий вариант ready-объекта»
|
||||
(`contracts/README.md`); метаданные — 200 тем же `Attachment`
|
||||
(`status=ready`, `error_code=null`: другого статуса контракт лабы 4 не
|
||||
знает), ссылка в новом сообщении — 201. До пометки — 500, как выше.
|
||||
Контракт неоднозначен («404 — объекта нет», «неожиданное исключение —
|
||||
500», `status` только `ready`): это вопрос преподавателю
|
||||
(`TEACHER_QUESTIONS.md`, локальный, п. 12; разбор — отчёт лабы 4), сделан вариант по
|
||||
умолчанию. Ответ «иначе» меняет ветку `open_content`, сценарий
|
||||
`attachments` «Потерянный оригинал» и тест
|
||||
`test_reconcile_finds_and_fixes`.
|
||||
- Отказ S3 — 503 только на загрузке и скачивании байтов. Метаданные,
|
||||
сообщения (в том числе со ссылкой на готовое вложение), история и
|
||||
`/health/ready` работают без S3. Отказ брокера, relay и worker API не видит:
|
||||
загрузка — 202, готовность — 200.
|
||||
@@ -0,0 +1,143 @@
|
||||
---
|
||||
paths:
|
||||
- "src/api/**"
|
||||
- "src/main.py"
|
||||
---
|
||||
|
||||
# Слой API (`src/api/`, `src/main.py`)
|
||||
|
||||
FastAPI, один процесс на реплику; реплик ≥2 за HAProxy (`balancer.md`).
|
||||
Что обязан отдавать HTTP — `.claude/rules/api-contract.md`; здесь — как
|
||||
устроен слой.
|
||||
|
||||
- В памяти процесса нет состояния, от которого зависит ответ: любой
|
||||
запрос может прийти на любую реплику. Сессии, данные и ключи
|
||||
идемпотентности — в Postgres; глобалы модулей — только клиенты
|
||||
хранилищ и неизменяемые значения (`instance_id`, фиктивный хэш
|
||||
пароля).
|
||||
|
||||
## Роутинг
|
||||
|
||||
| Что | Файл | Путь |
|
||||
|---|---|---|
|
||||
| health | `routers/health.py` | `/health/live`, `/health/ready` — вне версии, без идентификации, из access-лога исключены |
|
||||
| ручки v1 | `routers/v1/<domain>.py` | `/api/v1/<prefix>/...` |
|
||||
|
||||
- Модуль домена: `router = APIRouter(prefix="/users", tags=["users"])`.
|
||||
Вложенный ресурс — префикс с параметром: `message.py` →
|
||||
`prefix="/chats/{chat_id}/messages"`. Логгер модуля
|
||||
`module="api_<domain>_router"`.
|
||||
- Исключение — `attachment.py` (лаба 4): один роутер домена с двумя
|
||||
префиксами путей, `APIRouter(tags=["attachments"])` и полные пути
|
||||
`/chats/{chat_id}/attachments`, `/attachments/{attachment_id}` и
|
||||
`/attachments/{attachment_id}/content` в декораторах.
|
||||
- Версию задаёт `v1_router` (`API_V1_PREFIX` из `src/utils/constants.py`)
|
||||
в `routers/v1/__init__.py`. Регистрация домена — импорт и
|
||||
`v1_router.include_router(...)` там, больше нигде.
|
||||
- `src/main.py`: `app = FastAPI(...)`, lifespan, middlewares, обработчики
|
||||
ошибок (`errors.register(app)`), `include_router` для health и
|
||||
`v1_router`. `src/__init__.py` пустой: импорт любого модуля `src` не
|
||||
должен поднимать приложение.
|
||||
- Новая версия API — пакет `routers/v2/` рядом с v1, v1 не ломать.
|
||||
|
||||
## Внутри ручки
|
||||
|
||||
- Ручки и зависимости — только `async def`: драйвер БД асинхронный, а
|
||||
синхронная `def` ушла бы в threadpool. CPU-тяжёлую работу (KDF пароля)
|
||||
явно выносят в поток (`auth.md`).
|
||||
- Ручка: зависимости → вызов сервиса именованными аргументами →
|
||||
DTO в модель ответа (`UserOut.model_validate(dto)`, у модели
|
||||
`from_attributes=True`). Логики, импортов repo и хранилища здесь нет.
|
||||
- Текущий пользователь — `Depends(get_current_user)` из
|
||||
`dependencies.py`, по Bearer-токену (`auth.md`). Сервис —
|
||||
зависимость-фабрика (`Depends(get_chat_service)`), которая собирает
|
||||
его из `UowDep`: `get_uow` создаёт `SqlAlchemyUnitOfWork` на запрос поверх
|
||||
глобального `session_factory` (`src/infra/db/session.py`), кэш зависимостей
|
||||
отдаёт входу и сервису один экземпляр, а их блоки идут по очереди. Соединение
|
||||
занято только на шаг: на хэш пароля, между шагами и на передачу ответа оно в
|
||||
пуле (`infra.md`, change `unit-of-work`, решение 5). Фиксирует сервис
|
||||
(`service-layer.md`).
|
||||
- Общий срок JSON-запроса — `request_deadline`: зависимость с `yield` вокруг
|
||||
`deadline_scope` (`src/infra/db/scope.py`), подключена в
|
||||
`routers/v1/__init__.py` на роутерах пользователей, сессий, чатов и сообщений
|
||||
(`json_deadline`), та же настройка `[database] request_timeout_seconds`.
|
||||
Срок блока один не даёт ни ответа раньше `timeout server` LB (два шага — до
|
||||
12 с), ни срока очереди хэшей (решение 6). Истёк — та же запись «Database is
|
||||
unavailable» и 503. Новый JSON-роутер получает срок одной строкой там же.
|
||||
- Длинная передача байтов (вложения, лаба 4; design change
|
||||
`attachments`, решение 5). Роутер вложений общего срока не имеет: передача
|
||||
дольше срока одного блока, у него срок только на шаг. Вход — тот же
|
||||
`CurrentUser`, соединение вернулось в пул до тела запроса. Поэтому ручки
|
||||
вложений:
|
||||
- загрузка объявляет `request: Request` и не объявляет параметр тела —
|
||||
FastAPI тело не читает; схема тела (`image/png`, `image/jpeg`,
|
||||
`format: binary`) — в `openapi_extra`. Тело уходит в сервис
|
||||
асинхронным итератором поверх `request.stream()`, обёртка переводит
|
||||
`ClientDisconnect` в доменное `UploadInterrupted` (400): в итоговой
|
||||
записи 400, а не 500 с traceback. `Content-Type` — тип до `;`, без
|
||||
пробелов, в нижнем регистре; `Content-Length` — `int` или `None`.
|
||||
До сервиса ручка проверяет кодировку `filename` по сырой строке
|
||||
запроса (`_check_filename_encoding` → `InvalidFilename`, 400):
|
||||
Starlette заменил бы неверный UTF-8 на U+FFFD (`api-contract.md`);
|
||||
- скачивание — `StreamingResponse` над генератором блоков объекта S3:
|
||||
`media_type` вложения (у `image/*` Starlette `charset` не добавляет),
|
||||
`Content-Length`, `X-Content-Type-Options: nosniff`; генератор сам
|
||||
закрывает объект в `finally`, тот же закрыватель — фоновой задачей
|
||||
ответа на случай, если генератор не начался;
|
||||
- `variant` — `Literal` четырёх значений контракта, по умолчанию
|
||||
`original`; в сервис — `AttachmentVariantName` или `None` (оригинал);
|
||||
- загрузка — `status_code=202`, а не 201: приём, а не создание готового
|
||||
объекта.
|
||||
- Ошибки — доменные исключения из сервиса. `HTTPException` не бросать.
|
||||
Статус, `code` и заголовки ответа (`WWW-Authenticate` у 401)
|
||||
назначает одна таблица в `errors.py`.
|
||||
- Модели запросов и ответов — `src/api/schemas/<domain>.py`, имена по
|
||||
схемам контракта (`CreateUser`, `User`, `ChatPage`...). В сервис модели
|
||||
API не передавать: разбирать в именованные аргументы или
|
||||
`Create<Entity>DTO`.
|
||||
- POST создания — `status_code=201` в декораторе; `response_model` —
|
||||
модель контракта.
|
||||
- `Idempotency-Key` (лаба 3) — параметр ручки `POST` сообщения:
|
||||
`Annotated[str, Header(alias="Idempotency-Key", pattern=...,
|
||||
max_length=128)]`, шаблон — константа в `src/utils/constants.py`. Так
|
||||
он есть в `/openapi.json`, а отсутствие и неверный формат дают 400
|
||||
через общий обработчик валидации. В сервис ключ уходит именованным
|
||||
аргументом вместе с телом; повтор с тем же ключом отвечает тем же 201,
|
||||
что и первый вызов (`api-contract.md`).
|
||||
|
||||
## Middlewares и обработчики ошибок
|
||||
|
||||
- Request id: генерируется на каждый запрос, пишется в contextvar
|
||||
логгера и в `request.state.request_id` и ставится заголовком
|
||||
`X-Request-Id` в ответ.
|
||||
- 500 от необработанного исключения формирует `ServerErrorMiddleware`.
|
||||
Он стоит снаружи пользовательских middleware, и заголовок из них в этот
|
||||
ответ не попадёт. Поэтому обработчик `Exception` в `errors.py` сам
|
||||
берёт id из `request.state` и ставит заголовок. Сам он не логирует:
|
||||
Starlette после ответа повторно бросает исключение, и traceback пишет
|
||||
uvicorn (`logging.md`).
|
||||
- Итоговая запись о запросе — одна строка: метод, полный шаблон пути,
|
||||
статус, длительность. Без тела, заголовков идентификации и query.
|
||||
Логи uvicorn access выключены (`access_log=False`), чтобы не было
|
||||
дублей.
|
||||
- Полный шаблон пути не брать из `scope["route"].path`: с FastAPI 0.137
|
||||
роутеры включаются деревом, и там путь без префикса `include_router`
|
||||
(`/chats/{chat_id}` вместо `/api/v1/chats/{chat_id}`). Источник —
|
||||
таблица из публичного `iter_route_contexts(app.routes)` в
|
||||
`request_context.py`. Структуру роутеров ради логов не менять.
|
||||
- С лабы 6 тот же middleware открывает server span и пишет histogram
|
||||
`http.server.request.duration` (design change `otel-telemetry`, решение 10): не для health
|
||||
(`HEALTH_PATHS` — ни записи, ни span, ни метрики), имя и атрибуты — после маршрутизации, из
|
||||
той же таблицы шаблонов, что итоговая запись (`http.route` без маршрута нет), метод — со
|
||||
стандартным набором или `_OTHER`, `messenger.request_id` — только в span. Итоговая запись
|
||||
пишется внутри span (у неё `trace_id`); 5xx и исключение — `ERROR` и `error.type`. Входящий
|
||||
`traceparent` не извлекается. Нестандартный метод, который не знает парсер uvicorn (BREW),
|
||||
до middleware не доходит (`KNOWN_ISSUES.md`). `FastAPI(version=SERVICE_VERSION)` — та же
|
||||
версия, что `service.version`.
|
||||
- `X-Instance-Id` (лаба 3) ставит тот же middleware, что и
|
||||
`X-Request-Id`, на каждый ответ, включая health, 404 и 405. Значение
|
||||
— `settings.app.instance_id` (по умолчанию hostname процесса, в
|
||||
compose — короткий ID контейнера), вычисляется один раз при старте.
|
||||
Ответ 500 собирает `ServerErrorMiddleware` снаружи пользовательских
|
||||
middleware, поэтому обработчик `Exception` в `errors.py` ставит и этот
|
||||
заголовок сам, как `X-Request-Id`.
|
||||
@@ -0,0 +1,119 @@
|
||||
---
|
||||
paths:
|
||||
- "src/**/session.py"
|
||||
- "src/core/services/user.py"
|
||||
- "src/api/dependencies.py"
|
||||
- "src/api/errors.py"
|
||||
- "student-tests/api_client.py"
|
||||
- "student-tests/test_identification.py"
|
||||
---
|
||||
|
||||
# Аутентификация и сессии (с лабы 2)
|
||||
|
||||
Что обязан отдавать HTTP — `contracts/README.md`, «Идентификация и
|
||||
сессии», и `api-contract.md`; здесь — как это реализовать. Домен
|
||||
называется `session` во всех слоях: `routers/v1/session.py` с префиксом
|
||||
`/auth/sessions`, `services/session.py`, `repos/session.py`.
|
||||
|
||||
## Пароль
|
||||
|
||||
- KDF — Argon2id (`argon2-cffi`). Контракт разрешает Argon2id, scrypt и
|
||||
bcrypt, но bcrypt режет пароль на 72 байтах, а пароль до 128 code
|
||||
points в UTF-8 занимает до 512 байт. Lab7 требует именно Argon2id, и
|
||||
выбор сейчас избавляет от перехэширования. SHA-256 и plaintext
|
||||
запрещены. Параметры KDF — в `REPORT.md`.
|
||||
- Хэширование и проверка занимают десятки миллисекунд CPU. В event
|
||||
loop их не вызывать: `await anyio.to_thread.run_sync(...)`, иначе
|
||||
один вход останавливает все запросы процесса.
|
||||
- Всё это — `src/infra/password.py`: профиль
|
||||
`RFC_9106_LOW_MEMORY` (t=3, m=64 MiB, p=4) назван явно, а не взят
|
||||
умолчанием библиотеки; свой `CapacityLimiter` на
|
||||
`[auth] kdf_concurrency` (4), а не общий пул anyio на 40 потоков:
|
||||
40 × 64 MiB = 2,5 GiB (design change `session-auth`, решение 3).
|
||||
- Регистрация хэширует пароль до блока единицы работы. Вход читает хэш в
|
||||
блоке и выходит из него до проверки пароля (писать нечего, откат): соединение
|
||||
пула не ждёт KDF и очередь лимита; сессия вставляется вторым блоком. Срок
|
||||
очереди KDF — общий срок JSON-запроса (`request_deadline`, `api-layer.md`).
|
||||
- Пароль хэшируется целиком как UTF-8, без обрезки и нормализации.
|
||||
Хэш не выходит за пределы repo и сервиса входа: в `UserFullDTO` и в
|
||||
ответе API его нет (`dto.md`).
|
||||
- Неизвестный username и неверный пароль — одно исключение и одинаковый
|
||||
401. Для неизвестного username пароль всё равно проверяется против
|
||||
фиктивного хэша, чтобы время ответа не выдавало, есть ли пользователь.
|
||||
Фиктивный хэш считает lifespan при старте (`prepare_dummy_hash`): при
|
||||
ленивом расчёте первый такой вход шёл бы вдвое дольше.
|
||||
|
||||
## Basic на входе
|
||||
|
||||
- Разбор свой, `HTTPBasic` FastAPI не годится (`api-contract.md`,
|
||||
«FastAPI»). Схему `basicAuth` объявляет
|
||||
`HTTPBase(scheme="basic", scheme_name="basicAuth", auto_error=False)`
|
||||
(импорт из `fastapi.security.http`: из `fastapi.security` его нет): он
|
||||
отдаёт схему и credentials как есть. Дальше схема `Basic` без учёта
|
||||
регистра → base64 строго (`b64decode(..., validate=True)`) → UTF-8 →
|
||||
`partition(":")` по **первому** двоеточию: в username двоеточия не
|
||||
бывает, в пароле оно допустимо. Любой сбой разбора — тот же 401, что и
|
||||
неверный пароль.
|
||||
- Username не по шаблону и пароль вне 12–128 code points отсекаются при
|
||||
разборе: тот же 401 без запроса к БД и KDF. Формат публичный, о
|
||||
пользователях такой отказ ничего не говорит.
|
||||
- JSON-тело на входе не читается.
|
||||
- 401 входа — с `WWW-Authenticate: Basic realm="messenger",
|
||||
charset="UTF-8"`.
|
||||
|
||||
## Токен и сессия
|
||||
|
||||
- Токен — `secrets.token_urlsafe(32)`: 256 бит энтропии, 43 символа
|
||||
(контракт требует не меньше 32). Не JWT, не UUID, ничего не кодирует.
|
||||
- Хранится не токен, а его SHA-256, поиск идёт по нему. Быстрого хэша
|
||||
здесь достаточно: у токена 256 бит энтропии, перебирать нечего. Пароль
|
||||
же выбирает человек, поэтому ему нужен медленный KDF — это вопрос
|
||||
защиты.
|
||||
- `expires_at = utcnow() + TTL` фиксируется при создании и хранится.
|
||||
Ни использование, ни рестарт срок не продлевают. На каждом запросе
|
||||
проверяется: сессия есть, не отозвана, `expires_at` в будущем.
|
||||
- TTL — `[auth] session_ttl_seconds` в `config.toml`; контрактное имя
|
||||
`SESSION_TTL_SECONDS` сопоставлено с ним в `REPORT.md`, мостом не
|
||||
заводится (`settings.md`). Разовая подмена —
|
||||
`AUTH__SESSION_TTL_SECONDS` в окружении. По умолчанию 3600, в обычном
|
||||
smoke не меньше 300, в тесте истечения — 2.
|
||||
- `DELETE /auth/sessions/current` отзывает только текущую сессию, дальше
|
||||
этот токен получает 401.
|
||||
- Сессии — в PostgreSQL, без кэша: отзыв мгновенный (design change
|
||||
`session-auth`). Таблица `sessions`: id, `user_id` (внешний ключ),
|
||||
SHA-256 токена (`bytea`, уникальный индекс, `CHECK` на 32 байта),
|
||||
`created_at` и `expires_at` (`timestamptz`). Отзыв — удаление строки.
|
||||
Проверка токена — один `SELECT` по `token_hash` с `JOIN` на
|
||||
пользователя; `now` для `expires_at > now` передаёт сервис, срок
|
||||
сравнивается по часам приложения.
|
||||
- Valkey сессии не хранит: он — кэш карточек чатов (спек
|
||||
`chat-cache`, change `membership-cache`). Любое хранилище сессий
|
||||
обязано пережить рестарт, соблюдать срок и отзыв, при недоступности
|
||||
отвечать 503 и никогда не пропускать запрос как анонимный или
|
||||
доверенный.
|
||||
|
||||
## Текущий пользователь
|
||||
|
||||
- `get_current_session` (`src/api/dependencies.py`):
|
||||
`HTTPBearer(scheme_name="bearerAuth", bearerFormat="opaque session
|
||||
token", auto_error=False)` — как в контракте → токен или `None` →
|
||||
`SessionService.authenticate` → `CurrentSessionDTO` (id сессии и
|
||||
`UserFullDTO`). Иначе `Unauthenticated` → 401 с `WWW-Authenticate:
|
||||
Bearer realm="messenger"`. `get_current_user` берёт пользователя из
|
||||
неё, logout — id сессии.
|
||||
- `X-User-Id` не читается нигде. Basic на бизнес-ручке для `HTTPBearer`
|
||||
— чужая схема: он отдаёт `None`, и получается тот же 401 с вызовом
|
||||
Bearer.
|
||||
- Заголовок `WWW-Authenticate` ставит таблица `errors.py` по типу
|
||||
исключения. Исключений два, для входа и для Bearer, а не одно с
|
||||
параметром.
|
||||
- `current_user_id` (contextvar логгера) ставится только после успешной
|
||||
проверки.
|
||||
|
||||
## Логи
|
||||
|
||||
Никогда не логируются пароль, токен, его хэш и заголовок
|
||||
`Authorization`. Создание и отзыв сессии — `info` с `user_id` и id
|
||||
сессии, неудачный вход — `warning` без username и пароля
|
||||
(`logging.md`). Параметры SQL в журнал не попадают: engine создан с
|
||||
`hide_parameters=True` (`infra.md`).
|
||||
@@ -0,0 +1,462 @@
|
||||
---
|
||||
paths:
|
||||
- "docker-compose.yml"
|
||||
- "infra/haproxy/**"
|
||||
- "scripts/stop-one.sh"
|
||||
- "scripts/rolling-update.sh"
|
||||
---
|
||||
|
||||
# Реплики за балансировщиком (с лабы 3)
|
||||
|
||||
Задание — `README.md` лабы 3, роли — `contracts/infrastructure.json`,
|
||||
семантика `X-Instance-Id` и `Idempotency-Key` — `api-contract.md`.
|
||||
Общие правила compose, пинов и volumes — `docker.md`; здесь то, что
|
||||
добавляет лаба 3. Почему HAProxy — `REPORT.md`, «Балансировщик и
|
||||
реплики» (таблица сравнения), и design change `replicas-lb`, решение 1;
|
||||
числа и их обоснование — тот же design (архив
|
||||
`openspec/changes/archive/`), спек `load-balancing`.
|
||||
|
||||
```
|
||||
клиент → 127.0.0.1:APP_OUT_PORT → haproxy → api × API_REPLICAS → postgres (данные, сессии, ключи)
|
||||
→ valkey (кэш карточек)
|
||||
→ s3 (байты вложений, с лабы 4)
|
||||
migrate (один раз на up) ──────→ postgres
|
||||
s3-bootstrap (один раз на up) ─→ s3 (bucket, пользователи API и уборщика)
|
||||
cleaner (долгоживущий, с лабы 4) → postgres, s3 (незавершённые загрузки)
|
||||
```
|
||||
|
||||
Реплики ждут обоих одноразовых сервисов (`service_completed_successfully`).
|
||||
|
||||
## Сервисы compose
|
||||
|
||||
- **`haproxy`** — единственный сервис с портом наружу:
|
||||
`127.0.0.1:${APP_OUT_PORT:-8080}:${APP__PORT:-8080}` (внутри LB
|
||||
слушает тот же `APP__PORT`, что реплики). Образ закреплён тегом с
|
||||
патч-версией и digest индекса (`docker.md`), сейчас 3.4 LTS. Конфиг —
|
||||
`infra/haproxy/haproxy.cfg`, монтируется read-only длинной записью с
|
||||
`create_host_path: false`. Окружение — только `API_PORT`, секретов LB
|
||||
не получает. `depends_on: api` (`service_started`): `make stop` гасит
|
||||
LB раньше реплик. Healthcheck — `bash` с `/dev/tcp` на
|
||||
`/lb/ready` (curl в образе нет): `healthy` значит «есть готовая
|
||||
реплика». Лимиты CPU/RAM.
|
||||
- **`api`** — `deploy.replicas: ${API_REPLICAS:-2}`, без `ports`,
|
||||
без `container_name`: оба мешают масштабированию одного сервиса
|
||||
(рубрика «4»). Разовая подмена — `make replicas API_REPLICAS=N`.
|
||||
Лимиты CPU/RAM у каждой реплики, `stop_grace_period: 10s`,
|
||||
`restart: unless-stopped`.
|
||||
- **`migrate`** — как в лабе 2: один раз до реплик, реплики ждут
|
||||
`service_completed_successfully` (`migrations.md`).
|
||||
- **`s3`, `s3-bootstrap`** (с лабы 4) — сервер S3 и его bootstrap
|
||||
(`docker.md`, раздел S3). Реплики ждут bootstrap, как миграций.
|
||||
- Лимиты CPU/RAM у **всех** сервисов, включая postgres, valkey и
|
||||
migrate (`deploy.resources.limits`). Сумма — в `REPORT.md`, рядом с
|
||||
расчётом соединений Postgres (`infra.md`).
|
||||
|
||||
## HAProxy
|
||||
|
||||
- Имена прокси разные: `frontend entry`, `backend api`, `frontend
|
||||
monitor`. С HAProxy 3.3 frontend и backend с одним именем — ошибка
|
||||
конфигурации. Проверка конфига — `haproxy -c` в закреплённом образе
|
||||
с `API_PORT`.
|
||||
- Реплики находятся через DNS Docker, а не списком адресов:
|
||||
`resolvers` на `127.0.0.11:53` и `server-template api- <N> api:<порт>
|
||||
check resolvers docker init-addr none`. Новая и пропавшая реплика
|
||||
видны без перезагрузки LB (`hold` 1 с). `<N>` — запас слотов не
|
||||
меньше максимального числа реплик в сериях трека 1 (сейчас 8). Слоты
|
||||
HAProxy (`api-1`, `api-2`) не совпадают с именами контейнеров
|
||||
compose: слот получает адрес из DNS.
|
||||
- `init-state down` у слотов: адрес из DNS появляется при старте
|
||||
контейнера, раньше, чем uvicorn слушает порт. Без него слот сразу
|
||||
`UP`, и запросы уходят на неготовую реплику; с ним — только после
|
||||
`rise` проверок `/health/ready` (старт LB, `make replicas`,
|
||||
поочерёдная замена).
|
||||
- Проверка готовности — активная: `option httpchk GET /health/ready`,
|
||||
`http-check expect status 200`, `inter`/`fall`/`rise` и
|
||||
`timeout check` явно. `/health/live` для LB не годится: живой
|
||||
процесс без Postgres не обслуживает запросы.
|
||||
- `balance roundrobin`, без `cookie` и `stick-table`: sticky session
|
||||
запрещён (README, п. 3), а разные `X-Instance-Id` у запросов одной
|
||||
сессии — проверка уровня 3.
|
||||
- Повтор запроса в LB — только `retry-on conn-failure` с `retries` и
|
||||
`option redispatch 1` (каждый повтор — на другую реплику). Запрос до
|
||||
реплики не дошёл, поэтому повтор безопасен для любого метода.
|
||||
`response-timeout`, `empty-response`, `5xx` не повторяются: `POST
|
||||
/chats` и `POST /users` не идемпотентны (`api-contract.md`). `POST`
|
||||
сообщения клиент повторяет сам, с тем же ключом.
|
||||
- `X-Request-Id` и `X-Instance-Id` ставит API, LB их не переписывает.
|
||||
Ответы, которые сгенерировал сам HAProxy (502/503/504), отдаются в
|
||||
формате ошибки контракта через `http-error … lf-string` с `code`
|
||||
`unavailable` (в перечислении кодов контракта нет отдельных для 502 и
|
||||
504); `request_id` — `%[unique-id]`, он же в заголовке
|
||||
`X-Request-Id`. `X-Instance-Id` у них нет — контракт это допускает.
|
||||
С change `upload-memory` так же `http-error status 400` с `code`
|
||||
`invalid_request`: неверный запрос и клиент, замолчавший посреди тела
|
||||
дольше `timeout client` (30 с; до change — HTML). 408 на медленные
|
||||
заголовки (`timeout http-request`) HAProxy строит до потока запроса,
|
||||
`http-error` его не меняет — остаётся HTML (`KNOWN_ISSUES.md`,
|
||||
`REPORT.md`).
|
||||
- `tune.sndbuf.server 262144` в `global` (change `upload-memory`,
|
||||
решение 6): буфер отправки LB к реплике фиксирован, тело загрузки,
|
||||
которое реплика не читает (ожидание места, отказ до тела), не копится
|
||||
в памяти LB целиком. Рядом — `tune.rcvbuf.client 131072` (apply,
|
||||
design «Уточнения apply», п. 11): буфер приёма от клиента фиксирован,
|
||||
иначе ядро растит его до `tcp_rmem` ВМ (32 MiB), и тело, которое LB не
|
||||
может отдать реплике, копится там — до 9 MiB на сокет клиента, `sock`
|
||||
LB до 112 MiB при 40 загрузках по 10 MiB. С ним `make
|
||||
bench_uploads_quick` («с лимитом», 10 MiB): пик LB 35,6 / 41,4 /
|
||||
57,3 MiB при C = 1 / 10 / 40 — 0,56 MiB на клиента (было ~2,6 в
|
||||
метке, отброшенной до правки), очередь приёма сокета клиента ≤
|
||||
0,24 MiB; скорость одного клиента прежняя (11,25 загрузки/с, p50
|
||||
84 мс). Окно 128 KiB даёт ~20 Мбит/с при RTT 50 мс: 10 MiB — за ~4 с
|
||||
при сроке тела 30 с; клиенту с RTT больше ~370 мс 30 с на 10 MiB не
|
||||
хватит — ограничение в `REPORT.md`. Буфер приёма LB от реплики
|
||||
(ответы, скачивание) не меняется. `maxconn` на слот не ставится —
|
||||
менял бы поведение всех путей лабы 3.
|
||||
- Статистика — страница `/stats` и `/stats;csv` (`stats show-legends`:
|
||||
адрес слота) во `frontend monitor` на `:8404`, там же `monitor-uri
|
||||
/lb/ready` (503, если готовых реплик нет). Только внутри сети
|
||||
compose, наружу не публикуется; оператору — `make lb_stats` (CSV
|
||||
читается изнутри контейнера LB).
|
||||
- С design change `slo-alerts` (решение 2) там же `/metrics` — встроенный
|
||||
экспортёр Prometheus (`http-request use-service prometheus-exporter`).
|
||||
Забирает его **только Collector** (приёмник `prometheus/haproxy`,
|
||||
`scope=frontend&scope=backend`, отбор имён в `collector.yaml`), Prometheus
|
||||
получает ряды с `job="haproxy"` у экспортёра Collector: LB не входит в
|
||||
сеть `telemetry`, Prometheus — в сеть приложения. Порт не публиковать,
|
||||
уровень `server` (адреса реплик в метках) не забирать. Ответы самого LB
|
||||
(502, 503, 504) есть только здесь — на них стоит SLI доступности; новое
|
||||
имя прокси (`entry`, `api`) — правка правил `infra/otel/prometheus/rules.yml`
|
||||
и панелей вместе с конфигом.
|
||||
- Журнал — `log stdout`, `option httplog` + `option dontlog-normal`:
|
||||
успешные запросы не пишутся, ошибки, повторы (`+N` в поле retries),
|
||||
перенаправления и смена состояния реплик — пишутся. `nbthread` равен
|
||||
лимиту CPU контейнера LB.
|
||||
|
||||
## Цепочка таймаутов
|
||||
|
||||
Числа живут в конфигах и в таблице `REPORT.md`, обоснование каждого
|
||||
звена — design change `graceful-failover`, решение 1. Правило —
|
||||
соотношения между ними:
|
||||
|
||||
- худшее время обнаружения отказа ≤ 10 с (рубрика «3»: «не позднее
|
||||
10 секунд»). HAProxy начинает следующую проверку через интервал после
|
||||
конца предыдущей, а после первой неудачи — через `fastinter`. Поэтому
|
||||
для зависшей реплики (соединение есть, ответа нет) худшее — `inter +
|
||||
timeout check + (fall − 1) × (fastinter + timeout check)`: при 1 с /
|
||||
2,5 с / 0,5 с / `fall 2` — 6,5 с (было 8 с без `fastinter` и с 3 с;
|
||||
замер `docker pause` change `replicas-lb` — 7,3–7,7 с). Пропавший
|
||||
адрес (`stop` после выхода, `kill`) проверка ждёт не дольше таймаута
|
||||
соединения проверки min(`timeout connect`, `inter`) = 0,5 с: худшее
|
||||
2,5 с, а DNS уводит слот в обслуживание за 1–2 с. Замер по режимам —
|
||||
профиль `failover` (`bench.md`), в `REPORT.md` — формула и замер;
|
||||
- `timeout connect` × (`retries` + 1) < 2 с: таймаут клиента в
|
||||
`tests/resilience.py` — 2 с, и повтор на живую реплику должен успеть
|
||||
раньше. Поэтому `timeout connect` 500 мс, а не 1 с, и `redispatch 1`;
|
||||
- `timeout server` > `[database] request_timeout_seconds` + запас на
|
||||
KDF входа, иначе LB рвал бы ответ, который API ещё отдаст. С change
|
||||
`unit-of-work` срок настройки — на блок, а соединение занято на шаг, поэтому
|
||||
звено держит общий срок JSON-запроса `request_deadline` на роутерах
|
||||
пользователей, сессий, чатов и сообщений (`api-layer.md`): без него два шага
|
||||
дали бы до 12 с и 504 от LB вместо 503 реплики. При замороженном PostgreSQL к
|
||||
общему сроку добавляется закрытие соединения (`DB_CLOSE_TIMEOUT_SECONDS`): 6 + 2
|
||||
= 8 с < 10 с; при сроке 8 с ответ стал бы 504. Ручки вложений его не имеют:
|
||||
вход и блок метаданных и скачивания — до 12 с при `timeout server` 10 с
|
||||
(`KNOWN_ISSUES.md`, дефект прежний);
|
||||
- путь загрузки вложения (change `upload-memory`, решение 7) — свой
|
||||
`timeout server` 30 с: `http-request set-timeout server 30s if
|
||||
METH_POST { path_reg ^/api/v1/chats/[^/]+/attachments$ }` в `backend
|
||||
api`. Больше самого долгого молчания живой загрузки: до тела `2 ×
|
||||
request_timeout_seconds + [uploads] wait_timeout_seconds` = 17 с
|
||||
(вход, членство, ожидание места), а с закрытием соединения на зависшем сервере
|
||||
(`DB_CLOSE_TIMEOUT_SECONDS`, вне срока блока) до 2 × (6 + 2) + 5 = 21 с; после тела — проверка (до ~4 с) +
|
||||
tx1 6 + PUT 5 + tx2 6 = 21 с, а ветка компенсации после неудачной tx2 — ещё
|
||||
DELETE 5, 26 с: брокера в пути нет (change `pipeline-reliability`, решение 11).
|
||||
Тело ограничивают
|
||||
`[uploads] body_timeout_seconds` (30 с) и `timeout client` (30 с).
|
||||
Остальные пути — прежние 10 с: общий 30 с держал бы любой запрос к
|
||||
зависшей реплике 30 с до 504, а замеры `failover` рассчитаны на 10.
|
||||
Выражение повторяет путь ручки в `src/api/routers/v1/attachment.py`:
|
||||
при смене префикса API менять вместе. Наибольшая длительность загрузки
|
||||
U = 21 + 30 + 26 ≈ 77 с < `ROLLOUT_DRAIN_TIMEOUT` 90 с;
|
||||
`graceful_shutdown_seconds` прежний (8 с): `stop-one.sh` и `docker
|
||||
stop` — отказ, загрузка дольше 8 с обрывается, строку `pending`
|
||||
убирает уборщик. Проверка поведения — `driver.py lb-upload-timeouts`:
|
||||
временная сеть, HAProxy закреплённого образа с конфигурацией проекта
|
||||
(`--config`) и заглушка реплики под именем `api` на образе API, пять
|
||||
случаев параллельно (~35 с) — молчание 12 с до и после тела загрузки —
|
||||
201, 12 с на другом пути — 504 через ~10 с, 32 с на пути загрузки —
|
||||
504 через ~30 с, клиент молчит посреди тела — 400 в формате контракта,
|
||||
`request_id` = `X-Request-Id`; код 1 при расхождении (на
|
||||
конфигурации `f894040` — 502 и 504 через 10 с и 400 HTML). Evidence —
|
||||
`evidence/uploads/lb-timeouts.md`;
|
||||
- таймаут проверки внутри `/health/ready` (2 с) < `timeout check`
|
||||
HAProxy (2,5 с, `infra.md`): медленный PostgreSQL даёт 503 от реплики,
|
||||
а не таймаут проверки. Уменьшать таймаут готовности ради быстрого
|
||||
обнаружения нельзя: проверка берёт соединение из общего пула, и заминка
|
||||
PostgreSQL вывела бы из LB все реплики разом;
|
||||
- простаивающее соединение LB → реплика закрывает LB, а не реплика.
|
||||
`http-reuse never`: соединение с репликой не уходит в общий пул и
|
||||
живёт, пока жив сеанс клиента, а простаивающий сеанс LB закрывает по
|
||||
`timeout http-keep-alive` (10 с). `[app] keep_alive_seconds` (60 с,
|
||||
`timeout_keep_alive` uvicorn) больше. Иначе LB может отправить запрос
|
||||
в соединение, которое реплика в этот момент закрывает, и клиент
|
||||
получит 502 (`empty-response` LB не повторяет). С пулом (`http-reuse
|
||||
safe`, по умолчанию) LB держал последнее простаивающее соединение,
|
||||
пока его не закрывала реплика. Проверка — `driver.py idle-conns`;
|
||||
- `[database] idle_in_transaction_timeout_ms` (10 с) >
|
||||
`request_timeout_seconds` (6 с): PostgreSQL прерывает только
|
||||
транзакцию замороженного процесса и снимает её блокировки, в том числе
|
||||
ключа идемпотентности (`infra.md`). Проверка — `driver.py hang-key`;
|
||||
- `[app] graceful_shutdown_seconds` < `stop_grace_period` (8 < 10,
|
||||
`run-modes.md`).
|
||||
|
||||
## `scripts/stop-one.sh`
|
||||
|
||||
Hook для `make test-failover ACTION_SCRIPT=scripts/stop-one.sh`
|
||||
(`tests/README.md`), по образцу `scripts/stop-one.example.sh`.
|
||||
|
||||
- `#!/bin/sh`, `set -eu`, исполняемый бит в git. Возврат 0 не позже
|
||||
чем через 10 с: `docker stop --timeout 9` (uvicorn сам завершается
|
||||
за ≤ 8 с). Остановленная реплика остаётся остановленной,
|
||||
восстановление — отдельной командой `make replicas` (те же
|
||||
контейнеры, те же ID), её печатает `REPORT.md`.
|
||||
- `TARGET_INSTANCE_ID` — `X-Instance-Id` реплики, то есть короткий ID
|
||||
контейнера: только hex, 12–64 символа. Скрипт ищет его префиксом
|
||||
среди работающих реплик сервиса `api` **этого** проекта (`docker
|
||||
compose ps -q api`). Иначе — отказ с ненулевым кодом: Postgres,
|
||||
Valkey, LB и чужие контейнеры он не трогает никогда. Volumes не
|
||||
удаляет.
|
||||
- Режим — `STOP_MODE=stop` (по умолчанию, `docker stop`: SIGTERM и
|
||||
graceful) или `kill` (`docker kill`: отказ процесса без graceful).
|
||||
`restart: unless-stopped` не поднимает реплику ни после `stop`, ни
|
||||
после `kill` (проверено на Docker 29.8: `exited`, `RestartCount` 0
|
||||
через 15 с), поэтому `docker stop -t 0` вместо `kill` не нужен.
|
||||
- `STOP_ONE_LOG=<файл>` — необязательная строка «время,
|
||||
`TARGET_INSTANCE_ID`, полный ID контейнера, режим»: тест скрывает
|
||||
вывод hook, но передаёт ему своё окружение. Так evidence показывает,
|
||||
какой ID выбрал тест и какой контейнер остановлен.
|
||||
- Секретов и окружения не печатает: вывод hook тест скрывает, но он
|
||||
остаётся в терминале при ручном запуске.
|
||||
- Доказательство на защите и в `evidence/failover/` — какой контейнер
|
||||
остановлен: `docker compose ps` до и после, ID совпадает с
|
||||
`TARGET_INSTANCE_ID` (строка `STOP_ONE_LOG`). Одного заголовка мало
|
||||
(README, «Сценарий защиты», п. 3). Повторить для каждой реплики,
|
||||
восстанавливая предыдущую (`make replicas`). Тест останавливает
|
||||
реплику, ответившую на его первую отправку; при round-robin по двум
|
||||
репликам после `make replicas` это снова та же, поэтому перед прогоном
|
||||
для другой очередь сдвигают одним запросом через LB.
|
||||
- Оборванный ответ при `kill` (запрос уже на реплике, LB его не
|
||||
повторяет) — `driver.py --port 8080 kill-inflight` скилла
|
||||
`run-mtusi-messenger`: входы по Basic в полёте и kill реплики через
|
||||
этот hook.
|
||||
- Отказ каждой реплики под постоянной нагрузкой (рубрика «4»: RPS,
|
||||
ошибки, время восстановления) — не этот hook, а профиль `failover`
|
||||
стенда `bench/` (`make bench_failover`, `bench.md`): свой проект
|
||||
compose, `docker stop` / `kill` / `pause` реплики и возврат, шкала по
|
||||
секундам в `evidence/failover/<метка>/`.
|
||||
|
||||
## Свои цели Makefile
|
||||
|
||||
- `make replicas` — `up -d --no-deps --no-recreate --wait --scale
|
||||
api=$(API_REPLICAS) api`: запускает остановленные реплики с теми же ID
|
||||
и доводит их число до `API_REPLICAS` (разово — аргументом make).
|
||||
- `make instances` — `driver.py instances` скилла `run-mtusi-messenger`:
|
||||
вход одним синтетическим пользователем и серия `GET /users/me` с одним
|
||||
токеном, `X-Instance-Id` каждого ответа (шаг 1 сценария защиты).
|
||||
- `make lb_stats` — занятые слоты HAProxy: адрес, состояние проверки
|
||||
(в том числе `DRAIN` и `MAINT` при замене), запросы, ошибки
|
||||
соединения, повторы, перенаправления.
|
||||
- `make rolling_update [COMMIT=…] [MIGRATE=0]` — поочерёдная замена
|
||||
реплик, раздел ниже.
|
||||
|
||||
## Поочерёдная замена: `scripts/rolling-update.sh`
|
||||
|
||||
Compose не умеет rolling update сам (это `update_config` Swarm). Цель —
|
||||
`make rolling_update`, решения — design change `rolling-update`
|
||||
(решения 1–6), спек `load-balancing`. Порядок:
|
||||
|
||||
0. Предусловия, ничего не меняют (код 2):
|
||||
- работает ровно `API_REPLICAS` реплик;
|
||||
- остановленных нет: `up --scale` запустил бы остановленную старую
|
||||
вместо новой;
|
||||
- все `UP` в LB;
|
||||
- `API_REPLICAS` + 1 помещается в слоты;
|
||||
- runtime API LB отвечает;
|
||||
- нет слотов с ручным состоянием (`drain`, `maint`), которое оставила
|
||||
прерванная замена: флаги 1 и 8 в `srv_admin_state` (`show servers
|
||||
state api`). `show stat` и `make lb_stats` их не показывают: у слота
|
||||
без адреса и ручное, и DNS-обслуживание — `MAINT (resolution)`.
|
||||
|
||||
Иначе — `make replicas`; слоты с ручным состоянием — `set server
|
||||
api/<слот> state ready` (команду печатает сам скрипт).
|
||||
1. Сборка нового образа: `docker compose build api` или
|
||||
`COMMIT=<commit>` — `git archive <commit> | docker build -t <тег> -`,
|
||||
рабочее дерево не трогается.
|
||||
2. Миграции один раз: `docker compose up --no-deps --no-build
|
||||
--force-recreate --abort-on-container-exit --exit-code-from migrate
|
||||
migrate` на **новом** образе — новые ревизии лежат в нём, поэтому
|
||||
сборка раньше миграций. Пересоздаётся контейнер самого сервиса
|
||||
`migrate`, а не одноразовый `run --rm`: иначе в стенде остался бы
|
||||
`migrate` прежнего образа, и `restart.sh` (`start api` запускает его
|
||||
как зависимость) гонял бы старые миграции на новой схеме — «Can't
|
||||
locate revision», exit 255, реплики не стартуют (найдено регрессией
|
||||
`make test-persistence` в apply). Миграция только расширяет схему
|
||||
(`migrations.md`), старые реплики работают на ней. Ошибка — код 1 до
|
||||
замены. `MIGRATE=0` — откат на прежний образ: его миграции не знают
|
||||
новой ревизии, контейнер `migrate` остаётся на новом образе.
|
||||
3. `up -d --no-deps --no-recreate --no-build --scale api=N+1 api`:
|
||||
новая реплика (ID, которого не было), старые не тронуты.
|
||||
4. Новая `healthy` (на `bench/` без healthcheck — `running`) **и** `UP`
|
||||
в статистике LB по её адресу: слот начинает `DOWN` (`init-state
|
||||
down`) и включается через ≤ 1,5 с проверок. Срок
|
||||
`ROLLOUT_READY_TIMEOUT` (60 с).
|
||||
5. Вывод старой из LB через runtime API (ниже): `drain` → запросов в
|
||||
полёте (`scur`) 0, не дольше `ROLLOUT_DRAIN_TIMEOUT` 90 с (с change
|
||||
`upload-memory`; больше `timeout server` пути загрузки 30 с и
|
||||
наибольшей длительности загрузки ≈ 73 с, иначе замена обрывала бы
|
||||
живую загрузку; обычно дренаж — 0–2 с) → `maint` → `docker stop
|
||||
--timeout 10` (в строке скрипта —
|
||||
время и код выхода: 0 — graceful, 137 — SIGKILL по сроку) → `docker
|
||||
rm` → адрес ушёл из слота (DNS, ≤ 10 с) → `ready`.
|
||||
6. Шаги 3–5 для каждой старой. В конце — N реплик на новом образе, все
|
||||
`UP`, ни одной прежней.
|
||||
|
||||
**Имена контейнеров после замены.** Compose нумерует новые контейнеры
|
||||
сервиса по возрастанию, поэтому после замен реплики называются `api-N`
|
||||
с растущим номером (`mtusi-lab6-api-3`, `-4`, …). Штатные цели
|
||||
(`make replicas`, `make test-failover`, `restart.sh`, `stop-one.sh`) с
|
||||
ними работают: они обращаются к сервису `api` (`docker compose ps -q
|
||||
api`, `stop` / `start api`), а не к имени контейнера. `make down` + `make run_docker` снова дают `api-1`, `api-2`.
|
||||
|
||||
**Runtime API LB** — `stats socket ipv4@127.0.0.1:9999 level admin` в
|
||||
`global`: только loopback контейнера LB, из сети compose и с хоста не
|
||||
достать. Команды — `docker compose exec -T haproxy bash -c 'exec
|
||||
3<>/dev/tcp/127.0.0.1/9999 …'` (socat и curl в образе нет), слот — по
|
||||
адресу реплики в `show stat`. `stats admin` на `:8404` не годится: порт
|
||||
открыт всей сети compose.
|
||||
|
||||
**Ручное состояние — свойство слота, а не реплики.** `drain` или
|
||||
`maint`, оставленные на слоте, достанутся следующей реплике, которой DNS
|
||||
отдаст этот слот: она не получит ни одного запроса. IPAM Docker
|
||||
переиспользует адрес удалённой реплики сразу (проверено: новая реплика
|
||||
получила адрес и слот только что удалённой). Поэтому `ready` — после
|
||||
ухода адреса из слота и до следующего `--scale`.
|
||||
|
||||
**Дренаж убирает 502 гонки keep-alive.** Слот выведен, LB не выбирает
|
||||
его для новых запросов, и простаивающие соединения, которые uvicorn
|
||||
закрывает по SIGTERM, ему уже не нужны (спек `graceful-shutdown`,
|
||||
«Плановая остановка реплики без ошибок»). `stop-one.sh` и профиль
|
||||
`failover` дренаж не делают: они имитируют отказ.
|
||||
|
||||
**Сбой на середине** (`trap` на `EXIT`, `INT`, `TERM`): новая не стала
|
||||
`UP` за срок — её убирает `remove_new` (design change
|
||||
`fix-known-issues`, решение 7):
|
||||
- слот есть (DNS уже отдал) → `maint` → `docker stop --timeout 10` →
|
||||
`docker rm -f` → адрес ушёл → `ready`; строка `removed new <id> (slot
|
||||
api-N: stop Ns, exit N)`. Стартующая реплика выходит сразу по раннему
|
||||
обработчику SIGTERM (`run-modes.md`), работающая — дорабатывает
|
||||
запросы, которые LB успел отправить на слот до `maint`;
|
||||
- слота нет → сразу `docker rm -f`, строка `removed new <id> (no slot:
|
||||
docker rm -f)`: запросов на ней не было, а это ещё и страховка на окно
|
||||
запуска интерпретатора, где SIGTERM некому принять.
|
||||
|
||||
Новая уже `UP` — вывод текущей старой доводится до конца.
|
||||
Прерывание внутри `up --scale`, когда ID новой ещё не известен: уборка
|
||||
находит её сама — контейнер, которого не было до команды. ID новой
|
||||
прежнего шага сбрасывается до перехода в это состояние: иначе уборка
|
||||
удалила бы уже рабочую реплику (найдено в verify, `evidence/rollout/
|
||||
script-failures.md`). В любом исходе — `API_REPLICAS` готовых реплик и
|
||||
слоты без ручного состояния, смешанные версии допустимы, повторный
|
||||
запуск доводит замену. Автоматического отката нет; откат — `make
|
||||
rolling_update COMMIT=<прежний> MIGRATE=0`.
|
||||
|
||||
**После отката тег сервиса указывает на прежний образ**, а схема новее
|
||||
его миграций. `docker compose up` без сборки пересоздал бы `migrate` на
|
||||
этом образе, тот упал бы на «Can't locate revision», и `restart.sh`
|
||||
перестал бы поднимать реплики (как в регрессии apply). Вперёд —
|
||||
снова `make rolling_update` или `make run_docker` (сборка рабочего
|
||||
дерева, все реплики разом).
|
||||
|
||||
**Уборщика скрипт не пересоздаёт** (design change `upload-consistency`,
|
||||
решение 9): как bootstrap, он не реплика за LB. После `make
|
||||
rolling_update` уборщик работает на прежнем образе — корректно, схема
|
||||
только расширяется (индекс). Новый код уборщика — `docker compose up -d
|
||||
--no-deps cleaner` или `make run_docker`; его SIGTERM доводит текущий
|
||||
шаг строки и выходит за ≤ 6 с. Пометка строки к уборке (verify W1,
|
||||
design `upload-consistency`, «Уточнения apply», п. 16 и 21) полностью
|
||||
защищает от `ready` без объекта, только когда новые и реплики, и
|
||||
уборщик. Смеси версий не хуже, чем до правки:
|
||||
- новый уборщик + реплики до `87c48b9` (пометку не проверяют): объект и
|
||||
строка удаляются одной транзакцией под блокировкой, поэтому прежний
|
||||
`mark_ready` либо делает строку `ready` с целым объектом (уборщик её
|
||||
пропускает), либо ждёт commit и находит 0 строк;
|
||||
- прежний уборщик (пометку не ставит) + новые реплики — как до правки.
|
||||
|
||||
В обеих остаётся прежний риск: загрузка, пережившая grace, при откате
|
||||
транзакции уборки после удачного DELETE объекта; это ограничение в
|
||||
`REPORT.md`. Порядок сокращает окно смеси: вперёд — сначала реплики
|
||||
(`make rolling_update`), потом `docker compose up -d --no-deps cleaner`;
|
||||
откат реплик на версию раньше `87c48b9` (`make rolling_update
|
||||
COMMIT=<прежний> MIGRATE=0`) — сначала уборщик (его откат или `docker
|
||||
compose stop cleaner`), потом реплики. Обратная совместимость есть:
|
||||
новый `mark_ready` на строках, вставленных прежним кодом, работает
|
||||
(вставка всегда писала `created_at` = `updated_at`).
|
||||
|
||||
**Порядок обновления со сверкой** (design change `track2-reconciler`,
|
||||
решение 6): вперёд — `docker compose up -d s3-bootstrap` (политика
|
||||
уборщика со списком по префиксу), затем `make rolling_update` (миграция
|
||||
`lost_at`, затем реплики), затем `docker compose up -d --no-deps cleaner`.
|
||||
Откат — сначала уборщик (`docker compose stop cleaner` или прежний
|
||||
образ), потом `make rolling_update COMMIT=<прежний> MIGRATE=0`; колонка и
|
||||
пометки остаются и прежнему коду не мешают. Смеси не хуже, чем до
|
||||
change: прежние реплики колонку не читают (у помеченного без объекта —
|
||||
500, как раньше); новый уборщик на прежней политике получает
|
||||
`AccessDenied` на списке — проход сверки прерван, уборка работает; новый
|
||||
уборщик на прежней схеме — «Reconcile pass failed», процесс живёт.
|
||||
|
||||
**Порядок обновления с брокером** (design change `async-attachments`, решение
|
||||
14): вперёд — `docker compose up -d --wait rabbitmq`, `docker compose up -d
|
||||
s3-bootstrap`, `make rolling_update`, `docker compose up -d --no-deps cleaner
|
||||
worker`. Смесь версий: прежняя реплика загружает по-старому (201, `ready`,
|
||||
конечный ключ) и даёт 500 на чтении строки нового статуса, новая читает её строку
|
||||
как `ready` без вариантов; переход 201 → 202 всё равно несовместим для клиента на
|
||||
время замены — названо в `REPORT.md`. Откат — `make rolling_update COMMIT=<прежний>
|
||||
MIGRATE=0`, `docker compose stop worker`, прежний образ уборщика.
|
||||
|
||||
**Порядок обновления с relay** (design change `pipeline-reliability`, Migration Plan):
|
||||
вперёд — `docker compose up -d s3-bootstrap`, `make rolling_update` (две ревизии, затем
|
||||
реплики), `docker compose up -d --no-deps worker cleaner`, затем `docker compose up -d
|
||||
--no-deps relay`: worker раньше relay, иначе прежний worker сделает `ready` только с
|
||||
thumbnail. До запуска relay новые загрузки отвечают 202 и ждут. Откат — `make
|
||||
rolling_update COMMIT=<прежний> MIGRATE=0
|
||||
COMPOSE_FILE=docker-compose.yml:infra/rollback/broker.compose.yml` (прежние реплики
|
||||
публикуют сами, и без адреса и пароля брокера их загрузка — 503), прежние
|
||||
worker и уборщик, relay останавливается, когда нет заданий `queued` без отметки. Схема
|
||||
остаётся. Новая реплика прежнего образа, созданная после отката без этого override
|
||||
(`make replicas`, `docker compose up`), тоже получит 503 на загрузке: `COMPOSE_FILE` с
|
||||
override нужен, пока стенд на прежнем образе.
|
||||
|
||||
**Bootstrap S3 скрипт не запускает** (design change `s3-storage`,
|
||||
решение 9): новая реплика поднимается с `--no-deps`. Bootstrap, как
|
||||
миграции, только расширяет: новые пользователи и политики не отбирают
|
||||
прав у старых реплик. Его изменения (новая строка `infra/s3/bootstrap.sh`,
|
||||
новый секрет API в `.env`) применяет `docker compose up -d s3-bootstrap`
|
||||
или `make run_docker` — до замены, если новый код на них опирается.
|
||||
|
||||
Прогон — под нагрузкой с постоянной интенсивностью: профиль `rollout`
|
||||
стенда `bench/` (`make bench_rollout`, `bench.md`) вызывает этот же
|
||||
скрипт со своим проектом (`COMPOSE_PROJECT_NAME`, `COMPOSE_FILE`,
|
||||
`COMPOSE_ENV_FILES`). Ошибки и их коды по секундам — в
|
||||
`evidence/rollout/<метка>/`. Сторонние плагины (docker rollout) не
|
||||
используются: это ещё одна незакреплённая зависимость.
|
||||
|
||||
## Что стенд не переживает
|
||||
|
||||
Один Docker-host, один HAProxy, одна Postgres, один Valkey, одна нода S3
|
||||
без репликации. Выдерживается отказ процесса API (любой одной реплики,
|
||||
при ≥2 живых). Не выдерживается отказ хоста, LB и Postgres. Отказ
|
||||
Valkey — деградация до Postgres, не отказ. Отказ S3 — 503 на путях
|
||||
вложений, текст работает, `/health/ready` 200. SIGKILL процесса S3
|
||||
подтверждённых объектов не теряет, отказ диска или ВМ — теряет (нет
|
||||
реплик и fsync). Это пишется в `REPORT.md` прямо (`COURSE.md`,
|
||||
«Воспроизводимость и честные измерения»).
|
||||
@@ -0,0 +1,932 @@
|
||||
---
|
||||
paths:
|
||||
- "bench/**"
|
||||
---
|
||||
|
||||
# Нагрузочный стенд (`bench/`)
|
||||
|
||||
Стенд перенесён из лабы 1 (трек 1 «5», нагрузка на in-memory API) и на
|
||||
лабе 2 переведён на PostgreSQL: матрица размеров истории и уровней
|
||||
конкуренции для чтения и записи, метрики, планы запроса истории и сырые
|
||||
данные в `evidence/bench/<метка>/`. Что стенд обязан делать — спек
|
||||
`load-benchmark`, почему так — archived changes `load-bench-harness`
|
||||
(стенд), `perf-bottleneck-fix` (сравнение меток) и `bench-postgres`
|
||||
(стенд на PostgreSQL, план запроса), `track2-query-plans` (чаты
|
||||
неравномерных размеров, варианты индекса и запроса, стоимость записи) в
|
||||
`openspec/changes/archive/`.
|
||||
Результаты и выводы — `REPORT.md`, раздел «Эксперименты и отказы».
|
||||
|
||||
На лабе 2 стенд нужен для двух вещей: план запроса истории
|
||||
`EXPLAIN (ANALYZE, BUFFERS)` на ≥10 000 сообщениях (уровень 4) и
|
||||
сравнение индексов и запросов со стоимостью записи на чатах разного
|
||||
размера, а также backup и восстановление со сверкой для трека «5» №2
|
||||
(`README.md`). Варианты сравниваются внутри
|
||||
одной метки, на одних данных; «до» и «после» через `make bench_ab` нужны,
|
||||
только когда меняется код приложения. Метки лабы 1 сюда не
|
||||
переносились: другое хранилище — другая методика, сравнивать их с
|
||||
лабой 2 нельзя.
|
||||
|
||||
**Лаба 3, трек «5» №1 «Цена масштабирования»** (design change
|
||||
`scaling-bench` в архиве; результаты — `REPORT.md`, «Цена
|
||||
масштабирования»). Стенд нужен для трёх вещей:
|
||||
|
||||
- серия A — фиксированный суммарный бюджет CPU/RAM на 1/2/4 реплики;
|
||||
- серия B — рост числа реплик до точки насыщения Postgres, LB или
|
||||
пула;
|
||||
- профили уровня 4: `failover` (постоянная интенсивность, поочерёдная
|
||||
остановка реплик, посекундные RPS и ошибки) и `rollout` (та же
|
||||
нагрузка во время `scripts/rolling-update.sh`).
|
||||
|
||||
Стенд с N репликами и профиль `failover` — change `graceful-failover`;
|
||||
нагрузка, метрики и графики трека 1 — change `scaling-bench` (раздел
|
||||
«Серии трека 1» ниже). Это смена методики: метки лабы 2 с метками лабы
|
||||
3 не сравниваются, базовый замер снимается заново. Профили лабы 2
|
||||
(`full`, `restore*`) продолжают работать и после перехода на N реплик.
|
||||
|
||||
Стенд с LB (design change `graceful-failover`, решение 6):
|
||||
|
||||
- override `bench/bench.compose.yml`: у `api` нет `container_name`,
|
||||
`deploy.replicas: ${BENCH_API_REPLICAS}`, лимиты `BENCH_APP_*` — на
|
||||
каждую реплику; у `haproxy` — `container_name: mtusi-bench-haproxy`
|
||||
(он один), лимиты `BENCH_LB_*`, порт сброшен, конфиг — тот же
|
||||
`infra/haproxy/haproxy.cfg`. Лимиты всех — в форме
|
||||
`deploy.resources.limits` (`cpus` / `mem_limit` рядом с ними compose не
|
||||
принимает), `memswap_limit` — на уровне сервиса;
|
||||
- k6 ходит на `http://haproxy:8080` (имя сервиса в сети `mtusi-bench`,
|
||||
`lib.js`), не к реплике напрямую — и при N = 1: серии трека 1
|
||||
сравнивают 1, 2 и 4 реплики на одном пути запроса;
|
||||
- `run.py` находит реплики через `docker compose ps api`. Стенд готов,
|
||||
когда LB видит `UP` все N реплик по их адресам (статистика LB изнутри
|
||||
контейнера LB). CPU, память и RSS приложения в метриках — сумма по
|
||||
репликам (`VmHWM` — максимум), при N = 1 — числа её процесса;
|
||||
- healthcheck образа у реплик выключен, но реплику раз в секунду
|
||||
проверяет LB (`SELECT 1` в квоте API). Вместе с LB в пути запроса это
|
||||
смена методики относительно лабы 2: метки лабы 3 до этого change (их в
|
||||
git нет) и метки лабы 2 с новыми не сравниваются. В паспорте метки со
|
||||
стендом с LB есть `limits.haproxy` и `limits.api_replicas`;
|
||||
`make bench_compare` отказывает, если `limits.api_replicas` есть только
|
||||
в одной из меток.
|
||||
|
||||
Стенд — свой проект compose `mtusi-bench`: тот же `docker-compose.yml`
|
||||
с override `bench/bench.compose.yml` (по образцу `make failure_checks`),
|
||||
подстановки — `bench/bench.env`, а не `.env` рабочего стенда. Пароли
|
||||
хранилищ `run.py` генерирует на прогон и никуда не пишет. Каждый размер —
|
||||
свежий стенд: `down -v`, Postgres и Valkey, миграции, API.
|
||||
|
||||
**S3 (лаба 4) описан, но профили лаб 2–3 его не запускают** (design
|
||||
change `s3-storage`, решение 9): старт стенда перечисляет сервисы, а
|
||||
реплики поднимает с `--no-deps`, поэтому ни `s3`, ни `s3-bootstrap` не
|
||||
стартуют, и методика прежних профилей не меняется. Compose всё равно
|
||||
требует секреты S3 при разборе файла (`:?`), их `compose_env` тоже
|
||||
генерирует на прогон (пять значений). Override `s3` —
|
||||
`container_name: mtusi-bench-s3`, `restart: "no"`, порты сброшены;
|
||||
`bench.env` — `S3_HOST`, `S3_PORT`, `S3__BUCKET=bench`. Реплики получают
|
||||
`S3__*` в окружении, и `S3__HOST`, `S3__PORT`, `S3__BUCKET` попадают в
|
||||
паспорт (`stand.app_env`); меток лабы 3 в этом репозитории нет, поэтому
|
||||
сравнивать их не с чем. Лимиты `BENCH_S3_*` и S3 в паспорте появятся с
|
||||
профилем, который его запускает (`upload-memory`, трек 2).
|
||||
|
||||
Фильтр окружения паспорта (`SECRET_ENV_MARKS` в `run.py`) убирает имена с
|
||||
`PASSWORD`, `SECRET` и `ACCESS_KEY`: иначе секрет и ключ доступа S3
|
||||
попали бы в `meta.json`.
|
||||
|
||||
Инструменты `bench/`:
|
||||
|
||||
| Файл | Команда | Что делает |
|
||||
|---|---|---|
|
||||
| `run.py`, `k6/`, `bench.compose.yml`, `bench.env` | `make bench`, `make bench_quick` | стенд: меряет пропускную способность, задержки, CPU API и Postgres, память, снимает планы запроса истории |
|
||||
| `run.py` (профили `restore`, `restore_quick`), `k6/after_backup.js`, `k6/restore_check.js` | `make bench_restore`, `make bench_restore_quick` | тот же стенд без матрицы прогонов: backup под записью, восстановление в новое хранилище, сверка, RTO и потеря, кэш до и после `FLUSHALL` |
|
||||
| `run.py` (профили `failover`, `failover_quick`), `failover.py`, `resources.py`, `sampler.sh` (режим `scan`), `k6/failover.js`, `k6/retry.js` | `make bench_failover`, `make bench_failover_quick` | две реплики с лимитами рабочего стенда, постоянная интенсивность записи с ключом и чтения, каждая реплика в каждом режиме (`stop`, `kill`, `pause`) с возвратом: посекундная шкала, время обнаружения и восстановления, сверка записей, CPU и память каждого компонента по окнам фазы; результаты — `evidence/failover/<метка>/` |
|
||||
| `run.py` (профили `rollout`, `rollout_quick`), `rollout.py`, `resources.py`, `sampler.sh` (режим `scan`), `k6/failover.js`, `k6/retry.js`, `scripts/rolling-update.sh` | `make bench_rollout`, `make bench_rollout_quick` | две реплики с лимитами рабочего стенда на образе прежнего commit, та же постоянная нагрузка, посреди неё — поочерёдная замена на образ текущего checkout: посекундная шкала с ответами старых и новых реплик, шаги по каждой реплике, контейнеры, образы и ревизия схемы до и после, сверка записей, CPU и память каждого компонента по окнам замены; результаты — `evidence/rollout/<метка>/` |
|
||||
| `run.py` (профили `uploads`, `uploads_quick`), `uploads.py`, `sampler.sh` (режим `peak`), `k6/uploads.js`, `k6/prepare.js` | `make bench_uploads [UPLOADS_LABEL=…]`, `make bench_uploads_quick` | память реплики при одновременных загрузках вложений (change `upload-memory`): одна реплика 1 CPU / 512 МБ без swap, S3 рабочего стенда, варианты «до» / «без лимита» / «с лимитом», тела PNG ~1 и ~10 MiB, 1 / 10 / 20 / 40 клиентов; пик `memory.peak` окна, OOM, ответы по кодам, загрузок/с и p50/p95/p99; результаты — `evidence/uploads/<метка>/` |
|
||||
| `run.py` (профили `reconcile`, `reconcile_quick`), `reconcile.py`, `fill_objects.py`, `sampler.sh` (режим `scan`), `k6/background.js`, `k6/prepare.js` | `make bench_reconcile [RECONCILE_LABEL=…]`, `make bench_reconcile_quick` | стоимость сверки bucket и БД (change `track2-reconcile-cost`): наполнение мимо API (`\copy` и PUT в S3), разовые проходы уборщика — стратегии `batch` и `head`, глубокая, CPU уборщика, предел скорости, фоновая нагрузка, отказ по пределу «до» и «после»; счёт сверки против метрик шлюза S3, CPU и память за окно прохода; результаты — `evidence/reconcile/<метка>/` |
|
||||
| `run.py` (профили `queue`, `queue_quick`), `overload.py`, `make_images.py`, `queue.compose.yml`, `rabbitmq/`, `sampler.sh` (режим `queue`), `k6/queue.js`, `k6/queue_sweep.js`, `k6/background.js`, `k6/prepare.js` | `make bench_queue [QUEUE_LABEL=…] [RESUME=1]`, `make bench_queue_quick` | очередь под перегрузкой (change `track1-queue-overload`): стенд с S3, брокером, relay, worker и уборщиком, настройки конкуренции и prefetch × классы изображений, блоки предела, приёма, второго worker и рестартов; результаты — `evidence/queue/<метка>/` |
|
||||
| `run.py` (профили `telemetry`, `telemetry_quick`), `telemetry_cost.py`, `telemetry_lookup.py`, `telemetry.compose.yml`, `otel/`, `make_images.py` (класс `bad`), `sampler.sh` (режим `cost`), `k6/telemetry.js`, `k6/queue.js`, `k6/queue_sweep.js`, `k6/prepare.js` | `make bench_telemetry [TELEMETRY_LABEL=…] [RESUME=1] [VARIANTS=…]`, `make bench_telemetry_quick`; `TELEMETRY=on` у `bench_uploads*` и `bench_queue*` | цена наблюдаемости (change `track1-telemetry-cost`): стенд очереди и сервисы телеметрии рабочего стенда, варианты `off`, `full`, `full-aa`, `head`, `tail`, `metrics`, `balanced` × 3 повтора, одинаковая открытая нагрузка с редкими событиями; задержки, CPU и память компонентов, приём, потери по звеньям, что сохраняет каждый вариант; результаты — `evidence/telemetry-cost/<метка>/` |
|
||||
| `run.py` (профили `scaling_*`), `scaling.py`, `sampler.sh`, `k6/mixed.js` | `make bench_scaling SERIES=a\|b\|pool\|ab\|db\|db4`, `make bench_scaling_quick`, `SERIES=db_quick` | серии трека 1: конфигурации реплик и лимитов, на каждую ячейку — свежий стенд, открытая модель, фиксированные уровни и поиск R* по SLO, посекундный сэмплер контейнеров, ВМ, LB и PostgreSQL; результаты — `evidence/bench/<метка>/` |
|
||||
| `plots.py` | `make bench_plots LABELS="…"` | графики SVG и сводка серий (R* от числа реплик, p95 от интенсивности, CPU по компонентам, точка насыщения) — `evidence/plots/<PLOTS>/` |
|
||||
| `compare.py` | `make bench_compare` | дельта двух меток стенда (ячейки матрицы или общие конфигурации серий), эффект или шум |
|
||||
| `ab.py` | `make bench_ab [SERIES=…]` | стенд «до» и «после» одного изменения подряд, в одной сессии хоста; с `SERIES` — серия трека 1 вместо матрицы |
|
||||
|
||||
## Что не меняется между метками
|
||||
|
||||
Метки сравнимы, только если различается код приложения и больше ничего.
|
||||
Не меняются:
|
||||
|
||||
- **лимиты контейнеров без swap:** API — 1 CPU / 2 ГБ, PostgreSQL —
|
||||
4 CPU / 3 ГБ, Valkey — 2 CPU / 512 МБ (поля `Profile`, в compose —
|
||||
переменными `BENCH_*`). Healthcheck API выключен, `restart: "no"`,
|
||||
порты на хост не публикуются. Сумма лимитов памяти должна
|
||||
помещаться в VM docker с запасом 1,5 ГиБ, иначе — предупреждение о
|
||||
хосте;
|
||||
- **хранилища:** образы PostgreSQL и Valkey — те же пины, что у рабочего
|
||||
стенда (из `docker-compose.yml`). Valkey — тот же `valkey.conf`.
|
||||
PostgreSQL — настройки образа плюс `shared_preload_libraries =
|
||||
auto_explain`, выключенный вне этапа плана. Настройки, от которых
|
||||
зависят план и запись, пишутся в паспорт (`stand.postgres.settings`);
|
||||
- **приложение:** настройки по умолчанию из `settings.py` и окружение
|
||||
из override (`AUTH__SESSION_TTL_SECONDS` из `Profile`), без `.env` и
|
||||
`config.toml`. Окружение без паролей — в паспорте (`stand.app_env`);
|
||||
- **данные:** кроме читаемого чата из N сообщений и чата записи —
|
||||
фоновые чаты уровнями из `Profile.background` (в `full` 10 × 5 000,
|
||||
100 × 400, 1 000 × 10). Сообщения всех чатов отправляются вперемешку
|
||||
по детерминированному расписанию (`fill_schedule`), распределение по
|
||||
чатам проверяется после наполнения;
|
||||
- **обслуживание после наполнения:** `VACUUM (ANALYZE)` и `CHECKPOINT`
|
||||
до сбора курсоров и прогонов. Затем этап плана (страницы читаемого
|
||||
чата и первого чата каждого уровня, варианты страницы сравнения),
|
||||
затем прогоны с прогревом перед каждым, затем пробы стоимости записи;
|
||||
- **варианты и пробы:** варианты индекса истории — `Profile.index_variants`,
|
||||
проба записи — `write_probe_rows` строк, `write_probe_repeats`
|
||||
повторов со сдвигом порядка конфигураций;
|
||||
- **восстановление** (профили `restore*`): `pg_dump -Fc` во время
|
||||
записи `restore_write_load` сообщений `restore_write_vus` клиентами,
|
||||
`pg_restore -j restore_jobs` в контейнер того же образа и с лимитами
|
||||
Postgres стенда на новом volume, `ANALYZE`, переключение API через
|
||||
`POSTGRES_HOST`. Файл backup живёт только в `.work/`: в нём хэши
|
||||
паролей и токенов;
|
||||
- **генератор:** `grafana/k6` той же версии и digest, в той же
|
||||
docker-сети; в профилях лабы 2, `failover` и `rollout` без лимита, в
|
||||
сериях трека 1 — 2 CPU / 1 ГиБ без swap (`generator_cpus`,
|
||||
`generator_memory`), сэмплер — 0,25 CPU / 128 МиБ (`sampler_cpus`,
|
||||
`sampler_memory`). Их лимиты — часть методики серий. У профилей
|
||||
`failover` и `rollout` (с change `profile-resources`) — тот же сэмплер
|
||||
0,25 CPU / 128 МиБ в режиме `scan` (`sample_resources`), k6 по-прежнему
|
||||
без лимита;
|
||||
- **буфер приёма сокетов реплики** (с change `upload-memory`): `sysctls`
|
||||
сервиса `api` из основного `docker-compose.yml` (`net.ipv4.tcp_rmem`
|
||||
`4096 131072 524288`) действует и на `bench/`; значение — в паспорте
|
||||
всех профилей (`stand.api_tcp_rmem`), ядро ВМ — `docker.kernel`.
|
||||
Для прежних профилей это смена стенда, но запросы и ответы JSON меньше
|
||||
начального буфера (128 KiB) — результаты не меняются; метки до change
|
||||
поля в паспорте не имеют. Там же исправлено: контейнер сэмплера (образ
|
||||
PostgreSQL) удаляется с `-v`, иначе каждый запуск оставлял анонимный
|
||||
volume `/var/lib/postgresql`;
|
||||
- **S3** — запускают только профили `uploads`, `reconcile` и `queue`: образ,
|
||||
аргументы и лимиты рабочего стенда (`BENCH_S3_*`, 1 CPU / 512 МБ, swap =
|
||||
память; у `reconcile` — ещё порт метрик шлюза на loopback), bucket
|
||||
`bench` (`bench.env`) и пользователи — тот же `s3-bootstrap`; override
|
||||
`s3` нужен compose и в остальных профилях;
|
||||
- **уборщик** — запускает только профиль `reconcile` разовыми проходами:
|
||||
лимиты `BENCH_CLEANER_*` (`cleaner_cpus` 0,25, `cleaner_memory` 256m —
|
||||
рабочего стенда, без swap) compose требует при разборе у всех профилей;
|
||||
окружение реплик (`stand.app_env`) они не меняют;
|
||||
- **брокер, relay и worker** — запускает только профиль очереди, лимиты
|
||||
`BENCH_BROKER_*`, `BENCH_RELAY_*`, `BENCH_WORKER_*` рабочего стенда; плагин метрик
|
||||
брокера и политика перезапуска worker — только его `queue.compose.yml`; остальные
|
||||
профили меряют реплику;
|
||||
- **телеметрия** (с лабы 6, design change `otel-telemetry`, решение 20) выключена:
|
||||
`TELEMETRY__ENABLED: "false"` у `api` и `worker` в `bench.compose.yml`, сервисы телеметрии
|
||||
описаны основным файлом, но ни один профиль их не запускает. `GRAFANA_ADMIN_PASSWORD` compose
|
||||
требует при разборе — его, как секреты S3, генерирует `compose_env`. Новые ключи окружения
|
||||
реплик (`TELEMETRY__ENABLED`, `TELEMETRY__OTLP_ENDPOINT`) попадают в `stand.app_env`: метки
|
||||
до лабы 6 с новыми не сравниваются (их в этом репозитории нет). Профиль трека 1 с
|
||||
телеметрией включает её явно своим окружением. С design change `job-trace-propagation`
|
||||
(решение 7) так же и у `relay`; при выключенной телеметрии модули SDK, экспортёра и
|
||||
`requests` процессы не загружают (ленивый импорт), поэтому память реплики в метках снова
|
||||
сравнима с кодом лабы 5, кроме модулей метрик SDK, которые грузит сам redis-py. Пул engine
|
||||
— `CountingQueuePool` (два счётчика вокруг `connect()`): поведение и цена выдачи прежние.
|
||||
С design change `track1-telemetry-cost` (решения 1, 13) сервисы телеметрии описаны в
|
||||
`bench.compose.yml` (`mtusi-bench-<сервис>`, `restart: "no"`, лимиты `BENCH_COLLECTOR_*`,
|
||||
`BENCH_PROMETHEUS_*`, `BENCH_LOKI_*`, `BENCH_TEMPO_*` — поля `Profile`, рабочего стенда, без swap;
|
||||
сеть `mtusi-bench-telemetry`; у Grafana порт сброшен, она не запускается никогда). Запускают их
|
||||
только варианты профиля цены телеметрии и выключатель `TELEMETRY=on` профилей загрузок и
|
||||
очереди (ниже); без него — всё прежнее, `stand.telemetry.mode` в паспорте — `off`. С `on` второй
|
||||
`-f` — `bench/telemetry.compose.yml` (`TELEMETRY__ENABLED: "true"` и адрес Collector у `api`,
|
||||
`worker`, `relay`), свой override профиля — третьим (`Stand.telemetry_files` между базой и
|
||||
`extra_files`, его профили не перезаписывают). Режим — поле `Profile.telemetry`, а не
|
||||
`overrides`: `RESUME` требует тот же режим (`resume_problems`). Сумма лимитов CPU с
|
||||
телеметрией больше CPU ВМ (очередь — 12,25 при 12) — предупреждение `host_warnings` и строка
|
||||
сводки, а не код 2; без телеметрии правило очереди прежнее. Лимиты телеметрии в `Profile`
|
||||
сверяются с основным `docker-compose.yml` до стенда (`telemetry_preflight`, код 2). У очереди
|
||||
с `on` — столбцы `tel_<сервис>_cpu_over`, `_throttle_over`, `_peak_mib` в конце `cells.csv`;
|
||||
у загрузок вариант «до» — код без SDK, сводка называет сравнение смешанным;
|
||||
- **PostgreSQL `max_connections`:** 100, как у образа (`-c
|
||||
max_connections` в override); у серий — из конфигурации ячейки,
|
||||
лимиты конфигурации в паспорте (`limits.<конфигурация>`);
|
||||
- **профиль `full`:** размеры, конкуренция, повторы, прогрев и
|
||||
длительности, длина текста, порция наполнения, зерно выбора курсоров
|
||||
и сдвиг зерна для прогрева, порог пометки `generator`, лимиты и срок
|
||||
сессии стенда. Все они — поля `Profile` в `run.py` и целиком пишутся в
|
||||
`meta.json`: новый параметр методики заводится там же, а не константой
|
||||
в коде.
|
||||
|
||||
`make bench_compare` проверяет совпадение всего этого по паспортам
|
||||
(лимиты, образы, настройки PostgreSQL, `maxmemory*` Valkey, окружение
|
||||
приложения, профиль).
|
||||
|
||||
Изменить что-то из списка — значит сменить методику: старые метки
|
||||
перестают быть «до», базовый замер переснимается, а в `REPORT.md`
|
||||
записывается, что и почему поменялось.
|
||||
|
||||
## Профиль отказа реплик (`failover`)
|
||||
|
||||
Доказательство уровня 4 «поочерёдная остановка каждой реплики: RPS,
|
||||
ошибки, время восстановления» (design change `graceful-failover`,
|
||||
решения 5 и 7). Матрицу лабы 2 он не снимает и с её метками не
|
||||
сравнивается.
|
||||
|
||||
- Лимиты — как у рабочего стенда `docker-compose.yml` (API 1 CPU /
|
||||
512 МБ на реплику, две реплики, PostgreSQL 2 CPU / 1 ГБ, Valkey
|
||||
0,5 CPU / 128 МБ, HAProxy 1 CPU / 256 МБ): профиль отвечает, что видит
|
||||
клиент `make run_docker` при отказе реплики. Читаемый чат —
|
||||
1 000 сообщений, без фоновых.
|
||||
- Нагрузка — k6 `constant-arrival-rate`: 100 записей с ключом
|
||||
`<прогон>.<фаза>.<n>` и 100 чтений страницы истории в секунду, около
|
||||
половины потолка одной реплики. Фаза — режим × реплика: окно до
|
||||
действия, `docker stop --timeout 9` / `docker kill` / `docker pause`,
|
||||
окно отказа, `docker start` того же контейнера или `docker unpause`,
|
||||
окно после возврата. Перед фазой LB видит обе реплики `UP`.
|
||||
- Все отметки — часы ВМ Docker: действие и возврат — события Docker
|
||||
(`docker events`), исключение и возврат в LB — строки журнала HAProxy
|
||||
(`docker logs -t`), запросы — `Date.now()` k6 при отправке. Часы хоста
|
||||
с ними не сравниваются.
|
||||
- События цели — **поток** `Stand.container_events` (`docker events
|
||||
--filter container=<id>` в `work_dir/<фаза>-events.log`), запущенный
|
||||
после выбора цели и до k6 и остановленный после возврата в LB, а не
|
||||
`docker events --since … --until …` после фазы: демон хранит только 256
|
||||
последних событий всех контейнеров, и проверки здоровья, `docker exec`
|
||||
оркестратора и чужих проектов их вытесняют. Сверка обоих способов на
|
||||
одном прогоне: без помех моменты совпали до наносекунды, под шумом
|
||||
`docker exec` буфер потерял события всех четырёх фаз, поток — ни
|
||||
одного (design change `fix-known-issues`, решения 9–10;
|
||||
`evidence/tests/fix-known-issues-checks.md`). Нет события действия
|
||||
или возврата — отказ с фазой и репликой.
|
||||
- Каждый запрос — строка `fo,…` в файл консоли k6 (`--console-output`),
|
||||
а не в вывод `docker exec`: там в самопроверке пропали две строки из
|
||||
4 601. Число строк сверяется с итерациями сценариев из итога k6,
|
||||
расхождение — отказ.
|
||||
- VU k6 создаются заранее с запасом под зависшую реплику
|
||||
(`failover_pre_vus` 600 на сценарий: половина запросов ждёт 504 10 с).
|
||||
Иначе k6 создаёт их на ходу и пропускает итерации, и интенсивность
|
||||
перестаёт быть постоянной; пропуски — `dropped_iterations` и пометка
|
||||
`dropped`.
|
||||
- После фазы каждая неуспешная запись повторяется с тем же ключом и
|
||||
телом до 201 (`k6/retry.js`), затем `psql` стенда: сообщений в чате
|
||||
записи и разных текстов столько, сколько отправлено ключей. Это
|
||||
доказательство «без потерь и дублей», расхождение — отказ.
|
||||
- Превышение формулы обнаружения — пометка `over_bound` в
|
||||
`phases.csv`, а не отказ: это результат, а не сбой стенда.
|
||||
- **Ресурсы** (design change `profile-resources`): после `prepare_load`
|
||||
и до первой фазы запускается сэмплер `mtusi-bench-sampler` в режиме
|
||||
`scan` (`Profile.sample_resources`), удаляется после последней фазы.
|
||||
Раз в секунду он обходит cgroup всех контейнеров ВМ и читает
|
||||
`/proc/stat`; без сети, без метки проекта и паролей, к PostgreSQL и LB
|
||||
не обращается, процессов в контейнерах стенда не запускает. Роли —
|
||||
у оркестратора (`Stand.container_map()`: метка сервиса compose, k6 и
|
||||
сэмплер по имени), чужие cgroup отбрасываются (`meta.resources.unmapped`
|
||||
— их число). Окна фазы: до действия (от первого запроса + 2 с), окно
|
||||
отказа (действие → возврат), после возврата (до последнего запроса);
|
||||
`docker start` после `stop` / `kill` — новая cgroup, её счёт идёт с
|
||||
момента возврата; у `pause` … `unpause` CPU интервалов, задевающих
|
||||
заморозку, относится к её внешней части. CPU на успешный запрос —
|
||||
только до действия.
|
||||
Разбор и агрегаты — `resources.py` (`--selftest`). Сторож: сэмплер
|
||||
остановился или тиков нет дольше 3 с в нагрузке — отказ с фазой.
|
||||
Сумма лимитов CPU на пике и сэмплера больше CPU ВМ — код 2 до стенда
|
||||
(`meta.resources.budget`).
|
||||
- Результаты — `evidence/failover/<метка>/` (`meta.json`, `phases.csv`,
|
||||
`timeline.csv`, `resources.csv` — строка на фазу × окно × компонент,
|
||||
`samples.csv` — посекундно от действия, `summary.md`,
|
||||
`raw/<фаза>-k6.json`, `raw/<фаза>-lb.log`), пробные
|
||||
`quick-failover-*` — в `.gitignore`.
|
||||
Профиль замера для отчёта — `make bench_failover` после проверки хоста
|
||||
(раздел «Результаты»), рабочий стенд на время замера остановлен.
|
||||
|
||||
## Профиль поочерёдной замены (`rollout`)
|
||||
|
||||
Доказательство уровня 4 «rolling update под нагрузкой; миграции
|
||||
однократно и совместимы» (design change `rolling-update`, решение 8).
|
||||
Матрицу не снимает и с метками `bench` не сравнивается.
|
||||
|
||||
- Стенд, лимиты, нагрузка, строки k6, повтор неуспешных записей и
|
||||
сверка — как у `failover` (`k6/failover.js`, `k6/retry.js`, поля
|
||||
`failover_*` профиля). Окна — `rollout_before_s` до запуска скрипта,
|
||||
бюджет замены `rollout_budget_s`, ещё `rollout_after_s`.
|
||||
- Реплики стартуют на образе `Profile.rollout_from`: `git archive
|
||||
<commit> | docker build` под тегом `mtusi-messenger:bench-from`, затем
|
||||
`docker tag` на `mtusi-messenger:bench`. Рабочее дерево не трогается;
|
||||
тег снимается при уборке. `--from <commit>` — отладка (`overrides`).
|
||||
- **Какой commit** (спек `load-benchmark`, «Прежний commit профиля
|
||||
замены»; design change `attachments`, решение 14): commit текущей лабы
|
||||
до изменения, которое показывает замена. Сейчас — `9cc6c0c`, commit
|
||||
переноса лабы 5 в лабу 6: замена показывает миграции лабы 6. В лабе 5 был
|
||||
`7f38948` (до change `pipeline-reliability`), его в истории лабы 6 нет.
|
||||
Commit меняется:
|
||||
- при переходе в следующую лабу — commit прошлой лабы в её истории нет
|
||||
(AGENTS.md, «Переход в следующую лабу»);
|
||||
- когда замена должна показать новое изменение схемы.
|
||||
|
||||
`run.py` проверяет commit до стенда (`git rev-parse --verify
|
||||
<commit>^{commit}`): нет в истории — код 2, сообщение называет commit
|
||||
и `--from`. Commit — в паспорте метки (`rollout.from_commit`).
|
||||
- Замену делает **тот же** `scripts/rolling-update.sh`, что у рабочего
|
||||
стенда. Правило «`-p mtusi-bench`, оба `-f`, `--env-file`»
|
||||
выполняется переменными `COMPOSE_PROJECT_NAME`, `COMPOSE_FILE`,
|
||||
`COMPOSE_ENV_FILES` (`Stand.script_env`). Скрипт сам пересобирает тег
|
||||
из текущего checkout (слои из кэша) и один раз применяет миграции.
|
||||
- Время — часы ВМ: начало замены — `create` контейнера миграции
|
||||
(события Docker с меткой проекта), шаги — события `create`/`start`
|
||||
новой и `kill`/`die`/`destroy` старой, `UP`/`drain`/`maint`/`ready`
|
||||
слотов из журнала LB, соответствие реплик слотам — строки скрипта.
|
||||
- Образы реплик в паспорте и сравнении «все на одном, отличном от прежнего» —
|
||||
метка `com.docker.compose.image`, у контейнера без неё — `.Image`
|
||||
(`CONTAINER_IMAGE` в `run.py`, `docker.md`, «Обновление кода на стенде»). Так
|
||||
же поле `id` образов `stand.*`: имя поля прежнее.
|
||||
- «Старые» и «новые» ответы — по `X-Instance-Id` контейнеров до и после.
|
||||
Ответ старой реплики, отправленный позже 0,2 с после её `drain`, —
|
||||
пометка `old_after_drain`: дренаж не сработал.
|
||||
- Отказ команды: скрипт вернул не 0, k6 упал, хранилище падало, сверка
|
||||
не сошлась, в конце не `API_REPLICAS` работающих реплик, есть прежняя
|
||||
или реплики на разных образах, LB за 30 с не видит `UP` все реплики.
|
||||
Ошибки клиента — пометка `errors`, не отказ.
|
||||
- **Ресурсы** — тот же сэмплер `scan`, что у `failover`: запуск после
|
||||
`containers_before`, до потока событий и k6. Режим `scan` видит и
|
||||
третью реплику, и контейнер миграции с первого тика. Роли: `api-old` /
|
||||
`api-new` по `X-Instance-Id` до и после, `migrate`, остальные — по
|
||||
сервису; удалённые к концу контейнеры — по `create` из потока событий.
|
||||
Окна: до (от первого запроса + 2 с до первого `exec_start` скрипта в
|
||||
контейнер проекта, кроме проверок здоровья — `Stand.healthcheck_actions`),
|
||||
подготовка (проверки и сборка до `create` миграции), замена (до
|
||||
`destroy` последней старой), после. CPU на запрос — только до и после.
|
||||
На пике — `API_REPLICAS` + 1 реплик: бюджет CPU и `vm_warnings` считают
|
||||
их. Сторож — как у `failover`.
|
||||
- Результаты — `evidence/rollout/<метка>/`: `meta.json` (с разделом
|
||||
`rollout`: commit, образы, контейнеры и ревизия до и после, начало
|
||||
подготовки `script_start_at`; `resources` — режим, бюджет, контейнеры),
|
||||
`rollout.csv`, `replicas.csv`, `timeline.csv`, `resources.csv`,
|
||||
`samples.csv` (секунды от начала замены), `summary.md`,
|
||||
`raw/rollout-k6.json`, `raw/rollout-lb.log`, `raw/rollout-script.log`
|
||||
(только строки скрипта, без вывода сборки и миграции). Пробные
|
||||
`quick-rollout-*` — в `.gitignore`. Замер для отчёта — `make
|
||||
bench_rollout` после проверки хоста, рабочий стенд остановлен.
|
||||
|
||||
## Профиль загрузок (`uploads`)
|
||||
|
||||
Спек `load-benchmark`, «Профиль загрузок»; design change `upload-memory`,
|
||||
решение 10. Методика — поля `Profile` (`uploads_*`) в `run.py`, разбор без
|
||||
docker — `bench/uploads.py` (`--selftest`). С change `pipeline-reliability`
|
||||
(решение 16) брокер, relay и worker описаны в `bench.compose.yml` (лимиты
|
||||
`BENCH_BROKER_*`, `BENCH_RELAY_*`, `BENCH_WORKER_*`, compose требует их при разборе
|
||||
у всех профилей) и здесь не запускаются: реплика к брокеру не обращается,
|
||||
задания ждут в PostgreSQL. Поэтому у всех вариантов `UPLOADS__MAX_UNFINISHED_JOBS=0`
|
||||
(change `track1-queue-overload`, решение 13): иначе профиль мерил бы предел, а не
|
||||
память приёма; `app_env` вариантов — в паспорте. Метка `baseline`, снятая на
|
||||
`ff1a83b` с брокером, с новыми
|
||||
не сравнивается. Успех — 202, у варианта «до» —
|
||||
201: столбец `s201` не переименован, код называет `success_code` в конце `runs.csv` и
|
||||
раздел `uploads` паспорта.
|
||||
|
||||
- **Стенд:** LB, одна реплика API 1 CPU / 512 МБ без swap (OOM-kill
|
||||
виден, а не прячется в swap), PostgreSQL, Valkey, S3 и `s3-bootstrap`
|
||||
(раздел выше); k6 без лимита.
|
||||
- **Варианты:** «до» — образ `Profile.uploads_before` (`9cc6c0c`, commit
|
||||
переноса лабы 5 в лабу 6: код лабы 5 с местами загрузок, успех 202 —
|
||||
`uploads_success_codes`; прежнего кода `f894040` в истории лабы 6 нет,
|
||||
поэтому H2 про «до» старой метки здесь не воспроизводится; `git archive` →
|
||||
тег `bench-from`,
|
||||
проверка commit до стенда — код 2, как у `rollout_from`); «без лимита» — образ checkout с
|
||||
`UPLOADS__MAX_CONCURRENT=1000`, `UPLOADS__MAX_WAITING=0`; «с лимитом» —
|
||||
образ checkout со значениями по умолчанию. Окружение варианта задаёт
|
||||
override `.work/variant.compose.yml`, а не `BENCH_*`: иначе изменился
|
||||
бы `stand.app_env` прежних профилей, и `bench_compare` отказал бы со
|
||||
старыми метками. В паспорте — `app_env` по вариантам.
|
||||
- **Тела:** PNG из шума RGB шириной 1024 (`random.Random(seed + высота)`,
|
||||
stdlib): ~1 MiB (1 048 276 байт) и ~10 MiB (10 479 107 байт), не больше
|
||||
10 485 760; размеры и SHA-256 — в паспорте. Тело 10 MiB у `uploads` и
|
||||
`uploads_quick` побайтно одно.
|
||||
- **Прогон:** вариант × размер × C ∈ {1, 10, 20, 40} × повтор (3), круги
|
||||
с перестановкой по зерну. Перед каждым — новый volume S3 с bootstrap
|
||||
(`kill`), новая реплика с окружением варианта, ожидание процесса и `UP` в LB,
|
||||
одна разогревающая загрузка. PostgreSQL, пользователь и чат — один раз
|
||||
на метку. Окно — `constant-vus` k6 (`k6/uploads.js`): C VU, 3 с
|
||||
разгона и 20 с окна без пауз; на 429 — пауза `Retry-After`, на прочие
|
||||
ошибки — 1 с; строка на запрос — в файл консоли.
|
||||
- **Память:** сэмплер `peak` сбрасывает `memory.peak` реплики, S3 и LB
|
||||
перед нагрузкой (после разогрева) и читает пик в конце; окно памяти —
|
||||
весь прогон k6. Раз в 0,2 с — `memory.current`, `anon`, `sock`,
|
||||
`oom_kill`. Ядро без сброса (< 6.12) — наибольшая выборка и
|
||||
`peak_sampled`. Загрузок/с и перцентили — по загрузкам окна `[t0 + 3,
|
||||
t0 + 23)`, ответы по кодам — за весь прогон, в том числе после OOM.
|
||||
- **Пометки:** `oom` (реплика завершена ядром — результат варианта, не
|
||||
сбой команды; следующий прогон на новой реплике), `host_swap`,
|
||||
`peak_sampled`, `s3_down`. Блокировка `bench/.bench.lock`, отказ
|
||||
занятой метки и остатков стенда — как у остальных профилей.
|
||||
- **Результаты:** `evidence/uploads/<метка>/` — `meta.json` (раздел
|
||||
`uploads`: commit «до», образы, тела, план, `app_env`), `runs.csv`
|
||||
(строка на прогон: вариант, размер, C, повтор, память до окна, пик
|
||||
окна, пик старта, наибольшие `anon` и `sock`, `oom_kill`, код выхода и
|
||||
`OOMKilled`, ответы по кодам, успешных загрузок/с, p50/p95/p99, пики S3
|
||||
и LB, пометки, код успеха; прочий 201 или 202 — `s_other`), `summary.md` (медиана и min–max по ячейкам, сценарии
|
||||
спеков — с ростом на клиента и итогом «Буферы соединений ограничены»
|
||||
по сумме роста LB и `sock` реплики от C = 1 до 40, H1–H4 с итогом
|
||||
только по ячейкам гипотез; у метки `baseline` этих строк ещё нет —
|
||||
design, «Уточнения apply», пп. 12–13), `raw/<прогон>-k6.json`,
|
||||
`raw/<прогон>-peak.log`.
|
||||
`quick-uploads-*` — в `.gitignore`.
|
||||
- **Время:** полный профиль — 72 прогона, ~50 мин; `uploads_quick` —
|
||||
«без лимита» и «с лимитом», 10 MiB, C ∈ {1, 10, 40}, один повтор,
|
||||
~4,5 мин. Замер для отчёта — `make bench_uploads` после проверки хоста,
|
||||
рабочий стенд остановлен (`make stop`), гипотезы H1–H4 закоммичены
|
||||
раньше метки.
|
||||
|
||||
## Профиль сверки (`reconcile`)
|
||||
|
||||
Спек `load-benchmark`, «Профиль сверки» и «Стоимость сверки в отчёте»;
|
||||
design change `track2-reconcile-cost`, решения 1–3, 7–13. Методика — поля
|
||||
`Profile` (`reconcile_*`, `cleaner_*`) в `run.py`, модель набора, план,
|
||||
разбор, вердикты и сводка без docker — `bench/reconcile.py`
|
||||
(`--selftest`), загрузчик объектов — `bench/fill_objects.py`, фоновая
|
||||
нагрузка — `bench/k6/background.js`.
|
||||
|
||||
- **Стенд:** LB, две реплики 1 CPU / 512 МБ, PostgreSQL 2 / 1 ГБ, Valkey
|
||||
0,5 / 128 МБ, S3 и `s3-bootstrap` рабочего стенда; к аргументам S3
|
||||
добавлен `-metricsPort=9327` (override `.work/s3-metrics.compose.yml`
|
||||
из `command` сервиса `s3` по `docker compose config` того же стенда —
|
||||
списка аргументов в двух местах нет). Порт слушает loopback контейнера
|
||||
S3, из сети стенда недоступен; **у прочих профилей и рабочего стенда его
|
||||
нет**. Сэмплер `scan` с интервалом 0,5 с (`reconcile_sample_interval_s`)
|
||||
на этап, k6 без лимита.
|
||||
- **Проход** — разовый уборщик `docker compose run -d --name
|
||||
mtusi-bench-reconcile-<n> --no-deps -e CLEANER__PENDING_GRACE_SECONDS=30
|
||||
cleaner reconcile …` (лимиты `BENCH_CLEANER_*` в `bench.compose.yml` —
|
||||
0,25 CPU / 256 МБ без swap, в управляемом опыте `BENCH_CLEANER_CPUS=1`
|
||||
на вызов), затем `docker wait`, журнал, `docker inspect` и `docker rm`
|
||||
при любом исходе. Вариант «до» — тот же вызов с override
|
||||
`.work/cleaner-before.compose.yml` (`image: mtusi-messenger:bench-from`,
|
||||
`Profile.reconcile_before` — `9cc6c0c`, commit переноса лабы 5 в лабу 6:
|
||||
прежнего `7f4e626` в истории нет, ранний отказ по пределу в «до» уже есть, поэтому
|
||||
S4 ждёт у обеих ячеек одно число находок, а вердикт S4 «до и после»
|
||||
ничего не показывает — метка лабы 4 осталась в её отчёте;
|
||||
`git archive` → тег `bench-from`, проверка commit до стенда — код 2, как
|
||||
у `rollout_from`). Тег стенда не меняется.
|
||||
- **Этапы полной метки:** A — свежий стенд, 1 000 × 1 MiB, `batch`,
|
||||
`deep`, `deep-fast`; B — свежий, 10 000 × 4 KiB, `batch`, `head`,
|
||||
`deep`; C — тот же, +20 000, `batch`, `head`; D — тот же, +70 000,
|
||||
`batch` и блок под нагрузкой `stand`, `stand-unlimited`,
|
||||
`fast-unlimited`, `fast-limited`; S4 — свежий, 10 000 согласованных и
|
||||
1 000, затем 10 000 строк `ready` без объектов, `before` и `after`
|
||||
(`--apply --max-changes 100`, у `after` — без предела скорости). Три
|
||||
повтора кругами внутри группы (`reconcile.plan_passes`), план — в
|
||||
`meta.json` до первого прохода. У группы из одной ячейки (D без
|
||||
нагрузки — только `batch`) повторы идут подряд: остальные проходы
|
||||
набора — блок под нагрузкой (спек `load-benchmark`, verify S8). Ячейки без нагрузки — dry-run без
|
||||
предела скорости. `reconcile_quick` — один стенд 2 000 × 4 KiB, все
|
||||
виды по одному проходу, окна 5 с, S4 с 300 кандидатами на своём свежем
|
||||
стенде.
|
||||
- **Набор** (решение 2): объект `i` — `id` UUID v4 из SHA-256
|
||||
`<зерно>:<i>`, содержимое — повторённый SHA-256 `<зерно>:<i>:c`, класс —
|
||||
`i mod 400` (0 — объект без строки, 1 — строка без объекта, 2 — размер
|
||||
в строке на байт больше, 3 — зависшая загрузка `pending` с объектом);
|
||||
строки — читаемый чат и его владелец из `prepare.js`, `created_at` =
|
||||
`updated_at` = сутки назад. Проходы этапа — через grace + 2 с после
|
||||
последнего PUT. Каждый проход сверяет `found` по классам,
|
||||
`listed_objects` и `checked_rows` с моделью (`reconcile.model`):
|
||||
расхождение — отказ команды с проходом, классом и обоими числами.
|
||||
- **Граница чёрного ящика** — новые исключения, только у этого профиля и
|
||||
только на свежем стенде `mtusi-bench`:
|
||||
- метаданные набора — `\copy attachments (…) FROM STDIN` через `docker
|
||||
exec -i … psql` (данные стенда, схему не трогает; файла CSV нет —
|
||||
строки генерирует `reconcile.rows_csv`);
|
||||
- объекты — `bench/fill_objects.py` в контейнере `mtusi-bench-fill` на
|
||||
образе стенда (botocore образа, `src` не импортируется, `bench/` на
|
||||
чтение, ключи API — `docker run -e <имя>` без значения в argv, три
|
||||
процесса × 24 потока);
|
||||
- метрики шлюза S3 — `docker exec mtusi-bench-s3 wget` на loopback до
|
||||
и после прохода; `pg_stat_database` — psql до и после;
|
||||
- проход — процесс уборщика из образа, результат — его записи
|
||||
«Started cleaner», «Finished reconcile pass», «Reconcile changes
|
||||
exceed limit» (`raw/<проход>-cleaner.json`; записи о расхождениях —
|
||||
числом).
|
||||
`mtusi-bench-fill` и `mtusi-bench-reconcile-*` — в остатках стенда и в
|
||||
уборке `Stand.stop()`.
|
||||
- **Счёт S3:** шлюз считает HEAD типом GET, поэтому `LIST = list`,
|
||||
`GET = head + get`, `DELETE = delete`; в ячейках без нагрузки неравенство
|
||||
— пометка `count_mismatch` (строка остаётся). С change `pipeline-reliability`
|
||||
(решение 16) сверка на один LIST больше: страница списка staging, пустая, —
|
||||
в счёте обоих источников и в модели H1 (`reconcile.STAGING_PAGES`);
|
||||
`listed_objects` её не считает. Строки набора идут `\copy` без `staging_key` —
|
||||
строки прежней версии с объектом по `object_key`: так сверка их и читает.
|
||||
Новые `attempt_base` и `attachment_job_replays` принадлежат заданиям, набор их не
|
||||
пишет. Вариант `before` (`9cc6c0c`, код лабы 5) staging уже знает; H1 его
|
||||
не считает.
|
||||
- **Ресурсы:** окно прохода — `[t − duration_ms, t]`, `t` — время записи
|
||||
«Finished reconcile pass» (часы ВМ); CPU уборщика (по `id` контейнера
|
||||
прохода), S3, PostgreSQL, реплик и LB — по отсчётам сэмплера; память
|
||||
уборщика — выборка у начала окна и наибольшая за жизнь контейнера.
|
||||
- **Фоновая нагрузка (H4):** один k6 `background.js` на блок — 300
|
||||
скачиваний (5 000 согласованных вложений от зерна, `.work/downloads.json`),
|
||||
50 записей и 50 чтений истории в секунду; тихие окна 30 с перед первым
|
||||
проходом и после каждого; окна «до» и «после» — по старту и выходу
|
||||
контейнера, окно прохода — по итогу. k6 останавливается `pkill -INT -f
|
||||
background.js` в контейнере k6 (итог он пишет и тогда). Полнота строк
|
||||
(`reconcile.line_problems`): строк `bg,…` сценария не меньше итераций
|
||||
сценария и не меньше счётчика k6 `bg_lines_<сценарий>` (его
|
||||
увеличивает тот же код перед строкой; меньше — «lines lost», отказ), а
|
||||
лишних против каждого — не больше VU сценария (`reconcile_bg_max_vus`)
|
||||
и не больше VU, созданных k6 за прогон (`vus_max` итога, verify S4).
|
||||
Лишние — итерации, прерванные SIGINT уже после строки: k6 их в
|
||||
`iterations` не считает, а их отсчёт счётчика может не принять (метка
|
||||
`aaf3fa3` упала на 264 071 строке download против 264 070 итераций,
|
||||
`a42dd27` — на 43 997 строках write против 43 996 и итераций, и
|
||||
отсчётов). Число прерванных — в `meta.reconcile.bg_interrupted`.
|
||||
Точного равенства нет ни с одним счётом. `r` = p95 прохода
|
||||
/ p95 тихих, `a` = p95 до / p95 после; 5xx окон прохода — пометка
|
||||
`bg_5xx`, неуспешные запросы (`http_req_failed`) и недосланные итерации
|
||||
(`dropped_iterations`) по всему итогу k6 — пометки `bg_failed` и
|
||||
`bg_dropped` всех проходов блока (`meta.reconcile.bg_errors`, verify
|
||||
S9); с любой из трёх H4 не подтверждается.
|
||||
- **Сравнение:** все варианты — внутри одной метки; второй метки A/A нет
|
||||
(шум — разброс повторов и `a`). `make bench_compare` метки сверки не
|
||||
сравнивает: он читает `evidence/bench/`, у сверки другая методика.
|
||||
- **Результаты:** `evidence/reconcile/<метка>/` — `meta.json` (раздел
|
||||
`reconcile`: план, этапы и модели, commit и образы «до», аргументы S3,
|
||||
CPU уборщика, фоновая нагрузка; `limits.cleaner` по CPU), `passes.csv`
|
||||
(строка на проход, новые столбцы — в конец; с verify S6 —
|
||||
`fixed_total` и `fixed_records`, неизменность данных S4; у метки
|
||||
`baseline` их нет), `windows.csv`, `summary.md`
|
||||
(таблицы, S4, вердикты H1–H4 и S4), `cost-by-n.svg`, `requests-by-n.svg`,
|
||||
`background-p95.svg`, `raw/`. `quick-reconcile-*` — в `.gitignore`.
|
||||
- **Время:** полная метка ~50 мин (45 мин у `baseline`), быстрая ~4 мин
|
||||
(3,7 мин на шумном хосте). Замер для отчёта —
|
||||
`make bench_reconcile` на тихом хосте, рабочий стенд остановлен (`make
|
||||
stop`), гипотезы H1–H4 закоммичены раньше метки.
|
||||
|
||||
## Профиль очереди (`queue`, `queue_quick`)
|
||||
|
||||
Спек `load-benchmark`, «Профиль очереди»; design change `track1-queue-overload`, решения
|
||||
5–11, 14. Методика — поля `Profile` (`queue_*`), `QUEUE_RATES`, конфигурации
|
||||
`queue_matrix` и `queue_blocks` в `run.py`; разбор без docker — `bench/overload.py`
|
||||
(`--selftest`), не `queue.py`: каталог скрипта первый в `sys.path`.
|
||||
|
||||
- **Стенд:** LB, две реплики 1 CPU / 512 МБ, PostgreSQL, Valkey, S3, брокер, relay, worker
|
||||
и уборщик с лимитами рабочего стенда без swap; третий `-f` — `queue.compose.yml`
|
||||
(плагин `rabbitmq_prometheus`, статистика в секунду, порт 15692 только в сети стенда;
|
||||
`restart: unless-stopped` у worker), окружение ячейки — `.work/variant.compose.yml`.
|
||||
У S3 остаётся `restart: "no"`: его гибель — пометка `storage_down`.
|
||||
- **Ячейка** — свежий стенд, `prepare.js`, разогрев 12 файлов `s` до `ready` (готовые байты
|
||||
контрольного потока), сэмплер `queue`, `background.js`, `queue.js`: окна `before` и `over`
|
||||
одним запуском, затем ожидание нуля незавершённых, окно `after` отдельным запуском,
|
||||
ожидание нуля, `queue_sweep.js`, чтение SQL и журналов. VU — заранее и без прибавления:
|
||||
тело — `open` на VU. Ответ не повторяется.
|
||||
- **Истина о готовности — `GET /attachments/{id}` после разбора:** `updated_at` у `ready`
|
||||
не меняется, живого опроса нет. Новые исключения границы чёрного ящика, только этот
|
||||
профиль и только чтение: `psql \watch` сэмплера и чтение SQL в конце ячейки, метрики
|
||||
брокера по HTTP в сети стенда, журналы контейнеров (разбор без копирования в метку).
|
||||
- **Сэмплер `queue`:** строки `cg`, `vm`, `lb` как в `scan` и `list`, `mp` (`memory.peak`,
|
||||
`anon`, `oom_kill`), `mq` (метрики брокера, `missing`), `jobs.log` — `psql \watch`.
|
||||
`rabbitmqctl` стоит 0,5 с CPU брокера на вызов: им не опрашивать. Перезапуск сбрасывает
|
||||
cgroup того же контейнера: `overload.split_lives` — наибольшее и сумма по жизням.
|
||||
- **Причины завершения** (verify S5): поток `Stand.death_events` (`docker events`: `oom`,
|
||||
`kill`, `die` с кодом выхода), разбор — `overload.die_causes`. Проба Docker 29.9: ядро —
|
||||
`oom` и `die` 137 в десятки мс; `docker kill` — `kill` с сигналом и `die`; процесс
|
||||
обработки — `oom` без `die`. Столбцы `worker_die_oom`, `worker_die_command`,
|
||||
`worker_die_other`, `worker_exit_codes`, `worker_oom_events`, `relay_restarts`, `relay_die`.
|
||||
`oom_kill` — счётчик cgroup плюс подтверждённые завершения процесса 1, а не каждый
|
||||
перезапуск. Перезапусков больше, чем `die` в потоке, — отказ: поток потерян.
|
||||
- **Реплики в LB** считает `overload.lb_up_count`: только слоты-серверы, не `BACKEND`, `UP
|
||||
1/2` — ещё в балансировке; наименьшее — столбец `lb_up_min`. В метке `baseline` `lb_down`
|
||||
не срабатывал: считал `BACKEND` третьей репликой.
|
||||
- **Сверка принятых — в обе стороны** (verify S4): вложение стенда не из 202 и не из разогрева
|
||||
— `unexpected_rows`; больше, чем 5xx и обрывов, — пометка `unexpected`.
|
||||
- **Пометки:** `oom`, `worker_restart`, `worker_crash`, `failed` — результат настройки; `lost`, `stuck`,
|
||||
`duplicate`, `sha_mismatch`, `unexpected` — ненулевой код команды в конце метки, ячейки сняты;
|
||||
`not_recovered`, `dropped`, `lb_down`, `host_swap`, `storage_down`. Запись «Started
|
||||
worker» не совпала с ячейкой — отказ. Тиков сэмплера нет 3 с в нагрузке — отказ.
|
||||
- **`RESUME=1`** — как у серий: тот же commit, готовая строка `cells.csv` — признак ячейки.
|
||||
- **Результаты:** `evidence/queue/<метка>/` — `meta.json`, `cells.csv` (новые столбцы —
|
||||
только в конец), `timeline.csv`, `summary.md`, четыре SVG, `raw/` — только итоги k6;
|
||||
журналы не копируются, `.work/` удаляется. `quick-queue-*` — в `.gitignore`. Метка
|
||||
`baseline` (`7999002`) снята раньше правок verify и не перезаписывается, столбцы правок —
|
||||
с `baseline2`. `baseline2` и `baseline3` сняты с выгрузкой хоста, остаются записью;
|
||||
основная для отчёта — `baseline4` (`QUESTIONS.md`, правило выбора). Образы S3 и брокера в
|
||||
паспорте (`stand.s3`, `stand.rabbitmq`) — только у меток после `baseline4`; её образы — в `REPORT.md`.
|
||||
- **Время:** полный профиль — 57 ячеек, ~2 ч 10 мин; `queue_quick` — `s` (2, 2), `lp` (4, 4),
|
||||
предел 40 и без него, `kill-worker`, `w2-p256`, ~11 мин. Рабочий стенд — `make stop`.
|
||||
|
||||
## Профиль цены телеметрии (`telemetry`, `telemetry_quick`)
|
||||
|
||||
Спек `load-benchmark`, «Профиль цены телеметрии», «Выключатель телеметрии стенда», «Цена телеметрии
|
||||
в отчёте»; design change `track1-telemetry-cost`, решения 1–14. Методика — поля `Profile`
|
||||
(`telemetry_*`, лимиты `collector_*`, `prometheus_*`, `loki_*`, `tempo_*`, `lookup_*`) в `run.py`;
|
||||
таблица вариантов, план, разбор, вердикты H1–H8 и B1–B5, сводка и проверки конфигураций без docker
|
||||
— `bench/telemetry_cost.py` (`--selftest`), выборка из хранилищ — `bench/telemetry_lookup.py`.
|
||||
|
||||
- **Стенд:** компоненты и лимиты профиля очереди (LB, две реплики, PostgreSQL, Valkey, S3, брокер,
|
||||
relay, один worker, уборщик; без `queue.compose.yml`: плагин метрик брокера и политика
|
||||
перезапуска worker вариантам не нужны), в вариантах с телеметрией — Collector, Prometheus, Loki и
|
||||
Tempo рабочего стенда (`bench/telemetry.compose.yml` вторым `-f`); Grafana — никогда. Порядок
|
||||
старта: PostgreSQL и Valkey → миграции → телеметрия (Prometheus `--wait`, затем Collector, Loki,
|
||||
Tempo, `wait-ready` контейнера выборки) → S3 и брокер → реплики и LB → relay, уборщик, worker.
|
||||
Каждый прогон — свежий стенд (`down -v` вместе с volume хранилищ телеметрии).
|
||||
- **Варианты** — `telemetry_cost.variants()`: окружение `TELEMETRY__*` трёх процессов, слой
|
||||
Collector (`bench/otel/tail-typical.yaml`, `tail-balanced.yaml` — второй `--config`) и
|
||||
конфигурация Prometheus (`bench/otel/prometheus-lean.yml` — bind на тот же путь) пишутся в
|
||||
`.work/variant.compose.yml` прогона. **До стенда** (`telemetry_preflight`, код 2 с именем файла):
|
||||
лимиты `Profile` против `docker compose config` основного файла; слои — `validate` и сравнение
|
||||
`print-config --format=json` со слоем и без него (только `processors.tail_sampling` и список
|
||||
процессоров pipeline трасс); копия Prometheus — построчно вне `# bench-lean` и `promtool check
|
||||
config`. **После** — записи «Started API/worker/relay» против варианта (`startup_problems`) и
|
||||
признаки слоёв в выборке (`layer_problems`): расхождение — отказ команды с прогоном.
|
||||
- **Нагрузка** — `k6/telemetry.js`: классы — сценарии `constant-arrival-rate` (`timeUnit` 10 с, VU
|
||||
заранее без прибавления, ответ не повторяется), строка `t,…` на запрос с `X-Request-Id`,
|
||||
`t-t0` в `setup()`; окна — разогрев, чистое (цена), отказов (блокировки `LOCK TABLE messages IN
|
||||
SHARE MODE` на `telemetry_locks` секундах, моменты `clock_timestamp()` — `meta.telemetry_cost.
|
||||
locks_at`). Перед нагрузкой — `prepare.js`, разогрев 12 файлов `s` до `ready` (готовые байты
|
||||
скачиваний, `queue_warm`), одна строка вложения `ready` без объекта (`\copy`, `reconcile.rows_csv`
|
||||
с `FORCE_MISSING` — класс `broken`). Регистрация — пароль из `crypto.randomUUID()` только в
|
||||
памяти итерации.
|
||||
- **Граница чёрного ящика** — новые исключения, только у этого профиля и только на свежем стенде:
|
||||
строка вложения без объекта; блокировка таблицы сообщений в своей сессии psql; счёт незавершённых
|
||||
заданий в PostgreSQL; чтение Prometheus, Loki, Tempo и метрик Collector по HTTP из контейнера
|
||||
`mtusi-bench-lookup` (образ стенда, stdlib, `bench/` на чтение, сеть `mtusi-bench-telemetry`,
|
||||
0,5 CPU / 256 МиБ); размер volume хранилищ — `mtusi-bench-du` (образ PostgreSQL, `--user 0`, без
|
||||
сети, volume на чтение); записи о старте процессов в журналах контейнеров. Оба контейнера — в
|
||||
остатках и уборке стенда.
|
||||
- **Выборка** (`telemetry_lookup.py collect`): трассы по `span.messenger.request_id` пачками по 40
|
||||
(регулярное выражение), цепочка загрузки — структурный TraceQL (`&& { kind = consumer && …outcome
|
||||
}` `&& { kind = producer }`), записи доступа по `request_id` и их `trace_id` → `/api/v2/traces`,
|
||||
счётчики приёма, потерь и событий (`query_range` с шагом 15 с по краям чистого окна, итог — в
|
||||
конце), ряды по `job`, `status/tsdb`, `status/config`, квантили из buckets против
|
||||
`quantile_over_time` Loki. Предел результатов — 4 × ожидаемого; равен пределу — отказ «lookup
|
||||
truncated». Повторы — только на обрыв соединения и 5xx (Tempo с 0,5 CPU под пулом запросов
|
||||
изредка закрывает соединение). К Tempo — не больше 3 запросов разом (`TEMPO_REQUESTS`): в метке
|
||||
`baseline` (`509afca`) Tempo завершился посреди выборки, вероятно OOM по лимиту 640m под её
|
||||
запросами (design, «Уточнения apply», п. 16). Перед выборкой и при её отказе
|
||||
`Bench.telemetry_alive` проверяет сервисы телеметрии (работает, код выхода, `OOMKilled`,
|
||||
перезапуски): погибший — отказ с его состоянием и хвост журнала в `raw/<прогон>-<сервис>.log`
|
||||
(уборка удаляет контейнер); после выборки `memory.peak` сервисов — `raw/<прогон>-peaks.json`
|
||||
(запас до лимита, контейнер `mtusi-bench-du` с `--cgroupns host`).
|
||||
- **Ожидание после нагрузки:** незавершённых заданий 0 (не дольше `telemetry_drain_s`, иначе
|
||||
`not_drained`), обход метаданных `queue_sweep.js` (без байтов), затем `telemetry_cost.wait_after`
|
||||
от конца нагрузки — последние отправки метрик и решения выбора трасс доходят до хранилищ.
|
||||
- **Сэмплер `cost`** — как `scan` (без сети), плюс строки `mp`; сторож — `check_observer`.
|
||||
- **Пометки:** `dropped`, `host_swap`, `storage_down`, `oom`, `not_drained`, `lost` (ненулевой код в
|
||||
конце метки), `telemetry_loss` (результат варианта), `saturated` (у `full` нарушена граница
|
||||
калибровки решения 8 — повод переснять).
|
||||
- **`RESUME=1`** — как у очереди: тот же commit и режим, готовая строка `runs.csv` — признак
|
||||
прогона. `VARIANTS=…` — отладка (`overrides`, продолжение с ними запрещено).
|
||||
- **Результаты:** `evidence/telemetry-cost/<метка>/` — `meta.json` (раздел `telemetry_cost`:
|
||||
варианты с SHA-256 слоёв, план, интенсивности, окна, блокировки, `app_env` по вариантам;
|
||||
`limits_by_mode`, `stand` и `stand_telemetry` с образами, лимитами и SHA-256 конфигураций),
|
||||
`runs.csv`, `components.csv`, `classes.csv` (новые столбцы — только в конец), `summary.md`, четыре
|
||||
SVG, `raw/` — итоги k6 и выборки (идентификаторы синтетические). `quick-telemetry-*` — в
|
||||
`.gitignore`.
|
||||
- **Время:** полный профиль — 21 прогон, ~1 ч 25 мин (метка `baseline2`, оценка была ~1 ч 50 мин); быстрый — шесть
|
||||
вариантов, ~20 мин;
|
||||
`VARIANTS=off,full,tail` — ~10 мин (защита «для 5»). Рабочий стенд — `make stop`.
|
||||
|
||||
## Серии трека 1 (`scaling_*`)
|
||||
|
||||
Доказательство уровня «5», трек 1 «Цена масштабирования» (design change
|
||||
`scaling-bench`; гипотезы H1–H3 — его решение 10 и `REPORT.md`).
|
||||
Матрицу не снимает; метки серий сравниваются только с метками серий.
|
||||
|
||||
- **Серии и конфигурации** (реплик × CPU / память, `max_connections`):
|
||||
`a` — бюджет 4 CPU / 2 ГиБ: 1 × 4, 2 × 2, 4 × 1; `b` — 1…6 × 1 CPU /
|
||||
512 МиБ; `pool` — 4 × 1 при 100 и 50; `ab` — 1 × 1 и 6 × 1 («до/после»
|
||||
и A/A, метка `scaling-aa`); `db` — 1, 2, 4 × 1 при PostgreSQL 0,5 CPU
|
||||
и контроль 4 × 1 при 2 CPU (насыщение БД управляемым опытом; лимит
|
||||
PostgreSQL — пятый элемент конфигурации, имя `<k>x1-pg<CPU>`); `db4`
|
||||
— две ячейки серии `db` (4 × 1 при 0,5 и 2 CPU) для «до/после» change
|
||||
`scaling-improvement`: окончательные метки попытки 2 —
|
||||
`scaling-db-aa2`, `scaling-db-before2` (пул 10 + 5) и
|
||||
`scaling-db-nooverflow2` (10 + 0); попытка 1 (`scaling-db-aa`,
|
||||
`-before`, `-nooverflow`) испорчена помехами хоста и оставлена как
|
||||
есть; метки `scaling-a`, `-b`, `-pool`, `-aa`, `-db` сняты на
|
||||
10 + 5); `quick` и `db_quick` —
|
||||
самопроверки. Общие поля — в
|
||||
`scaling_profile()` `run.py`, чтобы методика серий не расходилась.
|
||||
- **Бюджет:** PostgreSQL 2 / 1 ГиБ, HAProxy 1 / 256 МиБ, Valkey 0,5 /
|
||||
128 МиБ, k6 2 / 1 ГиБ, сэмплер 0,25 / 128 МиБ — 5,75 CPU без реплик.
|
||||
Сумма CPU конфигурации больше CPU ВМ — отказ до стенда (код 2); поэтому
|
||||
серия `b` — до 6 реплик (11,75 CPU), граница пула при 10 + 5 того
|
||||
времени (k = 7) — управляемым опытом `pool`; с 10 + 0 — k = 10. Бюджет — `meta.budget`.
|
||||
- **Ячейка** — конфигурация × повтор, 3 повтора, каждая на свежем стенде
|
||||
(`down -v`, миграции, данные: читаемый чат 10 000, 10 чатов записи).
|
||||
Порядок — круги, перестановка с зерном `order_seed`, повтор одной
|
||||
конфигурации не стоит подряд; план — `meta.plan` до первой ячейки.
|
||||
- **Ступень** — один запуск `k6/mixed.js` (смесь 70/20/10, три сценария
|
||||
`ramping-arrival-rate`): прогрев 15 с с нуля (первая ступень и после
|
||||
паузы) или 5 с подъёма, окно 20 с. Тег `window` по
|
||||
`exec.scenario.startTime`; окно на часах ВМ — от `t0` из `setup()`.
|
||||
Сначала фиксированные 250 и 500/с, затем поиск R*: L0 = ступенька
|
||||
`100 × 1,25^i` ≥ max(300 × реплик, пройденный фиксированный), подъём
|
||||
или спуск, два деления по среднему геометрическому (`scaling.Search`).
|
||||
- **SLO:** p95 успешных ≤ 200 мс и (ошибки + короткие страницы +
|
||||
недосланные) / запланированные ≤ 1 %. Нарушила — пауза 10 с и
|
||||
`wait_ready`. Ошибок > 50 % или p95 > 2 с — досрочный выход k6 (код
|
||||
99), причина `abort`.
|
||||
- **Генератор с лимитом и брак:** CPU k6 ≥ 1,8 ядра, его троттлинг ≥ 10 %
|
||||
или недосланные при CPU k6 ≥ 70 % лимита (`vus` k6 — выборка раз в
|
||||
секунду, «свободные VU» по нему не видны). Брак останавливает поиск,
|
||||
R* — нижняя граница (`generator_bound`); лечение — поднять лимит
|
||||
(смена методики) и переснять серию.
|
||||
- **Сэмплер** `mtusi-bench-sampler` (`bench/sampler.sh` на образе
|
||||
PostgreSQL стенда, `--cgroupns host`): раз в секунду `cpu.stat`,
|
||||
`memory.current`, `cpu.pressure` каждого контейнера, `/proc/stat` и
|
||||
PSI ВМ, CSV статистики HAProxy, а одним постоянным соединением `psql
|
||||
\watch` — `pg_stat_activity` по адресам реплик и `wait_event`,
|
||||
`pg_stat_database`, `pg_stat_wal`, `pg_stat_io`. Его соединение
|
||||
занимает слот: граница пула — `max_connections − 1`. Строки ступени,
|
||||
признаки узкого места и пороги — `scaling.py` (`THRESHOLDS`). Это режим
|
||||
`list` (явный список контейнеров, сеть стенда, метка проекта, `psql` и
|
||||
опрос LB); профили `failover` и `rollout` берут тот же скрипт в режиме
|
||||
`scan` — без сети, без `psql` и LB (design change `profile-resources`).
|
||||
- **Файлы метки:** `runs.csv` (строка на ступень, новые столбцы в
|
||||
конце), `searches.csv` (строка на ячейку), `samples.csv` (посекундно
|
||||
в окнах), `prefill.csv`, `summary.md`, `p95-by-rate.svg`,
|
||||
`cpu-by-component.svg`, `raw/<ячейка>-a<попытка>-s<NN>.json`,
|
||||
`raw/…-errors.log` (5xx и «too many clients»: строки PostgreSQL, API,
|
||||
LB без секретов), `progress.json`.
|
||||
- **Продолжение:** `RESUME=1` — тот же профиль и commit, дерево чистое
|
||||
без каталога своей метки; готовые ячейки (строка в `searches.csv`)
|
||||
пропускаются, прерванная снимается с попыткой +1. Метку каждой серии
|
||||
коммитить до запуска следующей: иначе паспорт следующей — `dirty:
|
||||
true`.
|
||||
- **Блокировка** `bench/.bench.lock` (`flock`) — для всех профилей:
|
||||
второй прогон — код 2. Остатки стенда серии удаляет сама (блокировка
|
||||
взята, значит, прогона нет); прочие профили по-прежнему отказывают.
|
||||
- **Сравнение и «до/после»:** `make bench_compare` у серий — по общим
|
||||
конфигурациям (R*, задержки на фиксированных уровнях, CPU на запрос,
|
||||
CPU PostgreSQL на R*; шум `AA` — наибольшее |Δ медианы R*|), и вторая
|
||||
таблица «PostgreSQL на R* и первой нарушившей ступени» (уровень, CPU
|
||||
PostgreSQL на запрос, новые сессии за окно, соединения; поля
|
||||
`config_stats` `*_r` / `*_f`). Серия против матрицы — отказ. `make
|
||||
bench_ab … SERIES=ab` снимает серию вместо матрицы.
|
||||
- **Графики:** `make bench_plots LABELS="scaling-a scaling-b"` —
|
||||
`evidence/plots/scaling/`; пробные `quick-*` — в `.gitignore`.
|
||||
|
||||
## Как писать
|
||||
|
||||
- Стенд — чёрный ящик: `run.py`, `k6/` и `compare.py` не импортируют
|
||||
`src` и не ходят в приложение мимо HTTP. Все запросы к API делает k6
|
||||
внутри сети стенда, оркестратор управляет только docker CLI.
|
||||
- Исключение — PostgreSQL стенда: оркестратор обращается к нему
|
||||
напрямую (`docker exec … psql` от пользователя контейнера, SQL через
|
||||
stdin, `docker logs`), но только для обслуживания и измерения:
|
||||
- `VACUUM (ANALYZE)` и `CHECKPOINT`;
|
||||
- размеры таблиц и число сообщений по чатам;
|
||||
- включение и выключение `auto_explain` между маркерами;
|
||||
- журнал Postgres с планами;
|
||||
- варианты запроса истории (без индекса, с вариантами индекса, с
|
||||
курсором через `OR`, generic plan) в транзакции, которая
|
||||
откатывается;
|
||||
- пробы записи по вариантам индекса в транзакции, которая
|
||||
откатывается, и `VACUUM messages` после каждой;
|
||||
- `pg_dump` исходной базы, второе хранилище (`docker run`, имя
|
||||
`mtusi-bench-postgres-restore`, volume `mtusi-bench_restore`, метка
|
||||
проекта), `pg_restore` и `ANALYZE` в нём, построчная сверка обеих
|
||||
баз;
|
||||
- `FLUSHALL` Valkey стенда и пересоздание API с адресом
|
||||
восстановленной базы — только на этапе восстановления, в конце
|
||||
размера. После пересоздания `switch_api` сначала ждёт, что процесс
|
||||
каждой новой реплики сам отвечает на `/health/ready` (`docker exec`
|
||||
команды HEALTHCHECK образа, `wait_processes_ready`), и только потом
|
||||
`UP` в LB: новый контейнер получает тот же IP, и LB ещё держит слот
|
||||
`UP` от прежнего — без этого шага первые запросы k6 получали 503
|
||||
`<NOSRV>` (design change `attachments`, «Уточнения apply», п. 9). Второе хранилище и его volume `Stand.stop()` удаляет до
|
||||
`compose down`;
|
||||
- ревизия `alembic_version` до и после замены (профиль `rollout`).
|
||||
- Исключение для S3 стенда (профиль `uploads`, change `upload-memory`):
|
||||
перед каждым прогоном оркестратор удаляет S3 (`kill`: volume всё равно
|
||||
уходит), его volume `mtusi-bench_s3_data`, поднимает S3 и `s3-bootstrap`
|
||||
заново. К bucket и объектам он не обращается. Счётчики памяти cgroup
|
||||
реплики, S3 и LB читает сэмплер `peak` (`--user 0`, cgroupfs на
|
||||
запись, `--network none`): сброс `memory.peak` через свой дескриптор —
|
||||
управление счётчиком, а не приложением.
|
||||
Схему меняет не оркестратор, а миграция приложения, которую
|
||||
запускает `scripts/rolling-update.sh`, — как на рабочем стенде.
|
||||
|
||||
Данных и схемы, видимых приложению, он не меняет: список индексов и
|
||||
число строк `messages` до и после этапа сверяются, при различии —
|
||||
отказ. Между прогонами нагрузки нет. Свою копию SQL приложения стенд
|
||||
не держит: варианты строятся из текста запроса в журнале Postgres.
|
||||
- Из журнала Postgres в результаты идут только планы запроса истории
|
||||
(`messages`). Между маркерами журнал содержит и проверку сессии с
|
||||
SHA-256 токена в параметрах: она отбрасывается и не пишется никуда.
|
||||
- Все вызовы `docker compose` — только с `-p mtusi-bench`, обоими `-f` и
|
||||
`--env-file bench/bench.env`, с окружением, собранным `run.py`:
|
||||
без `-p` `down -v` удалил бы чужой volume, без `--env-file` compose
|
||||
прочитал бы рабочий `.env`.
|
||||
- Скрипты `bench/` на хосте — только stdlib Python, запуск
|
||||
`uv run python bench/<файл>.py`. Новых зависимостей не добавлять.
|
||||
`bench/sampler.sh` — bash, работает только внутри контейнера
|
||||
сэмплера, на хосте не запускается.
|
||||
- Сценарии k6 — JavaScript без Node.js: только встроенные модули k6.
|
||||
Заголовок идентификации собирается в одном месте `lib.js`: Bearer,
|
||||
как `Actor.headers()` в `student-tests/`. Отправка сообщения — только
|
||||
с `messageHeaders(token)` из `lib.js`: с лабы 3 она добавляет новый
|
||||
`Idempotency-Key` (`crypto.randomUUID()`) на каждую отправку; без
|
||||
ключа запись получит 400. Стенд отправки не повторяет, поэтому число
|
||||
сообщений равно числу подтверждённых 201, а запись ключа входит в
|
||||
стоимость записи всех меток лабы 3. Пароли пользователей стенда
|
||||
живут только в памяти `prepare.js`, токены — в `.work/fixture.json`,
|
||||
который удаляется в конце прогона; в каталог метки не попадает ни то,
|
||||
ни другое.
|
||||
- Имена контейнеров и сети — `mtusi-bench-*`. Чужие контейнеры
|
||||
(`make run_docker`, другие проекты) стенд не трогает и не
|
||||
останавливает. Уборка своих — в `finally` и по Ctrl+C. Остатки
|
||||
прерванного прогона `run.py` не удаляет сам: он отказывается
|
||||
стартовать и печатает команды уборки.
|
||||
- Рабочий каталог `.work/` лежит в каталоге метки (`evidence/**/.work/` —
|
||||
в `.gitignore`) и удаляется в `finally`; процесс, убитый сигналом без
|
||||
перехвата, его оставляет, поэтому запуск под блокировкой удаляет
|
||||
оставшийся `.work` сам. Файл консоли k6 (`--console-output`) k6
|
||||
дописывает, а не перезаписывает: `Stand.k6_console` удаляет его до
|
||||
старта (метка `baseline` профиля telemetry: разогрев 24 из 12).
|
||||
- Случайность только через свой генератор с зерном из профиля
|
||||
(`seed + номер VU`), не `Math.random`.
|
||||
|
||||
## Измеренное состояние — commit
|
||||
|
||||
Замер или тест, результат которого идёт в отчёт, снимается с
|
||||
закоммиченного состояния кода; хеш попадает в шапку файла доказательства
|
||||
и в `REPORT.md`. Любое число в отчёте должно воспроизводиться из
|
||||
названного commit (указание пользователя 2026-09-30).
|
||||
|
||||
Коммит делает не агент сам: перед замером он показывает изменения
|
||||
(`git status`, `git diff --stat`), предлагает сообщение коммита и ждёт
|
||||
подтверждения пользователя (указание пользователя 2026-10-01).
|
||||
Пробное изменение `src`, которое потом откатывается, — отдельный commit,
|
||||
откат — новый commit поверх (`git revert`), без переписывания истории;
|
||||
оба — по тому же порядку. Push и остальные операции git — только по
|
||||
просьбе.
|
||||
|
||||
## Сравнение меток: `make bench_compare`
|
||||
|
||||
- «До» и «после» снимаются в одной сессии хоста, подряд, без
|
||||
перезагрузки между ними. Код приложения между ними отличается одним
|
||||
изменением.
|
||||
- Порядок: изменение закоммичено, проверено тестами и откачено
|
||||
отдельным commit; затем `make bench_ab BEFORE=... AFTER=...
|
||||
REAPPLY=<commit отката>` снимает «до», коммитит доказательства,
|
||||
возвращает изменение и снимает «после». Команда сама делает два
|
||||
коммита и отказывается стартовать на нечистом рабочем дереве: стенд
|
||||
записал бы в паспорт `dirty: true`. Поэтому `make bench_ab` агент
|
||||
запускает только с согласия пользователя.
|
||||
- Уровень шума берётся из сравнения двух меток одного и того же кода
|
||||
приложения (A/A), параметр `AA`. Что код одинаков, проверяется по git
|
||||
(`git diff <commit> <commit> -- src Dockerfile pyproject.toml
|
||||
uv.lock`): команда этого не видит.
|
||||
- Изменение в ячейке — эффект, только если разбросы повторов не
|
||||
пересекаются и изменение медианы больше уровня шума сценария. Дельту
|
||||
в отчёт переносить из таблицы команды, не считать вручную.
|
||||
- Ячейки сценария, который изменение не затрагивает, — контроль: они
|
||||
тоже показываются в отчёте.
|
||||
- У серий трека 1 R* дискретен: шаг сетки поиска после двух делений —
|
||||
1,25^¼ ≈ 5,7 %, и шум A/A `scaling-aa` (5,4–5,7 %) — одна ступень.
|
||||
Сдвиг R* на одну ступень при непересекающихся разбросах команда
|
||||
назовёт эффектом, но он в пределах разрешения. Эффект R*
|
||||
засчитывается при сдвиге медианы не меньше двух ступеней сетки: R*
|
||||
после / R* до ≥ √1,25 ≈ 1,118 (+11,8 %; например, 931 → 1 041), иначе
|
||||
— с явной оговоркой о разрешении (verify change `scaling-bench`, S6;
|
||||
порог уточнён до замеров change `scaling-improvement`, решение 5).
|
||||
Шум `scaling-aa` оценён по двум конфигурациям × 3 повтора.
|
||||
- `CHANGE=<change>` у `make bench_compare` пишет change в шапку
|
||||
сравнения серий (по умолчанию `scaling-bench`).
|
||||
- Пул приложения в метке — дефолт `src/config/settings.py`, а не
|
||||
окружение стенда: окружение приложения пишется в `stand.app_env`, и
|
||||
сравнение меток с разным пулом из окружения откажет как «разная
|
||||
методика» (design change `scaling-improvement`, решение 2). Изменение
|
||||
пула для «до/после» — правка дефолта в коде.
|
||||
- Метка A/A годится как `AA`, только пока код приложения тот же: после
|
||||
правки `src` (например, 53300 в `68edc66` после `scaling-aa`) A/A
|
||||
снимается заново на коде «до».
|
||||
|
||||
## Результаты
|
||||
|
||||
- Каталог метки не перезаписывается. `evidence/bench/quick-*` — в
|
||||
`.gitignore`: короткий прогон проверяет стенд, а не даёт результат.
|
||||
- `evidence/compare/<до>__<после>.md` выводится из неизменяемых
|
||||
каталогов меток и может пересоздаваться; сравнения пробных меток
|
||||
`quick-*` — в `.gitignore`.
|
||||
- Планы запроса истории — `explain-<размер>.txt` в каталоге метки, как
|
||||
есть из журнала Postgres и psql. В отчёт числа плана переносятся из
|
||||
этих файлов или из раздела планов `summary.md`, не пересчитываются.
|
||||
- Столбцы `runs.csv` и `prefill.csv` не переименовываются и не
|
||||
удаляются: по ним сравниваются метки. Новая метрика — новый столбец
|
||||
в конце.
|
||||
- В результатах нет секретов, `.env` и абсолютных путей домашнего
|
||||
каталога; данные синтетические.
|
||||
- Перед замером для отчёта (полная матрица, серии трека 1, профили
|
||||
`failover` и `rollout`) хост должен быть в состоянии, которое можно
|
||||
проверить: питание от сети, давления на память нет и свободной памяти
|
||||
хватает на стенд (`memory_pressure`), посторонних контейнеров нет.
|
||||
Занятый swap сам по себе не помеха (указание пользователя 2026-10-10):
|
||||
в него уходят неактивные страницы. Помеха — выгрузка во время прогона:
|
||||
`run.py` пишет счётчик `Swapouts` (`vm_stat`) в начале и в конце
|
||||
(`host_state.swapouts`), прирост — `host_state.swapouts_delta`
|
||||
(`swapouts_delta`: пишется и при 0, нет — только без одного из
|
||||
счётчиков; до change `fix-known-issues` при `Swapouts` 0 в конце поле
|
||||
пропадало, так у меток `scaling-db-*2`) и предупреждает о приросте; у серий — ещё по
|
||||
ячейке и ступени (`host_swapouts`, пометка `host_swap`). Давление на
|
||||
память или батарея — перезагрузить или подключить питание. Состояние
|
||||
записывается в паспорт (`host_state`), в отчёте оно указывается по
|
||||
паспорту, а не по плану. Во время прогона ноутбук не нагружать и не
|
||||
закрывать крышку: цели `bench*` запускаются под `caffeinate -isu`
|
||||
(`-u` будит из DarkWake полностью, `-i -s` не дают уснуть по простою),
|
||||
но от сна при закрытой крышке он не спасает. Сон посреди прогона ставит
|
||||
ВМ Docker на паузу; `run.py` замечает его по разнице реального и
|
||||
монотонного времени (`host_state.slept_seconds`, предупреждение больше
|
||||
5 с). Предупреждения о хосте в `meta.json` (`host_warnings`) — повод
|
||||
переснять, а не игнорировать.
|
||||
@@ -0,0 +1,512 @@
|
||||
---
|
||||
paths:
|
||||
- "Dockerfile"
|
||||
- "docker-compose.yml"
|
||||
- ".dockerignore"
|
||||
- "scripts/restart.sh"
|
||||
- "infra/**"
|
||||
- ".github/ci/**"
|
||||
- ".github/workflows/application.yml"
|
||||
---
|
||||
|
||||
# Dockerfile и compose
|
||||
|
||||
Форма — как в bp_proxies: мультистейдж с uv, compose с портами из `.env`,
|
||||
литеральным режимом в `environment` и python-healthcheck. Требования
|
||||
рубрики (`README.md`, уровни 3 и 4) и `Dockerfile.example` важнее
|
||||
образца; отличия от него перечислены ниже. Режимы запуска —
|
||||
`run-modes.md`.
|
||||
|
||||
## Dockerfile
|
||||
|
||||
- Мультистейдж. В builder — `uv sync --locked --no-dev
|
||||
--no-install-project` по `pyproject.toml` и `uv.lock` в
|
||||
`/app/.venv`: слой зависимостей кешируется отдельно от кода. В
|
||||
runtime — копия `.venv` и `src/`, `PATH` на `/app/.venv/bin`.
|
||||
Компиляторы и uv в runtime не нужны (в bp_proxies uv ставился в оба
|
||||
stage).
|
||||
- Оба stage — на **одном** базовом образе: `.venv/bin/python` —
|
||||
ссылка на интерпретатор базового образа, на другом образе она
|
||||
сломается.
|
||||
- `--no-install-project`: `src/` в builder не копируется, и hatchling
|
||||
не собирает проект пакетом. `python -m src` находит `src` через
|
||||
рабочий каталог `/app`.
|
||||
- Версии закреплены: `тег@sha256:<digest индекса>`. Тег с патч-версией
|
||||
(`python:3.12.14-slim-trixie`) показывает версию, digest **индекса**
|
||||
(не манифеста одной платформы) даёт повторяемость и работает на arm64
|
||||
и amd64. Digest брать из `docker buildx imagetools inspect <тег>`,
|
||||
строка `Digest:` в начале вывода. Не `latest` и не `3.12-slim`. uv —
|
||||
`COPY --from=ghcr.io/astral-sh/uv:<версия>@sha256:... /uv /bin/uv`, а
|
||||
не незакреплённый `pip install uv`. Зависимости — только из lock
|
||||
(`--locked`): если `uv.lock` не совпадает с `pyproject.toml`, сборка
|
||||
падает. Директиву `# syntax=` не добавлять: это ещё один
|
||||
незакреплённый образ, а встроенный frontend BuildKit и так понимает
|
||||
`RUN --mount`.
|
||||
- Непривилегированный пользователь: системный `app` с UID/GID 10001 и
|
||||
`USER app` перед `CMD`. Код и `.venv` копируются от root и доступны
|
||||
пользователю только на чтение.
|
||||
- `CMD` в exec-форме: `["python", "-m", "src"]`. Тогда сервер — PID 1 и
|
||||
сам получает SIGTERM. Не `sh -c "... && ..."` и не `uv run`: это
|
||||
лишний процесс между docker и сервером.
|
||||
- PID 1 ядро не доставляет сигнал без обработчика — он отбрасывается.
|
||||
Поэтому `src/__main__.py` ставит ранний обработчик SIGTERM и SIGINT
|
||||
(`src/infra/early_stop.py`) до импорта приложения: импорт — почти
|
||||
весь старт (~0,7 с из ~0,8 при 1 CPU), и без него `docker stop`
|
||||
стартующей реплики ждал 10 с и кончался SIGKILL
|
||||
(`evidence/failover/stop-at-start.md`). Окна старта — `run-modes.md`.
|
||||
- `init: true` (tini) у `api` не ставится: сервер перестал бы быть
|
||||
PID 1. Остаётся окно запуска интерпретатора — десятки миллисекунд до
|
||||
первых строк точки входа; `rolling-update.sh` убирает реплику без
|
||||
слота LB `docker rm -f` (`balancer.md`). У PostgreSQL стенда отказов
|
||||
init есть — по другой причине (`student-tests.md`).
|
||||
- `ENV APP__RUN_MODE=docker PYTHONUNBUFFERED=1
|
||||
PYTHONDONTWRITEBYTECODE=1`, `EXPOSE 8080`.
|
||||
- С лабы 4 ещё `MALLOC_MMAP_THRESHOLD_=131072`: блоки glibc от 128 KiB
|
||||
всегда в mmap, и буфер тела загрузки растёт через `mremap`, без копии.
|
||||
Без него порог динамический: после первой загрузки glibc поднимает его
|
||||
до ~10 MiB, следующие буферы растут в куче, и `realloc` на миг держит
|
||||
два тела (замер — design change `attachments`, «Уточнения apply»,
|
||||
п. 10). Не убирать без нового замера.
|
||||
- `HEALTHCHECK` на `/health/ready` через `python -c "import
|
||||
urllib.request; ..."` (curl в slim нет) с явными `--interval`,
|
||||
`--timeout`, `--start-period` и `--start-interval=1s`: без него первая
|
||||
проверка идёт только через `interval`, и контейнер становится
|
||||
`healthy` не раньше 10 с. Порт — `APP__PORT` из окружения, по
|
||||
умолчанию 8080. Healthcheck живёт только в образе: он нужен и без
|
||||
compose (стенд `bench/`), а compose берёт его из образа и не
|
||||
дублирует.
|
||||
- В образ не попадают `.env`, `config.toml`, секреты, `tests/`,
|
||||
`student-tests/`, `service-tests/`, `contracts/`, `evidence/`, `.claude/`, `openspec/`,
|
||||
`.venv/`. Отличие от bp_proxies: там `config.toml` копируется в образ,
|
||||
здесь нельзя. Чистый clone его не содержит, и сборка упала бы, а
|
||||
`Dockerfile.example` (п. 6) запрещает класть конфиг и секреты в образ.
|
||||
Конфигурация приходит на старте: `config.toml` монтируется
|
||||
read-only в `/app/config.toml`, переменные — `environment` compose.
|
||||
Это согласовано с преподавателем
|
||||
2026-09-29 как выполнение README лабы 1, п. 3 и `Dockerfile.example`,
|
||||
п. 6 (AGENTS.md, «Согласования с преподавателем»). Что где лежит —
|
||||
`settings.md`.
|
||||
- Миграции едут вместе с образом: `migrations/` и `alembic.ini`
|
||||
копируются в runtime, и миграционный сервис compose запускает тот же
|
||||
образ с другой командой (`migrations.md`). `.dockerignore` их не
|
||||
исключает.
|
||||
|
||||
## `.dockerignore`
|
||||
|
||||
Файл из skeleton дополнять, а не заменять: `config.toml`, `.claude`,
|
||||
`openspec`, `tests`, `student-tests`, `service-tests`, `contracts`, `infra`,
|
||||
`*.md`, `Makefile`. `Dockerfile` копирует только `src/` и миграции, но контекст
|
||||
сборки быстрых тестов тоже не тащит (спек `unit-of-work`, «Быстрых тестов нет в
|
||||
образе»).
|
||||
`.dockerignore` не заменяет явный `COPY` только нужного.
|
||||
|
||||
Паттерн без `**/` действует только в корне контекста: `__pycache__` из
|
||||
skeleton не исключает `src/**/__pycache__`, и `.pyc` хоста попадали в
|
||||
образ. Для вложенных путей — `**/__pycache__`, `**/*.py[cod]`,
|
||||
`**/.DS_Store`.
|
||||
|
||||
## Проверка сборки «из чистого clone»
|
||||
|
||||
Без коммита и временного каталога: контекст — ровно файлы будущего
|
||||
clone (отслеживаемые и новые неигнорируемые):
|
||||
|
||||
```sh
|
||||
git ls-files -z -co --exclude-standard | tar --null -T - -cf - | docker build -t mtusi-messenger:lab6 -
|
||||
```
|
||||
|
||||
`.env`, `config.toml` и `.venv` в него не попадают по `.gitignore`.
|
||||
Перед PR — ещё и настоящий `git clone`.
|
||||
|
||||
## docker-compose.yml
|
||||
|
||||
- Имя проекта — `name: mtusi-lab6`, образ — `mtusi-messenger:lab6`. Имя
|
||||
проекта задаёт имена volume: с прежним `mtusi-lab5` стенд этой лабы
|
||||
подключился бы к данным пятой лабы, а `make wipe_data` их удалил бы.
|
||||
Имя меняется в каждой новой лабе.
|
||||
- Сервис `api`: `build: .`; с лабы 3 **без `ports` и без
|
||||
`container_name`**, реплик `${API_REPLICAS:-2}`, наружу только LB
|
||||
(`balancer.md`). До лабы 3 порт был
|
||||
`"127.0.0.1:${APP_OUT_PORT:-8080}:${APP__PORT:-8080}"`; теперь эта
|
||||
строка — у сервиса `haproxy`. `environment` собирается из якорей:
|
||||
`x-db-env` (`APP__RUN_MODE: docker`, `DATABASE__*` из переменных
|
||||
`POSTGRES_*`), `x-cache-env` (`CACHE__*` из `VALKEY_*`) и с лабы 4
|
||||
`x-s3-env` (адрес: `S3__HOST`, `S3__PORT`, `S3__BUCKET`) и
|
||||
`x-s3-api-keys-env` (ключи API мостами из `S3_API_*`), у `api` —
|
||||
`<<: [*db-env, *cache-env, *s3-env, *s3-api-keys-env]` плюс
|
||||
`APP__PORT` (`settings.md`, «Консоль и docker»). У `migrate` — только
|
||||
`x-db-env`: пароль Valkey и секреты S3 ему не нужны; `haproxy`
|
||||
получает только `API_PORT` (секреты только там, где нужны, рубрика
|
||||
«4»). Секреты S3 по сервисам — раздел S3 ниже, уборщик — раздел
|
||||
«Уборщик» ниже.
|
||||
Healthcheck образа проверяет `APP__PORT`; `stop_grace_period: 10s`;
|
||||
с change `upload-memory` — `sysctls: net.ipv4.tcp_rmem: "4096 131072
|
||||
524288"`: буфер приёма сокетов реплики до 512 KiB, а не до 32 MiB ВМ
|
||||
Docker Desktop. Ядро копит недочитанное тело (ожидание места загрузки,
|
||||
отказ до тела) в буфере сокета, и он считается памятью контейнера
|
||||
(`sock` в `memory.stat`): при 40 загрузках по 10 MiB `sock` реплики
|
||||
17 MiB вместо 134. Параметр сетевого пространства контейнера — его
|
||||
получают все контейнеры сервиса `api`, в том числе `docker compose
|
||||
run` (`make test_isolated`, стенд отказов) и `bench/`; новые реплики —
|
||||
после `make rolling_update`. Скорость не страдает: RTT в сети Docker —
|
||||
доли миллисекунды. В консоли sysctl нет (`run-modes.md`);
|
||||
`restart: unless-stopped`; лимиты CPU/RAM
|
||||
(`deploy.resources.limits`) у всех сервисов — override стендов
|
||||
(`bench/`) задаёт лимиты в той же форме: `cpus` / `mem_limit` рядом с
|
||||
ними compose не принимает. Имена переменных в `.env` — `settings.md`,
|
||||
«Имена в `.env`».
|
||||
- Литералов адреса и порта Postgres в compose нет: `POSTGRES_HOST`
|
||||
становится алиасом сервиса в сети, `POSTGRES_PORT` — портом самого
|
||||
сервера через `PGPORT` (его же берут `pg_isready` и `psql` в
|
||||
контейнере). Литерал — только адрес публикации `127.0.0.1`: это
|
||||
требование безопасности, а не параметр.
|
||||
- `config.toml` — только длинной записью, иначе при отсутствии файла
|
||||
Docker молча создаст на хосте каталог `config.toml/`, и приложение
|
||||
упадёт на чтении настроек (проверено):
|
||||
|
||||
```yaml
|
||||
volumes:
|
||||
- type: bind
|
||||
source: ./config.toml
|
||||
target: /app/config.toml
|
||||
read_only: true
|
||||
bind:
|
||||
create_host_path: false
|
||||
```
|
||||
|
||||
Без файла compose сразу падает с `bind source path does not exist`.
|
||||
Поэтому `make run_docker` зависит от `env_setup`: недостающие `.env`
|
||||
и `config.toml` создаются из шаблонов, существующие не трогаются.
|
||||
Голый `docker compose up` без файла по-прежнему падает. Голый
|
||||
`docker run` монтирует его так же строго — `--mount
|
||||
type=bind,src="$PWD/config.toml",dst=/app/config.toml,readonly`, а не
|
||||
`-v`. Сам файл необязателен: без него приложение стартует на
|
||||
дефолтах.
|
||||
- Смонтированный файл должен читаться непривилегированным пользователем
|
||||
контейнера. На Docker Desktop права хоста не мешают, на Linux нужен
|
||||
режим `644` или совпадающий uid.
|
||||
- Новая переменная контейнера — строка в `.env.example` и в
|
||||
`environment` сервиса.
|
||||
- С лабы 2 compose — основной запуск стенда: API без Postgres запросы
|
||||
не обслуживает. Проверка и запуск — по README:
|
||||
`docker compose --env-file .env config --quiet`, затем
|
||||
`up -d --build`, ожидание `/health/ready`. Роли лабы 4 — load_balancer
|
||||
(HAProxy), api × ≥2, postgres, s3 (SeaweedFS) и valkey
|
||||
(`contracts/infrastructure.json`: Redis/Valkey необязателен, у нас
|
||||
остаётся кэшем).
|
||||
`compose.example.yaml` — лишь список ролей, стенд — свой
|
||||
`docker-compose.yml` (compose находит его сам, как и `compose.yaml`).
|
||||
- Образы зависимостей закреплены так же, как базовый: тег с патч-версией
|
||||
и digest индекса (`postgres:18.6-trixie@sha256:...`), не
|
||||
`postgres:18` и не `latest`. Точка монтирования volume — из
|
||||
`Config.Volumes` образа: у Postgres 18 это `/var/lib/postgresql`, а не
|
||||
`/var/lib/postgresql/data`, как у 17.
|
||||
- У каждой зависимости свой healthcheck, API ждёт `depends_on:
|
||||
condition: service_healthy`. У Postgres — `pg_isready -h 127.0.0.1`
|
||||
по TCP: при инициализации образ поднимает временный сервер только на
|
||||
сокете, и проверка через сокет сказала бы «готов» раньше времени.
|
||||
Миграции — отдельный одноразовый сервис на образе API
|
||||
(`pull_policy: never`, образ собирает `api`), API ждёт его
|
||||
`service_completed_successfully`.
|
||||
- Данные — именованные volumes. `make down` и скрипты их не удаляют;
|
||||
удаление учебных данных — отдельная явная команда в `REPORT.md`.
|
||||
- Postgres наружу — только `127.0.0.1:${POSTGRES_OUT_PORT}`, для
|
||||
console-режима. Пароль — `POSTGRES_PASSWORD` в `.env`, в приложение
|
||||
мостом (`settings.md`).
|
||||
- Valkey (сервис `valkey`, кэш карточек чатов): тот же пин тега с
|
||||
патч-версией и digest индекса, `restart: unless-stopped`, healthcheck,
|
||||
`api` ждёт `service_healthy`. Отличия от Postgres:
|
||||
- volume нет: persistence выключен в `infra/valkey/valkey.conf`
|
||||
(`save ""`, `appendonly no`), кэш после рестарта пуст, а данные —
|
||||
в Postgres. Если бы в Valkey жили сессии, persistence был бы
|
||||
обязателен: без него рестарт стёр бы их, и `make test-persistence`
|
||||
упал бы;
|
||||
- пароль — `VALKEY_PASSWORD` в `.env`, в контейнер — переменной
|
||||
окружения. Сервер получает его в `command` через `sh -c` из
|
||||
переменной контейнера (`--requirepass "$$VALKEY_PASSWORD"`), в
|
||||
compose он не литерал. Запуск — `exec docker-entrypoint.sh
|
||||
valkey-server ...`: с `sh` первым аргументом entrypoint образа не
|
||||
сбрасывает root, а так сервер работает от пользователя `valkey`;
|
||||
- healthcheck — `valkey-cli ping` с паролем из `VALKEYCLI_AUTH`
|
||||
(без `-a` в команде): `PONG` только после AUTH, и проверка
|
||||
ловит неверный пароль;
|
||||
- порт сервера — `VALKEY_PORT` (`--port`), алиас в сети —
|
||||
`VALKEY_HOST`, публикация — `127.0.0.1:${VALKEY_OUT_PORT}`, как у
|
||||
Postgres.
|
||||
- S3 (с лабы 4, design change `s3-storage`, решения 1–4) — сервис `s3`
|
||||
на SeaweedFS (`chrislusf/seaweedfs:4.48@sha256:…`, якорь
|
||||
`x-s3-image`) и одноразовый `s3-bootstrap` на том же образе:
|
||||
- `s3` — `weed server` одним процессом: master, volume и filer только
|
||||
на `127.0.0.1` контейнера (`-ip`, `-ip.bind`), в сеть выходят порт
|
||||
API S3 (`S3_PORT`) и gRPC шлюза (`S3_PORT` + 10000); телеметрия,
|
||||
Iceberg, Lance и IAM API выключены. Volume `s3_data:/data`
|
||||
(`Config.Volumes`), алиас `${S3_HOST}`, публикация только
|
||||
`127.0.0.1:${S3_OUT_PORT}:${S3_PORT}`. Healthcheck — `wget` на
|
||||
`/cluster/healthz` master, непустой `DataNodes` в `/dir/status`
|
||||
master (том зарегистрирован), `/healthz` filer и шлюза, всё на
|
||||
loopback. Без проверки тома `healthy` наступал на ~4 с раньше
|
||||
регистрации, и первая запись ждала её почти весь срок вызова клиента
|
||||
(5 с). Та же команда — проба `fault_hook.py`.
|
||||
Лимиты 1 CPU / 512 МБ, `GOMEMLIMIT=400MiB` и
|
||||
`-s3.concurrentUploadLimitMB=64` (решение 2);
|
||||
- **`stop_grace_period: 20s`**, а не 10: плавная остановка SeaweedFS
|
||||
~15 с (срок ожидания подписок filer зашит в код), при 10 с —
|
||||
SIGKILL и код 137. Цена — `make stop` и `restart.sh` дольше на
|
||||
~15 с. На стенде отказов — 2 с (`student-tests.md`);
|
||||
- секреты по сервисам: административная пара `S3_ROOT_*` — только
|
||||
`s3` (`AWS_ACCESS_KEY_ID` / `AWS_SECRET_ACCESS_KEY`: без учётной
|
||||
записи сервер открыт анониму); ключ подписи `S3_JWT_SIGNING_KEY`
|
||||
(`WEED_JWT_FILER_SIGNING_KEY`) — `s3` и `s3-bootstrap`: без него
|
||||
gRPC шлюза принимает администратора от любого контейнера сети; ключи
|
||||
API `S3_API_*` — `s3-bootstrap` и `api`; ключи уборщика
|
||||
`S3_CLEANER_*` — `s3-bootstrap` и `cleaner` (с `:?` «run make
|
||||
env_setup»: он допишет их в существующий `.env`). Остальные — с `:?`
|
||||
«copy S3 lines from .env.example»;
|
||||
- `s3-bootstrap` — `network_mode: service:s3` (master и filer сервера
|
||||
на его `127.0.0.1`), `user: seaweed`, `restart: "no"`, `tmpfs:
|
||||
[/tmp, /data]` и `HOME=/tmp` (`/data` — volume образа: без tmpfs
|
||||
каждый новый контейнер bootstrap оставлял анонимный volume, а
|
||||
пересоздание его переносит — `up -d --renew-anon-volumes
|
||||
s3-bootstrap` отвязывает старый), скрипт `infra/s3/bootstrap.sh` read-only
|
||||
длинной записью, `depends_on: s3: service_healthy`, лимиты 0,5 CPU /
|
||||
128 МБ. Режим `apply` (по умолчанию) идемпотентно сводит состояние
|
||||
к `.env` (bucket, анонимный доступ `none`, политики `api-objects` и
|
||||
`cleaner-objects`, пользователи `api` и `cleaner` с их ключами;
|
||||
шаги пользователя общие — `apply_user <имя> <политика>`) и проверяет
|
||||
приватность: ключ API пишет и читает проверочный объект, ключ
|
||||
уборщика читает его, получает 403 на запись и список всего bucket,
|
||||
200 на список своего префикса и удаляет его, после этого GET ключом
|
||||
API — 404. Политика `cleaner-objects` с change `track2-reconciler`
|
||||
(решение 2) — два оператора: `s3:GetObject` и `s3:DeleteObject` на
|
||||
`<bucket>/*` и `s3:ListBucket` на `<bucket>` с условием `StringLike
|
||||
s3:prefix <база>/attachments/*` (SeaweedFS 4.48 условие соблюдает:
|
||||
весь bucket, `test_<db>/`, `.s3-check/` и HEAD bucket — 403). Префикс
|
||||
bootstrap получает в `S3_CLEANER_LIST_PREFIX:
|
||||
${POSTGRES_DB:?…}/attachments/` (окружение `s3-bootstrap`, не секрет)
|
||||
и проверяет по `^[a-z0-9_]+/attachments/$` до любого шага (иначе
|
||||
«FAILED: cleaner list prefix» и код 1); уборщику его не передают —
|
||||
свой префикс он строит из имени базы. Новая политика доходит до шлюза
|
||||
подпиской, как ключ: проверка списка — с ожиданием. `check` печатает
|
||||
строки «cleaner key list attachments prefix» (200), «… objects»,
|
||||
«… other prefix», «… other bucket» (403). Ожидание, пока ключ дойдёт до шлюза: у
|
||||
API — PUT проверочного объекта, у уборщика — DELETE несуществующего
|
||||
ключа (204; PUT ему запрещён); `SignatureDoesNotMatch` — новый
|
||||
секрет, ключ пересоздаётся. `check` (свой проверочный объект для
|
||||
удаления ключом уборщика) и `cleanup` — для `make s3_check`. `api` ждёт его
|
||||
`service_completed_successfully`, как `migrate`. Секреты — в
|
||||
`weed shell` через stdin, в `curl` файлом `-K` на tmpfs, не в argv;
|
||||
- `up -d --wait` одноразовый сервис без healthcheck считает готовым
|
||||
уже запущенным: код bootstrap отдельно — `up --no-deps
|
||||
--exit-code-from s3-bootstrap s3-bootstrap` (`make start_s3`).
|
||||
- **Уборщик** (с лабы 4, сервис `cleaner`, design change
|
||||
`upload-consistency`, решения 2 и 9): образ API (`image:
|
||||
mtusi-messenger:lab6`, `pull_policy: never`), `entrypoint: ["python",
|
||||
"-m", "src.cleaner"]`, а не `command`: аргументы после имени сервиса
|
||||
(`docker compose run --rm --no-deps cleaner --once`) — флаги
|
||||
уборщика, а с `command` они заменили бы саму команду («executable file
|
||||
not found», design change `upload-consistency`, «Уточнения apply»,
|
||||
п. 6). `restart: unless-stopped`, без портов.
|
||||
Окружение — `<<: [*db-env, *s3-env]`, `DATABASE__POOL_SIZE: "1"` и
|
||||
ключи уборщика `S3_CLEANER_*` в `S3__ACCESS_KEY_ID` /
|
||||
`S3__SECRET_ACCESS_KEY`: ни пароля Valkey, ни ключей API, ни
|
||||
административных ключей S3 и ключа подписи. `config.toml` read-only,
|
||||
`depends_on`: `postgres` healthy, `migrate` и `s3-bootstrap`
|
||||
completed successfully; реплики его не ждут. Healthcheck образа (HTTP)
|
||||
выключен (`healthcheck: disable: true`): уборщик HTTP не слушает и
|
||||
стал бы `unhealthy`, живость — журнал. `stop_grace_period: 10s`,
|
||||
лимиты 0,25 CPU / 256 МБ (простой — `memory.current` ~105 MiB после ленивого импорта SDK,
|
||||
пик — плановая сверка при старте; числа — раздел change `job-trace-propagation` в
|
||||
`evidence/telemetry/budget.md`). В консоли (`make run_dev`)
|
||||
уборщика нет; разовый проход — `docker compose run --rm --no-deps
|
||||
cleaner --once`. Стенд отказов запускает его с grace 20 с, интервалом
|
||||
1 с и без плановой сверки (`RECONCILER__INTERVAL_SECONDS: "0"`,
|
||||
`student-tests.md`), `bench/` описывает (тоже с 0) и запускает только
|
||||
разовыми проходами профиля сверки (`bench.md`, «Профиль сверки»). Выход
|
||||
процесса — `os._exit` после `main()` (`src/cleaner/__main__.py`):
|
||||
финализация интерпретатора при 0,25 CPU — до 1,5 с (design change
|
||||
`track2-reconcile-cost`, «Уточнения apply», п. 14).
|
||||
С change `track2-reconciler` сервис ещё и сверяет bucket с БД — при
|
||||
старте и раз в `[reconciler] interval_seconds` (3600 с); разовая
|
||||
сверка — `make reconcile [APPLY=1] [MAX_CHANGES=N]` (`docker compose
|
||||
run --rm --no-deps cleaner reconcile …`). **На время восстановления
|
||||
базы уборщик останавливают** (`docker compose stop cleaner`): база из
|
||||
старой копии или пустая при живом bucket сделала бы объекты новых
|
||||
вложений «объектами без метаданных», и сверка удалила бы их в пределах
|
||||
`max_changes`. После восстановления — сначала `make reconcile`
|
||||
(dry-run), потом `docker compose start cleaner` (design change
|
||||
`track2-reconciler`, Risks).
|
||||
- Конфигурации сервисов (`valkey.conf`, при необходимости
|
||||
`postgresql.conf`, скрипт `infra/s3/bootstrap.sh`) — в
|
||||
`infra/<сервис>/`, монтируются read-only
|
||||
длинной записью с `create_host_path: false` (`infra/README.md`). В
|
||||
`REPORT.md` — таблица роль → сервис → версия/digest → healthcheck →
|
||||
volume → порт → способ передачи credentials.
|
||||
- **Стенд в CI** — тот же `docker-compose.yml` плюс override
|
||||
`.github/ci/compose.yml` (job `.github/workflows/application.yml`,
|
||||
AGENTS.md, карта кода). Job раннера Gitea — контейнер на том же Docker,
|
||||
что стенд: bind mount файла из рабочего каталога там не работает (пути
|
||||
нет на хосте раннера), порты хоста job не видит. Override заменяет
|
||||
каждый bind mount на `configs` из переменной окружения
|
||||
(`.github/ci/stand-env.sh`), убирает `ports` (`!reset []`) и даёт образу
|
||||
API тег прогона. Поэтому новый bind mount, новый порт или новый сервис
|
||||
на образе API в `docker-compose.yml` — строка и в override, иначе job
|
||||
упадёт на `bind source path does not exist` или возьмёт чужой образ.
|
||||
|
||||
## Брокер и worker (с лабы 5)
|
||||
|
||||
Design change `async-attachments`, решения 4, 6, 12, 14.
|
||||
|
||||
- **`rabbitmq`** — `rabbitmq:4.3.7@sha256:bd88…` (индекс), `hostname: rabbitmq`:
|
||||
имя узла задаёт каталог данных, без него `up --force-recreate` теряет очередь.
|
||||
Volume `rabbitmq_data:/var/lib/rabbitmq`, `RABBITMQ_NODE_PORT`, порт только AMQP
|
||||
на `127.0.0.1:${RABBITMQ_OUT_PORT}`, алиас, healthcheck
|
||||
`check_port_connectivity`, `stop_grace_period: 20s` (на деле ~2 с), лимиты 1 CPU /
|
||||
512 МБ. **`vm_memory_high_watermark.absolute = 400MiB`** в
|
||||
`infra/rabbitmq/rabbitmq.conf` (`conf.d`, read-only): лимит cgroup брокер не видит
|
||||
(проба: 4760 МиБ), и его убило бы ядро. Неверная настройка этого файла — отказ
|
||||
старта, проверять запуском. Без management-плагина: состояние — `rabbitmqctl`.
|
||||
- **`worker`** — образ API, `entrypoint: ["python", "-m", "src.worker"]`,
|
||||
`restart: unless-stopped`, без портов, `healthcheck: disable: true`, окружение
|
||||
`<<: [*db-env, *s3-env, *broker-env]`, `DATABASE__POOL_SIZE: "2"`, ключи
|
||||
`S3_WORKER_*`; `depends_on` PostgreSQL и брокер healthy, `migrate` и
|
||||
`s3-bootstrap` completed; `stop_grace_period: 10s`, лимиты 1 CPU / 1 ГБ.
|
||||
- **`relay`** (design change `pipeline-reliability`, решения 1, 2, 13) — образ API,
|
||||
`entrypoint: ["python", "-m", "src.relay"]` (аргументы после имени сервиса —
|
||||
подкоманда `replay`), `restart: unless-stopped`, без портов, `healthcheck: disable:
|
||||
true`, окружение `<<: [*db-env, *broker-env]`, `DATABASE__POOL_SIZE: "1"`; `depends_on`
|
||||
PostgreSQL и брокер healthy, `migrate` completed; `stop_grace_period: 10s`, лимиты
|
||||
0,25 CPU / 256 МБ. Реплики его не ждут. У `api` нет `*broker-env` и зависимости от
|
||||
брокера.
|
||||
- **Секреты:** пароль брокера — только `rabbitmq`, `relay`, `worker`; ключи worker —
|
||||
только `s3-bootstrap` и `worker`. Пользователь S3 `worker`, политика
|
||||
`worker-objects`: `s3:GetObject`, `s3:PutObject` на `<bucket>/*` — без удаления и
|
||||
списка; `check` печатает строки «worker key …». Политика уборщика — список с условием
|
||||
на два префикса, `<база>/attachments/*` и `<база>/staging/*`; `check` — ещё строки
|
||||
«cleaner key list staging prefix» и «cleaner key list database prefix».
|
||||
- **`restart.sh`** перезапускает и брокер; relay, worker и уборщика не трогает: защита
|
||||
вызывает hook при остановленном worker, и он останется остановленным.
|
||||
- **Суммы** (до лабы 6; с телеметрией — раздел «Наблюдаемость»): постоянные 9,0 CPU, 4992 МБ, с разовыми 10,0 CPU, 5376 МБ; соединений
|
||||
PostgreSQL `API_REPLICAS × 10 + migrate 1 + cleaner 1 + worker 2 + relay 1` = 25, при
|
||||
замене 35.
|
||||
|
||||
## Наблюдаемость (с лабы 6)
|
||||
|
||||
Design change `otel-telemetry`, решения 1, 7, 14–20; правила конфигураций — `telemetry.md`.
|
||||
|
||||
- **Сервисы:** `otel-collector` (contrib 0.164.0), `prometheus` (v3.15.1), `loki` (3.7.9),
|
||||
`tempo` (3.1.1), `grafana` (13.3.1) — тег и digest индекса, `restart: unless-stopped`,
|
||||
`GOMEMLIMIT` ~80 % лимита, у Tempo — лимит / 1,6 (Go лимит cgroup не видит; «Суммы» ниже). Каждый конфиг `infra/otel/` — отдельный
|
||||
bind mount файла длинной записью; volumes `prometheus_data:/prometheus`, `loki_data:/loki`,
|
||||
`tempo_data:/var/tempo` (образы стартуют на пустых без chown), у Grafana — tmpfs
|
||||
`/var/lib/grafana` (пароль из `.env` действует на каждом старте, правки UI не переживают
|
||||
рестарт).
|
||||
- **Сеть `telemetry`** (не `internal`: иначе не работает порт Grafana): хранилища и Grafana —
|
||||
только в ней, Collector — в `default` и `telemetry`. Наружу — только
|
||||
`127.0.0.1:${GRAFANA_OUT_PORT:-3000}:3000`. Сервисы приложения от телеметрии не зависят
|
||||
(`depends_on` нет), сервисы телеметрии друг от друга — тоже.
|
||||
- **Healthcheck** — `wget` у Prometheus (`/-/ready`) и Grafana (`/api/health`); у Collector,
|
||||
Loki и Tempo оболочки в образе нет — healthcheck нет, живость — цели `up` в Prometheus.
|
||||
- **Секреты:** `GRAFANA_ADMIN_PASSWORD` (`:?` «run make env_setup») — только `grafana`; у
|
||||
Collector, Prometheus, Loki и Tempo секретов нет; `api`, `worker` и с design change
|
||||
`job-trace-propagation` (решение 7) `relay` получают только якорь `x-telemetry-env`
|
||||
(`TELEMETRY__ENABLED`, `TELEMETRY__OTLP_ENDPOINT` — адрес, не секрет). У `bench/`, стенда
|
||||
отказов и `make test_isolated` relay — с `TELEMETRY__ENABLED: "false"`.
|
||||
- **Без сокета Docker** (design change `job-trace-propagation`, решение 12): CPU и память
|
||||
контейнеров `api`, `worker`, `relay` процессы читают из своей cgroup v2 (`/sys/fs/cgroup`,
|
||||
`ro` от UID 10001). Монтирование `docker.sock` никому не добавлять: API Docker — root на ВМ, а
|
||||
Collector принимает OTLP без аутентификации. cAdvisor, `docker_stats` и `hostmetrics` тоже не
|
||||
ставятся.
|
||||
- **Брокер** (решение 19): healthcheck — exec-форма `gosu rabbitmq rabbitmq-diagnostics -q
|
||||
check_port_connectivity`: CLI от root на пустом volume создавал `.erlang.cookie` (0400, root)
|
||||
раньше сервера, тот падал на `eacces`. Стенд с нуля проверяет `driver.py stand-from-scratch`
|
||||
(свой проект, удаляет свои volumes сам).
|
||||
- **`restart.sh`** сервисы телеметрии не трогает (решение 6).
|
||||
- **Стенд `bench/`** (design change `track1-telemetry-cost`, решения 1, 13): те же сервисы и
|
||||
конфигурации под проектом `mtusi-bench` — `container_name` `mtusi-bench-<сервис>`, `restart:
|
||||
"no"`, лимиты `BENCH_*` (поля `Profile`, рабочего стенда, сверка с этим файлом до стенда), без
|
||||
swap и портов, сеть `telemetry` — имя `mtusi-bench-telemetry`; Grafana описана, порт сброшен, не
|
||||
запускается. Запускают их только профиль цены телеметрии и `TELEMETRY=on` (`bench.md`). Правка
|
||||
лимитов или образа сервиса телеметрии здесь — та же правка полей `Profile` в `bench/run.py`,
|
||||
иначе профили с телеметрией откажут до стенда (код 2).
|
||||
- **Суммы:** постоянные лимиты 11,5 CPU / 7296 МиБ, с одноразовыми 12,5 CPU / 7680 МиБ при ВМ
|
||||
12 CPU / 7934 МиБ; телеметрия — 2,5 CPU / 2304 МиБ (Collector 256, Prometheus 384, Loki 512,
|
||||
Tempo 640, Grafana 512); пики и правило «лимит ≥ 1,5 × пика» — `evidence/telemetry/budget.md`;
|
||||
пик — `memory.peak`, а если он с файловым кэшем не проходит правило — `anon` + `kernel` + `shmem`
|
||||
(`telemetry.md`, «Что считать пиком»).
|
||||
У Tempo пик упирается в `GOMEMLIMIT` (398 из 400 МиБ): его лимит — не меньше 1,5 ×
|
||||
`GOMEMLIMIT`, а не «`GOMEMLIMIT` — 80 % лимита» (design change `otel-telemetry`, «Уточнения
|
||||
apply», п. 19). До ВМ 7934 МиБ оставалось 254 МиБ; с 2026-11-11 ВМ — 11 902 МиБ (ниже, change
|
||||
`slo-alerts`). Новый сервис или поднятый лимит — с пересчётом. Соединений PostgreSQL телеметрия не добавляет.
|
||||
- **CI** — `configs` для восьми файлов (с design change `slo-alerts` — ещё `prometheus_rules`,
|
||||
`CI_PROMETHEUS_RULES`), у Prometheus, Loki и Tempo `volumes: !override` с одним
|
||||
именованным volume, у Collector и Grafana `volumes: !reset []`, порт Grafana `!reset []`. Шаг
|
||||
`make alerts_test` — файлы правил через `tar` в одноразовый контейнер, без bind mount.
|
||||
- **С design change `slo-alerts`** (решения 1, 3, 6, 13): у Prometheus — флаг
|
||||
`--enable-feature=created-timestamp-zero-ingestion` и второй bind mount
|
||||
`infra/otel/prometheus/rules.yml` (длинной записью, `read_only`); runbooks и `rules.test.yml` в
|
||||
контейнер не монтируются. Новых сервисов и портов нет: Alertmanager отвергнут по функции.
|
||||
Суммы лимитов и ВМ — пункт «Суммы» выше с пересчётом в `evidence/telemetry/budget.md` (раздел
|
||||
change `slo-alerts`); ВМ с 2026-11-11 — 12 CPU / 11 902 МиБ (пользователь увеличил память
|
||||
Docker Desktop до 12 ГБ): с одноразовыми и стендом `make test_isolated` рядом запас есть.
|
||||
|
||||
## Обновление кода на стенде
|
||||
|
||||
- `make run_docker` после пересборки пересоздаёт реплики, образ которых
|
||||
изменился, — все разом, с простоем. Compose сравнивает метку
|
||||
контейнера `com.docker.compose.image` (манифест платформы) с
|
||||
манифестом тега. Пересборка без изменений кода реплики не трогает,
|
||||
хотя digest тега новый: индекс образа содержит отметки времени
|
||||
сборки (`evidence/rollout/compatibility.md`).
|
||||
- Хранилище образов Docker Desktop — containerd. Что чем называется:
|
||||
- индекс — ID тега, `docker image inspect <тег>`; у каждой пересборки
|
||||
свой;
|
||||
- манифест платформы — метка контейнера `com.docker.compose.image` и
|
||||
`docker image inspect --platform`;
|
||||
- поле `.Image` контейнера — не digest конфигурации: на пробе оно
|
||||
совпадало с ID тега на момент создания контейнера, а при том же
|
||||
манифесте отличалось.
|
||||
|
||||
`docker ps` показывает у реплик ID, а не имя тега, когда тег уже указывает
|
||||
на другой индекс. Это не признак «старого образа»: прежний пункт
|
||||
`KNOWN_ISSUES.md` о том, что `run_docker` не пересоздаёт реплики, на этом
|
||||
и ошибся. Образы сравниваются по метке, а не по `.Image`: `docker inspect
|
||||
-f '{{index .Config.Labels "com.docker.compose.image"}}' <контейнер>`.
|
||||
- Без простоя новый код доходит до реплик через `make rolling_update`
|
||||
(`balancer.md`): по одной, с выводом из LB и одной миграцией.
|
||||
|
||||
## `scripts/restart.sh`
|
||||
|
||||
Hook для `make test-persistence ACTION_SCRIPT=scripts/restart.sh`
|
||||
(`tests/README.md`), по образцу `scripts/restart.example.sh`.
|
||||
|
||||
- Перезапускает **все** реплики API, LB и **все** используемые
|
||||
хранилища: Postgres, Valkey и с лабы 4 S3. Volumes, схему и данные
|
||||
сохраняет: без `down -v`, `FLUSHALL`, повторного seed и изменения
|
||||
тестовых данных. Кэш Valkey после рестарта пуст сам: persistence у
|
||||
него выключен. Bucket, учётные записи и объекты S3 — в его volume.
|
||||
- Порядок: `stop haproxy api` → `restart postgres valkey s3` → `up -d
|
||||
--wait --no-recreate postgres valkey s3` (те же контейнеры, ожидание
|
||||
healthcheck) → `start api haproxy`. `--no-recreate` обязателен:
|
||||
Compose 5.4 пересоздаёт контейнер, если его образ скачивался при первом
|
||||
`up` (метка — digest индекса, сверка — digest манифеста платформы), и
|
||||
`s3-bootstrap` (`network_mode: service:s3`) после пересоздания `s3` не
|
||||
стартует — код 128, `start api` падает. Нашёл CI на раннере Gitea
|
||||
(`evidence/tests/ci-application.md`); локально образы были в кэше, и
|
||||
Compose 5.6 так не делает. `start api` запускает и зависимости `migrate` и
|
||||
`s3-bootstrap`: повторные миграции и bootstrap — no-op («exists»).
|
||||
Число реплик не меняется: `start` поднимает те же контейнеры, а не
|
||||
масштабирует (реплику, остановленную `stop-one.sh`, тоже). Уборщика
|
||||
hook не трогает: он не хранилище и не реплика API, рестарт PostgreSQL
|
||||
и S3 переживает сам (`warning` отказа в журнале, проход — через
|
||||
интервал).
|
||||
- `#!/bin/sh`, `set -eu`, исполняемый бит в git (`chmod +x`,
|
||||
`git update-index --chmod=+x`). Возвращает 0 только после действия,
|
||||
укладывается в 90 с (с S3 — ~25 с, из них ~15 с — остановка S3).
|
||||
Готовность ждёт сам тест. Секреты не печатает.
|
||||
- Успех теста не доказывает, что БД действительно перезапускалась. В
|
||||
`evidence/` — состояние контейнеров до и после (`docker compose ps`,
|
||||
`StartedAt` из `docker inspect`).
|
||||
|
||||
## Дальше
|
||||
|
||||
Реплики, HAProxy, `scripts/stop-one.sh`, поочерёдная замена, лимиты и
|
||||
пулы — `balancer.md`.
|
||||
@@ -0,0 +1,93 @@
|
||||
---
|
||||
paths:
|
||||
- "src/schemas/**"
|
||||
---
|
||||
|
||||
# DTO и enum-ы (`src/schemas/`)
|
||||
|
||||
Обработка вложений (design change `async-attachments`, решения 1–3):
|
||||
`AttachmentFullDTO` — ещё `staging_key`, `error_code` и `variants` кортежем
|
||||
(не колонка: подставляет сервис); `AttachmentInListDTO.staging_key`;
|
||||
`AttachmentJobDTO`, `AttachmentVariantDTO`; enum `AttachmentJobState`,
|
||||
`AttachmentVariantName`, `AttachmentErrorCode`, `AttachmentJobReason`,
|
||||
`JobOutcome`. Сообщение брокера — pydantic-модель
|
||||
`src/schemas/jobs/attachment.py`, а не DTO: оно приходит извне и разбирается по
|
||||
`contracts/jobs.schema.json`.
|
||||
|
||||
С change `pipeline-reliability`: `AttachmentJobDTO.attempt_base`,
|
||||
`AttachmentInListDTO.status`, `updated_at`, `ReconcilePassDTO.listed_staging`, новые
|
||||
`AttachmentJobReplayDTO`, `FailedJobDTO`, `RelayPassDTO`, `StagingCleanupPassDTO`,
|
||||
`ReplayResultDTO`, `ReplayPassDTO`, `RenderedVariantDTO`, `RenderedVariantsDTO`;
|
||||
`AttachmentJobReason` — ещё лимиты, `render_killed`, `render_crashed`,
|
||||
`lease_expired`; `ReconcileFinding.ORPHAN_STAGING`.
|
||||
|
||||
С design change `job-trace-propagation` (решения 3, 4, 8, 9): `AttachmentJobDTO.traceparent`,
|
||||
`tracestate` — последними, `None` по умолчанию (колонки задания); `TraceContextDTO`
|
||||
(`traceparent`, `tracestate=None` — значения W3C, без baggage; слой API передаёт его сервису
|
||||
значением), `JobPublicationDTO` (элемент публикации relay: `job_id`, тело, номер попытки
|
||||
сообщения, `replayed`, `retry_reason`, контекст), `JobDeliveryResultDTO` (итог доставки worker:
|
||||
исход, попытка, причина, код ошибки, `time_to_ready_seconds`), `QueueSnapshotDTO` (снимок
|
||||
очереди: время, четыре стадии, `oldest_created_at`).
|
||||
|
||||
`src/schemas/dataclasses/<domain>.py` — DTO между repo → service → api;
|
||||
`src/schemas/enums/<domain>.py` — `StrEnum` доменов. HTTP-модели
|
||||
(pydantic) лежат не здесь, а в `src/api/schemas/` (`api-layer.md`).
|
||||
|
||||
Создавать только те DTO, без которых слой не может отдать данные. Не
|
||||
плодить обёртки «на будущее».
|
||||
|
||||
| Назначение | Имя | Когда нужен |
|
||||
|---|---|---|
|
||||
| Вход на создание записи | `Create<Entity>DTO` | полей больше трёх-четырёх, иначе хватит именованных аргументов |
|
||||
| Полная запись | `<Entity>FullDTO` | сервису и API нужны все поля записи |
|
||||
| Выборка подмножества полей | `<Entity>InListDTO` | repo выбирает часть колонок |
|
||||
| Страница | `<Entity>PageDTO` | `items` и `next_cursor: str \| None` |
|
||||
|
||||
- Каждый класс — `@dataclass(frozen=True, slots=True)`, суффикс `DTO`.
|
||||
Repo отдаёт снимок строки, а не ORM-объект: изменение DTO в БД не
|
||||
попадёт, и frozen не даёт сделать вид, что попадёт. pydantic читает
|
||||
DTO через `from_attributes`.
|
||||
- Обязательные поля первыми, поля со значением по умолчанию — последними;
|
||||
для `list` / `dict` — `field(default_factory=...)`. В frozen-DTO
|
||||
коллекции — `tuple` / `frozenset`.
|
||||
- Типы доменные: `UUID`, а не `str`; `datetime` (aware UTC), а не строки;
|
||||
`enums.*`; `X | None` для nullable.
|
||||
- Имена полей `<Entity>FullDTO` совпадают с колонками модели, иначе
|
||||
`FullDTO(**row.to_dict())` сломается. Исключение — секреты: хэш
|
||||
пароля и хэш токена в `UserFullDTO` и в DTO, уходящие в API, не
|
||||
попадают. Для входа — отдельный DTO из выбранных колонок
|
||||
(`auth.md`).
|
||||
- Каждый новый класс добавляется в `__init__.py` пакета (импорт и
|
||||
`__all__`) в алфавитном порядке.
|
||||
- Короткий docstring на русском, если назначение не очевидно из имени.
|
||||
- Enum-ы — `StrEnum`. Значение хранится в БД, поэтому переименование
|
||||
значения = миграция (`migrations.md`).
|
||||
- Вложения (лаба 4): `AttachmentStatus` (`pending`, `ready`; новое
|
||||
значение — замена CHECK) и `ImageType` (`image/png`, `image/jpeg`) в
|
||||
`enums/attachment.py`. `AttachmentFullDTO` — все колонки строки, в
|
||||
том числе `object_key` и `sha256` байтами: ключ в API не уходит, hex
|
||||
собирает модель ответа. `AttachmentContentDTO` — не снимок строки, а
|
||||
поток на отдачу: тип, размер, асинхронный итератор блоков и `close`.
|
||||
`MessageFullDTO.attachment_ids: tuple[UUID, ...] = ()` — значение по
|
||||
умолчанию последним полем.
|
||||
- Сверка bucket и БД (design change `track2-reconciler`, решение 8):
|
||||
`AttachmentFullDTO.lost_at: datetime | None = None` — последним полем
|
||||
(колонка `lost_at`, в API не уходит); `ReconcileFinding` (классы
|
||||
`orphan_object`, `missing_object`, `size_mismatch`, `stale_pending`,
|
||||
`restored_object`, `unknown_object`) и `ReconcileAction`
|
||||
(`deleted_object`, `marked_lost`, `cleared_lost`, `removed_pending`) —
|
||||
`StrEnum` в `enums/attachment.py`, в БД не хранятся;
|
||||
`ReconcileFindingDTO` (класс, ключ, `id`, возраст, размеры) и
|
||||
`ReconcilePassDTO` (итог прохода; `found` и `fixed` — неизменяемые
|
||||
отображения `MappingProxyType`, а не `dict`: DTO frozen).
|
||||
- Стоимость сверки (design change `track2-reconcile-cost`, решения 8 и
|
||||
15): `ReconcileFinding.CHECKSUM_MISMATCH` (`checksum_mismatch`) и
|
||||
`ReconcileStrategy` (`batch`, `head`) в `enums/attachment.py`;
|
||||
`ReconcilePassDTO` — новые поля в конце со значениями по умолчанию:
|
||||
`strategy`, `deep`, `max_objects_per_second`, `storage_objects`,
|
||||
`s3_requests` и `phase_ms` (`MappingProxyType`, по умолчанию пустой —
|
||||
`field(default_factory=…)`), `read_bytes`, `db_sessions`, `unchecked`;
|
||||
`ReconcileFindingDTO.sha256: bytes | None = None` — SHA-256 строки для
|
||||
перепроверки прочитанного объекта, в журнал не попадает. Снимок
|
||||
счётчиков клиента S3 `StorageStats` — тип `src/infra/s3`, не DTO
|
||||
слоёв.
|
||||
@@ -0,0 +1,321 @@
|
||||
---
|
||||
paths:
|
||||
- "src/infra/**"
|
||||
---
|
||||
|
||||
# Инфраструктура (`src/infra/`)
|
||||
|
||||
Брокер (`broker/`, с лабы 5, design change `async-attachments`, решение 5):
|
||||
`client.py` — `JobPublisher` (только relay), `JobConsumer` (только worker),
|
||||
`JobDelivery`, `queue_name`; у реплик API клиента брокера нет (design change
|
||||
`pipeline-reliability`, решение 1). aio-pika без `connect_robust`: фоновый reconnect
|
||||
скрыл бы, что исход публикации неизвестен. Издатель открывает соединение первым
|
||||
вызовом, `publisher_confirms=True`, `mandatory`, `on_return_raises=True`, очередь
|
||||
объявляется при каждом соединении. `publish_many(items) -> set[UUID]` — задача на
|
||||
сообщение и `asyncio.wait` с общим сроком `[broker] publish_timeout_seconds`:
|
||||
подтверждённые до срока считаются, остальные отменяются; подмножество — ошибка уже
|
||||
записана, соединение сброшено. `ready_messages()` — активное объявление, считает
|
||||
только готовые; отказ — `BrokerUnavailable`.
|
||||
Любая ошибка — сброс соединения (`is_closed` соединения не верить: канал закрыт при
|
||||
«живом» соединении), закрытие в фоне (при заморозке оно само зависло бы),
|
||||
`warning` «Broker is unavailable»; повторов нет. Закрытый канал (`is_closed` канала)
|
||||
перед публикацией — брокер перезапускался, пока заданий не было: в него ничего не
|
||||
ушло, поэтому это новое соединение, а не повтор. Процесс обработки (`render/`):
|
||||
`ImageRenderer`, см. `worker.md`.
|
||||
Потребитель
|
||||
— своё соединение: блокировка публикации не должна останавливать ack. Строка URL
|
||||
с паролем не собирается, `aio_pika` и `aiormq` на `WARNING`. С design change
|
||||
`job-trace-propagation` (решения 1, 3, 6): `publish_many` принимает `JobPublicationDTO`,
|
||||
`_publish_one` — span producer и заголовки `traceparent` / `tracestate` сообщения (тело
|
||||
прежнее); `JobDelivery.trace_context` — из заголовков (`trace_context_from_headers`: `str` или
|
||||
ASCII `bytes`, шаблон W3C версии `00`, `tracestate` до 512 символов, иначе `None`).
|
||||
|
||||
Всё, что не содержит бизнес-логики и может смениться от лабы к лабе:
|
||||
логгер, PostgreSQL (`db/`), кэш Valkey (`cache/`), S3 (`s3/`), дальше —
|
||||
брокер, телеметрия. Бизнес-правил (уникальность, доступ, валидация) здесь нет:
|
||||
они в сервисах, атомарные операции — в repo.
|
||||
|
||||
- Клиент хранилища (engine Postgres, кэш Valkey, S3) — глобал своего
|
||||
модуля (`db/session.py`, `cache/instance.py`, `s3/instance.py`):
|
||||
создаётся при импорте по
|
||||
`settings` (настройки читаются один раз на процесс), соединения
|
||||
открывает лениво, при первом запросе. Пакет `src/infra/<клиент>/` этот
|
||||
модуль не импортирует, модели тоже, поэтому alembic и скрипты клиента
|
||||
не создают. Закрытие (`engine.dispose()`, `cache.aclose()`) — в
|
||||
lifespan `src/main.py` (S3 — ещё и `start()` там же). Почему не
|
||||
`app.state` — design change
|
||||
`postgres-storage`, решение 5.
|
||||
- Глобал импортируют только `src/main.py` (закрытие) и
|
||||
`src/api/dependencies.py`; сервисы получают единицу работы или клиент через
|
||||
конструктор из зависимости и сами глобал не импортируют. Процессу со
|
||||
своим пулом (уборщик с лабы 4, worker с лабы 5) — свой вызов фабрик
|
||||
`create_engine` и `create_object_storage`.
|
||||
- Уборщик (`src/cleaner/main.py`, design change `upload-consistency`,
|
||||
решения 2 и 7): свой engine — пул из `DATABASE__POOL_SIZE` (на стенде
|
||||
1: проход последовательный), свой клиент S3 с namespace — имя базы и
|
||||
ключами пользователя уборщика; глобалы `db/session.py` и
|
||||
`s3/instance.py` он не импортирует. Закрывает их сам при выходе.
|
||||
- `db/`: `engine.py` — фабрики engine и сессий, `BoundedCloseConnection`,
|
||||
`ping`; `session.py` — глобалы `engine` и `session_factory`;
|
||||
`scope.py` — `session_scope(session_factory, *, timeout_seconds)`:
|
||||
сессия на блок, блок вместе с откатом при выходе — под сроком (change
|
||||
`unit-of-work`, решение 4: блок заканчивается до ответа, и замороженный
|
||||
PostgreSQL иначе повесил бы готовый ответ), `is_db_unavailable` →
|
||||
`invalidate()`, `warning` «Database is unavailable» (модуль `database`) и
|
||||
`ServiceUnavailable`; отмена задачи тоже сбрасывает соединение (`close()`
|
||||
послал бы ROLLBACK); и `deadline_scope(*, timeout_seconds)` — общий срок JSON-запроса
|
||||
без сессии (`api-layer.md`). Внутри общего срока таймер блока не взводится
|
||||
(`_deadline_task`, только в той же задаче): оба истекали бы почти разом, и вторая
|
||||
отмена прерывала бы закрытие соединения в пуле. Срок отката на JSON-ручке — общий
|
||||
срок, вне их — срок блока. `uow.py` — `SqlAlchemyUnitOfWork(session_factory,
|
||||
*, timeout_seconds)` поверх `session_scope`, repo создаются на блок, соединение
|
||||
выдаётся лениво. Импортируют `uow.py` только точки входа процессов;
|
||||
`db/__init__.py` не импортирует ни его, ни `scope.py` (логгер не настраивается
|
||||
в alembic). `errors.py` — `is_db_unavailable`; модели — `models/`
|
||||
(`migrations.md`). Драйвер — asyncpg.
|
||||
- Проверка соединения при выдаче — одним обменом `;` (`_ping_once`,
|
||||
`engine.dialect.do_ping`; change `unit-of-work`, решение 7): проверка
|
||||
диалекта — `BEGIN`, `;`, `ROLLBACK` ради pgbouncer, которого на стенде нет, а
|
||||
соединение на шаг выдаётся двухшаговой ручке дважды. Разбор обрыва прежний:
|
||||
`_do_ping_w_event` получает ту же ошибку адаптера. Опирается на внутренние
|
||||
`_connection` и `_handle_exception` адаптера, SQLAlchemy закреплён `<2.2`;
|
||||
смену имён ловит `make service_test_db` (`test_ping_*`).
|
||||
- `cache/`: `client.py` — фабрика `create_cache` и обёртка `Cache`;
|
||||
`instance.py` — глобал `cache`. Ключи и формат значений — в repo
|
||||
(`src/core/repos/chat_cache.py`), не здесь.
|
||||
- `s3/` (с лабы 4, design change `s3-storage`, решения 6–7): `client.py`
|
||||
— фабрика `create_object_storage`, обёртка `ObjectStorage` и типы
|
||||
`StoredObjectInfo`, `StoredObject`; `instance.py` — глобал
|
||||
`object_storage` с `namespace` = имя базы. Ключ объекта строит repo
|
||||
(`attachments`): `f"{namespace}{S3_KEY_SEPARATOR}…"`, как ключи кэша, —
|
||||
объекты `make test_isolated` лежат под `test_<db>/`. Клиент
|
||||
aiobotocore создаёт `start()` в lifespan (модели botocore — при
|
||||
старте, сети нет), закрывает `aclose()` рядом с `cache.aclose()`.
|
||||
Ниже — правила клиента.
|
||||
- `upload_slots.py` (change `upload-memory`, design, решение 1) — класс
|
||||
`UploadSlots` и глобал `upload_slots` из `settings.uploads` (при
|
||||
импорте, как `_limiter` в `password.py`): места загрузок процесса на
|
||||
`asyncio.Semaphore` (ожидающие — по порядку прихода), счётчик
|
||||
ожидающих и срок ожидания. Контекст `slot()`: места нет и ожидающих
|
||||
уже `max_waiting` — сразу `UploadsBusy`; иначе ожидание не дольше
|
||||
`wait_timeout_seconds` (`asyncio.timeout`), не вышло — `UploadsBusy`;
|
||||
отдаёт ожидание в мс, место освобождает в `finally`. Отмену во время
|
||||
ожидания `Semaphore` обрабатывает сам: место, отданное отменённому
|
||||
ожидающему, переходит следующему. Это допуск к обработке, а не данные:
|
||||
места считает каждая реплика, корректность ответов от них не зависит
|
||||
(`api-layer.md`). Глобал импортирует только `dependencies.py`,
|
||||
уборщик его не создаёт. Отвергнуты — очередь в LB, `--limit-concurrency`
|
||||
uvicorn, места по байтам, счётчик в Valkey или PostgreSQL (design).
|
||||
- `early_stop.py` — ранний обработчик SIGTERM и SIGINT процесса
|
||||
(`install(process_name)`, `disarm()`, `write_record`): только stdlib,
|
||||
ни настроек, ни логгера, ни других модулей `src`; клиентом хранилища
|
||||
не является, глобала клиента нет, `dependencies.py` его не
|
||||
импортирует. Импортируется в `src/__main__.py` до приложения;
|
||||
`disarm()` — первая строка lifespan `src/main.py` (а не `main()`
|
||||
перед `uvicorn.run`: до `capture_signals` сигнал снова терялся бы).
|
||||
У уборщика — `install("cleaner")` в `src/cleaner/__main__.py`,
|
||||
`disarm()` — после обработчиков сигналов asyncio; `write_record` пишет
|
||||
ещё и запись о неверных настройках уборщика (логгер их тоже читает).
|
||||
Окна старта — `run-modes.md`, запись — `logging.md`.
|
||||
- Источник истины — PostgreSQL. SQLite, файлы и память процесса его не
|
||||
заменяют (`README.md`, п. 2). Кэш не хранит ничего, чего нет в
|
||||
Postgres: сессии в Valkey не лежат (`auth.md`).
|
||||
- Пул ограничен (`pool_size`, `max_overflow`, `pool_timeout`), у
|
||||
подключения и запроса есть таймауты (`connect_timeout_seconds`,
|
||||
серверный `statement_timeout`, срок блока `request_timeout_seconds`).
|
||||
Это требование уровня 4; значения — поля секции `[database]`
|
||||
(`settings.md`). Пул — на один процесс, а процессов `API_REPLICAS`:
|
||||
`API_REPLICAS × (pool_size + max_overflow)` + migrate + запас
|
||||
(psql, стенд `bench/`) не больше `max_connections` Postgres (по
|
||||
умолчанию 100); с лабы 4 ещё уборщик (пул 1). Расчёт для заявленного
|
||||
числа реплик — в `REPORT.md`;
|
||||
граница пула — гипотеза H3 трека 1 (`REPORT.md`, «Цена
|
||||
масштабирования»).
|
||||
- Пул — постоянный набор: `pool_size` 10, `max_overflow` 0 по умолчанию
|
||||
(change `scaling-improvement`). Соединение переполнения `QueuePool`
|
||||
закрывает при возврате, если в очереди уже `pool_size` простаивающих,
|
||||
и под нагрузкой открывает заново: новый процесс PostgreSQL (~2,7 мс
|
||||
CPU) и SCRAM-SHA-256 asyncpg в потоке event loop (~11 мс CPU реплики)
|
||||
на каждое (`evidence/storage/connection-cost.md`). Поэтому
|
||||
переполнение не включать; больше соединений — больше `pool_size`, и
|
||||
тогда соединений стенда `API_REPLICAS × pool_size` + 1. Свойство
|
||||
проверяет `test_pool_keeps_connections` (`make failure_checks`).
|
||||
`/health/ready` берёт соединение из той же очереди пула (ждёт не
|
||||
дольше 2 с): на перегрузке проверка готовности стоит в очереди вместе
|
||||
с запросами.
|
||||
- `idle_in_transaction_session_timeout` — серверная настройка соединений
|
||||
приложения (`server_settings`, рядом с `statement_timeout`) из
|
||||
`[database] idle_in_transaction_timeout_ms` (10 с; 0 — не задаётся).
|
||||
Замороженный процесс (`docker pause`, зависание) держит открытую
|
||||
транзакцию бесконечно: его TCP-соединение живо, keepalive ничего не
|
||||
замечает. Без этой настройки строка ключа идемпотентности, которую он
|
||||
вставил, оставалась бы заблокированной до разморозки, и повтор того же
|
||||
ключа через другую реплику получал бы 503 снова и снова. Значение
|
||||
больше `request_timeout_seconds` (валидатор `Database`): транзакция
|
||||
живого блока дольше не живёт, `session_scope` сбрасывает соединение
|
||||
по сроку (design change `graceful-failover`, решение 4).
|
||||
- `command_timeout` asyncpg не использовать: на таймауте он отменяет
|
||||
запрос через новое соединение и ждёт сервер без срока, и замёрзший
|
||||
Postgres держит запрос до разморозки. Срок блока ставит
|
||||
`asyncio.timeout` в `session_scope`, а мягкое закрытие соединения
|
||||
ограничивает `BoundedCloseConnection` (`connection_class` asyncpg). Он же обрывает
|
||||
транспорт после закрытия: `abort()` asyncpg на прерванном `close()` выходит сразу и
|
||||
сокет не трогает, а сессия без транзакции (проверка `;`) жила бы сверх пула без
|
||||
срока. Опирается на внутренний `_transport`, смену ловит
|
||||
`test_no_sessions_over_pool_after_freeze`.
|
||||
- Engine — с `hide_parameters=True`. `str()` у `DBAPIError` включает
|
||||
`[SQL: ...]` и `[parameters: ...]`, и эта строка уходит в журнал: в
|
||||
`warning` из `session_scope` и в traceback ошибки 500. Без флага там
|
||||
оказались бы текст сообщений, а с `session-auth` — хэши паролей и
|
||||
токенов (`logging.md`, «Чего в логах быть не должно»).
|
||||
- `/health/ready` проверяет критичные зависимости через infra:
|
||||
`SELECT 1` в Postgres с коротким таймаутом. Valkey не проверяется: это
|
||||
кэш, без него обязательный путь идёт в Postgres. Недоступность
|
||||
критичной зависимости — 503. Какие зависимости критичны, фиксируется
|
||||
в `REPORT.md`. С лабы 3 по `/health/ready` HAProxy решает, слать ли
|
||||
реплике запросы (`balancer.md`): таймаут проверки внутри ручки
|
||||
меньше `timeout check` HAProxy, иначе медленный Postgres выглядел бы
|
||||
как мёртвая реплика. `/health/live` для LB не используется.
|
||||
- Потеря соединения и таймауты драйвера на бизнес-запросе — 503
|
||||
`unavailable` без деталей (`api-contract.md`), не 500 и не обход
|
||||
аутентификации. Перевод — в `session_scope` (`db/scope.py`, под единицей
|
||||
работы): `is_db_unavailable` решает, отказ ли это, сессия закрывается
|
||||
через `invalidate()`, в журнал — `warning`. Остальные `DBAPIError`
|
||||
(ограничения, синтаксис) — откат и дефект, им положен 500.
|
||||
- Valkey (не Redis) — кэш карточки чата (спек `chat-cache`, design
|
||||
change `membership-cache`). Роль, источник истины, срок, вытеснение и
|
||||
отсутствие инвалидации — в `REPORT.md`. С лабы 3 Valkey один на все
|
||||
реплики; инвалидация между ними не нужна, потому что карточка
|
||||
неизменна (состав чата не меняется). Пропуск кэша после отказа
|
||||
(`retry_after_seconds`) — состояние своей реплики, на корректность
|
||||
не влияет. Клиент — redis-py
|
||||
(`redis.asyncio`):
|
||||
- **один повтор, только на обрыв**: `retry=Retry(NoBackoff(), 1,
|
||||
supported_errors=(ConnectionError,))`. По умолчанию redis-py
|
||||
повторяет команду с backoff, и замороженный Valkey держал запрос
|
||||
6 с вместо 0,2 с. Таймаут не повторяется, а обрыв повторяется один
|
||||
раз: после рестарта Valkey старое соединение пула иначе давало бы
|
||||
отказ на первой команде;
|
||||
- `Retry` — **из `redis.asyncio.retry`**. Синхронный `redis.retry.Retry`
|
||||
асинхронное соединение принимает молча, но повтор с ним не
|
||||
выполняется никогда (первая реализация так и ошиблась);
|
||||
- `BlockingConnectionPool` на `[cache] max_connections` с ожиданием не
|
||||
дольше `timeout_seconds`: обычный пул при всплеске запросов сразу
|
||||
бросает `MaxConnectionsError`, и здоровый Valkey считался бы
|
||||
отказавшим;
|
||||
- `socket_timeout` и `socket_connect_timeout` — `[cache]
|
||||
timeout_seconds`, а всю команду (пул, соединение, повтор, ответ)
|
||||
ограничивает `asyncio.timeout` того же срока в `Cache`.
|
||||
- Отказ Valkey — промах, а не 503 и не 500: `Cache.get` / `Cache.set`
|
||||
ловят `RedisError` и `OSError` (в том числе `TimeoutError` от
|
||||
`asyncio.timeout`), отдают `None` / `False`, и запрос идёт в
|
||||
Postgres. После отказа кэш пропускается на `[cache]
|
||||
retry_after_seconds` без обращений к Valkey. В журнал — один
|
||||
`warning` «Cache is unavailable» на отказ и `info` «Cache is
|
||||
available again» при первом успехе. Пароль в журнал не попадает: он
|
||||
есть только в настройках пула.
|
||||
- S3 (SeaweedFS) — байты вложений; источник истины метаданных —
|
||||
PostgreSQL. Клиент — aiobotocore (botocore закреплён им узко,
|
||||
обновлять вместе через `uv lock`):
|
||||
- **повторов нет** (`retries={"total_max_attempts": 1}`): рестарт S3
|
||||
повтора не требует (старый клиент проходит первым же вызовом), таймаут
|
||||
не повторяется, загрузку повторяет клиент контракта;
|
||||
- **срок на вызов** — `asyncio.timeout([s3] timeout_seconds)` (5 с,
|
||||
меньше `timeout server` HAProxy), у `open` — ещё и на каждый блок
|
||||
чтения тела. Кроме срока установки соединения
|
||||
(`connect_timeout_seconds` из `[s3]`), это единственный срок вызова:
|
||||
`read_timeout` botocore **выключен (`None`)**; пул aiohttp — `[s3]
|
||||
max_connections`;
|
||||
- **почему без `read_timeout`** (design change `fix-upload-put-flake`,
|
||||
решение 1): aiobotocore превращает его в `sock_read` aiohttp, а
|
||||
aiohttp 3.14.5 (версия `uv.lock`, проверено пробой) после потокового
|
||||
ответа с паузой чтения перевзводит этот срок в `resume_reading()` уже
|
||||
у соединения, которое вернулось в пул. Пауза — когда буфер ответа
|
||||
больше 512 KiB (`read_bufsize` по умолчанию 256 KiB, верхний порог —
|
||||
вдвое больше: `aiohttp/helpers.py:65`, `streams.py:117–118`, `300`;
|
||||
замер: 64–200 KiB — 0 взведённых из 90, 1 MiB — до 2 из 10). Пробой
|
||||
другие версии aiohttp не проверялись, их исходники — в
|
||||
`evidence/s3/idle-connection.md`, раздел 1. Через срок он
|
||||
срабатывает на простаивающем соединении, пул отдаёт его следующему
|
||||
вызову (проверяет только
|
||||
`is_connected()` и keep-alive), и вызов падает за 1 мс —
|
||||
`ReadTimeoutError`, 503 на исправном S3. Включать `read_timeout`
|
||||
снова — только с новой пробой (`driver.py s3-idle`, тест
|
||||
`test_upload_after_idle_s3`). Отсюда правило: всякое новое чтение из
|
||||
S3 — внутри `_call` или `_read_chunk` под `asyncio.timeout`, а не
|
||||
голым `await` на ответе aiohttp, иначе оно останется без срока;
|
||||
- правило «повторов нет» (пункт выше) прежнее: причина 503 убрана, а не
|
||||
скрыта повтором (решение 2 того же design). Отдельного срока PUT
|
||||
по размеру нет: места API ограничивают одновременные PUT (4 на
|
||||
реплику, 12 при замене), p95 при 12 — 1,6–1,9 с (design change
|
||||
`upload-memory`, решение 8), а больший срок удлинил бы границу B
|
||||
уборщика;
|
||||
- `put(key, body, *, size, content_type)` — тело потоком с `read`,
|
||||
`seek`, `tell` (сервис передаёт свой `BytesIO`), `size` — в журнал
|
||||
вызова. Не `bytes`: botocore обернул бы его в `BytesIO` с общим
|
||||
буфером, и aiohttp скопировал бы тело при `getbuffer()`;
|
||||
- `list_page(prefix, *, token, max_keys)` (design change
|
||||
`track2-reconciler`, решение 3) — страница ListObjectsV2:
|
||||
`StoredObjectPage` (объекты с размером и `last_modified`, токен
|
||||
продолжения или `None`). Срок — на страницу, как у любого вызова; у
|
||||
`_call` ключ необязателен (`None` — вызов без `Key`, в журнал —
|
||||
префикс). Нет bucket — `ObjectStorageUnavailable` («bucket is
|
||||
missing»), а не пустая страница: у списка и 404 без тела считается
|
||||
отсутствующим bucket; отказ в списке — «denied access».
|
||||
`StoredObjectInfo.last_modified` — из списка, HEAD и GET (часы S3,
|
||||
точность — секунда). Порядок списка SeaweedFS —
|
||||
обход каталогов, а не порядок байтов: сверка не сливает
|
||||
отсортированные потоки, а собирает множество ключей. Префикс —
|
||||
только `<namespace>/attachments/` (repo): политика уборщика другие
|
||||
префиксы запрещает;
|
||||
- счётчики клиента (design change `track2-reconcile-cost`, решение 8):
|
||||
попытки вызовов по операциям — в `_call` до вызова, в том числе
|
||||
неудачные (`OPERATION_NAMES`: `list`, `head`, `get`, `delete`, `put`),
|
||||
ключи страниц — в `list_page`, прочитанные байты — в `_read_chunk`.
|
||||
`stats()` — неизменяемый снимок `StorageStats` (`calls` —
|
||||
`MappingProxyType`); стоимость прохода сверка считает разностью
|
||||
снимков. На поведение, сроки и перевод ошибок счётчики не влияют.
|
||||
`open` отдаёт и `last_modified` (GET), чтобы глубокая сверка `head`
|
||||
проверяла свежесть без HEAD;
|
||||
- адресация `path`: `bucket.s3` Docker DNS не разрешает;
|
||||
простаивающее соединение aiohttp закрывает через
|
||||
`S3_KEEPALIVE_TIMEOUT_SECONDS` (15 с), раньше шлюза (120 с);
|
||||
- ключи передаются в botocore всегда, даже пустые: с `None` он искал
|
||||
бы учётные данные в окружении и `~/.aws` хоста. Пустые ключи —
|
||||
`warning` при старте;
|
||||
- ошибки: отказ соединения, обрыв, таймаут, 5xx, отказ в учётных
|
||||
данных (`InvalidAccessKeyId`, `SignatureDoesNotMatch`), отказ в
|
||||
доступе (`AccessDenied`, 403 без тела у HEAD) и отсутствующий bucket
|
||||
(`NoSuchBucket`) — `ObjectStorageUnavailable` (наследник
|
||||
`ServiceUnavailable`, 503 `unavailable`); отсутствующий ключ
|
||||
(`NoSuchKey`, 404 без тела у HEAD) — `StoredObjectMissing` (`head` —
|
||||
`None`, `delete` глушит только его). Удалённый bucket не выдаётся за
|
||||
отсутствующий объект; исключение — HEAD: SeaweedFS отвечает тем же
|
||||
404 без тела. Прочие ошибки S3 и botocore не перехватываются — 500,
|
||||
дефект;
|
||||
- обхода и пропуска после отказа, как у Valkey, нет: без S3 путь
|
||||
вложений всё равно 503. `/health/ready` S3 не проверяет (спек
|
||||
`health`, design change `s3-storage`): текст работает без него.
|
||||
- Телеметрия (`telemetry/`, с лабы 6, design change `otel-telemetry`, решения 4, 8, 12, 13;
|
||||
правило `telemetry.md`): глобальных провайдеров OpenTelemetry нет — состояние пакета, при
|
||||
выключенной телеметрии все вызовы no-op. Запускает её точка входа процесса (API — lifespan,
|
||||
worker — `run()`), не модули клиентов. Дочерний span — в единственной точке вызова клиента:
|
||||
`ObjectStorage._call` (`S3.<Операция>`, без ключа, `StoredObjectMissing` у HEAD и DELETE —
|
||||
исход), `Cache.get` / `Cache.set` (`messenger.cache.result`: `hit`, `miss`, `stored`, `error`,
|
||||
`skipped`), `ImageRenderer.render`, `SqlAlchemyUnitOfWork._commit` (`COMMIT`), запросы —
|
||||
слушатели `instrument_engine` (фабрика engine о телеметрии не знает). Span не меняет ни
|
||||
перевода ошибок, ни сроков; новое чтение из хранилища — внутри уже обёрнутого вызова.
|
||||
С design change `job-trace-propagation` (решения 7, 10, 12): пакет на уровне модуля
|
||||
импортирует только API OpenTelemetry, SDK — `sdk.py` из `core.start()`; публикация брокера
|
||||
— span producer (`messaging.py`); `instrument_engine` ещё регистрирует
|
||||
`db.client.connection.*` (`metrics.py`), метрики контейнера — `container.py` по cgroup v2.
|
||||
- Пул engine — `CountingQueuePool` (`db/engine.py`, `poolclass=`; design change
|
||||
`job-trace-propagation`, решение 10): `AsyncAdaptedQueuePool`, у которого публичный
|
||||
`connect()` считает ожидающих и отказы по сроку (`pending()`, `timeouts()`). `dispose()`
|
||||
пересоздаёт пул того же класса (`recreate`), метрики читают текущий
|
||||
`engine.sync_engine.pool`. Опирается на `Pool.connect()`, SQLAlchemy закреплён `<2.2`; смену
|
||||
ловит `service-tests/db/test_pool_counts.py`.
|
||||
- Клиенты внешних сервисов: адреса и секреты из `settings`
|
||||
(`.claude/rules/settings.md`), таймаут на каждый вызов, ошибки
|
||||
переводятся в доменные исключения. Логи — по `logging.md`, без
|
||||
секретов.
|
||||
@@ -0,0 +1,337 @@
|
||||
---
|
||||
paths:
|
||||
- "src/core/services/**"
|
||||
- "src/api/**"
|
||||
- "src/infra/**"
|
||||
- "src/main.py"
|
||||
---
|
||||
|
||||
# Логирование
|
||||
|
||||
Инфраструктура — `src/infra/logger.py`, по образцу bp_proxies
|
||||
(`src/core/services/logger.py` там). `get_logger()` возвращает
|
||||
`AbstractLogger` поверх structlog: JSON в stdout, уровень из
|
||||
`[app] log_level`.
|
||||
|
||||
Само попадает в запись, руками не добавлять: `request_id` из contextvar
|
||||
(ставит request-id middleware, то же значение, что в `X-Request-Id`),
|
||||
`user_id` из contextvar (ставит `get_current_user`), timestamp ISO/UTC,
|
||||
уровень, `filename` / `func_name` / `lineno`. Enum печатается как repr.
|
||||
С лабы 3 — ещё `instance_id` (то же значение, что `X-Instance-Id`) в
|
||||
каждой записи, включая строки старта и shutdown: логи реплик
|
||||
сливаются в один поток `docker compose logs`, и только по нему видно,
|
||||
какая реплика остановилась и когда.
|
||||
|
||||
## Устройство `src/infra/logger.py`
|
||||
|
||||
Это перенос логгера bp_proxies
|
||||
(`~/PycharmProjects/bp_proxies/src/core/services/logger.py`, есть только
|
||||
на машине автора) с тремя отличиями, перечисленными ниже.
|
||||
|
||||
- `AbstractLogger` (ABC: `debug` / `info` / `warning` / `error` /
|
||||
`critical` / `bind`) и реализация `StructLogger` лежат в этом же
|
||||
модуле. `bind()` возвращает новый логгер с объединённым контекстом,
|
||||
исходный не меняется.
|
||||
- `get_logger()` инициализируется лениво: первый вызов выполняет
|
||||
`configure_logger()` и создаёт корневой `StructLogger`. Модули зовут
|
||||
его на уровне модуля, поэтому настройка применяется уже при импорте
|
||||
`src.main`, до `uvicorn.run`.
|
||||
- `structlog.configure_once`, процессоры по порядку:
|
||||
1. `stdlib.filter_by_level` — запись ниже уровня отбрасывается до
|
||||
остальных процессоров, включая поиск места вызова;
|
||||
2. `contextvars.merge_contextvars`, `stdlib.add_log_level`,
|
||||
`stdlib.ExtraAdder()`;
|
||||
3. `TimeStamper(fmt="iso", utc=True)`, `format_exc_info`;
|
||||
4. `CallsiteParameterAdder` (`FILENAME`, `FUNC_NAME`, `LINENO`) с
|
||||
`additional_ignores=["src.infra.logger"]`;
|
||||
5. контекстный процессор: `request_id` и `user_id` из contextvar-ов;
|
||||
6. перестановка ключей: `request_id`, `event`, `user_id` в начало;
|
||||
7. Enum → repr, UUID → строка (иначе JSONRenderer пишет `UUID('...')`),
|
||||
поэтому в kwargs можно передавать `UUID` как есть;
|
||||
8. `stdlib.ProcessorFormatter.wrap_for_formatter`.
|
||||
|
||||
`logger_factory=stdlib.LoggerFactory()`,
|
||||
`wrapper_class=stdlib.BoundLogger`, `cache_logger_on_first_use=True`.
|
||||
- `logging.config.dictConfig` с `disable_existing_loggers=False`:
|
||||
- форматтер — `ProcessorFormatter` с `remove_processors_meta` и
|
||||
`JSONRenderer()`; для записей чужих библиотек — `foreign_pre_chain`
|
||||
из `merge_contextvars`, `add_log_level`, `add_logger_name`,
|
||||
`TimeStamper`, `format_exc_info`, контекстного процессора и
|
||||
перестановки ключей;
|
||||
- handler — один `StreamHandler` в `ext://sys.stdout`;
|
||||
- root — `WARNING` с этим handler: предупреждения прочих библиотек тоже
|
||||
JSON (в bp_proxies root был без handlers);
|
||||
- `src` — уровень `[app] log_level`, этот handler,
|
||||
`propagate=False`;
|
||||
- `uvicorn` — `INFO`, этот handler, `propagate=False`;
|
||||
`uvicorn.error` — `INFO` без своего handler, пишет через `uvicorn`
|
||||
(свой handler дал бы дубли); `uvicorn.access` — выключен;
|
||||
- шумные библиотеки (`sqlalchemy.engine`, драйвер Postgres, `httpx`,
|
||||
`httpcore`) — `WARNING`: SQL с параметрами в лог не попадает; логгер пула
|
||||
engine `src.infra.db.engine.CountingQueuePool` (`DB_POOL_LOGGER`: SQLAlchemy
|
||||
называет его по классу пула, а класс живёт в `src`) — тоже `WARNING`, иначе
|
||||
«Pool recreating» шло бы INFO (design change `job-trace-propagation`,
|
||||
«Уточнения apply», п. 11);
|
||||
- клиент S3 (с лабы 4): `botocore`, `aiobotocore`, `aiohttp` — явно
|
||||
`WARNING`, даже если кто-то опустит уровень root: на `DEBUG`
|
||||
botocore пишет заголовки запроса с подписью (`Authorization`).
|
||||
|
||||
### Отличия от bp_proxies
|
||||
|
||||
1. **Место вызова — через `CallsiteParameterAdder`, а не
|
||||
`inspect.stack()`.** В bp_proxies каждый метод `StructLogger` зовёт
|
||||
`inspect.stack()`, а тот читает исходники всех кадров стека. Замер
|
||||
на глубине стека 40 кадров (как у ручки FastAPI под uvicorn):
|
||||
~470 мкс только на поиск места вызова против ~3,5 мкс на всю запись
|
||||
с `CallsiteParameterAdder`. На одном event loop 2–3 строки лога на
|
||||
запрос съели бы 1–1,5 мс CPU, то есть заметную долю потолка RPS
|
||||
(замер — трек 1 лабы 1).
|
||||
2. **`request_id` в процессоре не генерируется.** В bp_proxies при
|
||||
пустом contextvar процессор создаёт случайный 8-символьный id и
|
||||
записывает его в contextvar. Здесь id запроса ставит только
|
||||
middleware, и он обязан совпасть с `X-Request-Id`. Вне запроса
|
||||
(старт, shutdown) поля нет. Фоновые задачи с лабы 5 ставят свой id
|
||||
сами, как job в bp_proxies.
|
||||
3. **uvicorn тоже пишет JSON.** В bp_proxies логгеры `uvicorn.*` не
|
||||
трогаются и пишут обычный текст. Здесь строки uvicorn об остановке
|
||||
(«Shutting down», «Waiting for application shutdown.», «Finished
|
||||
server process») доказывают на защите уровня 4, что SIGTERM
|
||||
отработал вовремя, поэтому идут в тот же JSON. Для этого
|
||||
`uvicorn.run(..., log_config=None, access_log=False)`: без
|
||||
`log_config=None` uvicorn при старте применит свой `LOGGING_CONFIG`
|
||||
поверх нашего. Access-лог пишет свой middleware (`api-layer.md`).
|
||||
|
||||
### Телеметрия журнала (с лабы 6)
|
||||
|
||||
Design change `otel-telemetry`, решения 2 и 12; правило `telemetry.md`. В обеих цепочках
|
||||
(`processors` перед `wrap_for_formatter` и `foreign_pre_chain`) — `export_to_telemetry`, затем
|
||||
`add_trace_fields`: запись уходит в логгер SDK (тело — `event`, уровень, время записи,
|
||||
остальные поля — атрибуты, контекст — текущий), затем stdout получает `trace_id` и `span_id`
|
||||
активного записывающего span. Вне span (старт, остановка, health, фоновые циклы) полей нет;
|
||||
без телеметрии хуков нет — записи прежние. `logger.py` SDK не импортирует. Записи логгеров
|
||||
`opentelemetry.*` не экспортируются, а handler пропускает в stdout не больше одной в минуту на
|
||||
логгер (`RateLimitFilter`, `TELEMETRY_SDK_LOG_WINDOW_SECONDS`). «Started API» и «Started worker»
|
||||
— `telemetry_enabled`, `telemetry_endpoint`, `telemetry_environment`, с design change
|
||||
`track1-telemetry-cost` (решение 3) ещё `telemetry_trace_sample_ratio`, `telemetry_metric_buckets`,
|
||||
`telemetry_metric_export_interval_seconds` (при выключенной — `null`), у всех трёх процессов —
|
||||
одной функцией `telemetry.startup_fields`; профиль цены телеметрии сверяет по ним вариант. Запись
|
||||
невыбранного в голове запроса уходит в Loki с `trace_id` и флагами без бита выборки, а в stdout
|
||||
полей трассы нет (span не записывается); `warning` «Ignored
|
||||
OpenTelemetry environment variables» — `names` без значений. С design change
|
||||
`job-trace-propagation` (решения 2, 7, 12): то же у relay — его записи идут в Loki
|
||||
(`service_name` `messenger-relay`), «Started relay» называет телеметрию, «Stopped relay» — после
|
||||
закрытия SDK, только stdout; проходы relay идут вне span — без `trace_id`. Записи доставки
|
||||
worker с контекстом — с `trace_id` трассы загрузки. `warning` «Container metrics are
|
||||
unavailable» (модуль `telemetry`, `cgroup_root`) — один раз при старте и до хуков журнала:
|
||||
только stdout. Запрет содержимого раздела ниже
|
||||
действует и на отправленные записи: в Loki — те же записи, что в stdout.
|
||||
|
||||
### Исключение: запись ранней остановки
|
||||
|
||||
`src/infra/early_stop.py` пишет одну запись мимо structlog: сигнал
|
||||
пришёл во время импорта приложения, а логгер настраивается при первом
|
||||
`get_logger()` — как раз во время импорта настроек, и обработчик застал
|
||||
бы модули полуинициализированными. Запись — одна строка JSON через
|
||||
`os.write` в stdout, затем `os._exit(0)`; ошибка записи выходу не мешает.
|
||||
Поля — как у записей structlog: `event` «Stopped API before startup»
|
||||
(у уборщика — «Stopped cleaner before startup») и `instance_id` первыми, `module` `startup`, `signal` (`SIGTERM` /
|
||||
`SIGINT`), `level` `info`, `timestamp` ISO 8601 UTC с микросекундами и
|
||||
`Z`. `instance_id` — `APP__INSTANCE_ID` или hostname, то же значение по
|
||||
умолчанию, что `[app] instance_id`. Уровень `info`: остановку запросил
|
||||
оператор, и она выполнена верно (design change `fix-known-issues`,
|
||||
решение 5).
|
||||
|
||||
## Журнал worker и брокера (с лабы 5)
|
||||
|
||||
Спек `service-logging`, «Журнал worker»; design change `async-attachments`,
|
||||
решение 18. Модуль `attachment_processing_service`, `request_id` — `job_id`:
|
||||
`info` «Started job attempt», «Attachment became ready» (`variant_width`,
|
||||
`variant_height`, `variant_size_bytes`, `duration_ms`), «Skipped job message»
|
||||
(`reason`: `finished`, `unknown`, `busy`); `warning` «Retrying job» (`reason`,
|
||||
`delay_seconds`), «Attachment failed» (`error_code`, `reason`), «Job waits for
|
||||
database»; `error` «Dropped malformed job message» — без содержимого, «Job attempt
|
||||
failed» с traceback. Модуль `worker`: «Started worker» со всеми значениями,
|
||||
«Stopped worker» с `exit_code`, «Invalid worker settings» мимо structlog, «Stopped
|
||||
worker before startup». Модуль `broker`: `warning` «Broker is unavailable»,
|
||||
`info` «Broker is available again», `debug` на публикацию; API: «Uploaded attachment»
|
||||
— ещё `job_id`, `content_type` значением. Пароля брокера и тел сообщений в записях нет.
|
||||
|
||||
С change `pipeline-reliability` (решение 18): «Started job attempt» — ещё `queue_wait_ms`
|
||||
(от подтверждения брокером до взятия), `message_attempt`, `redelivered`; «Attachment
|
||||
became ready» — вместо `variant_*` — `variants` (имя, ширина, высота, размер), `render_ms`,
|
||||
`render_peak_kib`, `render_memory_limit_applied`, `duration_ms`; «Retrying job» — ещё
|
||||
`next_attempt_at`; «Skipped job message» — ещё `not_due`, `superseded`. Модуль
|
||||
`image_renderer`: `warning` «Render process failed» (`exit_code`), «Render process output
|
||||
is damaged». Модуль `relay`: «Started relay» со всеми значениями, «Stopped relay»,
|
||||
«Invalid relay settings», «Stopped relay before startup», `warning` «Relay pass was
|
||||
interrupted», `error` «Relay pass failed». Модуль `attachment_relay_service`: «Relay
|
||||
pass» (`published`, `unconfirmed`, `recovered`, `republished`, `published_backlog`,
|
||||
`duration_ms`; `info`, пустой — `debug`), `warning` «Recovered expired lease», `info`
|
||||
«Relay backlog is full» / «Relay backlog has room» на смену состояния. Модуль
|
||||
`attachment_replay_service`: «Found failed job», «Replayed job» (`operator`, прежние
|
||||
`error_code`, `reason`), `warning` «Refused job replay» (`refusal`), «Finished replay
|
||||
pass». Модуль `attachment_cleanup_service`: «Finished staging cleanup pass»
|
||||
(`removed_ready`, `removed_failed`, `skipped`, `interrupted_by`, `duration_ms`), `warning`
|
||||
«Staging key is not own». Итог сверки — ещё `listed_staging`.
|
||||
|
||||
## Чего в логах быть не должно
|
||||
|
||||
Рубрика уровня 4: логи полезные, но **без содержимого сообщений**.
|
||||
|
||||
- Текст сообщений, `display_name`, `title` чата, тела запросов и ответов
|
||||
целиком. Вместо текста — идентификаторы и размеры
|
||||
(`text_length=len(text)`).
|
||||
- Пароли, токены сессий и их хэши, заголовок `Authorization` (`auth.md`);
|
||||
с лабы 3 — `Idempotency-Key` (ни целиком, ни частью: ключ выбирает
|
||||
клиент, в нём может оказаться что угодно; повтор виден по
|
||||
`replayed=true` и `message_id`); с лабы 4 — ключи доступа и секреты
|
||||
S3, ключ подписи служебных вызовов, подписи запросов к S3 (заголовок
|
||||
`Authorization`, параметры подписанного URL) и байты объектов. Для
|
||||
обращений к S3 допустимы адрес S3, bucket, ключ объекта, размер,
|
||||
длительность и класс ошибки (спек `service-logging`). Клиент
|
||||
(`src/infra/s3/client.py`, модуль `object_storage`) пишет `warning`
|
||||
«Object storage is unavailable» на отказ и таймаут, `error` с кодом
|
||||
ошибки S3 — «Object storage rejected credentials» (неверный ключ или
|
||||
подпись), «Object storage denied access» (`AccessDenied`) и «Object
|
||||
storage bucket is missing» (`NoSuchBucket`), `debug` на успешный
|
||||
вызов; текста исключения botocore в записи нет. Запись «Started API» —
|
||||
с `s3_host`, `s3_port`, `s3_bucket`; пустые ключи — `warning`. С change
|
||||
`upload-memory` в ней же `uploads_max_concurrent`,
|
||||
`uploads_max_waiting`, `uploads_wait_timeout_seconds`,
|
||||
`uploads_body_timeout_seconds`, с change `track1-queue-overload` —
|
||||
`uploads_max_unfinished_jobs` (спек `service-configuration`,
|
||||
«Параметры загрузок»).
|
||||
- С лабы 4 — `filename` вложений (его выбирает пользователь) и байты
|
||||
изображений. Модуль `attachment_service` пишет `info` «Uploaded
|
||||
attachment» (`attachment_id`, `chat_id`, `size_bytes`,
|
||||
`content_type`, `width`, `height`, `waited_ms`, `duration_ms`), `info`
|
||||
«Rejected attachment» с `reason` (`type`, `declared_size`, `size`,
|
||||
`content`, `content_mismatch`, `damaged`, `pixels`, `interrupted`; с
|
||||
change `upload-memory` — `busy` с `waited_ms`: места заняты, 429, и
|
||||
`body_timeout` с `size` прочитанного: тело не пришло за срок, 400; с
|
||||
change `track1-queue-overload` — `backlog` с `unfinished` и `limit`: предел
|
||||
заданий, 429; профиль очереди сверяет эти записи с числом 429),
|
||||
`chat_id` и `filename_length`, `error` «Attachment content is missing» / «…size
|
||||
differs» с `attachment_id` и `object_key`. С change
|
||||
`upload-consistency`: `warning` «Attachment upload left pending» с
|
||||
`attachment_id` и `step` (`put`, `ready`, `commit`), `info` «Deleted
|
||||
attachment object» или `warning` «Attachment object kept for cleaner»
|
||||
(`object_key`, `error_type`) о компенсации, `error` «Pending
|
||||
attachment was removed before ready». `MessageService` пишет
|
||||
`attachments_count` в «Created message» и «Rejected message
|
||||
attachments». Поле `filename` у записей — место вызова в коде
|
||||
(`CallsiteParameterAdder`), а не имя файла вложения.
|
||||
- Stack trace — только в лог, никогда в ответ.
|
||||
|
||||
## Журнал уборщика (с лабы 4)
|
||||
|
||||
Спек `service-logging`, «Журнал уборщика»; design change
|
||||
`upload-consistency`. Тот же `get_logger()`, `instance_id` — hostname
|
||||
контейнера уборщика.
|
||||
|
||||
- `cleaner` (`src/cleaner/main.py`): `info` «Started cleaner»
|
||||
(`interval_seconds`, `pending_grace_seconds`, `batch_size`,
|
||||
`live_upload_bound_seconds`, `once`, адрес и имя базы, размер пула,
|
||||
`s3_host`, `s3_port`, `s3_bucket`), `info` «Stopped cleaner»
|
||||
(`exit_code`), `error` «Cleaner grace period is not longer than live
|
||||
upload bound» (grace, оба срока, граница), `error` «Cleanup pass
|
||||
failed» с traceback. Неверные настройки — запись «Invalid cleaner
|
||||
settings» мимо structlog (`early_stop.write_record`: `loc` и `msg`
|
||||
ошибок, без значений полей), «Stopped cleaner before startup» — как у
|
||||
API.
|
||||
- `attachment_cleanup_service`: `info` «Removed stale attachment»
|
||||
(`attachment_id`, `object_key`, `age_seconds`) — после commit
|
||||
транзакции уборки (второй шаг строки: объект и строка под
|
||||
блокировкой); пометка (первый шаг) и пропуск занятой строки своих
|
||||
записей не пишут, пропуски видны в `skipped`; итог прохода
|
||||
«Finished cleanup pass» / «Interrupted cleanup pass» (`removed`,
|
||||
`skipped`, `interrupted_by`, `duration_ms`): `warning` при отказе S3
|
||||
или БД, `info`, если что-то убрано или проход остановлен сигналом,
|
||||
иначе `debug` — пустой проход раз в минуту журнал не засоряет.
|
||||
- Причину отказа пишет нижний слой: клиент S3 (`object_storage`) и
|
||||
`session_scope` под единицей работы (`database`, `warning` «Database is
|
||||
unavailable»; та же запись у общего срока JSON-запроса — `deadline_scope`);
|
||||
сервис только называет `interrupted_by`.
|
||||
- Сверка bucket и БД (спек `service-logging`, «Журнал сверки»; design
|
||||
change `track2-reconciler`, решение 8), модуль
|
||||
`attachment_reconcile_service`, `method=reconcile`, `apply`:
|
||||
- находка, которая осталась, — `warning` «Found storage discrepancy»;
|
||||
исправленная — `info` «Fixed storage discrepancy» с `action`
|
||||
(`deleted_object`, `marked_lost`, `cleared_lost`, `removed_pending`).
|
||||
Поля: `kind`, `object_key`, `attachment_id`, `age_seconds`, а
|
||||
`size_bytes` и `stored_size` — только если размеры разные. Отдельных
|
||||
записей — не больше `RECONCILE_FINDINGS_LOGGED_MAX` (1000) за проход,
|
||||
остальные — `unlogged` в итоге;
|
||||
- итог — «Finished reconcile pass» (`listed_objects`, `checked_rows`,
|
||||
`found` и `fixed` по классам, `remaining`, `fresh_objects`,
|
||||
`fresh_rows`, `lost_known`, `refused`, `unlogged`, `interrupted_by`,
|
||||
`duration_ms`): `info`, если ничего не осталось, иначе `warning`;
|
||||
- предел — `error` «Reconcile changes exceed limit» (`changes`,
|
||||
`max_changes`, с change `track2-reconcile-cost` — `unchecked`;
|
||||
`changes` после раннего отказа — `max_changes + 1`, нижняя граница);
|
||||
- стоимость прохода (change `track2-reconcile-cost`, решения 8 и 15):
|
||||
записи прохода связаны полями `strategy` и `deep`; итог ещё называет
|
||||
`max_objects_per_second`, `storage_objects`, `s3_requests` (`list`,
|
||||
`head`, `get`, `delete`), `read_bytes`, `db_sessions`, `unchecked`,
|
||||
`phase_ms` (`list`, `rows`, `stale`, `recheck`, `act`) — ключи
|
||||
постоянные, значения числа; «Started cleaner» — ещё
|
||||
`reconcile_max_objects_per_second`, а у разового прохода
|
||||
`reconcile_strategy` и `reconcile_deep` (у сервиса — `null`). SHA-256
|
||||
объектов и строк в записях нет;
|
||||
- непредвиденная ошибка — `error` «Reconcile pass failed» с traceback
|
||||
(`cleaner`); «Started cleaner» с change называет ещё `mode`,
|
||||
`reconcile_interval_seconds`, `reconcile_page_size`,
|
||||
`reconcile_max_changes`, `reconcile_apply`;
|
||||
- зависшую загрузку сверка убирает шагом уборщика: «Removed stale
|
||||
attachment» пишет `attachment_cleanup_service`;
|
||||
- реплика API на скачивание помеченного оригинала — `info` «Attachment
|
||||
content is lost» (`attachment_id`, `object_key`), а не `error`.
|
||||
- `filename`, ключей и секретов S3, подписей в записях уборщика нет.
|
||||
|
||||
## Где логировать
|
||||
|
||||
| Слой | Логи | Логгер модуля |
|
||||
|---|---|---|
|
||||
| `core/repos` | **никогда** | нет |
|
||||
| `core/services/<domain>.py` | в каждом методе с побочным эффектом | `module="<domain>_service"` |
|
||||
| `api/routers/v1/<domain>.py` | только заметные шаги, которых не видно из сервиса | `module="api_<domain>_router"` |
|
||||
| `api/middlewares` | access-лог: одна строка на запрос; health не логировать | `middleware="http"` |
|
||||
| `api/errors.py` | не логирует: 4xx — штатные ответы, а traceback непредвиденной ошибки пишет uvicorn (`uvicorn.error`, с `request_id` из contextvar) после повторного броска исключения Starlette | нет |
|
||||
| `infra/<client>.py` | подключение, закрытие, ошибки; запросы к внешним API (`debug`) | `module="<client>"` (S3 — `object_storage`) |
|
||||
| `main.py` | старт (host, port, режим), начало и конец shutdown | `module="startup"` |
|
||||
| `infra/early_stop.py` | только остановка до старта сервера, одна запись без structlog (раздел выше) | нет, поле `module` — `startup` |
|
||||
| чистые функции | не логируют, бросают доменные исключения | нет |
|
||||
|
||||
Строки старта и shutdown нужны на защите: по ним видно, что SIGTERM
|
||||
отработал за заявленный срок.
|
||||
|
||||
## Как логировать
|
||||
|
||||
Логгер модуля один, сразу после импортов:
|
||||
|
||||
```python
|
||||
from src.infra.logger import AbstractLogger, get_logger
|
||||
|
||||
logger: AbstractLogger = get_logger().bind(module="chat_service")
|
||||
```
|
||||
|
||||
Contextvar-ы `http_request_id` и `current_user_id` лежат в этом же
|
||||
модуле; ставят их только request-id middleware и `get_current_user`.
|
||||
|
||||
- В начале метода с побочным эффектом —
|
||||
`log = logger.bind(method="create_chat", chat_id=..., members_count=...)`.
|
||||
В `bind` идут идентификаторы, по которым лог будут искать.
|
||||
- Вложенный шаг большой операции принимает `log: AbstractLogger`
|
||||
параметром и пишет через него.
|
||||
- Сообщение — константная строка на английском: прошедшее время для
|
||||
результата («Created chat»), -ing для начала («Creating chat»).
|
||||
Переменные данные только в kwargs, не в f-string.
|
||||
- Исключения: `error=str(e)`; `exc_info=e` — только там, где нужен
|
||||
traceback непредвиденной ошибки.
|
||||
- Только `get_logger()`: без `print`, `traceback.print_exc()` и
|
||||
`logging.getLogger`.
|
||||
|
||||
Уровни: `debug` — промежуточные шаги; `info` — бизнес-событие (создан
|
||||
пользователь, чат, сообщение), старт и остановка; `warning` —
|
||||
обработано, но требует внимания; `error` — операция не выполнена,
|
||||
непредвиденное исключение. `critical` не используется.
|
||||
@@ -0,0 +1,185 @@
|
||||
---
|
||||
paths:
|
||||
- "migrations/**"
|
||||
- "alembic.ini"
|
||||
- "src/infra/db/models/**"
|
||||
---
|
||||
|
||||
# Миграции alembic и модели
|
||||
|
||||
Основа — правила bp_proxies; отличия продиктованы контрактом и
|
||||
рубрикой лаб 2–3.
|
||||
|
||||
- Схема — до запросов: таблицы, ограничения, индексы и транзакционные
|
||||
границы описываются в design change раньше, чем пишутся repo
|
||||
(`README.md`, «Что сделать», п. 1).
|
||||
- `alembic upgrade head` поднимает схему на пустом volume и повторно
|
||||
отрабатывает без ошибок и без дублей. Данные миграции не сеют:
|
||||
тестовых пользователей создают тесты через API.
|
||||
- Обязательно для «3»: первичные и внешние ключи (участник → чат и
|
||||
пользователь, сообщение → чат и отправитель), уникальный `username`,
|
||||
уникальная пара чат–участник. Таблица сессий, если сессии в
|
||||
Postgres, — `auth.md`.
|
||||
- Лаба 3 — таблица `idempotency_keys` (модель `IdempotencyKey`,
|
||||
ревизия `7652184b7016`): первичный ключ `(user_id, chat_id, key)`;
|
||||
составной внешний ключ `(chat_id, user_id) → chat_members` (ключ есть
|
||||
только у участника — этим же выполнены ссылки на пользователя и чат);
|
||||
`message_id → messages` `DEFERRABLE INITIALLY DEFERRED` — ключ
|
||||
вставляется раньше сообщения в той же транзакции; SHA-256 тела
|
||||
(`CHECK` на 32 байта); `created_at` и индекс по нему (ручная очистка
|
||||
просроченных). Длину ключа (1–128) и формат держит ещё и `CHECK`.
|
||||
- С лабы 3 миграция совместима с работающей версией API: при rolling
|
||||
update старые реплики работают на новой схеме, пока их не заменят
|
||||
(`balancer.md`, спек `db-migrations`). Поэтому только расширение —
|
||||
новые таблицы, колонки с `server_default` или `NULL`, индексы
|
||||
`CONCURRENTLY` вне транзакции. Удаление и переименование — отдельной
|
||||
миграцией после того, как старой версии не осталось (expand/contract);
|
||||
если так нельзя — ограничение в `REPORT.md`. Откат кода к прежнему
|
||||
образу не требует отката схемы (`make rolling_update COMMIT=<прежний>
|
||||
MIGRATE=0`): прежний код на расширенной схеме работает.
|
||||
- Пример — ревизия `e656d6bbe1a4`: колонка `messages.instance_id`
|
||||
(`text NULL`, реплика, которая записала сообщение). Новый код её
|
||||
пишет и без неё упал бы, старый не знает: вставка перечисляет свои
|
||||
колонки, чтение выбирает свои (design change `rolling-update`,
|
||||
решение 7).
|
||||
- Первой строкой ревизии, которая берёт `ACCESS EXCLUSIVE` на
|
||||
рабочую таблицу (`ADD COLUMN`, `ALTER`), — `op.execute("SET LOCAL
|
||||
lock_timeout = '2s'")`: в очереди за ожидающей блокировкой стоят
|
||||
все новые запросы к таблице, и чужая долгая транзакция остановила
|
||||
бы запись всех реплик. По сроку миграция падает без изменений,
|
||||
замена не начинается, повтор проходит.
|
||||
- Ревизия `ef25d50b01a8` (лаба 4, design change `attachments`,
|
||||
решение 3): таблицы `attachments` (составной FK `(chat_id,
|
||||
owner_id) → chat_members`, CHECK размера, SHA-256 32 байта, типа,
|
||||
статуса, длины и символов `filename` — `!~ '[/\\\u0001-\u001f\u007f-\u009f]'`,
|
||||
уникальный `object_key`) и `message_attachments` (PK `(message_id,
|
||||
position)`, `position` 0–9, уникальная пара `(message_id,
|
||||
attachment_id)`, индекс по `attachment_id`, FK без `ON DELETE`).
|
||||
Плюс **ослабление** `ck_messages_text_length` с `1–4000` до
|
||||
`<= 4000`: `DROP CONSTRAINT` и `ADD CONSTRAINT … NOT VALID` в той же
|
||||
транзакции. Прежние строки строже нового условия, проверять их
|
||||
нечего, а `VALIDATE` держал бы `ACCESS EXCLUSIVE` на время полного
|
||||
просмотра `messages`. Не `autocommit_block`: он зафиксировал бы DDL
|
||||
раньше `alembic_version`, и сбой оставил бы неповторяемую миграцию.
|
||||
Отметка «не проверено» в каталоге — цена, она в `REPORT.md`.
|
||||
`downgrade` — зеркально, строгое ограничение тоже `NOT VALID`.
|
||||
Autogenerate изменение CHECK не видит; имя ограничения — через
|
||||
`op.f(...)`, иначе шаблон имён даст `ck_messages_ck_messages_…`.
|
||||
- Ревизия `739b8f04d5fb` (лаба 4, design change `upload-consistency`,
|
||||
решение 6): частичный индекс `ix_attachments_pending_created_at` на
|
||||
`attachments (created_at, id) WHERE status = 'pending'` — кандидаты
|
||||
уборщика keyset. Индекс на рабочей таблице — только `CONCURRENTLY`:
|
||||
обычный `CREATE INDEX` берёт `SHARE` и останавливает запись загрузок
|
||||
на время сборки. `CONCURRENTLY` не работает в транзакции, поэтому
|
||||
`with op.get_context().autocommit_block()`; в нём `SET LOCAL` не
|
||||
действует — `SET lock_timeout = '2s'` на уровне сессии и `RESET
|
||||
lock_timeout` в конце. `create_index(..., postgresql_concurrently=True,
|
||||
if_not_exists=True)`: повтор после сбоя проходит. `downgrade` —
|
||||
`drop_index(..., postgresql_concurrently=True, if_exists=True)` так
|
||||
же. Модель — `Index(..., postgresql_where=text(...))` в `Attachment`;
|
||||
autogenerate условие не видит, ревизия руками. Проверено: с нуля,
|
||||
повтор, откат и снова `upgrade` на асинхронном `env.py`,
|
||||
`indisvalid` — true.
|
||||
- Ревизия `5c3e1f0a9b7d` (лаба 4, design change `track2-reconciler`,
|
||||
решение 6): колонка `attachments.lost_at timestamptz NULL` без
|
||||
значения по умолчанию — время, когда сверка подтвердила потерю
|
||||
оригинала. Первой строкой `SET LOCAL lock_timeout = '2s'` (`ADD
|
||||
COLUMN` берёт `ACCESS EXCLUSIVE`, но меняет только каталог — 0,36 мс
|
||||
на пробе), `downgrade` — `drop_column` с тем же сроком. Индекса нет:
|
||||
сверка просматривает все `ready`, API читает по `id`; CHECK «помечено
|
||||
только `ready`» не добавлен (на существующей таблице — `NOT VALID` или
|
||||
скан под блокировкой), пометку ставит только условный `UPDATE`.
|
||||
Прежние реплики колонку не читают и не пишут. Проверено на временной
|
||||
базе: с нуля, повтор, `downgrade -1`, снова `upgrade`, `--sql`;
|
||||
- Ревизия `a1d4c7e90b23` (лаба 5, design change `async-attachments`, решение
|
||||
1): `attachments.staging_key`, `error_code` (NULL), таблицы `attachment_jobs`
|
||||
(FK без каскада, UNIQUE вложение + версия, CHECK состояния и попыток) и
|
||||
`attachment_variants` (PK — ключ эффекта, UNIQUE `object_key`, CHECK).
|
||||
Статус — ослабление: `DROP` и `ADD CHECK … NOT VALID` в той же транзакции, как
|
||||
`ck_messages_text_length`; новый `ck_attachments_error_code_failed` тоже `NOT
|
||||
VALID`: прежние строки условию отвечают. Первой строкой `SET LOCAL lock_timeout
|
||||
= '2s'`; `downgrade` — зеркально. Прежний образ на новой схеме работает, но
|
||||
падает 500 на чтении строки нового статуса: ограничение в `REPORT.md`.
|
||||
- Ревизии `c7e2f1a04b56` и `d3f9a6b2c1e7` (лаба 5, design change
|
||||
`pipeline-reliability`, решение 10). Первая, атомарная, первой строкой `SET LOCAL
|
||||
lock_timeout = '2s'`: `attachment_jobs.attempt_base` (`NOT NULL DEFAULT 0`), CHECK
|
||||
`attempt_base BETWEEN 0 AND attempt NOT VALID`, таблица `attachment_job_replays`
|
||||
(FK на задание без каскада). Вторая — `autocommit_block`, `SET lock_timeout`,
|
||||
`CONCURRENTLY`, `if_not_exists`: `ix_attachment_jobs_outbox` по выражению
|
||||
`COALESCE(next_attempt_at, created_at), id`, `ix_attachment_jobs_published`,
|
||||
`ix_attachment_jobs_lease`, `ix_attachments_staging_cleanup`. Autogenerate условие и
|
||||
выражение не видит. У `ix_attachment_jobs_published` условие `published_at IS NOT
|
||||
NULL` запрос называет явно: без него общий план на пробе — Seq Scan. Прежний образ
|
||||
на новой схеме работает: новых статусов и `error_code` нет.
|
||||
- Ревизия `e4b8c2d17f90` (лаба 6, design change `job-trace-propagation`, решение 4):
|
||||
`attachment_jobs.traceparent` и `tracestate` (`text NULL`) — контекст W3C загрузки,
|
||||
CHECK `ck_attachment_jobs_traceparent` (шаблон `jobs.schema.json` версии `00`) и
|
||||
`ck_attachment_jobs_tracestate` (1–512 символов и только вместе с `traceparent`) — оба `NOT
|
||||
VALID`, как `ck_attachment_jobs_attempt_base`. Первой строкой `SET LOCAL lock_timeout = '2s'`,
|
||||
`downgrade` — зеркально. Прежний код колонок не пишет и не читает. Проверено на временной
|
||||
базе: с нуля, повтор, `downgrade -1`, снова `upgrade`, `--sql`, `alembic check` — изменений
|
||||
нет.
|
||||
- **INVALID-индекс.** Прерванная `CREATE INDEX CONCURRENTLY` (сбой,
|
||||
`lock_timeout`, Ctrl+C) оставляет индекс с `pg_index.indisvalid =
|
||||
false`, и `IF NOT EXISTS` его не пересоздаст: повтор миграции
|
||||
«пройдёт», а индекс останется негодным. Проверка — `SELECT
|
||||
indisvalid FROM pg_index WHERE indexrelid =
|
||||
'ix_attachments_pending_created_at'::regclass`; починка — `DROP INDEX
|
||||
CONCURRENTLY ix_attachments_pending_created_at;`, затем `alembic
|
||||
downgrade` на ревизию раньше (или правка `alembic_version`) и снова
|
||||
`upgrade`. Запросы к частичному индексу пишут статус константой, а
|
||||
не параметром (`repo-layer.md`).
|
||||
- `lock_timeout` миграции меньше `[database] statement_timeout_ms`
|
||||
приложения (5 с) с запасом. Запросы в очереди за миграцией ждут
|
||||
её отказа, и при равных сроках все они получали 503 вместе с ним:
|
||||
6 из 6 запросов в полёте (verify change `rolling-update`,
|
||||
`evidence/rollout/script-failures.md`). С 2 с они дожидаются отказа
|
||||
миграции и выполняются, цена — задержка до 2 с.
|
||||
|
||||
- Модели — `src/infra/db/models/<domain>.py`. `Base` даёт `created_at`
|
||||
и `to_dict()`. Новая модель экспортируется в `models/__init__.py`,
|
||||
иначе autogenerate её не видит.
|
||||
- Первичный ключ — `UUID`, значение генерирует сервис (`uuid4()`):
|
||||
контракт отдаёт UUID. Автоинкремент не использовать.
|
||||
- Время — `DateTime(timezone=True)` (`timestamptz`), aware UTC: контракт
|
||||
требует `...Z`. В bp_proxies было naive UTC — здесь так нельзя.
|
||||
- Индексы под запросы контракта: `(chat_id, created_at, id)` для
|
||||
keyset-истории, уникальный `username`, участник → чаты. Индекс
|
||||
истории обосновывается запросом и `EXPLAIN (ANALYZE, BUFFERS)` на
|
||||
≥10 000 сообщениях (уровень 4), вывод — в `evidence/`.
|
||||
- Колонки типизированы `Mapped[...]`, внешние ключи — через
|
||||
`ForeignKey`.
|
||||
- Имя файла ревизии `YYYY_MM_DD_HHMM-<rev>_<slug>.py` (`file_template`
|
||||
в `alembic.ini`). Сообщение короткое, на английском, в прошедшем
|
||||
времени («added chats tables»). Пустая ревизия (`pass` в `upgrade`) —
|
||||
удалить.
|
||||
- Autogenerate не видит: новые значения enum, изменение
|
||||
`server_default`, частичные индексы (`postgresql_where`),
|
||||
переименования (сделает drop + create). Их правят руками.
|
||||
- `NOT NULL` на существующей таблице — с `server_default` или с
|
||||
backfill через `op.execute` перед `alter_column`.
|
||||
- Constraint-ы именованные, чтобы `downgrade` мог их снять. `downgrade`
|
||||
зеркалит `upgrade` в обратном порядке. Применённую ревизию не
|
||||
редактировать: новая ревизия поверх.
|
||||
- Миграции применяются до старта API: в compose — отдельный
|
||||
одноразовый сервис на образе API (`docker.md`), API ждёт
|
||||
`service_completed_successfully`; в консоли — `make run_dev` через
|
||||
`make upgrade`. Не `sh -c "alembic upgrade head && python -m src"`
|
||||
(сервер перестаёт быть PID 1) и не из lifespan: реплик несколько, и
|
||||
каждая гонялась бы с остальными за одну схему. Сервис `migrate`
|
||||
выполняется один раз на `up`, реплики ждут его завершения; повторный
|
||||
запуск — no-op. При поочерёдной замене — один запуск на новом образе до
|
||||
первой новой реплики (`scripts/rolling-update.sh`): пересоздаётся
|
||||
контейнер самого сервиса (`up --no-deps --force-recreate
|
||||
--exit-code-from migrate migrate`), а не одноразовый `run --rm`. Иначе
|
||||
в стенде остался бы `migrate` прежнего образа, и `restart.sh` (`start
|
||||
api` запускает его как зависимость) падал бы на «Can't locate
|
||||
revision» (`balancer.md`).
|
||||
- `migrations/env.py` — асинхронный шаблон alembic: URL из
|
||||
`settings.database.url`, мимо ConfigParser (`%` в пароле ничего не
|
||||
ломает), журнал — JSON через `src/infra/logger.py`. Синхронный
|
||||
`env.py` с asyncpg, как в bp_proxies, на SQLAlchemy 2.1 не работает:
|
||||
флаг `async_fallback` удалён. Ревизии — обычный синхронный `op.*`.
|
||||
- В ревизиях — литералы, а не константы `src`: применённая ревизия не
|
||||
меняется вместе с кодом. Autogenerate для новой таблицы рендерит и
|
||||
`CHECK`; для существующей таблицы новые `CHECK` дописываются руками.
|
||||
@@ -0,0 +1,146 @@
|
||||
---
|
||||
paths:
|
||||
- "src/core/repos/**"
|
||||
- "src/core/ports/**"
|
||||
---
|
||||
|
||||
# Слой repo (`src/core/ports/<domain>.py`, `src/core/repos/<domain>.py`)
|
||||
|
||||
Только доступ к данным. Ни бизнес-логики (проверок доступа, валидации),
|
||||
ни логов, ни внешних вызовов.
|
||||
|
||||
- Порт — `Abstract<Domain>Repository(abc.ABC)` в `src/core/ports/<domain>.py`:
|
||||
абстрактный метод и докстринг-контракт (что значат `None` и `False`, какие
|
||||
условия у перехода). Импорты порта — только DTO, enum и `src.utils`: без
|
||||
SQLAlchemy. Реализация — `SqlAlchemy<Domain>Repository(порт)` в
|
||||
`src/core/repos/<domain>.py` с `self._session`; подробности SQL (почему
|
||||
константа, какой индекс) — у неё. Модульные помощники (`_to_dto`,
|
||||
`MESSAGE_COLUMNS`) остаются модульными (change `unit-of-work`, решения 1 и
|
||||
9).
|
||||
- **Новый метод — порт, SQL, фейк `service-tests/fakes/repos.py` и проверка
|
||||
в `service-tests/repo_contract.py`,** если по результату ветвится сервис.
|
||||
Иначе `make service_test` падает и называет класс и метод.
|
||||
- Методы — только keyword-only (`*,`); вызывающий передаёт параметры по имени.
|
||||
- **Одна атомарная операция на метод:** максимум один
|
||||
`self._session.execute(...)`. Нужна вторая выборка — второй метод,
|
||||
CTE, подзапрос или `.returning(...)`.
|
||||
- Запросы — только через SQLAlchemy (Core или ORM) с параметрами; SQL
|
||||
из f-строк и конкатенации запрещён (уровень 4). `text()` — только с
|
||||
bind-параметрами.
|
||||
- Уникальность проверяется в том же методе, что и вставка:
|
||||
`pg_insert(...).on_conflict_do_nothing(...).returning(...)`. При
|
||||
конфликте метод возвращает `None`, исключение бросает сервис.
|
||||
- Наружу отдаются DTO (`.claude/rules/dto.md`), а не ORM-объекты:
|
||||
`expunge` и `<Entity>FullDTO(**row.to_dict())` либо DTO из выбранных
|
||||
колонок, а не `select(Model)`.
|
||||
- Никаких `commit()` / `rollback()`: транзакцией управляет сервис.
|
||||
- Мутации возвращают осмысленный результат: созданный DTO, `bool`,
|
||||
`None` при конфликте.
|
||||
- Keyset-страница: параметры `after: tuple[datetime, UUID] | None` и
|
||||
`limit`, выборка `limit + 1` элементов, чтобы сервис узнал о следующей
|
||||
странице. Условие — `tuple_(Model.created_at, Model.id) > tuple_(...)`,
|
||||
`ORDER BY created_at, id`, `LIMIT`, по индексу
|
||||
`(chat_id, created_at, id)`. Без `OFFSET` и `count(*)`: уровень 4
|
||||
запрещает полный scan истории на каждую страницу, план подтверждается
|
||||
`EXPLAIN (ANALYZE, BUFFERS)` (`migrations.md`).
|
||||
- Опциональные фильтры и лимиты — условное дополнение выборки
|
||||
(`if limit is not None: ...`).
|
||||
- Логов в репозиториях нет: ни `get_logger`, ни `print`.
|
||||
- Repo ключей идемпотентности (`idempotency.py`, лаба 3) — два метода
|
||||
(design change `instance-id-idempotency`, решение 3):
|
||||
- `claim_key` — одно выражение `pg_insert(...).on_conflict_do_update(
|
||||
set_=..., where=created_at < expired_before).returning(...)`.
|
||||
`True` — ключ свободен: новый или просроченный, который заменён тем
|
||||
же выражением; `False` — занят и действует. `DO UPDATE`, а не
|
||||
`DO NOTHING`: иначе замене просроченного ключа нужны были бы ещё
|
||||
`DELETE` и повторная вставка, то есть ещё одна гонка. Занятая строка
|
||||
блокируется до конца транзакции даже при ложном `WHERE`;
|
||||
- `get_key_result` — хэш тела и сообщение (`JOIN messages`).
|
||||
|
||||
Порог `expired_before`, решение «повтор или 409» и commit — в
|
||||
сервисе. Ключ в исключения и логи не попадает.
|
||||
- Repo вложений (лаба 4, design change `attachments`, решения 3, 4, 8):
|
||||
- `attachment.py`: `insert_attachment` (`created_at` и `updated_at`
|
||||
одним значением), `mark_queued` (`UPDATE … WHERE status = 'pending'
|
||||
AND updated_at = created_at RETURNING`, `None` — строки `pending` нет
|
||||
или уборщик пометил её к уборке), с лабы 5 (design change
|
||||
`async-attachments`, решения 1–3) `mark_processing`,
|
||||
`return_to_queued`, `commit_ready`, `commit_failed` — условные `UPDATE`,
|
||||
`updated_at` через `greatest`: часы процессов расходятся, а CHECK
|
||||
`updated_at >= created_at` падал бы; с change `pipeline-reliability`
|
||||
`return_group_to_queued`, `replay_failed`, `lock_attachment` (`FOR NO KEY
|
||||
UPDATE`), `get_staging_candidates`, `lock_staging_candidate` (`FOR NO KEY
|
||||
UPDATE SKIP LOCKED`), `clear_staging_key` (`updated_at` не меняется);
|
||||
`attachment_job.py` (`insert_job`, `lock_job` — `FOR UPDATE`, `get_job`,
|
||||
`get_attachment_job`, `start_attempt`, `return_to_queued` с условием своей
|
||||
попытки, `finish_job`; relay — `lock_due_jobs` (`FOR UPDATE SKIP LOCKED`,
|
||||
порядок по выражению индекса), `count_published`, `count_unfinished` (сумма трёх
|
||||
`count(*)` с `LIMIT` на группу по условиям частичных индексов outbox, опубликованных
|
||||
и аренды: цена не растёт с превышением, число выше предела неточно, design change
|
||||
`track1-queue-overload`, решение 3), `mark_published` пакета,
|
||||
`recover_expired_leases`, `has_published_before`, `reset_published_before`;
|
||||
`replay_job`, `list_failed` — состояние в выборках relay константой
|
||||
`literal_execute`; с design change `job-trace-propagation`, решения 4 и 9:
|
||||
`insert_job` пишет `traceparent` и `tracestate`, `_JOB_COLUMNS` их читает;
|
||||
`queue_snapshot(now)` — одно выражение из подзапросов по условиям частичных
|
||||
индексов outbox (по выражению срока — `scheduled` и `outbox`), опубликованных и
|
||||
аренды, `LEAST` трёх `min(created_at)`, состояния константой, иначе Seq Scan),
|
||||
`attachment_job_replay.py` (`insert_replay`,
|
||||
`get_job_replays`) и
|
||||
`attachment_variant.py` (`insert_variant` — `ON CONFLICT DO NOTHING`,
|
||||
`get_variants`, `get_variant`);
|
||||
`get_attachment`, `get_attachments` (до 10 строк по первичному
|
||||
ключу). Значения `content_type` и `status` — `.value` enum на
|
||||
записи и enum в DTO на чтении. Для уборщика (design change
|
||||
`upload-consistency`, решение 3): `get_stale_pending` (keyset по
|
||||
`(created_at, id)`, `status = 'pending'`, `created_at <
|
||||
older_than`, `LIMIT`), `lock_stale_pending` (те же условия по `id`,
|
||||
`FOR UPDATE SKIP LOCKED`; `None` — строки нет, она `ready` или её
|
||||
держат), `mark_removing` (пометка к уборке: `updated_at` = время
|
||||
уборщика, позже `created_at`; без миграции, CHECK
|
||||
`updated_after_created` выполняется), `delete_attachment`
|
||||
(`RETURNING id`, `bool`); DTO — `AttachmentInListDTO`. Порядок
|
||||
вызовов — в сервисе (`service-layer.md`), два шага: транзакция
|
||||
`lock_stale_pending` → `mark_removing`, затем транзакция
|
||||
`lock_stale_pending` → `delete_original` → `delete_attachment`.
|
||||
Статус в этих выражениях — константа
|
||||
(`literal(..., literal_execute=True)`), а не параметр: условие
|
||||
частичного индекса `ix_attachments_pending_created_at` планировщик
|
||||
доказывает только по константе, и общий план подготовленного
|
||||
выражения asyncpg иначе индекс не взял бы. Для сверки bucket и БД
|
||||
(design change `track2-reconciler`, решения 3–5):
|
||||
`get_attachments_for_objects` (`id = ANY(:ids) OR object_key =
|
||||
ANY(:keys)`, параметры-массивы, план — Bitmap OR `pk_attachments` и
|
||||
`uq_attachments_object_key`, при пустом `keys` — по сути только pk),
|
||||
`get_ready_page` (keyset `ready` по `id`, Index Scan
|
||||
`pk_attachments`), `find_attachment_reference` (строка этого `id` или
|
||||
любая с этим ключом, до двух), `mark_lost` (`UPDATE … SET lost_at
|
||||
WHERE id AND status = 'ready' AND lost_at IS NULL AND object_key
|
||||
RETURNING id`) и `clear_lost` (`lost_at IS NOT NULL` и тот же ключ);
|
||||
`_ATTACHMENT_COLUMNS` выбирает и `lost_at`;
|
||||
- `attachment_object.py` — repo над S3, как `chat_cache.py` над
|
||||
Valkey: модульные функции, первый параметр `storage: ObjectStorage`, один
|
||||
вызов на функцию; порта у этих двух нет (change `unit-of-work`, решение 8). `original_key` собирает `<namespace>/attachments/<id>/
|
||||
original` (namespace — имя базы, `filename` не входит),
|
||||
`put_original`, `open_original` (контекст объекта),
|
||||
`delete_original` (отсутствие объекта — не ошибка; компенсация
|
||||
загрузки и уборщик). Ключ хранится в
|
||||
строке и при чтении берётся из неё, не вычисляется заново. Для сверки:
|
||||
`originals_prefix` (`<namespace>/attachments/`), `is_own_key` (ключ
|
||||
под этим префиксом, без вызова S3), `parse_original_key`
|
||||
(`UUID` ключа `<id>/original` в записи сервера, иначе `None`),
|
||||
`list_originals` (страница списка), `probe_originals` (список с
|
||||
`MaxKeys=1`: bucket на месте и список разрешён), `head_original`; с change
|
||||
`pipeline-reliability` — `staging_prefix`, `is_own_staging_key`,
|
||||
`parse_staging_key`, `list_staging`, `variant_keys` (ключи вариантов всех имён);
|
||||
- `message.py`: `MESSAGE_COLUMNS` с коррелированным подзапросом
|
||||
`ARRAY(SELECT attachment_id … ORDER BY position)` — одно выражение на
|
||||
страницу и на сохранённый результат ключа; план — `SubPlan` по
|
||||
`pk_message_attachments` на строку страницы, индекс истории прежний.
|
||||
DTO — `to_message_dto` (массив → кортеж). Вставка сообщения
|
||||
перечисляет свои колонки, связи — `insert_message_attachments` одной
|
||||
многострочной вставкой с `position`.
|
||||
- Repo кэша (`chat_cache.py`) — то же правило над Valkey: первый
|
||||
параметр `cache: Cache`, одна команда на функцию, ключ и формат
|
||||
значения (JSON ↔ DTO) живут здесь. Ключ включает
|
||||
`CACHE_KEY_PREFIX` (версию формата) и `cache.namespace` (имя базы).
|
||||
@@ -0,0 +1,291 @@
|
||||
---
|
||||
paths:
|
||||
- "src/main.py"
|
||||
- "src/__main__.py"
|
||||
- "src/config/settings.py"
|
||||
- "Makefile"
|
||||
- "docker-compose.yml"
|
||||
- ".env.example"
|
||||
- "config_example.toml"
|
||||
---
|
||||
|
||||
# Режимы запуска: console и docker
|
||||
|
||||
Режим задаёт `APP__RUN_MODE` (`settings.app.run_mode`, `RunModeEnum`),
|
||||
дефолт — `console`. В `.env` режим не хранится. Для docker его задают
|
||||
`ENV APP__RUN_MODE=docker` в Dockerfile (чтобы голый `docker run` из
|
||||
README слушал `0.0.0.0`) и литерал в `environment` compose; для консоли —
|
||||
цели Makefile.
|
||||
|
||||
| | console | docker |
|
||||
|---|---|---|
|
||||
| Процесс | `uv run python -m src` на хосте | `python -m src` — PID 1 контейнера |
|
||||
| uvicorn | `127.0.0.1`, `reload=True` по `src/` | `0.0.0.0`, без reload |
|
||||
| Порт | `settings.app.port`: `APP__PORT` из `.env`, без него — 8080 | `APP__PORT` из `.env` внутри каждой реплики (на нём же healthcheck и проверки HAProxy); с лабы 3 `APP_OUT_PORT` публикует только HAProxy |
|
||||
| Хранилища | Postgres, Valkey и S3 — контейнеры compose, приложение ходит на `127.0.0.1:<*_OUT_PORT>` (`settings.md`, «Консоль и docker»); `make run_dev` сам поднимает Postgres, накатывает миграции, поднимает Valkey и S3 с bootstrap | всё в compose, зависимости по имени сервиса; миграции и bootstrap S3 — отдельные сервисы до старта API (`migrations.md`, `docker.md`) |
|
||||
| Рестарт | reload процесса данные и сессии не теряет | рестарт API и хранилищ с volumes данные, сессии и объекты S3 не теряет (`make test-persistence`); кэш Valkey после рестарта пуст |
|
||||
|
||||
## Точка входа
|
||||
|
||||
`python -m src` → `src/__main__.py` → `early_stop.install()`
|
||||
(`src/infra/early_stop.py`, до импорта приложения) → `src.main:main()` →
|
||||
`uvicorn.run("src.main:app", host=..., port=..., reload=...,
|
||||
timeout_graceful_shutdown=..., timeout_keep_alive=..., log_config=None,
|
||||
access_log=False)`. Импорты в `src/__main__.py` — внутри `if __name__ ==
|
||||
"__main__"`: простой импорт модуля обработчики не ставит.
|
||||
Хост выбирается по режиму, как в bp_proxies. `log_config=None` нужен,
|
||||
чтобы uvicorn не перетёр JSON-логирование (`logging.md`).
|
||||
|
||||
- Worker в процессе всегда один. Масштабирование — числом контейнеров
|
||||
`api` за HAProxy (`API_REPLICAS`, `balancer.md`), а не `workers=N`:
|
||||
у каждого процесса свой пул соединений (`infra.md`), и LB должен
|
||||
видеть каждый процесс отдельной репликой со своим `X-Instance-Id`.
|
||||
- SIGTERM: uvicorn перестаёт принимать новые соединения и ждёт текущие
|
||||
запросы до `timeout_graceful_shutdown` (настройка
|
||||
`[app] graceful_shutdown_seconds`, не больше 8 с). Docker шлёт SIGKILL
|
||||
через 10 с, в compose — `stop_grace_period`. Shutdown в lifespan
|
||||
только логирует и закрывает клиенты (`engine.dispose()`,
|
||||
`cache.aclose()`, `object_storage.aclose()`), долгих операций в нём
|
||||
нет.
|
||||
Рубрика уровня 4 требует завершения не дольше 10 с.
|
||||
Сигнал на старте (спек `graceful-shutdown`, «Остановка во время
|
||||
старта»; design change `fix-known-issues`, решения 3–6):
|
||||
- **окно 0** — запуск интерпретатора до `install()`, десятки мс:
|
||||
обработчика нет, PID 1 сигнал теряет. Это ограничение;
|
||||
- **A** — импорт приложения, `Config`, `Server`, цикл событий (~0,7 с
|
||||
в контейнере с 1 CPU): ранний обработчик пишет одну запись `info`
|
||||
«Stopped API before startup» и делает `os._exit(0)` — запросов и
|
||||
соединений ещё нет;
|
||||
- **B** — от `capture_signals` uvicorn до «Uvicorn running on»:
|
||||
uvicorn доводит старт и сразу штатно останавливается («Shutting
|
||||
down», «Stopped API», «Finished server process»), код 0;
|
||||
- **C** — работа: как описано выше;
|
||||
- **D** — после выхода из `capture_signals` uvicorn возвращает ранний
|
||||
обработчик и повторяет пойманный сигнал; `early_stop.disarm()`
|
||||
(первая строка lifespan) его уже снял, и процесс выходит с кодом 0.
|
||||
|
||||
В консоли с reload ранний обработчик есть только у родителя-reloader
|
||||
(до `BaseReload.startup()`): Ctrl+C на старте — код 0 и та же запись
|
||||
вместо traceback. Воркер `src/__main__.py` не выполняет (spawn), его
|
||||
сигналы — от uvicorn. Проверка — `driver.py stop-at-start`.
|
||||
|
||||
С лабы 3 закрытый сокет остановленной реплики HAProxy видит как отказ соединения и
|
||||
перенаправляет запрос на живую; новые запросы на неё перестают идти
|
||||
после проваленных проверок (`balancer.md`, цепочка таймаутов). Под
|
||||
нагрузкой `docker stop` реплики ошибок от её недоступности не даёт —
|
||||
замер профиля `failover` (`bench.md`).
|
||||
- Keep-alive: uvicorn держит простаивающее соединение
|
||||
`[app] keep_alive_seconds` (60 с, `timeout_keep_alive`), а не 5 с по
|
||||
умолчанию. Тогда простаивающее соединение LB → реплика закрывает LB
|
||||
раньше реплики (`balancer.md`, цепочка таймаутов). При SIGTERM uvicorn
|
||||
закрывает простаивающие соединения сразу. Запрос, который LB отправил
|
||||
в такое соединение в тот же миг, получает 502: под нагрузкой
|
||||
200 запросов в секунду — одиночный 502 в части фаз `stop` профиля
|
||||
`failover` (1 из 4 на `459f84c`). Клиенты с новым соединением на
|
||||
запрос (`tests/resilience.py`) его не встречают. Плановая остановка
|
||||
(`scripts/rolling-update.sh`) сначала выводит реплику из LB через его
|
||||
runtime API (`drain`, затем `maint`) и только потом шлёт SIGTERM:
|
||||
слот выведен, и гонки нет (`balancer.md`, design change
|
||||
`rolling-update`, решение 3). Остановка без дренажа (`stop-one.sh`,
|
||||
`docker stop`, профиль `failover`) имитирует отказ, исключение для
|
||||
одиночного 502 к ней по-прежнему относится.
|
||||
- Console-режим — один процесс на `127.0.0.1` без LB, для разработки и
|
||||
скилла `run-mtusi-messenger`. Места загрузок (`[uploads]`) и срок тела
|
||||
в консоли работают, а ограничения буфера приёма сокетов (`sysctls` у
|
||||
`api` в compose, `docker.md`) нет: процесс на macOS, ожидающая
|
||||
загрузка держит в буфере ядра больше 512 KiB — ограничение в
|
||||
`REPORT.md` (design change `upload-memory`, решение 6). Проверки лабы 3 (≥2 реплики, failover,
|
||||
гонка через разные реплики) — только на стенде compose через LB.
|
||||
|
||||
## Телеметрия (с лабы 6)
|
||||
|
||||
Design change `otel-telemetry`, решения 8, 13, 20, и `job-trace-propagation`, решения 7, 15.
|
||||
Консоль (`make run_dev`, `make run_worker`, `make run_relay`) — без телеметрии: «Started API»,
|
||||
«Started worker» и «Started relay» говорят `telemetry_enabled: false`, к `127.0.0.1:4318`
|
||||
обращений нет, модулей SDK трасс и журнала, экспортёра и protobuf в процессе нет (модули SDK
|
||||
метрик грузит сам redis-py — не больше, чем `import redis.asyncio`). На стенде compose её включает окружение `api`,
|
||||
`worker` и `relay`; `make test_isolated`, стенд отказов и `bench/` выключают её у всех трёх.
|
||||
Relay закрывает SDK в окне `gather` закрытия клиентов (0,5 с), «Stopped relay» — после него:
|
||||
худший случай остановки прежний.
|
||||
Остановка: API закрывает SDK после «Stopped API» и ждёт не дольше
|
||||
`TELEMETRY_SHUTDOWN_TIMEOUT_SECONDS` (1 с; 8 с дренажа + 1 с < 10 с; дренаж 9 с с телеметрией —
|
||||
ошибка настроек, `settings.md`), worker — в окне `gather`
|
||||
закрытия клиентов (0,5 с; худший случай прежний, 9,5 с); `shutdown()` провайдеров — в
|
||||
daemon-потоках, процесс их не ждёт. Без Collector и при замороженном Collector сроки прежние
|
||||
(`driver.py telemetry-outage`).
|
||||
|
||||
## Уборщик (с лабы 4)
|
||||
|
||||
`python -m src.cleaner [--once]` → `src/cleaner/__main__.py` →
|
||||
`early_stop.install("cleaner")` до импорта приложения → `main()`
|
||||
(`src/cleaner/main.py`; design change `upload-consistency`, решение 2).
|
||||
В compose — сервис `cleaner` на образе API (`docker.md`), PID 1
|
||||
контейнера, как сервер.
|
||||
|
||||
- Старт: неверные настройки — запись «Invalid cleaner settings» и код
|
||||
2; grace не больше границы живой загрузки — `error` и код 2, до
|
||||
engine и клиента S3; затем обработчики SIGTERM и SIGINT asyncio,
|
||||
`early_stop.disarm()`, «Started cleaner».
|
||||
- Цикл: проход, затем ожидание `[cleaner] interval_seconds` или
|
||||
сигнала. SIGTERM / SIGINT ставят флаг: доводится до commit или отката
|
||||
текущий шаг строки — пометка или уборка (объект и строка одной
|
||||
транзакцией; не дольше срока шага с БД, 6 с, DELETE в S3 внутри него
|
||||
≤ 5 с; флаг проверяется и между шагами), новые не берутся, клиенты
|
||||
закрываются,
|
||||
«Stopped cleaner» и код 0 — раньше `stop_grace_period` 10 с. Сигнал
|
||||
до обработчиков asyncio — ранний обработчик: «Stopped cleaner before
|
||||
startup», код 0.
|
||||
- `--once` — один проход и выход: 0 — дошёл до конца, 1 — прерван
|
||||
отказом хранилища или ошибкой, 2 — неверная конфигурация.
|
||||
- С change `track2-reconciler` (решения 1, 8, 9):
|
||||
- `python -m src.cleaner reconcile [--apply] [--max-changes N]` —
|
||||
разовая сверка bucket и БД, по умолчанию dry-run; в compose —
|
||||
`docker compose run --rm --no-deps cleaner reconcile …`, цель `make
|
||||
reconcile [APPLY=1] [MAX_CHANGES=N]`. Коды: 0 — расхождений нет, 3 —
|
||||
остались (в том числе чужие объекты и отказ по пределу), 1 — прервана
|
||||
отказом, ошибкой или сигналом, 2 — конфигурация (в том числе
|
||||
`--max-changes 0` — ошибка аргумента argparse). Подготовка общая с
|
||||
сервисом: проверка grace, сигналы, `early_stop.disarm()`, engine,
|
||||
клиент S3;
|
||||
- плановая сверка в цикле сервиса: после прохода уборки, если подошёл
|
||||
срок, — `reconcile(apply=True)` с пределом из настроек; первая — при
|
||||
старте, следующая — через `[reconciler] interval_seconds` после
|
||||
конца предыдущей (0 — нет); пауза цикла — меньшее из интервала
|
||||
уборки и времени до сверки. Пока идёт сверка, уборка ждёт;
|
||||
- SIGTERM во время сверки: текущий вызов S3 или шаг с БД доводится,
|
||||
новые страницы и действия не начинаются, итог — `interrupted_by:
|
||||
stop`; сервис выходит с кодом 0, разовый проход — с 1. Паузу предела
|
||||
скорости сигнал прерывает сразу (куски по 0,2 с): остановка — не
|
||||
позже секунды (`driver.py reconcile-signal --pace`). Для этого
|
||||
`src/cleaner/__main__.py` после `main()` выходит `os._exit(code)`
|
||||
(stdout и stderr сброшены, клиенты закрыты): финализация
|
||||
интерпретатора при 0,25 CPU — 0,8–1,5 с (design change
|
||||
`track2-reconcile-cost`, «Уточнения apply», п. 14);
|
||||
- с change `track2-reconcile-cost` (решения 4–6) у разового прохода ещё
|
||||
`--strategy {batch,head}` (по умолчанию `batch`), `--deep` и
|
||||
`--max-objects-per-second R` (≥ 0, иначе ошибка argparse, код 2; без
|
||||
аргумента — `[reconciler] max_objects_per_second`); `make reconcile
|
||||
STRATEGY=head DEEP=1 RATE=R`. Плановая сверка — всегда `batch`, без
|
||||
глубокой, предел из настроек.
|
||||
- Непредвиденная ошибка прохода — `error` с traceback, процесс живёт
|
||||
до следующего прохода; отказ S3 или PostgreSQL — `warning`, без
|
||||
перезапуска (решение 5).
|
||||
- В консоли (`make run_dev`) уборщика нет: зависшие загрузки
|
||||
консольного API убирает уборщик стенда (та же база) или разовый
|
||||
`docker compose run --rm --no-deps cleaner --once`. Цели Makefile
|
||||
нет: образ для него собирает `make run_docker`.
|
||||
|
||||
## Worker (с лабы 5)
|
||||
|
||||
`python -m src.worker` → `src/worker/__main__.py` → `early_stop.install("worker")`
|
||||
→ `main()` (`worker.md`), в compose — сервис `worker`, PID 1. SIGTERM: новые
|
||||
сообщения не берутся, начатые ждут ≤ `[worker] graceful_shutdown_seconds`,
|
||||
остальные отменяются (их процессы обработки убиты), «Stopped worker», код 0,
|
||||
`os._exit`. Сигнал на старте — «Stopped worker before startup». Неверные настройки —
|
||||
код 2. Отказ брокера, S3, PostgreSQL процесс не роняет. Консоль — `make run_dev`
|
||||
(поднимает и брокер) плюс `make run_worker` и `make run_relay` в других терминалах:
|
||||
тот же `.env`, ключи worker в окружении процесса. Без relay консольный API принимает
|
||||
файлы, а задания ждут в PostgreSQL. Лимит памяти процесса обработки на macOS не
|
||||
действует (`worker.md`).
|
||||
|
||||
## Relay (с лабы 5)
|
||||
|
||||
`python -m src.relay` → `src/relay/__main__.py` → `early_stop.install("relay")` →
|
||||
`main()`, в compose — сервис `relay`, PID 1. SIGTERM: текущий шаг доводится (≤ 6 с),
|
||||
новые не начинаются, паузу сигнал прерывает сразу, «Stopped relay», код 0, `os._exit`.
|
||||
Сигнал на старте — «Stopped relay before startup». Неверные настройки — код 2. Отказ
|
||||
брокера и PostgreSQL процесс не роняет. `python -m src.relay replay …` — разовая
|
||||
команда реестра `failed`, коды 0 / 3 / 1 / 2 (`make replay`).
|
||||
|
||||
## Makefile
|
||||
|
||||
- Цели skeleton `help`, `check`, `validate`, `test`, `load`,
|
||||
`test-persistence`, `test-failover` (с лабы 3) не менять:
|
||||
в следующей лабе `Makefile` придёт новый, и свои цели в него
|
||||
переносятся слиянием (AGENTS.md, «Переход в следующую лабу»).
|
||||
- Свои цели — отдельными секциями ниже целей skeleton, в стиле
|
||||
bp_proxies: переменные наверху (`DC=docker compose`), заголовки
|
||||
`# -------------------------`, свой `.PHONY` у каждой цели, имена в
|
||||
snake_case. Apple Container не делать.
|
||||
- Запуск и общие цели:
|
||||
- `run_dev: upgrade start_cache start_s3` — Postgres из compose и
|
||||
миграции, Valkey и S3 с bootstrap из compose, затем
|
||||
`APP__RUN_MODE=console uv run python -m src`;
|
||||
- `run_docker: env_setup` (недостающие `.env` и `config.toml` из
|
||||
шаблонов, затем `DOCKER_BUILDKIT=1 $(DC) build` и `$(DC) up -d`:
|
||||
хранилища → migrate и s3-bootstrap → `api` × `API_REPLICAS` →
|
||||
haproxy),
|
||||
к нему `stop`, `down` (volume остаётся), `logs`
|
||||
(`$(DC) logs -f --no-log-prefix api`: без префикса `api-1 |`
|
||||
каждая строка — JSON, реплику называет поле `instance_id`);
|
||||
- `lint` (`ruff format .` + `ruff check --fix .`, дважды),
|
||||
`env_setup` (шаблоны `.env` и `config.toml`, в новый `.env` —
|
||||
случайные `POSTGRES_PASSWORD`, `VALKEY_PASSWORD` и шесть секретов
|
||||
S3; в существующий `.env` дописываются переменные шаблона, которых
|
||||
в нём нет, секреты — случайными, прежние строки не меняются;
|
||||
печатаются только имена — `settings.md`),
|
||||
`student_test`.
|
||||
|
||||
Оба способа запуска — `run_docker` и `run_dev` — описываются в
|
||||
`REPORT.md`. Запуска одного контейнера без compose нет: API без
|
||||
Postgres не обслуживает запросы.
|
||||
- PostgreSQL и миграции: `start_db` (`$(DC) up -d --wait postgres`),
|
||||
`stop_db`, `upgrade: start_db` (`uv run alembic upgrade head`),
|
||||
`revision: upgrade` (autogenerate, сообщение — `read -p`),
|
||||
`wipe_data` (`$(DC) down -v --remove-orphans` только после ввода
|
||||
`yes`; запрос называет удаляемые volumes Postgres и S3 —
|
||||
`<проект>_postgres_data`, `<проект>_s3_data`). Volumes — именованные
|
||||
`postgres_data` и `s3_data` в compose; `wipe_data` пересоздаёт и
|
||||
Valkey, то есть чистит кэш.
|
||||
- Valkey: `start_cache` (`$(DC) up -d --wait valkey`), `stop_cache`.
|
||||
- S3 (с лабы 4): `start_s3` — `$(DC) up -d --wait s3`, затем `$(DC) up
|
||||
--no-deps --exit-code-from s3-bootstrap s3-bootstrap`: `--wait`
|
||||
одноразовый сервис считает готовым уже запущенным, а код bootstrap
|
||||
нужен цели (design change `s3-storage`, «Уточнения apply», п. 1);
|
||||
`stop_s3` (плавно ~15 с); `s3_check` — `driver.py s3-check`:
|
||||
проверка приватности bucket вне API на запущенном стенде (права ключа
|
||||
API, чужой bucket, административные запросы, аноним с хоста и из
|
||||
сети, порты контейнера S3), таблица «проверка → ожидаемо → получено»,
|
||||
код 1 при нарушении.
|
||||
- Реплики за HAProxy (с лабы 3, `balancer.md`): `replicas` (вернуть
|
||||
остановленные и выставить число, `API_REPLICAS ?= 2` после `-include
|
||||
.env`), `instances` (распределение одной сессии по `X-Instance-Id`),
|
||||
`lb_stats` (слоты HAProxy), `rolling_update` (поочерёдная замена на
|
||||
новый образ без простоя, `COMMIT`, `MIGRATE`).
|
||||
- `student_test` передаёт pytest `EXPECT_REPLICAS` (по умолчанию
|
||||
`API_REPLICAS`): сколько реплик за `BASE_URL` ждут тесты реплик.
|
||||
Против одного процесса — `EXPECT_REPLICAS=1` (`student-tests.md`).
|
||||
- Быстрые тесты (`service-tests.md`): `service_test` — `uv run pytest -c
|
||||
service-tests/pytest.ini service-tests/unit`, без хранилищ и docker;
|
||||
`service_test_db: start_db` — `service-tests/db` на временной базе в PostgreSQL
|
||||
стенда.
|
||||
- `test_isolated: env_setup start_db start_cache start_s3` — образ на
|
||||
временной базе (`student-tests.md`); Valkey и S3 общие с рабочим
|
||||
стендом, ключи кэша и объектов разделены именем базы, префикс
|
||||
`test_<db>/` bucket удаляется при уборке. Один контейнер API без LB: скрипт зовёт `make
|
||||
student_test EXPECT_REPLICAS=1`. Скрипт запускается `$(PYTHON)`, а не
|
||||
`uv run`: uv повторно пересылает SIGINT, и Ctrl+C обрывал уборку.
|
||||
- `failure_checks: env_setup` — проверки отказов на отдельном стенде,
|
||||
проект compose `<рабочий>-failures` (`student-tests.md`). От
|
||||
`start_db` не зависит: стенд свой (Postgres, Valkey, S3) и удаляется
|
||||
вместе с volumes.
|
||||
`FAULT_ARGS` — аргументы pytest (`make failure_checks FAULT_ARGS='-k
|
||||
valkey'`). Скрипт тоже запускается `$(PYTHON)`. Все команды docker
|
||||
проекта отказов — только с `-p <рабочий>-failures`: `down -v` без
|
||||
него удалил бы рабочий volume.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- `make test` падает с 404 на `/health/live` вместо ошибки соединения:
|
||||
на 8080 отвечает чужой сервис. Найти его — `lsof -nP -iTCP:8080
|
||||
-sTCP:LISTEN` и `docker ps`; для своего стенда взять другой
|
||||
`APP_OUT_PORT` и `make test BASE_URL=http://localhost:<порт>`.
|
||||
- Разовая подмена внешнего порта для целей Makefile — только
|
||||
аргументом: `make run_docker APP_OUT_PORT=8090`. Внутренний
|
||||
`APP__PORT` — только в `.env`: его читают и compose, и приложение в
|
||||
console, а аргумент make поменял бы одну переменную make. Префикс
|
||||
`APP_OUT_PORT=8090 make ...` не сработает: `-include .env` перекроет
|
||||
его, и в recipe (в том числе в `docker compose`) уйдёт значение из
|
||||
`.env`.
|
||||
- Поменял `config.toml` и не видишь эффекта: значение перекрыто
|
||||
окружением или `.env` (приоритет env > .env > toml).
|
||||
@@ -0,0 +1,316 @@
|
||||
---
|
||||
paths:
|
||||
- "src/core/services/**"
|
||||
---
|
||||
|
||||
# Слой service (`src/core/services/<domain>.py`)
|
||||
|
||||
Бизнес-логика, проверки доступа, серверные значения (id, время),
|
||||
транзакции, вызовы внешних клиентов, логи.
|
||||
|
||||
- Класс `<Domain>Service`. `__init__` принимает
|
||||
`uow: AbstractUnitOfWork` (`src/core/ports/uow.py`) и хранит её в
|
||||
`self`; кэш Valkey (`cache: Cache`), если он нужен домену, — вторым
|
||||
параметром (`ChatService`, `MessageService`). Методы принимают
|
||||
keyword-only параметры (`*,`) и вызываются только именованными
|
||||
аргументами.
|
||||
- **Граница транзакции — блок единицы работы** (change `unit-of-work`,
|
||||
спек `unit-of-work`, Cosmic Python, глава 6). Один блок — одна
|
||||
транзакция:
|
||||
|
||||
```python
|
||||
async with self.uow:
|
||||
job = await self.uow.jobs.lock_job(job_id=job_id)
|
||||
if job is None:
|
||||
return JobOutcome.ACK # выход без commit — откат
|
||||
await self.uow.jobs.finish_job(...)
|
||||
await self.uow.commit()
|
||||
```
|
||||
|
||||
Выход без `commit()`, в том числе по исключению, откатывает. После
|
||||
`commit()` блок закончен: repo и вторая фиксация — `UnitOfWorkError`,
|
||||
следующая транзакция — следующим блоком. Вложенный блок и repo вне блока
|
||||
— та же ошибка, в том числе на фейке. В сервисах нет `AsyncSession`,
|
||||
SQLAlchemy, реализаций repo на SQL и глобалов хранилищ: это проверяет
|
||||
`service-tests/unit/test_architecture.py`, реализации выбирают точки
|
||||
входа процессов. Экземпляр единицы работы — одна задача: в API на
|
||||
запрос, в worker сервис на доставку, в relay, уборщике, сверке и replay —
|
||||
на сервис. Кэш и S3 в единицу работы не входят: фиксация и откат на них
|
||||
не действуют.
|
||||
- Кэш карточки чата (`chat_cache_repo`, спек `chat-cache`):
|
||||
cache-aside — сначала кэш, при промахе БД и запись в кэш; новый чат
|
||||
пишется в кэш **после** `commit()`, чтобы откат не оставил в кэше
|
||||
чата, которого нет в БД. Отсутствующий чат не кэшируется. Кэшировать
|
||||
можно только неизменяемое: историю, списки и сессии — нет. Отказ
|
||||
Valkey сервис не обрабатывает: `Cache` уже вернул промах.
|
||||
- Repo — через единицу работы: `self.uow.chats.get_chat(chat_id=…)`,
|
||||
только именованные аргументы. `chat_cache` и `attachment_object` остаются
|
||||
модулями: `from src.core.repos import chat_cache as chat_cache_repo`, первый
|
||||
параметр — клиент. Членство внутри чужого блока — `require_member(uow, cache,
|
||||
*, chat_id, user_id)` из `services/chat.py`, требует открытый блок.
|
||||
- Проверка доступа — здесь. Не участник получает то же исключение, что
|
||||
«не найден» (`ChatNotFound`): API отдаст 404 и не раскроет, что чат
|
||||
существует.
|
||||
- Ошибки — доменные исключения из `src/core/exceptions` (новое — в
|
||||
модуль домена и реэкспорт в `__init__.py`). Не `ValueError` и не
|
||||
`HTTPException`: статус и `code` назначает `src/api/errors.py`.
|
||||
- Серверные значения назначает сервис: `id = uuid4()`,
|
||||
`created_at = utcnow()` из `src/utils/utc.py`.
|
||||
- Атомарность — транзакция Postgres. Составная операция (чат вместе с
|
||||
участниками) — все вызовы repo внутри одного блока и один
|
||||
`await self.uow.commit()` в конце. Ошибка до commit — откат при выходе
|
||||
из блока, и в БД не остаётся ничего. Откат составной операции —
|
||||
проверка уровня 4.
|
||||
- Фиксирует только сервис, repo не фиксирует и не откатывает.
|
||||
- Уникальность (`username`) держит ограничение БД, а не проверка
|
||||
перед вставкой: repo делает `ON CONFLICT DO NOTHING RETURNING`,
|
||||
`None` сервис превращает в доменное исключение (→ 409). Схема «сначала
|
||||
SELECT, потом INSERT» ломается на гонке регистрации даже внутри
|
||||
транзакции (READ COMMITTED), а эта гонка — проверка уровня 4.
|
||||
- Идемпотентность отправки сообщения (лаба 3, `api-contract.md`) —
|
||||
в `MessageService.send_message`, в одной транзакции с сообщением:
|
||||
- порядок: сессия уже проверена зависимостью → членство в чате
|
||||
(`ChatNotFound` → 404) → ключ. Повтор проходит обе проверки заново;
|
||||
- ключ вставляется **раньше** сообщения, с `message_id` ещё не
|
||||
вставленного сообщения: внешний ключ на `messages` отложен до
|
||||
commit. Так повтор не пишет и не откатывает сообщение (design
|
||||
change `instance-id-idempotency`, решение 2);
|
||||
- захват — `self.uow.idempotency.claim_key` по `(user_id, chat_id, key)`
|
||||
с порогом `expired_before = now - [idempotency] ttl_seconds`
|
||||
(часы приложения, как у сессий). Захватили (новый или просроченный
|
||||
ключ) — вставка сообщения и один `commit()`. Не захватили — ключ
|
||||
уже есть, в том числе у конкурентного запроса другой реплики:
|
||||
захват ждёт его commit;
|
||||
- существующий ключ: `get_key_result`, затем `commit()` — снять
|
||||
блокировку строки до ответа; проверка хэша — после неё. Хэш тела совпал
|
||||
— вернуть сохранённое сообщение (тот же DTO из БД, не новый
|
||||
`uuid4()`/`utcnow()`); не совпал — доменное `IdempotencyConflict` (→
|
||||
409);
|
||||
- хэш — SHA-256 канонического JSON тела, собранного из аргументов
|
||||
сервиса (сортированные ключи, значения по умолчанию подставлены):
|
||||
модульная функция `message_request_hash`;
|
||||
- ошибка до `commit()` — откат: ни ключа, ни сообщения. Результат
|
||||
транзиентной ошибки не сохраняется;
|
||||
- лог: `Created message` или `Replayed message` с `message_id` и
|
||||
`replayed`, без ключа и текста (`logging.md`).
|
||||
- Вложения (лаба 4, design change `attachments`, решения 1, 5–9):
|
||||
- `AttachmentService(uow, cache, storage, slots)`: каждый шаг с БД —
|
||||
свой блок: соединение пула не занято передачей тела, на запрос не больше
|
||||
одного соединения. `storage` — глобал
|
||||
`object_storage` из зависимости, `slots` — глобал `upload_slots`
|
||||
(места загрузок процесса, `infra.md`; в сервисе только тип под
|
||||
`TYPE_CHECKING`);
|
||||
- предел принятой работы (design change `track1-queue-overload`, решение 3): в том
|
||||
же первом блоке, что членство, — `Content-Type`, `Content-Length`, затем
|
||||
`self.uow.jobs.count_unfinished(limit=…)`; у предела `info` «Rejected attachment»
|
||||
`reason=backlog`, `unfinished`, `limit` и `UploadBacklogFull`. Значение 0 — запроса
|
||||
нет. Шаг с БД до тела один, поэтому граница молчания реплики и цепочка LB прежние.
|
||||
Предел мягкий: превышение — только загрузки в полёте, жёсткая граница потребовала
|
||||
бы блокировки на фиксацию;
|
||||
- порядок записи загрузки: проверки (членство, `Content-Type`,
|
||||
`Content-Length`, предел заданий) — без места → `async with self.slots.slot()` (429
|
||||
`UploadsBusy`: `info` «Rejected attachment», `reason=busy`,
|
||||
`waited_ms`) → внутри `_store` весь остальной путь до ответа: чтение
|
||||
тела со счётчиком под `asyncio.timeout([uploads]
|
||||
body_timeout_seconds)` (истёк — `UploadTimedOut`, 400) → структура
|
||||
изображения и SHA-256 одним `anyio.to_thread.run_sync` над
|
||||
`buffer.getvalue()` → `size = len(data)`, `del data` → строка
|
||||
`pending` с `object_key` и `staging_key` (commit) → `buffer.seek(0)`,
|
||||
PUT этим же `BytesIO` в staging (`attachment_object_repo.put_original(...,
|
||||
body=buffer, size=size)`), `buffer.close()` → `_mark_queued`: `queued` и
|
||||
задание одной транзакцией → снимок DTO; место освобождается при выходе из
|
||||
контекста, в том числе после компенсации и при отмене. С change
|
||||
`pipeline-reliability` (решение 1) брокера в пути запроса нет: строка
|
||||
`queued` без `published_at` — намерение, его публикует relay. Worker и relay —
|
||||
`worker.md`. Отказ S3 или БД после `pending` — 503, строка остаётся до уборщика.
|
||||
Отклонённая до `pending` загрузка ничего не пишет (design change
|
||||
`upload-memory`, решения 1–5);
|
||||
- одна копия тела: `del data` до PUT обязателен. Пока жива ссылка на
|
||||
`bytes` из `getvalue()`, буфер `BytesIO` общий, и `getbuffer()`
|
||||
aiohttp при PUT копирует тело целиком — два тела на загрузку вместо
|
||||
одного (проба: 2,3 тела против 1,19). `bytes` в `put` не передавать:
|
||||
botocore оборачивает его в `BytesIO` с общим буфером, и копия та же;
|
||||
- ожидание места, тело и проверка — до `created_at` строки `pending`:
|
||||
граница живой загрузки уборщика (B = 17 с по формуле кода, с закрытием соединения
|
||||
до 21 с: `KNOWN_ISSUES.md`) от очереди и медленного клиента не растёт
|
||||
(`settings.md`, «Уборщик»);
|
||||
- компенсация (design change `upload-consistency`, решение 1) — только
|
||||
удаление объекта staging и только при известном исходе, в `_mark_queued`:
|
||||
флаг «COMMIT отправлен» ставится прямо перед `commit()` и только при
|
||||
найденной строке. Сбой до него (сам `UPDATE`, пул, срок) — объект
|
||||
удаляется до ответа (`_compensate`: `delete_original` без повторов,
|
||||
неудача — `warning`, исходная ошибка уходит дальше); сбой на
|
||||
`commit()` — исход неизвестен, объект не трогается. `mark_queued` →
|
||||
`None` (строку убрал или пометил к уборке уборщик) — `error`,
|
||||
удаление объекта, 503 `ServiceUnavailable`. После неудачного PUT
|
||||
компенсации нет, строку
|
||||
компенсация не удаляет никогда — её убирает уборщик. `CancelledError`
|
||||
не ловится (`except Exception`);
|
||||
- уборка — `AttachmentCleanupService(uow, storage)`
|
||||
(`services/attachment_cleanup.py`), сервис процесса уборщика, а не
|
||||
реплик API: `clean_stale_pending(*, older_than, batch_size,
|
||||
stop_requested)`. Кандидаты — блок без блокировки (keyset), затем
|
||||
каждая строка — два блока (verify W1 и повторный verify, design,
|
||||
«Уточнения apply», п. 16 и 21):
|
||||
1. блок пометки: `lock_stale_pending` (`FOR UPDATE SKIP LOCKED`) →
|
||||
`mark_removing` (`updated_at = utcnow()`) → commit;
|
||||
2. блок уборки: снова `lock_stale_pending` →
|
||||
`delete_original` → `delete_attachment` → commit; строки нет или
|
||||
она занята — пропуск.
|
||||
|
||||
Шаг 2 удаляет `staging_key or object_key`: строка прежней версии —
|
||||
конечный объект, новая — staging. Помеченную строку `mark_queued` в
|
||||
`queued` не переводит (`updated_at =
|
||||
created_at`), поэтому сбой после удаления объекта (откат шага 2,
|
||||
DELETE, который S3 выполнил после срока) не даёт `ready` без
|
||||
объекта. Не одна транзакция на строку: её откат после удачного
|
||||
DELETE в S3 вернул бы строку непомеченной, и загрузка, пережившая
|
||||
grace, сделала бы её `ready` без объекта. DELETE в S3 — под
|
||||
блокировкой шага 2, а не между транзакциями: реплика до `87c48b9`
|
||||
пометку не проверяет и иначе сделала бы строку `ready` прямо перед
|
||||
удалением её объекта. Вызов S3 внутри транзакции ≤ `[s3]
|
||||
timeout_seconds` (5 с) < `idle_in_transaction_session_timeout` (10 с).
|
||||
Объект раньше строки: сбой между ними оставляет строку без объекта, а
|
||||
не наоборот. Отказ S3 или
|
||||
БД прерывает проход (`session_scope` уже записал `warning`),
|
||||
помеченная строка ждёт следующего прохода — пометка ставится заново.
|
||||
`stop_requested()` проверяется перед строкой и между шагами. Итог —
|
||||
`CleanupPassDTO`;
|
||||
- очистка staging (`AttachmentCleanupService.clean_staging`, design change
|
||||
`pipeline-reliability`, решение 9): кандидаты keyset сначала `ready`, затем
|
||||
`failed` с `updated_at < retention_before`; строка — одна транзакция: `FOR NO
|
||||
KEY UPDATE SKIP LOCKED` с теми же условиями → DELETE в S3 → `staging_key = NULL`.
|
||||
`NO KEY`, не `FOR UPDATE`: отправка сообщения берёт `FOR KEY SHARE` и не должна
|
||||
ждать DELETE в S3. У `failed` ещё объекты вариантов всех имён и конечный
|
||||
оригинал; ключ вне своего префикса staging — `warning`, строка не меняется;
|
||||
- чтение: `pending`, нет строки, не участник — одно
|
||||
`AttachmentNotFound`; варианты подставляются только у `ready`;
|
||||
скачивание любого `variant` не `ready` вложения — `AttachmentNotReady`
|
||||
(409) без обращения к S3; нет варианта — 404, нет его объекта или другой
|
||||
размер — 500; оригинал — `open_original` вне транзакции,
|
||||
нет объекта или другой размер — `error` в журнале и
|
||||
`AttachmentContentMissing` (500), строка не меняется. Оригинал,
|
||||
который сверка уже пометила потерянным (`lost_at`, design change
|
||||
`track2-reconciler`, решение 5), — `info` «Attachment content is
|
||||
lost» и `AttachmentNotFound` (404) до обращения к S3; метаданные и
|
||||
`MessageService` эту колонку не смотрят (200 и 201, как у любого
|
||||
`ready`). Ответ — вариант по умолчанию до ответа преподавателя
|
||||
(`TEACHER_QUESTIONS.md`, локальный, п. 12; разбор — отчёт лабы 4);
|
||||
- сверка bucket и БД — `AttachmentReconcileService(uow, storage)`
|
||||
(`services/attachment_reconcile.py`, design change
|
||||
`track2-reconciler`, решения 3, 4, 7, 8), сервис процесса уборщика:
|
||||
`reconcile(*, older_than, apply, max_changes, page_size, batch_size,
|
||||
stop_requested)` → `ReconcilePassDTO`. Проход:
|
||||
1. S3 → БД: страницы `list_originals`, на страницу одна выборка
|
||||
`get_attachments_for_objects` (по `id` стандартных ключей, по
|
||||
тексту — нестандартных), ключи — в множество `seen`;
|
||||
2. БД → S3: `get_ready_page` keyset по `id`, ключа нет в `seen` —
|
||||
кандидат «метаданные без объекта»;
|
||||
3. зависшие — `get_stale_pending`;
|
||||
4. перепроверка каждого кандидата в БД (`get_attachment`,
|
||||
`find_attachment_reference`) и HEAD до решения, в обоих режимах;
|
||||
отсутствие объекта — только после `probe_originals` (bucket на
|
||||
месте);
|
||||
5. предел `max_changes` (удаления объектов, пометки и снятия пометок;
|
||||
больше — `error`, ни одного из них, код 3), затем с `apply` по
|
||||
порядку: зависшие (`AttachmentCleanupService.remove_stale_pending` —
|
||||
тот же шаг уборщика) → объекты без строки (ещё раз
|
||||
`find_attachment_reference`, затем `delete_original`) → `mark_lost`
|
||||
→ `clear_lost` (перед каждым — HEAD, условный `UPDATE`, свой
|
||||
commit).
|
||||
|
||||
Удаляется только объект без строки и зависшая загрузка; `ready`,
|
||||
объект строки любого статуса и чужой ключ — никогда. Действия
|
||||
начинаются после классификации: отказ на шагах 1–4 — ни одного
|
||||
изменения. Строка `ready` или зависшая загрузка с ключом вне
|
||||
`<база>/attachments/` (`attachment_object_repo.is_own_key`) — «чужой
|
||||
объект»: без HEAD, без пометки и без уборки; HEAD, пометка, снятие и
|
||||
DELETE ещё раз проверяют префикс (design change `track2-reconciler`,
|
||||
«Уточнения apply», п. 19). Отказ S3 или БД — `interrupted_by`, после
|
||||
сигнала — `stop`; `stop_requested()` (`_Pass.check_stop`) — перед
|
||||
каждым вызовом S3 и шагом с БД: остановка ждёт не больше одного вызова
|
||||
(п. 20);
|
||||
- стоимость сверки (design change `track2-reconcile-cost`, решения
|
||||
4–8): `reconcile(…, strategy, deep, max_objects_per_second, …)`.
|
||||
Параметры, счётчики и находки прохода — `_Pass`, вызовы S3 — свои
|
||||
обёртки сервиса (`_list_page`, `_probe`, `_head`, `_read`, `_delete`):
|
||||
сигнал до вызова, предел скорости после;
|
||||
- `strategy=head` — только разовый проход: шаг S3 → БД — выборка
|
||||
строки на объект (`get_attachments_for_objects` с одним элементом),
|
||||
пара «строка — объект» с тем же ключом пропускается; шаг БД → S3 —
|
||||
HEAD на строку своей базы (с `deep` у непомеченной строки старше
|
||||
grace — сразу GET). Множества `seen` нет. Классификация пары —
|
||||
общая `_row_with_object`, строки без объекта — `_row_without_object`:
|
||||
расхождения те же, что у `batch`. Каждая строка сравнивается с
|
||||
объектом по своему ключу: у `batch` шаг списка сравнивает объект
|
||||
стандартного ключа со строкой своего `id`, нестандартного — с
|
||||
каждой строкой этого ключа, а строку с ключом `<id>/original`
|
||||
другого вложения — шаг строк HEAD (`_key_of_other_id`; verify W2,
|
||||
design, «Правки по verify», п. 2);
|
||||
- `deep` — GET и SHA-256 потоком (`open_original`, блоки клиента,
|
||||
`hashlib`) у строки `ready` без пометки, старше grace, с объектом
|
||||
того же размера, не моложе grace; класс `checksum_mismatch` — в
|
||||
`LIMITED_KINDS` и `ACTION_ORDER` (пометка), не в `NEEDS_BUCKET`.
|
||||
«Оригинал вернулся» и «другой SHA-256» (`NEEDS_READ`) перепроверка и
|
||||
действие подтверждают заново прочитанным объектом: размер и SHA-256
|
||||
строки (`ReconcileFindingDTO.sha256`). Без `deep` вернувшийся объект
|
||||
тоже читается — пометку снимает только тот же SHA-256; другой —
|
||||
`lost_known`. Объект моложе grace — свежий и в перепроверке: «другой
|
||||
SHA-256» читается с `fresh_before` (`_fresh_before`), объект другого
|
||||
размера свежим не подтверждается ни в классификации, ни в
|
||||
перепроверке, ни перед пометкой; вернувшийся читается без порога
|
||||
(verify S1);
|
||||
- предел скорости — после каждого вызова S3 (`_pace`): затронуто
|
||||
(`_touched` — ключи страниц и HEAD/GET/DELETE, разность
|
||||
`storage.stats()` с начала) больше `R × время с начала прохода` —
|
||||
`asyncio.sleep` кусками ≤ `RECONCILE_PACE_STEP_SECONDS` (0,2 с) с
|
||||
проверкой сигнала. Пауза после вызова, а не перед следующим: тогда и
|
||||
последний вызов прохода не обгоняет предел (design, «Уточнения
|
||||
apply»). DELETE шага уборки зависшей — тоже: `_pace` после
|
||||
`remove_stale_pending`. Сигнал прекращает ожидание, но `_pace` не
|
||||
бросает `_Stopped`: итог вызова перед паузой (страница, удаление)
|
||||
доходит до записи «Fixed» и счёта, а проход останавливает
|
||||
`check_stop()` перед следующим вызовом (verify W1);
|
||||
- ранний отказ: с `apply` в `_recheck_all`, как только подтверждённых
|
||||
классов `LIMITED_KINDS` больше `max_changes`, остальные кандидаты
|
||||
этих классов не перепроверяются, а считаются в `unchecked`; `_act`
|
||||
отказывает тем же условием (`changes` = `max_changes + 1`). Dry-run
|
||||
перепроверяет всех;
|
||||
- счёт сеансов — `db_sessions` итога, разность `uow.blocks_opened` с
|
||||
начала прохода; внутренний `AttachmentCleanupService` работает на том
|
||||
же экземпляре единицы работы, его блоки входят в счёт; длительность
|
||||
шагов — `_Pass.phase` (`list`,
|
||||
`rows`, `stale`, `recheck`, `act`). Плановая сверка — `batch`, без
|
||||
`deep`, предел из настроек (`src/cleaner/main.py`);
|
||||
- сверка (с лабы 5, решение 11): объект варианта
|
||||
(`parse_variant_key`) — строка `id` есть, пропуск; нет — объект без
|
||||
метаданных (удаление с `--apply`), свежий — свежий. `processing` и `failed` не
|
||||
находки, зависшая загрузка называет ключ staging. С change
|
||||
`pipeline-reliability` (решение 9) — ещё шаг `_list_staging` (та же обёртка
|
||||
сигнала и скорости): `<id>/original` строки с этим `staging_key` — пропуск; иначе
|
||||
`orphan_staging` старше срока хранения (`staging_older_than`), моложе — свежий;
|
||||
другой ключ под staging — `unknown_object`; итог — `listed_staging`;
|
||||
- `MessageService.send_message(..., attachment_ids)`: членство →
|
||||
`get_attachments` (все найдены, чат этого сообщения, не `pending`; иначе
|
||||
`AttachmentNotFound` до захвата ключа) → хэш → ключ → новый ключ при
|
||||
`failed` среди вложений: откат и `AttachmentFailed` (409), ключ свободен;
|
||||
занятый — прежняя ветка повтора, на состояние вложения не глядя → сообщение
|
||||
→ `insert_message_attachments` (если список непустой) → один commit;
|
||||
- хэш: `message_request_hash(text, attachment_ids)` — `attachment_ids`
|
||||
в каноническом JSON только непустым, id — `str(UUID)` (нижний
|
||||
регистр), порядок значим. Пустой список хэш версии `e1161f7` не
|
||||
меняет: ключ, сохранённый до замены реплик, повторяется.
|
||||
- Недоступность Postgres (там же хранятся сессии) — доменное
|
||||
`ServiceUnavailable` (→ 503), не 500 и никогда не пропуск запроса без
|
||||
аутентификации (`infra.md`). Недоступность Valkey — не ошибка, а
|
||||
промах кэша.
|
||||
- KDF пароля — в потоке, не в event loop (`auth.md`).
|
||||
- Курсор кодирует и разбирает сервис через `src/utils/cursor.py`:
|
||||
проверяет область (этот чат или этот пользователь) и возвращает
|
||||
`<Entity>PageDTO` с готовым `next_cursor`. Неверный курсор — доменное
|
||||
исключение (→ 400).
|
||||
- Чистые вычисления — модульные функции над классом, без обращения к
|
||||
хранилищу.
|
||||
- Read-only методы, которые лишь делегируют в repo, не логируют.
|
||||
Остальное — по `.claude/rules/logging.md`.
|
||||
- Константы (лимиты, размер страницы) — `src/utils/constants.py`.
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
paths:
|
||||
- "service-tests/**"
|
||||
---
|
||||
|
||||
# Быстрые тесты сервисов (`service-tests/`)
|
||||
|
||||
Спек `unit-of-work`, «Быстрые тесты сервисов»; design change `unit-of-work`,
|
||||
решения 11 и 13. Каталог вне `student-tests/`: правило black-box там прежнее, `make
|
||||
student_test` его не собирает. В образ не попадает (`.dockerignore`).
|
||||
|
||||
| Что | Где | Цель |
|
||||
|---|---|---|
|
||||
| ветки сервисов, архитектура, контракт repo на фейке | `unit/` | `make service_test`: без PostgreSQL, Valkey, S3, брокера, docker и сети, секунды |
|
||||
| настоящая единица работы, контракт repo на SQL, общий срок запроса | `db/` | `make service_test_db`: временная база `test_uow_<db>` в PostgreSQL стенда |
|
||||
| блокировки, конкуренция, исход COMMIT, триггеры | `student-tests/test_failures.py` | только `make failure_checks`: фейк их не воспроизводит |
|
||||
|
||||
- **Фейки, а не моки.** Тест проверяет исход и журнал `database.events`, а не набор
|
||||
вызовов. Метод фейка реализует контракт из докстринга порта: условие перехода, keyset
|
||||
по полям, порядок результата. Нет плана запроса, блокировок, индексов, внешних
|
||||
ключей и `greatest` сверх контракта. Занятая строка — `database.held`, отказ —
|
||||
`database.fail_on`, `database.fail_commit`.
|
||||
- **Новый метод — порт, SQL, фейк и строка контракта.** `test_architecture.py` сверяет
|
||||
набор методов и сигнатуры порт — реализация — фейк и фейки клиентов — настоящие
|
||||
клиенты; `repo_contract.py` — условия, по результату которых ветвятся сервисы: один
|
||||
набор на фейке и на SQL. Разошлись — чинится фейк: SQL определяет поведение.
|
||||
- **Кэш и S3 — настоящие модули поверх фейков клиентов:** `chat_cache`,
|
||||
`attachment_object` не дублируются. `UploadSlots` — настоящий.
|
||||
- **Настройки.** `settings` читает `.env` и `config.toml` по абсолютному пути, поэтому
|
||||
поля, от которых зависят ветки, подставляет автоматическая фикстура `unit/conftest.py`:
|
||||
результат не зависит от локальных файлов. Новое поле настроек в ветке сервиса —
|
||||
строка там. В `db/conftest.py` — окружение «тесного» API до импорта `src`.
|
||||
- **Временная база:** имя проверяется `^test_uow_[a-z0-9_]+$` до любых действий, иначе
|
||||
код 2; создаётся и мигрирует в начале, удаляется при любом исходе
|
||||
(`pytest_unconfigure`). Рабочая база не затрагивается, чужие контейнеры — тоже.
|
||||
- **Замороженный сервер** — `TcpProxy` из `db/conftest.py`, а не `docker pause`
|
||||
рабочего PostgreSQL. Смена внутренних имён адаптера в `_ping_once` падает тестами
|
||||
`test_ping_*`.
|
||||
- `async def` тесты запускает плагин `anyio`: `pytestmark = pytest.mark.anyio` в модуле,
|
||||
новых зависимостей нет. Цикл событий на тест: engine закрывается в том же тесте.
|
||||
@@ -0,0 +1,405 @@
|
||||
---
|
||||
paths:
|
||||
- "src/config/**"
|
||||
- ".env.example"
|
||||
- "config_example.toml"
|
||||
---
|
||||
|
||||
# Настройки: `.env`, `config.toml`, `src/config/settings.py`
|
||||
|
||||
Схема из bp_proxies (`src/data/settings.py` там). Что делают режимы
|
||||
console и docker — `.claude/rules/run-modes.md`. Здесь — откуда берутся
|
||||
значения и куда класть новое.
|
||||
|
||||
## Источники `Settings`
|
||||
|
||||
- `src/config/settings.py`: `Settings(BaseSettings)` из секций-`BaseModel`
|
||||
(`App`, `Database`, `Auth`, `Cache` — Valkey, `S3`, `Idempotency`,
|
||||
`Uploads`, `Cleaner`, `Reconciler`).
|
||||
Экземпляр один —
|
||||
`settings` на уровне модуля. Импорт везде `from src.config import
|
||||
settings`. Второй `Settings()` не создавать, поля в рантайме не менять.
|
||||
- Приоритет (`settings_customise_sources`): окружение процесса → `.env`
|
||||
→ `config.toml` → дефолты. Отсутствующий файл пропускается. Без
|
||||
`.env` и `config.toml` `Settings` обязан загрузиться на дефолтах: так
|
||||
работают импорт `src`, alembic и чистый clone. Стенд (с лабы 2)
|
||||
запускается через compose и получает значения из `.env`; без Postgres
|
||||
приложение стартует, но `/health/ready` отвечает 503.
|
||||
- Все поля живут в секциях, откуда бы ни пришло значение: секцию задаёт
|
||||
класс `Settings`, а не файл. Вложенные поля в env — через `__`,
|
||||
регистр не важен: `DATABASE__PASSWORD` попадает в
|
||||
`settings.database.password` так же, как `[database] password` из
|
||||
TOML. Переменную без префикса секции (`APP_PORT`, `POSTGRES_PASSWORD`)
|
||||
приложение не видит: она для compose.
|
||||
- Имена из контракта и skeleton (`SESSION_TTL_SECONDS`, `APP_HOST`)
|
||||
буквально не заводятся, если значение читает только приложение. Поле
|
||||
живёт в секции (`[auth] session_ttl_seconds` в `config.toml`), а
|
||||
соответствие имени описано в `REPORT.md`. Мост — только для значения,
|
||||
которое читает ещё контейнер зависимости (раздел «Мосты» ниже).
|
||||
- `extra="ignore"`: опечатка в ключе молча оставит дефолт. После правки
|
||||
проверить конкретное поле: `uv run python -c "from src.config import
|
||||
settings; print(settings.app.port)"`. Полный дамп настроек не печатать:
|
||||
в нём пароли.
|
||||
- Подмена через окружение ставится до первого импорта `src`: потом
|
||||
`settings` уже прочитан.
|
||||
|
||||
## Что где хранится
|
||||
|
||||
Критерий — кто читает значение, а не секретное ли оно.
|
||||
|
||||
| Где | Что | В git |
|
||||
|---|---|---|
|
||||
| `config.toml` | всё, что читает **только приложение**, по секциям: `log_level`, пул и таймауты `[database]`, TTL сессии, таймауты, пул и срок записей `[cache]`, регион, сроки и пул `[s3]`, секреты, которые нужны одному приложению | нет; шаблон `config_example.toml` |
|
||||
| `.env` | всё, что читает **compose** (и Makefile) и контейнеры зависимостей: порты `APP__PORT` / `APP_OUT_PORT`, `POSTGRES_*`, `VALKEY_*` и `S3_*` (адрес, порты, учётные данные, секреты S3 с лабы 4), пароль брокера с лабы 5; мосты `SECTION__FIELD=${...}` для приложения, в том числе консольные адреса Postgres, Valkey и S3 | нет; шаблон `.env.example` |
|
||||
| окружение процесса | режим `APP__RUN_MODE` и разовые подмены | — |
|
||||
| `src/utils/constants.py` | лимиты контракта (3–32, 100, 4000, `limit` 1–100 / 50; с лабы 4 — 10 MiB и 40 млн пикселей вложения, 10 вложений в сообщении, `filename` 1–255), пути: одинаковы на всех установках | да |
|
||||
|
||||
Схему согласовали с преподавателем 2026-09-29 (AGENTS.md, «Согласования
|
||||
с преподавателем»). Секреты в `config.toml` допустимы. Запрет
|
||||
`Dockerfile.example` касается запекания в образ (`COPY`), а
|
||||
`config.toml` в образ не копируется, его монтируют на старте
|
||||
(`docker.md`). Но почти все секреты курса — пароли
|
||||
Postgres, Valkey, брокера, ключи S3 — нужны ещё и контейнеру зависимости,
|
||||
а его настраивает только compose из `.env`. Поэтому такой секрет живёт
|
||||
в `.env` и попадает в приложение мостом. Если продублировать его в
|
||||
`config.toml`, как `postgres_password` в bp_proxies, получатся два
|
||||
источника, которые рано или поздно разойдутся.
|
||||
|
||||
## Имена в `.env`: параметр приложения — в формате настроек
|
||||
|
||||
Если переменная касается самого приложения, в `.env` она пишется в
|
||||
формате настроек (`SECTION__FIELD`), даже когда её читают ещё compose и
|
||||
Makefile. Пример — внутренний порт `APP__PORT`: на нём слушает
|
||||
приложение, его публикует compose, на нём работает healthcheck. Compose
|
||||
читает `${APP__PORT}` напрямую и передаёт в `environment` под тем же
|
||||
именем.
|
||||
|
||||
Имя без секции — только у того, что приложение не читает:
|
||||
`APP_OUT_PORT` (порт на хосте), `POSTGRES_*` и другие переменные
|
||||
контейнеров зависимостей. Если такое значение нужно ещё и приложению,
|
||||
оно приходит мостом (ниже).
|
||||
|
||||
Поле, которое задаётся в `.env`, в `config_example.toml` не
|
||||
дублируется: по приоритету значение из `.env` перекрыло бы toml, и
|
||||
строка там ни на что не влияла бы. Поэтому в `[app]` нет `port`.
|
||||
|
||||
`.env` читает и Makefile (`-include .env`), поэтому комментарии в нём
|
||||
пишутся только отдельными строками. make, в отличие от compose,
|
||||
оставляет пробел перед `# комментарий` в конце строки частью значения.
|
||||
|
||||
## Мосты: значение из `.env` в секцию приложения
|
||||
|
||||
Мост нужен, когда имя переменной навязано контейнером зависимости
|
||||
(`POSTGRES_PASSWORD` для образа postgres), а приложению то же значение
|
||||
нужно в своей секции. Мост — строка, которая отдаёт значение переменной
|
||||
compose полю секции:
|
||||
|
||||
- в `.env` — `DATABASE__PASSWORD=${POSTGRES_PASSWORD}`: pydantic-settings
|
||||
раскрывает `${VAR}` при чтении `.env` (проверено на 2.15), так
|
||||
значение получает приложение в console-режиме;
|
||||
- в `environment` сервиса compose — та же строка, так значение получает
|
||||
контейнер. Сам `.env` в контейнер не передаётся.
|
||||
|
||||
`docker run --env-file .env` раскрывать `${...}` не умеет и передаст
|
||||
строку буквально, поэтому стенд запускается только через compose.
|
||||
|
||||
Окружение не перекрывает мост по исходному имени. python-dotenv
|
||||
подставляет `${VAR}` сначала из самого `.env` и лишь потом из окружения,
|
||||
поэтому `POSTGRES_OUT_PORT=5545 uv run ...` оставит в `DATABASE__PORT`
|
||||
значение из файла (проверено на таком же мосте срока сессии, change
|
||||
`session-auth`). Разовая подмена —
|
||||
только по имени поля: `DATABASE__PORT=5545`.
|
||||
|
||||
## Консоль и docker из одного `.env`
|
||||
|
||||
Переключение консоль ↔ docker не требует правки файлов и
|
||||
комментирования блоков, как в bp_proxies (design change
|
||||
`postgres-storage`, решение 7):
|
||||
|
||||
- консоль: приложение на хосте читает `.env`, мосты
|
||||
`DATABASE__HOST=127.0.0.1`, `DATABASE__PORT=${POSTGRES_OUT_PORT}` и
|
||||
учётные данные из `POSTGRES_*`; для Valkey —
|
||||
`CACHE__HOST=127.0.0.1`, `CACHE__PORT=${VALKEY_OUT_PORT}`,
|
||||
`CACHE__PASSWORD=${VALKEY_PASSWORD}`; для S3 —
|
||||
`S3__HOST=127.0.0.1`, `S3__PORT=${S3_OUT_PORT}`,
|
||||
`S3__ACCESS_KEY_ID=${S3_API_ACCESS_KEY}`,
|
||||
`S3__SECRET_ACCESS_KEY=${S3_API_SECRET_KEY}`;
|
||||
- docker: `.env` в контейнер не попадает, адрес и порт приходят из
|
||||
`environment` compose — `DATABASE__HOST: ${POSTGRES_HOST}`,
|
||||
`DATABASE__PORT: ${POSTGRES_PORT}` (якорь `x-db-env`),
|
||||
`CACHE__HOST: ${VALKEY_HOST}`, `CACHE__PORT: ${VALKEY_PORT}`
|
||||
(`x-cache-env`), `S3__HOST: ${S3_HOST}`, `S3__PORT: ${S3_PORT}`
|
||||
(`x-s3-env`).
|
||||
|
||||
Адреса и порты Postgres, Valkey и S3 в compose — только переменные
|
||||
`.env`, литерал — лишь адрес публикации `127.0.0.1` (`docker.md`).
|
||||
|
||||
В новый `.env` `make env_setup` подставляет случайные
|
||||
`POSTGRES_PASSWORD`, `VALKEY_PASSWORD` и шесть секретов S3 и печатает
|
||||
только их имена. Существующий `.env` он не перезаписывает, а дописывает
|
||||
в конец переменные шаблона, которых в нём нет (с change
|
||||
`upload-consistency`, design, «Уточнения apply», п. 1): секреты —
|
||||
случайными значениями той же подстановкой, что для
|
||||
нового `.env` (`ENV_FILLED`), остальные — значениями шаблона, под
|
||||
комментарием `# added by make env_setup from .env.example`. Прежние
|
||||
строки не меняются, в вывод — только имена («added to existing .env:
|
||||
…»), повторный запуск ничего не дописывает. Так приходят и секреты
|
||||
уборщика `S3_CLEANER_*` (без них compose останавливается на `:?` «run
|
||||
make env_setup»). Значение уже существующей переменной (пустой секрет,
|
||||
изменённый шаблоном порт) он не трогает: такое переносится руками,
|
||||
секреты — `openssl rand -hex 32`.
|
||||
|
||||
### S3 (с лабы 4)
|
||||
|
||||
- `[s3]`: `host`, `port` (8333), `bucket` (`messenger`, валидатор по
|
||||
`S3_BUCKET_NAME_PATTERN`: иначе сервис не стартует, в ошибке —
|
||||
`bucket`), `access_key_id` и `secret_access_key` (`SecretStr`, пусто
|
||||
— `warning` при старте), `region` (`us-east-1`), сроки
|
||||
`connect_timeout_seconds` (1) и `timeout_seconds` (5, `gt=0`), пул
|
||||
`max_connections` (10, `ge=1`). URL — свойство `endpoint_url`.
|
||||
- Имя bucket читают и приложение, и bootstrap, поэтому в `.env` оно в
|
||||
формате настроек — `S3__BUCKET`; bootstrap получает его как
|
||||
`S3_BUCKET: ${S3__BUCKET:-messenger}`. Регион, сроки и пул — в
|
||||
`config.toml`, адреса и ключей там нет.
|
||||
- Секреты S3 в `.env` (кто какой получает — `docker.md`):
|
||||
`S3_ROOT_ACCESS_KEY` / `S3_ROOT_SECRET_KEY` — административная пара,
|
||||
только сервер; `S3_JWT_SIGNING_KEY` — ключ подписи служебных вызовов;
|
||||
`S3_API_ACCESS_KEY` / `S3_API_SECRET_KEY` — пользователь API: один
|
||||
источник для bootstrap и приложения (мост). Новый секрет API действует
|
||||
после следующего bootstrap (`make run_docker`), прежний перестаёт.
|
||||
`S3_CLEANER_ACCESS_KEY` / `S3_CLEANER_SECRET_KEY` — пользователь
|
||||
уборщика (чтение и удаление объектов): bootstrap и сервис `cleaner`
|
||||
через `environment` compose (`S3__ACCESS_KEY_ID`,
|
||||
`S3__SECRET_ACCESS_KEY`), моста в консоль нет — консольного уборщика
|
||||
нет, разовый проход идёт в контейнере.
|
||||
|
||||
### Загрузки (с change `upload-memory`)
|
||||
|
||||
`[uploads]` (класс `Uploads`, design change `upload-memory`, решения 1–4
|
||||
и 9) читает процесс API: `max_concurrent` (int, `ge=1`, 4),
|
||||
`max_waiting` (int, `ge=0`, 16; 0 — без очереди, сразу 429),
|
||||
`wait_timeout_seconds` (float, `gt=0`, 5), `body_timeout_seconds`
|
||||
(float, `gt=0`, 30). Значения — в `config.toml`, разовая подмена —
|
||||
`UPLOADS__*` (стенд отказов — 1 / 1 / 1 / 3 у третьего API, профиль
|
||||
`uploads` — 1000 / 0 у варианта «без лимита»). Настройки, а не
|
||||
константы: у установок разный лимит памяти. Неверное значение —
|
||||
ошибка проверки настроек с именем поля, сервис не стартует. «Started
|
||||
API» называет все пять (с `max_unfinished_jobs`).
|
||||
|
||||
- `max_unfinished_jobs` (int, `ge=0`, 250; 0 — без предела; design change
|
||||
`track1-queue-overload`, решения 1–2): при каком числе незавершённых заданий стенда
|
||||
(`queued` и `processing`) загрузка получает 429 `Retry-After: 5`. Выбран по худшему
|
||||
измеренному классу: предел / потолок worker — срок ожидания, ~270 с. Файл на лимите
|
||||
CPU процесса (15 с, scan bomb в пределах контракта) этим не покрыт и не мерился:
|
||||
расчёт 250 × 15 с ≈ 1 ч разбора, при таком ожидании relay шлёт копии. При другом
|
||||
числе worker предел другой. Разовая подмена —
|
||||
`UPLOADS__MAX_UNFINISHED_JOBS` (стенд отказов и профиль `uploads` — 0, пятый API
|
||||
стенда отказов — 3). `Retry-After` — константа `UPLOAD_BACKLOG_RETRY_AFTER_SECONDS`;
|
||||
|
||||
- `max_concurrent` 4 — бюджет реплики 512 МБ: база ~105 MiB + хэши
|
||||
паролей 4 × 64 MiB + места до ~90 MiB при 40 клиентах ≈ 450 MiB; при
|
||||
8 местах — ~530 MiB;
|
||||
- `wait_timeout_seconds` 5 — молчание реплики до тела `2 × [database]
|
||||
request_timeout_seconds + wait_timeout_seconds` = 17 с, а с закрытием соединения
|
||||
на зависшем сервере (`DB_CLOSE_TIMEOUT_SECONDS`, вне срока блока) до 2 × (6 + 2) +
|
||||
5 = 21 с меньше `timeout server` LB пути загрузки (30 с, `balancer.md`); при смене
|
||||
любого из них пересчитать цепочку. **Проверки соотношения при старте нет** (в
|
||||
отличие от grace уборщика): `timeout server` живёт в `haproxy.cfg`, и
|
||||
процесс API его не знает. Поэтому `wait_timeout_seconds` больше `30 −
|
||||
2 × (request_timeout_seconds + закрытие)` = 14 с сервис примет молча, а ожидающая
|
||||
загрузка может получить 504 от LB вместо 429 реплики (design change
|
||||
`upload-memory`, «Уточнения apply», п. 14). То же для молчания после
|
||||
тела (≈ 26 с): бо́льшие `request_timeout_seconds` и `[s3]
|
||||
timeout_seconds` выводят его за 30 с так же молча;
|
||||
- `body_timeout_seconds` 30 — один срок на всё тело с момента, как
|
||||
загрузка заняла место (не срок простоя: клиент по байту раз в 29 с
|
||||
держал бы место вечно). Наибольшая длительность загрузки 21 + 30 + 26
|
||||
≈ 77 с < `ROLLOUT_DRAIN_TIMEOUT` (90 с);
|
||||
- **граница B уборщика прежняя** (17 с по формуле кода, с закрытием соединения до 21
|
||||
с): ожидание места, тело и проверка идут до `created_at` строки `pending`, а сроки
|
||||
tx1, PUT и tx2 не менялись. Поэтому `[uploads]` в проверку grace уборщика не входит.
|
||||
Закрытия формула не учитывает: при grace 900 с это неважно, `KNOWN_ISSUES.md`.
|
||||
|
||||
### Брокер и worker (с лабы 5)
|
||||
|
||||
`[broker]` (класс `Broker`, design change `async-attachments`, решение 13):
|
||||
`host`, `port`, `user`, `password` (`SecretStr`) — мосты из `RABBITMQ_*` в `.env`,
|
||||
в docker — `x-broker-env`; `connect_timeout_seconds` (2),
|
||||
`publish_timeout_seconds` (2; секцию читают relay и worker, в цепочку LB больше не
|
||||
входит). `[worker]` (класс `Worker`, design change `pipeline-reliability`, решение
|
||||
12): `concurrency` (2), `prefetch` (2), `max_attempts` (5), `job_timeout_seconds` (60),
|
||||
`lease_margin_seconds` (10), `retry_base_delay_seconds` (5), `retry_max_delay_seconds`
|
||||
(300, не меньше основы), `render_timeout_seconds` (40, меньше срока попытки),
|
||||
`render_cpu_limit_seconds` (15), `render_memory_limit_mib` (450),
|
||||
`graceful_shutdown_seconds` (8, ≤ 8), `reconnect_seconds` (2). Прежний ключ
|
||||
`retry_delay_seconds` в существующем `config.toml` молча игнорируется. `[relay]` (класс
|
||||
`Relay`): `poll_interval_seconds` (0,25), `batch_size` (100), `max_published_backlog`
|
||||
(1000, 0 — без предела), `republish_after_seconds` (300), `failure_pause_seconds` (2).
|
||||
`[cleaner] staging_retention_seconds` (86400). Подмена — `BROKER__*`, `WORKER__*`,
|
||||
`RELAY__*`. Ключи worker `S3_WORKER_*` — в `.env`, контейнеру — `environment`
|
||||
compose, консоль — `make run_worker` (мост `S3__*` в `.env` — ключи API); `make
|
||||
run_relay` — те же мосты. Имена skeleton: `BROKER_URL_FILE` → мосты `RABBITMQ_*`;
|
||||
`WORKER_CONCURRENCY`, `JOB_MAX_ATTEMPTS`, `JOB_TIMEOUT_SECONDS` → поля `[worker]`;
|
||||
`STAGING_RETENTION_SECONDS` → `[cleaner] staging_retention_seconds`.
|
||||
|
||||
### Телеметрия (с лабы 6)
|
||||
|
||||
`[telemetry]` (класс `Telemetry`, design change `otel-telemetry`, решение 8) читают только
|
||||
процессы API, worker и с design change `job-trace-propagation` (решение 7) relay; уборщик,
|
||||
миграции и команда replay — нет: `enabled` (`False`), `otlp_endpoint` (`http://127.0.0.1:4318`,
|
||||
валидатор: схема `http`/`https`, хост, порт, без пути, query и учётных данных),
|
||||
`environment` (`lab`, `^[a-z0-9._-]{1,32}$`), с design change `track1-telemetry-cost` (решения
|
||||
3–4) `trace_sample_ratio` (`float`, 0…1, 1 — все трассы, прежний `ParentBased(ALWAYS_ON)`) и
|
||||
`metric_buckets` (`MetricBucketsEnum`: `default` | `coarse`) — оба в `config_example.toml` со
|
||||
значениями по умолчанию, в `.env` их нет, вариант стенда `bench/` задаёт окружением;
|
||||
`metric_export_interval_seconds` (15, не больше 30 — половины срока рядов экспортёра Collector),
|
||||
`export_timeout_seconds` (2), `max_queue_size` (2048), `max_export_batch_size` (512, не больше
|
||||
очереди), `schedule_delay_seconds` (1); `float` — `allow_inf_nan=False`. Включает стенд
|
||||
compose у `api`, `worker` и `relay` (`x-telemetry-env`: `TELEMETRY__ENABLED`,
|
||||
`TELEMETRY__OTLP_ENDPOINT`), в `.env` и
|
||||
`config_example.toml` включения нет: файл монтируется и в консоль. Разовая подмена —
|
||||
`TELEMETRY__*`. **`OTEL_*` — не настройки**, как любые переменные без секции: процесс с
|
||||
включённой телеметрией удаляет их из окружения и пишет `warning` с именами; прокси окружения
|
||||
(`HTTP(S)_PROXY`) экспортёры тоже не берут (`trust_env=False`). Сочетание секций: с включённой
|
||||
телеметрией `[app] graceful_shutdown_seconds` не больше `API_STOP_BUDGET_SECONDS −
|
||||
TELEMETRY_SHUTDOWN_TIMEOUT_SECONDS` = 8 (валидатор поля `telemetry` в `Settings`, ошибка называет
|
||||
`app.graceful_shutdown_seconds`), без неё — прежние 9 (design change `otel-telemetry`,
|
||||
«Уточнения apply», п. 13). Имена skeleton:
|
||||
`OTEL_SERVICE_NAME` → константы `TELEMETRY_SERVICE_API` / `_WORKER` / `_RELAY`,
|
||||
`OTEL_EXPORTER_OTLP_ENDPOINT` → `otlp_endpoint`, `OTEL_EXPORTER_OTLP_PROTOCOL` — постоянно
|
||||
`http/protobuf`, `OTEL_RESOURCE_ATTRIBUTES` → `environment` (`service.*` вычисляет код), `OTEL_TRACES_SAMPLER` —
|
||||
постоянно `parentbased_traceidratio` (при доле 1 — `parentbased_always_on`),
|
||||
`OTEL_TRACES_SAMPLER_ARG` → `trace_sample_ratio`.
|
||||
`GRAFANA_ADMIN_PASSWORD` (секрет, `ENV_SECRETS` и `ENV_FILLED` Makefile) и `GRAFANA_OUT_PORT`
|
||||
— переменные compose, приложение их не читает.
|
||||
|
||||
### Уборщик (с лабы 4)
|
||||
|
||||
`[cleaner]` (класс `Cleaner`, design change `upload-consistency`,
|
||||
решение 4) читает только процесс `python -m src.cleaner`:
|
||||
`interval_seconds` (float, `gt=0`, 60), `pending_grace_seconds` (int,
|
||||
`gt=0`, 900), `batch_size` (int, `ge=1`, 100). Значения — в
|
||||
`config.toml`, разовая подмена — `CLEANER__*` в окружении (стенд
|
||||
отказов — 20 и 1 в `failures.compose.yml`, драйвер — grace 30 с).
|
||||
Неверное значение — запись «Invalid cleaner settings» без значений
|
||||
полей и код 2 (`src/cleaner/__main__.py`). Grace сравнивает с границей
|
||||
живой загрузки `2 × [database] request_timeout_seconds + [s3]
|
||||
timeout_seconds` (17 с) сама точка входа уборщика, а не валидатор
|
||||
`Settings`: реплики API от неё не зависят. Сроки берутся из настроек
|
||||
процесса уборщика: `config.toml` общий, а подмена сроков окружением
|
||||
только у API проверку обошла бы — ограничение в `REPORT.md`.
|
||||
- Порт API S3 в сети — `S3_PORT`, на `127.0.0.1` хоста — `S3_OUT_PORT`
|
||||
(8334, как 5433 и 6380).
|
||||
|
||||
### Сверка (с change `track2-reconciler`)
|
||||
|
||||
`[reconciler]` (класс `Reconciler`, design change `track2-reconciler`,
|
||||
решение 10) читает только процесс уборщика: `interval_seconds` (float,
|
||||
`ge=0`, 3600; 0 — без плановой сверки), `page_size` (int, 1–1000, 1000:
|
||||
больше 1000 ключей S3 за страницу не отдаёт), `max_changes` (int,
|
||||
`ge=1`, 100). Значения — в `config.toml`, разовая подмена —
|
||||
`RECONCILER__*`; разовый проход принимает предел ещё и аргументом
|
||||
`--max-changes`. Своего grace у сверки нет — `[cleaner]
|
||||
pending_grace_seconds` и его проверка при старте (одна ручка «свежести»).
|
||||
Неверное значение — «Invalid cleaner settings» с `loc` поля и код 2, как
|
||||
у `[cleaner]`. «Started cleaner» называет `reconcile_interval_seconds`,
|
||||
`reconcile_page_size`, `reconcile_max_changes` и `mode`. Стенд отказов и
|
||||
`bench/` — `RECONCILER__INTERVAL_SECONDS: "0"`.
|
||||
|
||||
С change `track2-reconcile-cost` (решение 6) ещё `max_objects_per_second`
|
||||
(float, `ge=0`, `allow_inf_nan=False`, 2000; 0 — без предела; `inf` —
|
||||
ошибка: «Started cleaner» было бы не JSON, verify S2; у прочих полей
|
||||
`float` тот же дефект — `KNOWN_ISSUES.md`) — предел скорости прохода:
|
||||
объектов S3 в секунду в среднем от начала прохода (ключи страниц списка,
|
||||
HEAD, GET, DELETE). Разовая подмена — `RECONCILER__MAX_OBJECTS_PER_SECOND`,
|
||||
у разового прохода — `--max-objects-per-second R` (`make reconcile
|
||||
RATE=R`); плановая сверка берёт значение из настроек. Почему 2000: CPU
|
||||
шлюза на ключ списка — 0,085–0,11 мс (проба), 2000 ключей в секунду —
|
||||
~0,2 ядра S3 из 1; проход 100k на лимите стенда — с ~30 до ~65 с, на
|
||||
рабочем стенде (2–3 тыс. объектов) — ~1,5 с в час; граница нагрузки на
|
||||
S3 не зависит от CPU уборщика. Проверка выбора — метка профиля сверки
|
||||
(`bench.md`), итог — `REPORT.md`. «Started cleaner» называет
|
||||
`reconcile_max_objects_per_second`.
|
||||
|
||||
`.env.example` skeleton lab2 предлагает «логические» имена: `APP_HOST`,
|
||||
`APP_PORT`, `APP_ENV`, `SESSION_TTL_SECONDS`, `DATABASE_URL_FILE`,
|
||||
`SESSION_STORE`, `CACHE_URL_FILE`; шапка шаблона просит сопоставить их
|
||||
с реальными в `REPORT.md`. `SESSION_TTL_SECONDS` называют ещё контракт и
|
||||
рубрика, но ни одна публичная проверка его не читает. Срок сессии читает
|
||||
только приложение, поэтому это `[auth] session_ttl_seconds` в
|
||||
`config.toml`, а короткий срок для проверки истечения —
|
||||
`AUTH__SESSION_TTL_SECONDS=2` в окружении. Мост с контрактным именем
|
||||
ничего бы не дал: по абзацу выше окружение его не перекрывает. Пароли
|
||||
Postgres и Valkey приходят мостами из `POSTGRES_PASSWORD` и
|
||||
`VALKEY_PASSWORD`, а не строкой подключения в файле (`DATABASE_URL_FILE`,
|
||||
`CACHE_URL_FILE`). `SESSION_STORE` — PostgreSQL, отдельной настройки
|
||||
нет. Соответствие переменных реальной конфигурации описать в
|
||||
`REPORT.md` (раздел «Архитектура и решения»).
|
||||
|
||||
Skeleton lab3 добавил ещё два имени:
|
||||
|
||||
- `API_REPLICAS` читают compose (`deploy.replicas` сервиса `api`) и
|
||||
Makefile (`make replicas`, `EXPECT_REPLICAS` тестов), приложение —
|
||||
нет. Поэтому имя остаётся как есть, без секции: строка в
|
||||
`.env.example`, `${API_REPLICAS:-2}` в compose и `API_REPLICAS ?= 2`
|
||||
в Makefile — без строки в `.env` действует 2. Разовая подмена —
|
||||
`make replicas API_REPLICAS=N`;
|
||||
- `IDEMPOTENCY_TTL_SECONDS` читает только приложение. Это
|
||||
`[idempotency] ttl_seconds` в `config.toml` (по умолчанию 86400 —
|
||||
24 ч по контракту), соответствие — в `REPORT.md`, как
|
||||
`SESSION_TTL_SECONDS`.
|
||||
|
||||
Skeleton lab4 добавил имена `S3_*` (буквально не заводятся,
|
||||
соответствие — в `REPORT.md`, design change `s3-storage`, решение 5):
|
||||
|
||||
- `S3_ENDPOINT` → `S3__HOST` и `S3__PORT` (мосты в консоли,
|
||||
`x-s3-env` в docker);
|
||||
- `S3_REGION` → `[s3] region`;
|
||||
- `S3_BUCKET` → `S3__BUCKET`;
|
||||
- `S3_ACCESS_KEY_ID_FILE`, `S3_SECRET_ACCESS_KEY_FILE` → мосты из
|
||||
`S3_API_*`: значения, а не файлы, как с `DATABASE_URL_FILE`;
|
||||
- `MAX_UPLOAD_BYTES`, `MAX_IMAGE_PIXELS` — **константы, не настройки**
|
||||
(спек `service-configuration`, «Лимиты вложений — константы
|
||||
контракта»; design change `attachments`, решение 10):
|
||||
`ATTACHMENT_MAX_BYTES` (10 485 760) и `ATTACHMENT_MAX_PIXELS`
|
||||
(40 000 000) в `src/utils/constants.py`. Их задаёт контракт, они
|
||||
одинаковы на всех установках, поэтому ни окружение, ни `.env`, ни
|
||||
`config.toml` их не меняют, и в `.env.example` они не заводятся.
|
||||
Соответствие имён — в `REPORT.md`.
|
||||
|
||||
`X-Instance-Id` берётся из `[app] instance_id`: по умолчанию пусто, и
|
||||
тогда валидатор поля подставляет hostname процесса (один раз, при
|
||||
загрузке `settings`); значение проверяется по `INSTANCE_ID_PATTERN`.
|
||||
Его не задают ни в `config.toml` (он смонтирован во все реплики; в
|
||||
`config_example.toml` вместо поля — комментарий), ни в `.env`, ни в
|
||||
compose (`environment` и `hostname:` сервиса `api`): у реплик одного
|
||||
сервиса эти источники общие, а значение должно различаться. Разовая
|
||||
подмена в консоли — `APP__INSTANCE_ID=...`.
|
||||
|
||||
В настройки идёт только то, что отличается между установками, либо
|
||||
секрет. Остальное — константа.
|
||||
|
||||
## Новое поле или секция
|
||||
|
||||
1. Поле с типом и безопасным дефолтом: `Settings` загружается без
|
||||
файлов.
|
||||
Секрет — `""` и проверка при старте там, где он нужен. Единицы —
|
||||
коротким комментарием (`# секунды`).
|
||||
2. Новая секция — класс `<Name>(BaseModel)` и поле
|
||||
`<name>: <Name> = <Name>()` в `Settings`. Имя поля одновременно имя
|
||||
секции TOML и префикс env.
|
||||
3. Строка в `config_example.toml` с плейсхолдером и в рабочем
|
||||
`config.toml`. Значения из `config.toml` не печатать в ответ и лог.
|
||||
4. Значение нужно и compose, и приложению:
|
||||
- параметр самого приложения (порт) — переменная `SECTION__FIELD` в
|
||||
`.env.example` с комментарием и в `environment` сервиса compose
|
||||
(`docker.md`);
|
||||
- значение с именем, которое навязывает контейнер зависимости
|
||||
(пароль Postgres), — переменная и мост в `.env.example`, мост в
|
||||
`environment` сервиса compose.
|
||||
|
||||
В обоих случаях в `config_example.toml` поле не дублировать.
|
||||
5. Строка подключения — `@property` секции (`Database.url`): вызывающий
|
||||
код URL сам не собирает.
|
||||
6. Когда появятся `config_example.toml` и `config.toml`, добавить
|
||||
`config.toml` в `.gitignore` и `.dockerignore`.
|
||||
@@ -0,0 +1,653 @@
|
||||
---
|
||||
paths:
|
||||
- "student-tests/**"
|
||||
---
|
||||
|
||||
# Собственные тесты (`student-tests/`)
|
||||
|
||||
Быстрые тесты сервисов на фейках и настоящая единица работы — не здесь:
|
||||
`service-tests/` (`service-tests.md`). Здесь только black-box по HTTP.
|
||||
|
||||
В bp_proxies тесты запрещены. Здесь они обязательны для уровня 4
|
||||
(`README.md`), и каждый должен запускаться одной командой. Лаба 2
|
||||
требует автоматических проверок:
|
||||
|
||||
- истечения сессии при коротком `SESSION_TTL_SECONDS`, logout, неверного
|
||||
пароля;
|
||||
- недоступности Postgres и Redis/Valkey: ограниченная ошибка или
|
||||
корректный обход кэша, и никогда запрос как от анонимного;
|
||||
- гонки регистрации одного `username` (ровно один 201, остальные 409) и
|
||||
отката составной операции.
|
||||
|
||||
Проверки лабы 1 остаются: возможности прежних лаб сохраняются
|
||||
(`README.md`, «Что должно быть в PR»). Это неверный JSON, чужой чат,
|
||||
пустое сообщение, дубликат `username`, обход нескольких страниц истории
|
||||
и гонка: 10 клиентов параллельно отправляют 100 сообщений, и в истории
|
||||
ровно 100 уникальных. Команду и результат сохранить.
|
||||
|
||||
Лаба 3 добавляет (`api-contract.md`, «Балансировка и повторная
|
||||
отправка»):
|
||||
|
||||
- `X-Instance-Id` на успехе, ошибке, health, 404 неизвестного пути и
|
||||
405 (`test_api_conventions.py`; 500 по HTTP не вызвать — исключение
|
||||
в `spec_coverage.py`). `contract.py` проверяет заголовок у каждого
|
||||
ответа, прошедшего `assert_ok` / `assert_error`;
|
||||
- идемпотентность (`test_idempotency.py`, спек `idempotency`):
|
||||
- повтор того же тела — тот же 201 и тот же JSON, в истории одно
|
||||
сообщение;
|
||||
- другое тело — 409;
|
||||
- нет ключа, пустой, длиннее 128, недопустимый символ — 400;
|
||||
- тот же ключ у другого пользователя или в другом чате — новое
|
||||
сообщение;
|
||||
- другая запись того же JSON (пробелы, `\u`-экранирование; с лабы 4
|
||||
— порядок полей и `attachment_ids` по умолчанию) — повтор;
|
||||
- отозванный токен — 401, новая сессия того же пользователя — повтор;
|
||||
- посторонний — 404;
|
||||
- порядок кодов 401 → 400 → 404 → 409;
|
||||
- невалидный запрос не занимает ключ; сбой записи сообщения, отказ БД
|
||||
и срок ключа — проверки отказов (`test_failures.py`);
|
||||
- гонка одного ключа (уровень 4, `test_race.py`): N потоков за
|
||||
`threading.Barrier` шлют одно тело с одним ключом. Все ответы 201 с
|
||||
одним `id`, в истории ровно одно сообщение (`test_same_key_at_once`,
|
||||
любой стенд). Через LB `test_same_key_through_replicas` ещё требует
|
||||
пару пересекающихся по времени запросов с разными `X-Instance-Id`:
|
||||
иначе «одновременно через разные реплики» не доказано;
|
||||
- тесты реплик (нужны ≥ 2 реплики за `BASE_URL`, фикстура
|
||||
`replicas`):
|
||||
- `test_load_balancing.py` — одна сессия на разных репликах, запись
|
||||
видна через другую реплику (спек `load-balancing` вне сверки
|
||||
покрытия: сценарий — в докстринге);
|
||||
- `test_idempotency.py::test_replay_on_other_replica` — повтор с
|
||||
ключом через другую реплику, 409 от разных реплик;
|
||||
- `test_race.py::test_same_key_through_replicas`.
|
||||
|
||||
Сколько реплик за `BASE_URL`, набор узнаёт из `EXPECT_REPLICAS`, а не
|
||||
угадывает по ответам: иначе сломанный LB давал бы пропуск вместо
|
||||
падения. `make student_test` берёт его из `API_REPLICAS` (2), `make
|
||||
test_isolated` и `driver.py student` против своего процесса передают
|
||||
1. При 1 тесты реплик пропускаются с причиной «one API process» (её
|
||||
печатает `-rsP` в `addopts`), при ≥ 2 и одном увиденном значении —
|
||||
падают с числом увиденных (`assert_replicas` в `contract.py`);
|
||||
- «Одно значение на процесс» (`test_api_conventions.py`) — две
|
||||
одинаковые серии по 18 запросов: против одного процесса одно
|
||||
значение, через LB каждое значение повторяется, и вторая серия не
|
||||
приносит новых. Опирается на round-robin LB.
|
||||
|
||||
Лаба 4 добавляет (спек `attachments`, design change `attachments`,
|
||||
решение 12):
|
||||
|
||||
- `test_attachments.py` — сценарии спека `attachments`, кроме проверок
|
||||
отказов и исключений: загрузка PNG/JPEG и разновидностей, граница
|
||||
размера, 413 по `Content-Length` и частями, пиксели, «бомба», тип по
|
||||
содержимому и подмена MIME, повреждения и хвост, `filename` (400 только
|
||||
по списку контракта, Cf/Zl принимаются как есть), порядок проверок,
|
||||
доступ, метаданные, побайтный оригинал, `variant`, следы хранилища,
|
||||
повторная загрузка; «Скачивание через другую реплику» — с фикстурой
|
||||
`replicas`. Новые сценарии `messages`, `idempotency`,
|
||||
`api-conventions`, `data-storage` — в их модулях; пять сценариев
|
||||
рубрики «4» лабы 4 — в `test_rubric.py` (сценарий `student-tests` — в
|
||||
докстринге, маркеры — на сценарии `attachments` и `messages`);
|
||||
- `images.py` — генераторы: PNG на stdlib (любые IHDR и IDAT, Adam7,
|
||||
точный размер чанком `tEXt`, «бомба», огромные размеры, порча байта
|
||||
IDAT), JPEG через Pillow (разновидности, в том числе baseline без DHT;
|
||||
подмена размеров в SOF; `jpeg_undecodable` — без таблиц, изменённый
|
||||
заголовок скана, пустой скан, 27 байт из замечания ревьюера —
|
||||
`test_undecodable_jpeg`, красный на `e30b649`), обрезка и хвост.
|
||||
Большие файлы и «бомбы» живут в памяти теста, в git
|
||||
не попадают. С лабы 5 Pillow — основная зависимость worker; в тестах он
|
||||
генератор и проверка пикселей;
|
||||
- `api_client.py`: `post_attachment` (байты или итератор — частями,
|
||||
без `Content-Length`; `None` — без заголовка или параметра),
|
||||
`upload` (201 и проверка размера, SHA-256, `owner_id`, `filename`),
|
||||
`attachment_meta`, `attachment_content`, `send_message(...,
|
||||
attachment_ids=…)`. `contract.py`: коды 413 и 415, `owner_id` и
|
||||
элементы `attachment_ids` — UUID в нижнем регистре, `updated_at` —
|
||||
время, `assert_content` (байты, тип, длина, `nosniff`, без `Location`
|
||||
и `x-amz-*`);
|
||||
- проверки отказов (`test_failures.py`): «Запись в S3 не удалась»,
|
||||
«Отклонённая загрузка ничего не оставляет», «S3 остановлен» (с
|
||||
историей `attachment_ids` без S3), «S3 завис»; вне сверки — «Окружение
|
||||
не меняет лимит» спека `service-configuration`. Срок «S3 завис» —
|
||||
`[s3] timeout_seconds` (5 с) плюс запас; клиент теста — со сроком
|
||||
больше этого, иначе httpx оборвёт раньше ответа;
|
||||
- с change `upload-consistency` (design, решение 10) — согласованность
|
||||
БД и S3 и уборщик, тоже проверки отказов:
|
||||
- **списки `id`, а не счётчики**: уборщик стенда отказов убирает
|
||||
строки прежних тестов параллельно, и «`pending` +1» зависел бы от
|
||||
порядка тестов; после DELETE SeaweedFS оставляет пустой каталог
|
||||
`<id>/` ещё ~2 мин, и счёт по каталогам завышен. Тесты сравнивают
|
||||
множества: новые `id` (`after − before`), готовые — те же, объекты
|
||||
без строки — `object-ids − attachment-ids` (сначала строки, потом
|
||||
объекты: уборщик удаляет объект раньше строки);
|
||||
- hook: `attachment-ids` (`<id> <status>` через psql), `last-pending`
|
||||
(замечание S6 verify `attachments`), `object-ids` (файлы `original`
|
||||
из `weed shell fs.tree` под `/buckets/<bucket>/<база>/attachments`;
|
||||
bucket и база — `FAULT_S3_BUCKET`, `FAULT_DATABASE` от
|
||||
`run_failures.py`), `fail-attachments
|
||||
insert|ready|stall|commit|outlive|undeletable <filename>` (триггеры
|
||||
на уникальный `filename` теста, сбой — SQLSTATE 08006, для API отказ
|
||||
БД, 503: вставка или перевод в `ready` падает; `stall` — перевод в
|
||||
`ready` ждёт `pg_sleep(4)`; `commit` — отложенный триггер
|
||||
ограничения роняет COMMIT перевода, исход для API неизвестен;
|
||||
`outlive` — строка вставляется на час старше вместе с `updated_at`,
|
||||
а перевод в `ready` ждёт до 4,5 с в триггере уровня оператора
|
||||
`BEFORE UPDATE OF status`, пока строку не уберёт уборщик: на уровне
|
||||
оператора строка не заблокирована, а пометку уборщика (только
|
||||
`updated_at`) `OF status` не задерживает; `undeletable` — как
|
||||
`outlive`, и удаление строки падает — в той же транзакции уборки,
|
||||
где уборщик уже удалил объект: это откат второго шага после удачного
|
||||
DELETE в S3), `clear-fail-attachments`,
|
||||
`kill-api` / `start-api` (`docker kill` / `docker start`
|
||||
`<FAULT_PROJECT>-api`, ожидание `healthy`);
|
||||
- тесты: `test_upload_with_object_storage_stopped` (+ «Незавершённая
|
||||
загрузка не видна»: метаданные, байты и ссылка — 404 с `message`
|
||||
неизвестного `id`), `test_rejected_uploads_leave_nothing`,
|
||||
`test_metadata_insert_failure`, `test_interrupted_body` (итератор
|
||||
тела бросает исключение после 1 MiB), `test_ready_failure_compensated`
|
||||
(объекта нет сразу после 503, на G/2 строка ещё `pending`, после
|
||||
G + I + 5 с ни строки, ни объекта), `test_object_storage_paused`
|
||||
(уборка после `unpause`), `test_killed_between_put_and_ready`
|
||||
(`stall` → строка и объект есть → `kill-api` → нет 201 → `start-api`
|
||||
в `finally` → уборка), `test_cleaner_survives_outages` (S3 и
|
||||
PostgreSQL остановлены, строка на месте после G + 3I, после возврата
|
||||
S3 убрана за I + 5 с, готовое вложение цело); по замечаниям verify —
|
||||
`test_ready_commit_outcome_unknown` (`commit`: 503, строка `pending`
|
||||
и объект есть сразу после ответа, после G + I + 5 с ни того, ни
|
||||
другого), `test_upload_outlives_grace` (`outlive`: 503, а не 201 и
|
||||
не 500, ни строки, ни объекта) и
|
||||
`test_cleaner_failure_after_object_delete` (`undeletable`: 503, а не
|
||||
201, строка `pending`, `ready` без объекта нет; после снятия
|
||||
триггера уборщик доводит уборку). Клиент загрузок с ожиданием в
|
||||
триггере — со сроком 30 с (у `Api` по умолчанию 5 с). G и I —
|
||||
`FAULT_CLEANER_GRACE_S` (20) и `FAULT_CLEANER_INTERVAL_S` (1) от
|
||||
`run_failures.py`; запас поверх G + I — 5 с;
|
||||
- красный прогон до кода (новые тесты против прежней ветки
|
||||
`mark_ready` без компенсации и без уборщика): упали
|
||||
`test_ready_failure_compensated` (объект остался),
|
||||
`test_killed_between_put_and_ready`, `test_cleaner_survives_outages`,
|
||||
`test_object_storage_paused` (строки никто не убрал); остальные
|
||||
сценарии прежний код уже выполнял. Тесты по замечаниям verify:
|
||||
`test_cleaner_failure_after_object_delete` красный на коде до пометки
|
||||
(201: ждавший `mark_ready` перевёл строку в `ready` после отката
|
||||
уборщика, объект уже удалён; на двухшаговой схеме — пометка, затем
|
||||
объект и строка одной транзакцией — тест не менялся и проверяет тот
|
||||
же откат); `test_ready_commit_outcome_unknown` и
|
||||
`test_upload_outlives_grace` на том коде зелёные (ветки были верны) и
|
||||
красные на временных регрессиях — компенсация на любой сбой (объекта
|
||||
нет сразу после 503) и возврат `RuntimeError` (500);
|
||||
- с change `upload-memory` (design, решение 11) — места загрузки и срок
|
||||
тела:
|
||||
- `test_attachments.py::test_concurrent_uploads` («Загрузки в
|
||||
пределах лимита», любой стенд): 10 участников одного чата за
|
||||
`threading.Barrier`, у каждого свой `Api` (срок 30 с) и свой PNG из
|
||||
шума ~1 MiB (`images.png_noise(seed=…)`); все 201, `id` разные,
|
||||
загрузки пересекались по времени, каждое скачивается побайтно;
|
||||
- `contract.py`: код 429 — `rate_limited`, `assert_error(resp, 429)`
|
||||
требует `Retry-After` — положительное целое;
|
||||
- третий API стенда отказов — «узкий по загрузкам»
|
||||
(`<проект>-api-uploads`, `UPLOADS_ENV` в `run_failures.py`: 1 место,
|
||||
1 в очереди, ожидание 1 с, срок тела 3 с), тестам —
|
||||
`FAULT_UPLOADS_BASE_URL` (фикстура `uploads_api`, срок клиента 30 с)
|
||||
и `FAULT_UPLOADS_ENV`; тесты сверяют, что стенд запущен с этим
|
||||
окружением (`assert_uploads_stand`). Место держит загрузка A
|
||||
(`held_slot`): генератор тела отдаёт половину и ждёт
|
||||
`threading.Event`; A отпускается до истечения её срока тела (3 с:
|
||||
в `test_upload_slots_busy` A держит место ~1,3–1,5 с, при 2 с запас
|
||||
был ~0,5 с — verify, S5);
|
||||
- тесты (`fault`): `test_upload_slots_busy` (B ждёт, C сразу 429 < 0,5
|
||||
с, B — 429 не раньше 1 с, `Retry-After` ≥ 1; из трёх загрузок новая
|
||||
строка и объект — только у A), `test_rejections_before_queue` (при
|
||||
полной очереди 404 постороннему, 413 по `Content-Length` 30 MiB и 415
|
||||
по `Content-Type` — быстрее срока ожидания и раньше 429 ожидавшей),
|
||||
`test_upload_waits_for_slot` (B ждёт и получает 201, `B.created_at >
|
||||
A.updated_at` — сценарий `storage-consistency`),
|
||||
`test_slot_released_after_failures` (413 по счётчику, 415 по
|
||||
содержимому, 400 по сроку тела, обрыв, 503 при остановленном S3 —
|
||||
после каждого `sample.png` получает 201 быстрее срока ожидания),
|
||||
`test_slow_body` (тело частями дольше срока — 400 «Upload body was
|
||||
not received in time», ни строки, ни объекта; мелкими частями в
|
||||
срок — 201 с тем же SHA-256);
|
||||
- красный прогон на `f894040`: упали все пять — у прежнего кода нет ни
|
||||
мест, ни срока тела (`evidence/tests/failure-checks.md`);
|
||||
- сценарии памяти «Одна копия тела при записи в S3» и «Память не
|
||||
растёт с числом загрузок» — исключения сверки: `make bench_uploads` →
|
||||
`evidence/uploads/baseline/summary.md` (`bench.md`, профиль
|
||||
`uploads`);
|
||||
- с change `track2-reconciler` (design, решение 11) — сверка bucket и
|
||||
БД, тоже проверки отказов, в конце `test_failures.py` (их тесты
|
||||
оставляют вложения, помеченные потерянными, — `ready` без объекта;
|
||||
прежние тесты таких не ждут, `ready_without_object`):
|
||||
- hook: `put-object <ключ>` (тело — stdin фикстуры `stand(...,
|
||||
stdin=байты)`; `docker exec -i <проект>-api python -c …` — botocore
|
||||
образа ключами API из окружения контейнера, ключи в hook не
|
||||
попадают), `delete-object <ключ>` (`weed shell fs.rm`, ошибка — по
|
||||
выводу), оба — только под `<FAULT_DATABASE>/attachments/` и символы
|
||||
`[A-Za-z0-9._/-]`; `delete-row`, `set-size`, `age-row` (сдвиг
|
||||
`created_at` и `updated_at` вместе — CHECK и непомеченность `pending`
|
||||
сохраняются), `set-key <id> <ключ>` (только `object_key` строки,
|
||||
ключ под `<FAULT_DATABASE>/`, в том числе вне `attachments/`; bucket
|
||||
не трогается), `lost-ids`; `fail-attachments mark <filename>` — свой
|
||||
триггер `BEFORE UPDATE OF lost_at` (08006), `clear-fail-attachments`
|
||||
снимает и его; `reconcile dry-run|apply [<предел>]` — `docker compose
|
||||
run --rm --no-deps -T cleaner reconcile …`, записи процесса и строка
|
||||
`exit_code=<n>`, код hook — 0; `stop|start cleaner` (`start` —
|
||||
`docker start` контейнера: `compose start` проверял бы зависимость
|
||||
`migrate`, а её одноразового контейнера нет); `run-cleaner
|
||||
<секунд>` — `<проект>-cleaner-scheduled` с
|
||||
`RECONCILER__INTERVAL_SECONDS=1`, затем `docker stop`, журнал и `rm`
|
||||
(`run_failures.py` убирает его вместе с API);
|
||||
- уборщик стенда — без плановой сверки (`RECONCILER__INTERVAL_SECONDS:
|
||||
"0"` в `failures.compose.yml`): иначе она исправляла бы внесённое до
|
||||
проверки; `run_failures.py` печатает интервал сверки в строке `start
|
||||
cleaner`;
|
||||
- тесты: `test_reconcile_finds_and_fixes` (уборщик стоит, A в сообщении
|
||||
без объекта, B без строки, C с другим размером, O мимо API, P —
|
||||
`commit`; после G + 1 dry-run — свои классы, код 3, ничего не
|
||||
изменилось, A — 500; apply — O и B удалены, P убрана, A и C помечены,
|
||||
A — 404, метаданные — 200; повтор — своих нет), `…_keeps_fresh_used_
|
||||
and_unknown`, `…_restored_original`, `…_change_limit`,
|
||||
`…_object_storage_stopped`, `…_interrupted_by_database`,
|
||||
`…_under_load` (4 потока ~G + 15 с загрузок PNG ~100 KiB и отправок,
|
||||
apply раз в 3 с; все 201 скачиваются с тем же SHA-256, новые пометки
|
||||
— только внесённые), `test_scheduled_reconcile`; по замечаниям
|
||||
verify — `test_reconcile_keeps_referenced_objects` (X с другим ключом,
|
||||
Y ссылается на `<Z>/original` без строки Z: три объекта — чужие и на
|
||||
месте, X помечено), `test_reconcile_limit_keeps_cleanup` (отказ по
|
||||
пределу, зависшая загрузка всё равно убрана) и
|
||||
`test_reconcile_foreign_key_untouched` (`set-key` на
|
||||
`<база>/elsewhere/<id>` у готовой строки и зависшей загрузки: чужие, ни
|
||||
пометки, ни уборки). Записи
|
||||
фильтруются по своим `id` и ключам, код выхода сверяется с записями
|
||||
того же прохода (`Reconcile.assert_code_matches`). Объекты без строки
|
||||
ждут G + 1 с (`LastModified` ставит S3), строки состаривает
|
||||
`age-row`; у состаренных и с изменённым размером метаданные
|
||||
сравниваются без полей, которые изменил сам hook;
|
||||
- красный прогон на `c13df14` (код до change): упали все восемь —
|
||||
команды `reconcile` нет (argparse, код 2), колонки `lost_at` нет
|
||||
(`lost-ids` — ошибка psql), плановой сверки нет
|
||||
(`evidence/tests/failure-checks.md`). Тесты по замечаниям verify: на
|
||||
`a6071da` `…_foreign_key_untouched` красный (готовая строка —
|
||||
`missing_object` после HEAD чужого префикса, зависшая — `stale_pending`),
|
||||
два теста W1 зелёные (ветки были верны) и красные на временных
|
||||
регрессиях — `_recheck_orphan` без проверки ссылок и уборка зависших
|
||||
под пределом (design, «Уточнения apply», п. 22);
|
||||
- с change `fix-upload-put-flake` (design, решение 3) — простой S3 после
|
||||
скачиваний, тоже проверка отказов:
|
||||
- четвёртый API стенда отказов — «с коротким сроком S3»
|
||||
(`<проект>-api-s3`, `S3_ENV` в `run_failures.py`:
|
||||
`S3__TIMEOUT_SECONDS=1`), тестам — `FAULT_S3_BASE_URL` (фикстура
|
||||
`s3_api`, срок клиента 30 с) и `FAULT_S3_ENV`; тест сверяет стенд
|
||||
(`assert_s3_stand`). Других тестов на нём нет: пул S3 процесса — только
|
||||
от этого теста. Короткий срок нужен, чтобы простой дольше срока вызова
|
||||
длился 1,5 с, а не 6;
|
||||
- `api_client.py`: `attachment_content_slowly` — скачивание потоком с
|
||||
паузой после каждого блока 64 KiB, ответ с байтами в `content` (его
|
||||
проверяет `assert_content`);
|
||||
- `test_upload_after_idle_s3` («Загрузка после простоя S3»): PNG из шума
|
||||
~4 MiB загружен один раз; до 8 раундов — 10 одновременных медленных
|
||||
скачиваний (барьер, своё соединение, 2 мс на блок), простой
|
||||
`S3__TIMEOUT_SECONDS + 0,5` с, 12 загрузок `sample.png` по одной,
|
||||
каждая 201; сообщение падения — раунд, загрузка и ответ. Тест
|
||||
вероятностный внутри раунда: до правки соединение портится с p ≈
|
||||
0,28, промах восьми раундов ≈ 4e-12 (докстринг);
|
||||
- красный прогон на `4cfaab0` (тест без правки клиента): `make
|
||||
failure_checks FAULT_ARGS='-k idle_s3'` три раза — каждый 1 failed в
|
||||
первом раунде (загрузки 4, 8, 3: 503 `unavailable`, в журнале API —
|
||||
`put_object` `ReadTimeoutError` за 1 мс); после правки — 1 passed,
|
||||
~16 с (`evidence/tests/failure-checks.md`);
|
||||
- с change `track2-reconcile-cost` (design, решение 14) — стоимость
|
||||
сверки, тоже проверки отказов, в конце `test_failures.py`:
|
||||
- hook: `reconcile dry-run|apply [<предел>] [--strategy batch|head]
|
||||
[--deep] [--max-objects-per-second R]` — каждый аргумент по списку
|
||||
(`reconcile_options`: стратегия из двух, R — неотрицательное число,
|
||||
повтор флага — отказ), иначе код 2 hook; команде передаются как есть.
|
||||
`run_reconcile(stand, mode, limit, options=…)` в тестах;
|
||||
- тесты: `test_reconcile_head_strategy_same_findings` (расхождения как в
|
||||
`…_finds_and_fixes`, уборщик стоит; dry-run `batch` и `head` — свои
|
||||
классы и ключи, весь отчёт, `found`, `listed_objects`, `checked_rows` и
|
||||
коды равны, у `head` больше HEAD и сеансов; затем apply — стенд без
|
||||
внесённого), `test_reconcile_deep_checksum` (A в сообщении
|
||||
перезаписано другими байтами того же размера, `age-row`, G + 1:
|
||||
поверхностная A не называет, `--deep` — `checksum_mismatch`,
|
||||
`read_bytes`, код 3, ничего не изменилось, SHA-256 обоих тел в журнале
|
||||
нет; `--deep --apply` — пометка, 404 / 200),
|
||||
`test_reconcile_restore_needs_same_bytes` (помечено → другие байты
|
||||
того же размера, G + 1: apply пометку не снимает, 404 → те же байты,
|
||||
G + 1: снята, 200 с тем же SHA-256), `test_reconcile_rate_limit`
|
||||
(восемь загрузок и одна потеря, уборщик стоит; dry-run с пределом 0 и
|
||||
с R = max(5, ⌈объектов / 4⌉): `duration_ms ≥ 1000 × storage_objects /
|
||||
R × 0,95`, без предела короче, находки и коды равны),
|
||||
`test_reconcile_limit_stops_rechecks` (6 потерь, apply с пределом 2:
|
||||
код 3, `changes` = 3, `unchecked` ≥ 3, ни одной пометки; dry-run
|
||||
называет все шесть, `unchecked` 0; apply 100 — помечены). Байты
|
||||
«того же размера» — `same_size_bytes(data, seed=…)` от зерна теста;
|
||||
по замечаниям verify — `test_reconcile_row_with_other_id_key` (W2: Y1
|
||||
и Y2 ссылаются на `<Z1>/original` другого размера и `<Z2>/original`
|
||||
тех же размера с другими байтами; dry-run `--deep` обеими стратегиями
|
||||
— Y1 `size_mismatch`, Y2 `checksum_mismatch`, четыре объекта чужие,
|
||||
без `--deep` — только Y1; `--deep --apply` — обе помечены, объекты на
|
||||
месте; записи сравниваются тройкой «класс, ключ, `id`»,
|
||||
`own_findings`) и `test_reconcile_fresh_overwrite_untouched` (S1:
|
||||
объекты двух состаренных вложений перезаписаны только что — другим
|
||||
размером и другими байтами; `--deep --apply` и `--deep --strategy
|
||||
head` в пределах grace — ни находок, ни пометок, `fresh_objects` ≥ 2;
|
||||
после G + 1 — `size_mismatch` и `checksum_mismatch`; исходные байты
|
||||
возвращаются в `finally`);
|
||||
- красный прогон на `7f4e626` (тесты и hook из рабочего дерева): упали
|
||||
все пять — новые аргументы — ошибка argparse (код 2; у `head` пустой
|
||||
отчёт, у предела скорости нет итога), у глубокой нет поля `deep`,
|
||||
пометку снимал другой объект того же размера, `changes` 7 вместо 3
|
||||
(`evidence/tests/failure-checks.md`). Тесты verify — на `16f2cde`:
|
||||
`…_row_with_other_id_key` красный (`batch` не назвал Y1 и Y2),
|
||||
`…_fresh_overwrite_untouched` красный (объект другого размера,
|
||||
перезаписанный только что, помечен); W1 тестом отказов не
|
||||
проверяется — hook не шлёт сигнал посреди прохода, это `driver.py
|
||||
reconcile-signal --pace --apply`;
|
||||
- исключения сверки: «Принявшая реплика остановлена» — `driver.py
|
||||
attachment-failover` → `evidence/attachments/failover.md`; «Байты не в
|
||||
БД и не на диске API» — `driver.py attachment-storage` →
|
||||
`evidence/attachments/storage.md`; «Рестарт стенда» — `make
|
||||
test-persistence` (с `LAB=4` публичная проверка скачивает оригинал
|
||||
после hook) → `evidence/replicas/test-persistence.md`.
|
||||
|
||||
Лаба 5 добавляет (design change `async-attachments`, решение 15):
|
||||
|
||||
- `api_client.py`: `upload` — 202 и снимок `queued` (`assert_accepted`),
|
||||
`wait_attachment(actor, id, status=…, timeout=60)` — опрос раз в 0,2 с,
|
||||
падение с последним состоянием, `upload_ready` — загрузка и ожидание.
|
||||
Тест, которому нужны байты, ждёт `ready`, а не считает его готовым после 202;
|
||||
форма ответа 202 проверяется до ожидания. `contract.py`:
|
||||
`assert_variant_content` (заголовки, размер и SHA-256 варианта). `images.py`:
|
||||
`jpeg_precision_12`, `jpeg_halves(orientation)`, `png_half_transparent`,
|
||||
`png_palette_transparent`, `png_rgba_large`;
|
||||
- `test_attachment_processing.py` — thumbnail, варианты, `failed` по HTTP на
|
||||
любом стенде с worker;
|
||||
- hook — ещё действия брокера и worker, `worker-state`, `queue-state`,
|
||||
`peek-job`, `publish-job`, `delete-queue`, `job`, `staging-ids`,
|
||||
`variant-object-count`, режимы `fail-attachments` на `queued`, а `ready-fail`,
|
||||
`ready-stall` — на фиксацию worker; ключи и пароль брокера hook не получает:
|
||||
`peek-job` и `publish-job` — Python в контейнере API его настройками;
|
||||
- стенд отказов: `rabbitmq` без порта, worker с `restart: "no"`, 4 попытки,
|
||||
пауза 5 с, срок 10 с, graceful 2 с (`FAULT_WORKER_*`), журнал worker при
|
||||
падении; `make test_isolated` — ещё контейнер `<проект>-test-worker` и уборка
|
||||
очереди `test_<db>.attachment.process.v1`. Полный прогон — 99 проверок, pytest
|
||||
~1300 с, вся команда ~22 мин. Описание лабы 4 выше — история: `upload` там
|
||||
отвечал 201, режим hook `ready` стал `queued`, тесты `test_ready_*` — `test_queued_*`.
|
||||
|
||||
С change `pipeline-reliability` (design, решения 14–15):
|
||||
|
||||
- `contract.py`: `assert_variant_image` (настоящий JPEG или WebP того размера);
|
||||
`images.py`: `png_stripes`, `png_solid`, `jpeg_with_metadata`, `jpeg_scan_bomb`
|
||||
(прогрессивный 8000 × 5000, самый маленький AC-скан повторён до 10 MiB);
|
||||
`test_failures.py`: `assert_variants` вместо `assert_one_thumbnail`;
|
||||
- hook: `stop|start|kill|pause|unpause relay`, `freeze worker` (`docker kill -s STOP`:
|
||||
контейнер `running`, поэтому KILL проходит), `pause|unpause worker`, `run-worker K=V…`,
|
||||
`run-relay K=V…`, `stop-extra`, `extra-log`, `kill-extra`, `pause-extra`,
|
||||
`unpause-extra`, `relay-log`, `relay-state`, `cleaner-log`, `kill-render`, `render-env`,
|
||||
`render-count`, `wait-commit-stall`, `object-sha256`, `broker-memory-limit`, режимы
|
||||
`ready-commit-stall`, `relay-stall`, `set-sha256`, `set-staging-key`,
|
||||
`set-next-attempt`, `expire-lease`, `attachment-row`, `attachment-free` (`FOR SHARE
|
||||
SKIP LOCKED`: держит ли строку чужая транзакция), `delete-variant`,
|
||||
`cancel-to-pending`, `replay`, `replays`, `reconcile … --staging-retention S --grace
|
||||
S`; `run-cleaner` ждёт конец первого прохода, а не весь срок; `peek-job`
|
||||
и `publish-job` — одноразовым контейнером relay; `run-worker-second` — третий
|
||||
worker рядом с замороженным первым (`test_hung_worker_lease_fencing`), `extra-log`,
|
||||
`pause-extra`, `unpause-extra` принимают `worker-second`;
|
||||
- окна сбоя — без точек в коде: после COMMIT до publish — relay убит; после confirm до
|
||||
отметки — `relay-stall`, `kill relay`; после записи S3 до COMMIT — `ready-stall`,
|
||||
`kill worker`; после COMMIT до ack — `ready-commit-stall`, `wait-commit-stall`, `freeze`,
|
||||
`kill`. Зависший worker: worker со сроками больше времени теста, иначе при
|
||||
разморозке его прервал бы таймер, а не fencing; аренду делает истекшей `expire-lease`.
|
||||
Номер попытки решает, только пока вторая жива: `test_hung_worker_lease_fencing`
|
||||
размораживает первую при замороженной второй (та взята и ждёт S3, блокировки строки
|
||||
нет); если вторая уже дала итог (`test_hung_worker_thawed_after_ready`), решает `state`;
|
||||
- `test_pixel_limit_png_modes` — обычный набор: `images.png_at_pixel_limit` даёт 8000 × 5000
|
||||
любого типа PNG; типы, которые переводятся в другой режим, не должны держать исходник на
|
||||
время масштаба;
|
||||
- стенд отказов: `relay` (`restart: "no"`, опрос 0,2 с, порог потерянного 5 с), worker —
|
||||
4 попытки, пауза 4–16 с, срок 10 с, запас аренды 2 с, процесс обработки 8 с / 3 с CPU,
|
||||
остановка 2 с; уборщик — срок хранения 60 с; `FAULT_RELAY_*`, новые `FAULT_WORKER_*`,
|
||||
`FAULT_CLEANER_STAGING_RETENTION_S`, журнал relay при падении, уборка
|
||||
`<проект>-worker-extra`, `<проект>-relay-extra`; `make test_isolated` — ещё контейнер
|
||||
`<проект>-test-relay`. После KILL новая попытка ждёт аренду 12 с. Время полного
|
||||
прогона — design change `pipeline-reliability`, «Уточнения apply».
|
||||
|
||||
С change `track1-queue-overload` (design, решение 13):
|
||||
|
||||
- пятый API стенда отказов — «узкий по заданиям» (`<проект>-api-backlog`, `BACKLOG_ENV`
|
||||
в `run_failures.py`: `UPLOADS__MAX_UNFINISHED_JOBS=3`), тестам — `FAULT_BACKLOG_BASE_URL`
|
||||
(фикстура `backlog_api`, срок клиента 30 с) и `FAULT_BACKLOG_ENV`, сверка —
|
||||
`assert_backlog_stand`; без адреса `pytest -m fault` останавливается до первого теста.
|
||||
У четырёх прежних — `UPLOADS__MAX_UNFINISHED_JOBS=0`: их проверки копят задания при
|
||||
остановленном worker, и предел отклонял бы чужие загрузки;
|
||||
- hook: `unfinished-jobs` (число заданий `queued` и `processing`, полный счёт, без обрыва),
|
||||
`backlog-api-log` (журнал пятого API); помощник `wait_no_unfinished` — перед проверкой
|
||||
предела стенд должен разобрать чужой бэклог, до 120 с;
|
||||
- тесты: `test_backlog_limit` («Предел достигнут», «Порядок проверок у предела»,
|
||||
«Остальной API у предела», «Загрузки снова принимаются», запись «Started API» и «Rejected
|
||||
attachment» по журналу), `test_backlog_ignores_finished`,
|
||||
`test_backlog_counts_waiting_retry` (relay стоит, срок следующей попытки отодвинут
|
||||
`set-next-attempt`), `test_backlog_without_broker`, `test_backlog_overshoot_bounded` (40
|
||||
клиентов за барьером, принято от K до K + 20), `test_backlog_off` (обычный API без
|
||||
предела);
|
||||
- девять сценариев `queue-overload` с открытой нагрузкой и счётчиками — исключения сверки:
|
||||
`make bench_queue QUEUE_LABEL=baseline4` → `evidence/queue/baseline4/summary.md`.
|
||||
|
||||
С лабы 6 (design change `otel-telemetry`, решение 20) телеметрия на тестовых стендах выключена:
|
||||
`make test_isolated` передаёт `-e TELEMETRY__ENABLED=false` контейнерам API и worker, стенд
|
||||
отказов — `TELEMETRY__ENABLED: "false"` у `api` и `worker` в `failures.compose.yml`; сервисы
|
||||
телеметрии они не запускают (старт списком), а `GRAFANA_ADMIN_PASSWORD` compose требует только
|
||||
при разборе — его даёт `make env_setup`. «Started API» их API называет `telemetry_enabled:
|
||||
false`. Сценарии `observability` по HTTP-тестам не проверяются: их проверяют быстрые тесты
|
||||
`service-tests/` и команды драйвера `telemetry-check`, `telemetry-outage`, `trace-chain`,
|
||||
`stand-from-scratch` на рабочем стенде. С design change `job-trace-propagation` (решение 7) и
|
||||
relay тестовых стендов без телеметрии: `-e TELEMETRY__ENABLED=false` у `<проект>-test-relay`
|
||||
(`run_isolated.py`), `TELEMETRY__ENABLED: "false"` у `relay` в `failures.compose.yml`.
|
||||
|
||||
Проверки отказов реплик (остановка, kill, зависание, rolling update) —
|
||||
не pytest, а `make test-failover`, профиль `failover` стенда `bench/`
|
||||
(`make bench_failover`, `bench.md`), команды драйвера `kill-inflight`,
|
||||
`hang-key` и сценарии `balancer.md`: им нужен стенд с LB и действие над
|
||||
контейнерами.
|
||||
|
||||
## Как писать
|
||||
|
||||
- Black-box по HTTP против запущенного сервера (`BASE_URL`, по умолчанию
|
||||
`http://localhost:8080`), как публичный smoke. Тест не импортирует
|
||||
`src` и не поднимает приложение сам: те же тесты проверяют и
|
||||
контейнер, и следующие лабы.
|
||||
- pytest + httpx в dev-группе uv, запуск — `make student_test`.
|
||||
- Каждый тест создаёт своих пользователей с уникальным `username`
|
||||
(uuid-суффикс): состояние сервера общее, а удалять данные API не умеет.
|
||||
- Проверять не только статус, но и форму: `{"error": {...}}` с
|
||||
`code`, `request_id` совпадает с `X-Request-Id`, у успешных ответов
|
||||
нет лишних полей. Семантика — `.claude/rules/api-contract.md`.
|
||||
- Тест гонок — реальная параллельность, а не цикл: потоки за
|
||||
`threading.Barrier`, у каждого свой `Api` (своё соединение). Тест
|
||||
требует, чтобы одновременно в полёте было ≥ 2 запросов, иначе гонка
|
||||
не доказана. Проверяются количество и уникальность `id`, а также
|
||||
отсутствие потерь при обходе всех страниц.
|
||||
- Обычный прогон — `make test_isolated` (`student-tests/run_isolated.py`):
|
||||
образ из рабочего дерева на временной базе `test_<db>` с Valkey и S3
|
||||
стенда (ключи кэша и объектов разделены именем базы), публичный smoke
|
||||
и весь набор против отдельного контейнера, затем уборка при любом
|
||||
исходе. С лабы 4 уборка удаляет и объекты под префиксом `test_<db>/`
|
||||
bucket — в начале (хвост прошлого прогона) и в конце: `docker compose
|
||||
exec -T s3` + `weed shell` `fs.rm -r /buckets/<bucket>/test_<db>`
|
||||
(отсутствие префикса — не ошибка). `weed shell` выходит с кодом 0 и
|
||||
при ошибке команды, поэтому успех проверяется отдельно: нет строк
|
||||
`rm:` с ошибкой и `fs.ls` префикса пуст; иначе в начале — код 1 до
|
||||
прогона, в уборке — «cleanup failed» и код 1. Префикс собирается только из
|
||||
имени, прошедшего `^test_[a-z0-9_]+$`, и проверенного имени bucket,
|
||||
иначе код 2 до любых действий: ошибка не может удалить рабочий
|
||||
префикс. `KEEP_TEST_DB=1` оставляет базу и префикс и печатает оба.
|
||||
Его вывод — evidence набора против контейнера. Это один контейнер
|
||||
API без LB (`EXPECT_REPLICAS=1`): тесты, которым нужны ≥2 реплики,
|
||||
здесь пропускаются. `make student_test` — против любого запущенного
|
||||
стенда (`BASE_URL`), он оставляет данные в рабочей базе. Против
|
||||
стенда compose лабы 3 (`BASE_URL` = HAProxy) выполняются и тесты
|
||||
реплик; их вывод — второй файл evidence
|
||||
(`evidence/tests/student-test-lb.md`).
|
||||
- Проверкам, которым нужен особый стенд (TTL 2 с, остановленные или
|
||||
замороженные Postgres и Valkey, сбой БД посреди транзакции), обычный
|
||||
прогон не подходит. Это **проверки отказов**: маркер `fault`, модуль
|
||||
`test_failures.py`, команда `make failure_checks` (change
|
||||
`failure-checks`). Попадание в кэш по HTTP не отличить от чтения из
|
||||
БД: такие сценарии `chat-cache` — исключения с evidence.
|
||||
- Как устроен `make failure_checks` (`student-tests/run_failures.py`):
|
||||
- тот же `docker-compose.yml` под проектом `<рабочий>-failures` с
|
||||
override `failures.compose.yml`: свои Postgres, Valkey и с лабы 4
|
||||
S3 со своими volumes, их порты не публикуются; bootstrap S3 —
|
||||
отдельным `up --no-deps --exit-code-from s3-bootstrap` после
|
||||
миграций; у `s3` `stop_grace_period: 2s` — здесь проверяется отказ,
|
||||
а не плавная остановка (~15 с), и `stop` не тянет время набора;
|
||||
healthcheck PostgreSQL проверяет
|
||||
служебную базу `postgres` (иначе каждая проверка — сессия в базе
|
||||
приложения и шум счётчика `db-sessions`);
|
||||
- пять API на свободных портах `127.0.0.1` (пятый — раздел change
|
||||
`track1-queue-overload` выше): обычный (`BASE_URL`; с
|
||||
лабы 4 в окружении `MAX_UPLOAD_BYTES=1` и `MAX_IMAGE_PIXELS=1` —
|
||||
`LIMITS_ENV`, тест получает их в `FAULT_LIMITS_ENV` и грузит
|
||||
`sample.png`: лимиты — константы, спек `service-configuration`),
|
||||
«тесный» (`FAULT_TIGHT_BASE_URL`: сроки сессии и ключа
|
||||
идемпотентности 2 с, пул 1, короткие таймауты), с change
|
||||
`upload-memory` «узкий по загрузкам» (`FAULT_UPLOADS_BASE_URL`,
|
||||
`UPLOADS_ENV` → `FAULT_UPLOADS_ENV`: 1 место, 1 в очереди, ожидание
|
||||
1 с, срок тела 3 с), с change `fix-upload-put-flake` — «с коротким
|
||||
сроком S3» (`FAULT_S3_BASE_URL`, `S3_ENV` → `FAULT_S3_ENV`: срок
|
||||
вызова S3 1 с); без любого из четырёх адресов `pytest -m fault`
|
||||
останавливается до первого теста; при падении печатаются журналы
|
||||
всех четырёх;
|
||||
- уборщик (с лабы 4): после bootstrap — `up -d --no-deps cleaner` с
|
||||
grace 20 с и интервалом 1 с из `failures.compose.yml`
|
||||
(`CLEANER__*`, `restart: "no"`: падение не прячется за
|
||||
перезапуском); значения `run_failures.py` берёт из конфигурации
|
||||
compose и передаёт тестам (`FAULT_CLEANER_GRACE_S`,
|
||||
`FAULT_CLEANER_INTERVAL_S`) и строкой `start cleaner: grace … s,
|
||||
interval … s` в вывод. При падении печатается и журнал уборщика.
|
||||
С change `track2-reconciler` — без плановой сверки
|
||||
(`RECONCILER__INTERVAL_SECONDS: "0"`, строка `start cleaner` называет
|
||||
и её интервал), а `<проект>-cleaner-scheduled` hook `run-cleaner`
|
||||
убирается вместе с API. Прогон — ~15 мин (с правками по verify
|
||||
`track2-reconcile-cost` — 56 проверок, pytest 877 с, вся команда 898 с
|
||||
на шумном хосте: два теста verify ~1,5 мин; до них — 54 проверки,
|
||||
pytest 712 с: пять тестов
|
||||
стоимости сверки ~3,5 мин, из них ожидание grace — 4 × 21 с; с change
|
||||
`fix-upload-put-flake` — 49 проверок, pytest ~550–570 с: тест простоя S3
|
||||
~17 с, остальное — разброс хоста; до него 48 проверок, pytest ~535 с;
|
||||
до правок по verify `track2-reconciler` — 45 и ~460 с;
|
||||
до `track2-reconciler` — 37 и ~255 с, до `upload-memory` — 32 и
|
||||
~220 с, до `upload-consistency` ~70 с);
|
||||
- `pytest -m fault`, затем журнал PostgreSQL стенда: сводка `postgres
|
||||
log: N lines, crash markers M; "too many clients" X, "administrator
|
||||
command" Y` после каждого прогона и ненулевой код при признаках
|
||||
аварийного перезапуска («untracked child process», «terminating any
|
||||
other active server processes», «reinitializing», «automatic
|
||||
recovery in progress») — найденные строки печатаются;
|
||||
- у `postgres` в override — `init: true`: `fill-connections` держит
|
||||
`psql` в фоне `sh` из `docker compose exec`, после
|
||||
`clear-connections` они сироты пространства PID. Без init их
|
||||
наследовал postmaster (PID 1), считал выход с кодом 2 аварией и
|
||||
перезапускал PostgreSQL посреди набора (design change
|
||||
`fix-known-issues`, решения 11–12). Правило `docker.md` «сервер —
|
||||
PID 1» — про образ API;
|
||||
- затем удаление стенда с volume при любом исходе. Рабочий стенд не
|
||||
трогается;
|
||||
- **два прогона одновременно не запускать** (терминал, IDE, агент):
|
||||
уборка хвоста в начале второго делает `down -v` стенда первого, и
|
||||
оба падают с конфликтом имён контейнеров. Блокировки нет намеренно.
|
||||
- Тесты `fault` сами docker не трогают. На стенд они действуют только
|
||||
через фикстуру `stand` — hook `student-tests/fault_hook.py`, как
|
||||
`make test-persistence` вызывает `ACTION_SCRIPT`. Маркер `fault`
|
||||
выбирает тесты, фикстура `stand` действует на стенд: имена разные
|
||||
намеренно. Действия: `stop` / `start` /
|
||||
`pause` / `unpause` сервиса `postgres`, `valkey` или `s3` (у `s3`
|
||||
проба после `unpause` — та же команда, что healthcheck: master,
|
||||
зарегистрированный том, filer и шлюз;
|
||||
`test_readiness_without_object_storage[stop|pause]` — спек `health`,
|
||||
«Хранилище объектов недоступно»), `flush-cache`, `cache-hits`, `cache-has-chat`,
|
||||
`fail-members` (триггер, который роняет вставку участников),
|
||||
`fail-messages` (триггер, который роняет вставку сообщения с данным
|
||||
текстом — уже после вставки ключа идемпотентности) и
|
||||
`clear-fail-*`, `count-chats`, `fill-connections <секунд>` (все слоты
|
||||
`max_connections` заняты сессиями `psql`, соединения API по TCP
|
||||
оборваны — пул получает «too many clients», 53300),
|
||||
`clear-connections` и `db-sessions` (счётчик
|
||||
`pg_stat_database.sessions`: сколько сессий PostgreSQL приняла, с
|
||||
сессией самого вызова; тест «Соединения пула не переоткрываются»), с
|
||||
лабы 4 — действия вложений и API выше (`attachment-ids`,
|
||||
`last-pending`, `object-ids`, `fail-attachments`,
|
||||
`clear-fail-attachments`, `kill-api`, `start-api`).
|
||||
Hook работает только с проектом из
|
||||
`FAULT_PROJECT` и
|
||||
отказывается работать с проектом рабочего стенда.
|
||||
- Тест `fault`, который останавливает или замораживает хранилище,
|
||||
делает это в `with outage(...)`: в `finally` хранилище возвращается,
|
||||
и упавшая проверка не ломает следующие. Границы времени — с запасом
|
||||
0,3–0,5 с, но на порядок ниже «плохого» поведения (6 с повторов
|
||||
redis-py, 8 с зависшего запроса).
|
||||
- `addopts` содержит `-m 'not fault'`: `make student_test` и
|
||||
`make test_isolated` тесты `fault` собирают (их сценарии видит сверка
|
||||
покрытия), но не выполняют. Запуск `pytest -m fault` без
|
||||
`make failure_checks` останавливается до первого теста с кодом 2.
|
||||
- Пароли и токены тестов синтетические, не печатаются и не попадают в
|
||||
`evidence/` (`evidence/README.md`).
|
||||
- `tests/` — публичные проверки skeleton: не править, не ослаблять,
|
||||
свои тесты туда не класть.
|
||||
- Вывод прогона (команда, дата, commit, результат) — в `evidence/` и
|
||||
строкой в таблицу доказательств `REPORT.md`.
|
||||
|
||||
## Как устроен набор
|
||||
|
||||
- **Идентификация — только `Actor.headers()`** (`api_client.py`):
|
||||
`Authorization: Bearer <token>`. Токен `Actor` получает при входе:
|
||||
регистрация с паролем, затем `POST /auth/sessions` по Basic. Тесты
|
||||
передают `actor=`; заголовок руками собирает только
|
||||
`test_identification.py` (Basic, битый и чужой Bearer, `X-User-Id`).
|
||||
`Actor.unregistered()` — токен, которого нет на сервере.
|
||||
- **Отправка сообщения — только `Api.post_message` / `send_message`**:
|
||||
по умолчанию новый `Idempotency-Key`, `key=None` — без заголовка,
|
||||
строка — этот ключ. Прямой `api.request("POST", …/messages)` без
|
||||
ключа получил бы 400 раньше проверки, которую тест хочет увидеть
|
||||
(404 постороннему, 401 после выхода). Общие циклы по нескольким
|
||||
путям добавляют заголовок `key_headers()`.
|
||||
- **Сценарий спека вне `CAPABILITIES`** (`student-tests`) — в
|
||||
докстринге теста, не маркером: маркер на такой capability сверка
|
||||
считает ссылкой на неизвестный сценарий.
|
||||
- **Форма ответа — через `contract.py`**, без ручного сравнения ключей:
|
||||
`assert_ok(resp, status, "<Schema>")` для успеха, `assert_error(resp,
|
||||
status)` для ошибки (`code` берётся из статуса). Хелперы `Api`
|
||||
(`register`, `create_chat`, `send_message`, обход страниц) уже
|
||||
проверяют схемы.
|
||||
- **Каждый тест сценария спека помечен** `@pytest.mark.spec("<capability>",
|
||||
"<Сценарий>")`, имя — дословно из `#### Scenario:`. Новый сценарий в
|
||||
основном спеке без теста роняет `test_coverage.py`. Если его нельзя
|
||||
проверить по HTTP даже на стенде отказов, добавить запись в
|
||||
`EXCLUDED` (`spec_coverage.py`) с причиной и способом проверки.
|
||||
- **Доказательство исключения — в репозитории этой лабы.** Файл
|
||||
`evidence/….md`, на который ссылается `check` исключения, должен
|
||||
существовать: `test_exclusion_evidence_exists` (`missing_evidence`)
|
||||
падает и называет сценарий и путь. `evidence/` в следующую лабу не
|
||||
переносится, поэтому там сверка красная, пока файлы не сняты заново
|
||||
на её стенде. Сверка проверяет только наличие файла, а не то, на
|
||||
каком стенде он снят: скопированные из прошлой лабы файлы `evidence/`
|
||||
сделают её зелёной без пересъёмки. Поэтому evidence прошлой лабы не
|
||||
копировать ни целиком, ни по одному файлу — только снимать заново.
|
||||
Способ проверки называет команду, которая снимает
|
||||
доказательство: `driver.py --port <LB> cache-check
|
||||
--require-test-keys` (после `make test_isolated`; без ключей тестовой
|
||||
базы — код 1, «Временная база» не доказана) →
|
||||
`evidence/cache/hits.md`,
|
||||
`driver.py --port <LB> auth-storage` →
|
||||
`evidence/auth/passwords-and-tokens.md`; `make test-persistence` →
|
||||
`evidence/replicas/test-persistence.md`; повтор после `docker compose
|
||||
up -d --force-recreate api` → `evidence/idempotency/replay-after-restart.md`.
|
||||
В доказательстве — только факты, счётчики и префиксы, без токенов,
|
||||
паролей и полных хэшей.
|
||||
Сценарии тестов `fault` сверка считает покрытыми и печатает их число.
|
||||
- Модуль сверки называется `spec_coverage.py`, а не `coverage.py`:
|
||||
каталог набора стоит в `pythonpath`, и `coverage.py` затенил бы
|
||||
пакет `coverage` (pytest-cov, coverage-runner IDE).
|
||||
- Новые пользователи и чаты — фикстуры `alice`, `bob`, `eve`, `chat` из
|
||||
`conftest.py`: у каждого теста свои. `eve` не состоит ни в одном чате
|
||||
фикстур.
|
||||
@@ -0,0 +1,197 @@
|
||||
---
|
||||
paths:
|
||||
- "src/infra/telemetry/**"
|
||||
- "infra/otel/**"
|
||||
- "bench/otel/**"
|
||||
---
|
||||
|
||||
# Телеметрия (с лабы 6)
|
||||
|
||||
Спеки `observability`, `service-logging` («Связь записей с трассой», «Журнал в хранилище
|
||||
логов»), `service-configuration` («Параметры телеметрии»), `graceful-shutdown` («Остановка при
|
||||
недоступном Collector»); решения — design change `otel-telemetry` (номера ниже без пометки) и
|
||||
`job-trace-propagation` («JTP-n»), `slo-alerts` («SA-n»: SLI и SLO, правила и runbooks,
|
||||
буферизация Collector, учёт потерь). Здесь то, что легко нарушить.
|
||||
|
||||
## SDK в процессе (`src/infra/telemetry/`)
|
||||
|
||||
- **API, worker и relay** (решение 5, JTP-7): `start_process_telemetry(<имя>)` после
|
||||
`early_stop.disarm()`, затем `instrument_engine(engine)`. Уборщик, миграции, команда replay и
|
||||
процесс обработки SDK не запускают; окружение процесса обработки — прежнее, без `OTEL_*` и
|
||||
адреса.
|
||||
- **Ленивый SDK** (JTP-7): SDK, экспортёр и `requests` импортирует только `sdk.py`, его — только
|
||||
`core.start()`; остальные модули пакета — только `opentelemetry-api` (типы SDK — под
|
||||
`TYPE_CHECKING`). Новый модуль пакета SDK на уровне модуля не импортирует. Исключение вне
|
||||
пакета — redis-py 8.1 сам грузит `opentelemetry.sdk.metrics` (проба «установлен ли SDK»):
|
||||
тест сравнивает с `import redis.asyncio` (design JTP, «Уточнения apply»).
|
||||
- **Настройки — только `[telemetry]`** (решение 8): ресурс конструктором без детекторов, sampler
|
||||
`ParentBased(ALWAYS_ON)` при `trace_sample_ratio` 1 (JTP-5: корни выбираются всегда, удалённый
|
||||
родитель из задания передаёт свой флаг), иначе `ParentBased(TraceIdRatioBased(доля))`
|
||||
(`sdk.sampler`, design change `track1-telemetry-cost`, «TC-n» ниже, TC-3); границы трёх histogram —
|
||||
набор `metric_buckets` (`default` / `coarse`, константы `*_BUCKETS_COARSE`, обе с границами SLO
|
||||
0,25 с и 30 с, TC-4); `metric_export_interval_seconds` ≤ 30 (половина срока рядов экспортёра
|
||||
Collector, `TELEMETRY_METRIC_EXPORT_INTERVAL_MAX_SECONDS`). Невыбранный span — валидный контекст
|
||||
без записи: дочерних span нет (`child_span`), запись журнала уходит в Loki с его `trace_id` и
|
||||
флагами без бита выборки, stdout — без полей трассы. Запись о старте трёх процессов —
|
||||
`telemetry.startup_fields` (доля, набор, интервал; при выключенной — `null`): по ней профиль цены
|
||||
телеметрии сверяет вариант. Лимиты span, очереди и сроки процессоров, `headers={}`, без сжатия,
|
||||
cumulative, exemplars выключены, `shutdown_on_exit=False`. Новый параметр SDK — поле секции, а
|
||||
не переменная `OTEL_*` и не значение по умолчанию SDK. `OTEL_*` удаляются из окружения до
|
||||
провайдеров (их читает конструктор: `OTEL_SDK_DISABLED`) и называются в `warning` без
|
||||
значений — только при включённой телеметрии.
|
||||
- **Выключено — ничего**: ни провайдеров, ни хуков журнала, ни обращений к Collector, ни полей
|
||||
трассы. Все функции пакета при выключенной телеметрии — no-op; глобальные провайдеры и
|
||||
глобальный propagator OpenTelemetry не ставятся.
|
||||
- **Правило корня** (решения 4, 12; JTP-2, 3): трассу начинают только server span запроса (кроме
|
||||
health) и consumer span доставки без контекста. Дочерний span (`child_span`, слушатели engine,
|
||||
`COMMIT`, Valkey, S3, процесс обработки) — только под записывающим родителем: проверка
|
||||
готовности, проходы уборщика и relay трасс не создают. Входящие `traceparent` и `tracestate`
|
||||
HTTP не извлекаются (`Context()` корня).
|
||||
- **Перенос контекста** (JTP-1–4, 6): только W3C Trace Context (`TraceContextTextMapPropagator`,
|
||||
`core.PROPAGATOR`), без baggage. Загрузка сохраняет контекст server span в
|
||||
`attachment_jobs.traceparent` / `tracestate` (`current_trace_context` → `TraceContextDep`);
|
||||
relay — span `PRODUCER` `publish <очередь>` дочерним к сохранённому контексту
|
||||
(`messaging.producer_span` в `JobPublisher._publish_one`), его контекст — заголовки AMQP
|
||||
`traceparent` и `tracestate` (поля тела не заполняются); worker — span `CONSUMER` дочерним к
|
||||
контексту заголовков и с link на него (`messaging.consumer_span`). Нет контекста или он не по
|
||||
W3C — ни span producer, ни заголовков, consumer span — корень; relay без телеметрии кладёт
|
||||
сохранённый контекст как есть. Заголовок разбирает клиент брокера
|
||||
(`trace_context_from_headers`), тело — сервис: контекст на обработку не влияет.
|
||||
- **Метрики уровня 4** (JTP-8–13): `messaging.JobObservation.finish(result=…)` — атрибуты попытки,
|
||||
причины, кода ошибки и `messenger.job.time_to_ready` (только у `ready` без replay); `metrics.py`
|
||||
— `db.client.connection.*` по текущему пулу engine (`CountingQueuePool`), насыщение worker
|
||||
(`WorkerLoad`), gauge очереди по последнему снимку relay (старше 30 с — ничего);
|
||||
`container.py` — cgroup v2 изнутри, без сокета Docker (`start_process_telemetry(...,
|
||||
cgroup_root=…)`; нет файлов — одна запись `warning` до хуков журнала). Имена и атрибуты —
|
||||
константы `src/utils/constants.py`, таблица — design JTP, решение 13.
|
||||
- **Атрибуты** (решения 10–12): метки метрик — только метод (стандартный или `_OTHER`), полный
|
||||
шаблон маршрута, код статуса, тип и исход задания. Ни `url.path`, `url.query` (в ней
|
||||
`filename`), заголовков, `client.address`, ключа объекта S3 и кэша (в них id), ни значений
|
||||
параметров SQL (`db.query.text` — параметризованный текст). Ошибка — статус `ERROR` и
|
||||
`error.type` (класс), `record_exception` не вызывать: текст исключения бывает с данными.
|
||||
`messenger.request_id` — только в span, не в метриках. Имена — константы
|
||||
`src/utils/constants.py`.
|
||||
- **Новая точка вызова хранилища** — span в единственном месте вызова (как `_call` S3,
|
||||
`Cache.get`/`set`), а не библиотека автоинструментирования: `instrumentation-sqlalchemy`
|
||||
несовместим с SQLAlchemy 2.1, остальные патчат клиенты глобально (решение 4).
|
||||
- **Журнал** (решения 2, 12): `src/infra/logger.py` SDK не импортирует — процессоры зовут хуки
|
||||
пакета. Экспорт стоит раньше полей трассы в обеих цепочках (`processors` и
|
||||
`foreign_pre_chain`); записи логгеров `opentelemetry.*` не экспортируются, в stdout — не чаще
|
||||
одной в минуту на логгер (`RateLimitFilter`). API логов SDK без стабильного имени: SDK закреплён
|
||||
`>=1.45.2,<1.46`, смену ловит `service-tests/unit/test_telemetry.py`.
|
||||
- **Закрытие со сроком** (решение 13): `shutdown()` провайдеров — в daemon-потоках
|
||||
(`begin_shutdown`), ожидание не дольше срока (`wait_closed`), не `asyncio.to_thread` и не
|
||||
`force_flush`: при замороженном Collector `shutdown()` ждёт до 6 с. API — после «Stopped API»,
|
||||
`TELEMETRY_SHUTDOWN_TIMEOUT_SECONDS` (1 с) внутри `API_STOP_BUDGET_SECONDS` (9 с) вместе с
|
||||
дренажом — сочетание проверяет `Settings`; worker и relay — в окне `gather` закрытия (0,5 с).
|
||||
Новый срок в остановке — в этот бюджет, а не сверх него.
|
||||
- **Отправка только в Collector:** экспортёры получают свою `requests.Session` с
|
||||
`trust_env=False` (`_export_session`): прокси, `NO_PROXY` и `.netrc` окружения на неё не
|
||||
действуют, как и `OTEL_*`.
|
||||
- **Исход доставки** (решение 11) называет сервис (`JobDeliveryOutcome`), действие с сообщением
|
||||
выводится из него; span и histogram пишет точка входа после места конкуренции, `error` — у
|
||||
непредвиденного исключения.
|
||||
- **Внутренние метрики SDK** (design change `slo-alerts`, «SA-n» ниже, SA-8, SA-9): `sdk.build()`
|
||||
сначала собирает `MeterProvider`, затем процессоры span и журнала и экспортёры OTLP span и журнала
|
||||
с `meter_provider=` этого провайдера — внутри `_internal_metrics()`, который ставит
|
||||
`OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED` (`TELEMETRY_SDK_INTERNAL_METRICS_ENV`) только на время
|
||||
их конструирования: другого выключателя в SDK 1.45 нет, внешнее значение уже удалено
|
||||
`remove_otel_environment`. Читатель метрик и `MeterProvider` строятся вне окна — своих метрик у
|
||||
них нет. С TC-3 в окне же `TracerProvider(meter_provider=…)` и `Tracer` (`Providers.tracer`, его
|
||||
конструктор читает переменную): `otel.sdk.span.started` по происхождению родителя и решению
|
||||
выборки (`DROP`, `RECORD_AND_SAMPLE`) — отброшенное выборкой отдельно от потерь, правило
|
||||
`telemetry:lost_items:total` его не берёт. Инструменты SDK, которые не отдаются
|
||||
(`TELEMETRY_SDK_DROPPED_INSTRUMENTS`: гистограммы SDK и `otel.sdk.span.live`), —
|
||||
`DropAggregation`. Новый процессор или экспортёр — тоже в окне и с провайдером, иначе его потери
|
||||
не считаются. Быстрый тест SDK OTLP — `Exporters(spans=None, logs=None, …)` и подставная
|
||||
`requests.Session.send`.
|
||||
|
||||
## Конфигурации (`infra/otel/`)
|
||||
|
||||
- **Каждый файл — отдельный bind mount файла** длинной записью (`read_only`, `create_host_path:
|
||||
false`), не каталог: override CI заменяет их `configs` по одному (`.github/ci/compose.yml`,
|
||||
`stand-env.sh`). Новый файл — строка в обоих (решение 20).
|
||||
- **Collector** (решение 14): только приёмник OTLP HTTP `:4318`, `memory_limiter` и `batch` в
|
||||
каждом pipeline, экспортёры `prometheus` (`:8889`), `otlp_http/loki`, `otlp_http/tempo`;
|
||||
тип `otlp_http`, а не устаревший `otlphttp`; `debug` и расширения (`pprof`, `zpages`,
|
||||
`health_check`) не добавлять. Проверка — подкоманда `validate` бинарника образа, в журнале
|
||||
старта нет `deprecated`.
|
||||
- **Хранилища** (решение 15): срок хранения 7 суток явно у всех трёх (у Tempo 3.x — два ключа
|
||||
`block_retention`, backend-scheduler и backend-worker), у Prometheus ещё предел объёма;
|
||||
данные — именованные volumes, без remote write, OTLP-приёмника Prometheus, admin API и
|
||||
lifecycle. Проверка — `promtool check config`, `-verify-config` Loki, старт Tempo и
|
||||
`/status/config`.
|
||||
- **Grafana** (решение 16): uid источников `prometheus`, `loki`, `tempo` постоянны, dashboard
|
||||
ссылается на них; `allowUiUpdates: false`, состояние — tmpfs; запросы панелей — имена и метки,
|
||||
которые есть в Prometheus (`http_server_request_duration_seconds_*`,
|
||||
`messenger_job_duration_seconds_*`, `job` = `service.name`; с JTP — ряды таблицы решения 13).
|
||||
Квантили — из суммы buckets всех реплик. Панели уровня 4 — в том же JSON (строки «Pipeline» и
|
||||
«Saturation», JTP-14); после правки файла — `docker compose restart grafana`: bind mount файла
|
||||
после замены редактором может показывать прежний inode. Встроенные источники с backend, кроме трёх, выключены (`GF_PLUGINS_DISABLE_PLUGINS`),
|
||||
установка плагинов из сети — тоже.
|
||||
- **Collector с change `slo-alerts`** (SA-2, SA-6, SA-7): приёмник `prometheus/haproxy` (цель
|
||||
`haproxy:8404`, `scope` frontend и backend, отбор имён `metric_relabel_configs`) в pipeline
|
||||
`metrics` — единственное исключение из «только OTLP»; экспорт в Loki и Tempo — `sending_queue`
|
||||
`sizer: bytes` (16 и 8 МиБ), `block_on_overflow: false`, `retry_on_failure` 1 / 5 / 30 с;
|
||||
пакет обязан помещаться в очередь (больший отклоняется целиком): у логов свой `batch/logs`
|
||||
256 / 256, у трасс и метрик `send_batch_max_size: 1024`. Экспортёр `prometheus` —
|
||||
`metric_expiration: 1m`. Собственные метрики Collector — без `_total` и без времени начала.
|
||||
- **Prometheus с change `slo-alerts`** (SA-1, SA-3, SA-4, SA-6, SA-9): правила записи и оповещения
|
||||
— `infra/otel/prometheus/rules.yml` (bind mount и `configs` CI), тесты — `rules.test.yml` (`make
|
||||
alerts_test`: `promtool` в одноразовом контейнере через `tar`, затем проверка `runbook_url`), в
|
||||
контейнер не монтируются. Новое оповещение — правило с `for`, `severity`, `summary`,
|
||||
`description` с `$value` (у `absent()` и `up == 0` значение пустое по смыслу — вместо него
|
||||
шаблон `query`: возраст последней точки, число недоступных целей; design `slo-alerts`,
|
||||
«Уточнения apply», п. 21), `runbook_url` на `infra/otel/runbooks/<имя>.md`, тест срабатывания,
|
||||
порога, «без трафика» и снятия (в `exp_annotations` — все аннотации дословно). Блока `alerting`
|
||||
нет: доставки нет, Alertmanager отвергнут по функции (SA-3). Флаг
|
||||
`created-timestamp-zero-ingestion`, у цели `otel-collector-exporter` — protobuf первым, глобально
|
||||
— прежний текстовый список Prometheus 3: время начала нужно только экспортёру Collector.
|
||||
Потери — правило `telemetry:lost_items:total` (сумма по процессу, не `increase()`); новое
|
||||
место потерь — его составляющая. Ряд суммы каждого процесса начинается с нуля со старта (у SDK —
|
||||
часть `… * 0` по ряду ёмкости очереди span, у Collector — его ряды `receiver_refused`): иначе
|
||||
первое значение нового ряда `rate()` панели потерь отбрасывает (verify, W1). `le` в запросах — как в хранилище (`"0.25"`, `"30.0"`).
|
||||
- **Панели с change `slo-alerts`** (SA-10): строки «SLO and alerts», «Load balancer», «Telemetry
|
||||
pipeline», id с 25. Ряд, которого может не быть (оповещения, потери, 5xx API), — `… or on()
|
||||
vector(0)`: обход панелей драйвером требует данных. Макрос `$__range` драйвер подменяет на
|
||||
`1h` (`panel_expr`); другие макросы Grafana в запросах не использовать.
|
||||
- **Сети и порты** (решение 17): хранилища и Grafana — только в сети `telemetry`, Collector — в
|
||||
обеих; наружу — только Grafana на `127.0.0.1`. Сервисы приложения не ждут сервисов
|
||||
телеметрии (`depends_on` нет).
|
||||
- **Healthcheck** (решение 18) — только у Prometheus и Grafana (`wget` в образе); у Collector,
|
||||
Loki и Tempo оболочки нет, живость — цели `up` в Prometheus и проверка источников.
|
||||
- **Go и память**: `GOMEMLIMIT` ~80 % лимита контейнера, лимит не меньше 1,5 × измеренного пика
|
||||
(`evidence/telemetry/budget.md`). Если пик упирается в `GOMEMLIMIT` (Tempo: 398 из 400 МиБ под
|
||||
`make student_test`), 80 % с правилом 1,5 × несовместимы: лимит — не меньше 1,5 × `GOMEMLIMIT`
|
||||
(Tempo 640 МиБ при 400). Пик меряется под `make test` + `make load` + `make student_test`.
|
||||
- **Что считать пиком** (verify change `job-trace-propagation`, W5): `memory.peak` cgroup — верхняя
|
||||
граница, в неё входит файловый кэш (`file` в `memory.stat`), который ядро освобождает до OOM.
|
||||
1,5 × `memory.peak` ≤ лимита — правило выполнено. Если нет, пик — неосвобождаемая часть
|
||||
`anon` + `kernel` + `shmem` из `memory.stat` (наибольшая за прогон, хотя бы в конце), и лимит не
|
||||
меньше 1,5 × её; в `budget.md` — оба числа и `file`. Grafana после рестарта: `memory.peak` 343 МиБ,
|
||||
из них `file` 95, `anon` + `kernel` + `shmem` ≈ 197 — лимит 512 достаточен.
|
||||
|
||||
## Проверки
|
||||
|
||||
`driver.py --port <LB> telemetry-check`, `telemetry-outage`, `trace-chain` (JTP-16),
|
||||
`alerts-check`, `backend-outage` (SA-11), `make alerts_test`,
|
||||
`stand-from-scratch` (решение 21; `SKILL.md` скилла `run-mtusi-messenger`), быстрые тесты
|
||||
`service-tests/unit/test_telemetry.py`, `service-tests/db/test_telemetry_db.py`,
|
||||
`service-tests/db/test_pool_counts.py`. Консоль, `make test_isolated`, стенд отказов и `bench/` —
|
||||
без телеметрии у API, worker и relay (`TELEMETRY__ENABLED: "false"`, решение 20). На `bench/` её
|
||||
включают только вариант профиля цены телеметрии и выключатель `TELEMETRY=on` профилей загрузок и
|
||||
очереди (TC-1, TC-13; `bench.md`): сервисы и конфигурации `infra/otel/` рабочего стенда, SDK через
|
||||
`bench/telemetry.compose.yml`.
|
||||
|
||||
## Слои вариантов (`bench/otel/`, TC-5–7)
|
||||
|
||||
- Не `infra/otel/`: рабочий стенд остаётся со всеми трассами и всеми рядами (TC-5).
|
||||
- Слой Collector (`tail-typical.yaml`, `tail-balanced.yaml`) — только процессор `tail_sampling` и
|
||||
`service.pipelines.traces.processors` (`[memory_limiter, tail_sampling, batch]`): второй
|
||||
`--config` сливает карты и заменяет списки. Правка `collector.yaml` или слоя — `telemetry_preflight`
|
||||
(`bench/run.py`) до стенда: `validate` и сравнение `print-config --format=json` со слоем и без
|
||||
него; формат JSON помечен нестабильным — смена версии Collector повод проверить.
|
||||
- `prometheus-lean.yml` — копия `prometheus.yml` с блоками `metric_relabel_configs` (`action:
|
||||
keep`) у `loki`, `tempo`, `prometheus` между строками `# bench-lean: begin` / `end`. **Правка
|
||||
`prometheus.yml` — та же правка копии**: вне блоков файлы совпадают построчно, иначе профиль —
|
||||
код 2 (`telemetry_cost.lean_problems`, и в `--selftest`).
|
||||
@@ -0,0 +1,147 @@
|
||||
---
|
||||
paths:
|
||||
- "src/worker/**"
|
||||
- "src/relay/**"
|
||||
- "src/infra/render/**"
|
||||
- "src/core/services/attachment_processing.py"
|
||||
- "src/core/services/attachment_relay.py"
|
||||
- "src/core/services/attachment_replay.py"
|
||||
- "src/utils/image_variants.py"
|
||||
---
|
||||
|
||||
# Worker, relay и процесс обработки (с лабы 5)
|
||||
|
||||
Спеки `attachment-processing`, `message-broker`, `job-outbox`; решения — design
|
||||
change `async-attachments` (2, 6–8) и `pipeline-reliability` (1–9, 19). Здесь то,
|
||||
что легко нарушить.
|
||||
|
||||
- **Worker:** `python -m src.worker` → `src/worker/__main__.py`
|
||||
(`early_stop.install("worker")`, «Invalid worker settings» и код 2,
|
||||
`os._exit` в конце) → `src/worker/main.py`. Свои engine, клиент S3 с ключами
|
||||
worker и потребитель брокера; издателя нет, глобалы процесса API не
|
||||
импортируются. Сервис собирается на доставку со своей `SqlAlchemyUnitOfWork`
|
||||
(change `unit-of-work`, решение 3): доставки идут одновременно, а единица работы
|
||||
держит открытую сессию; `storage`, `renderer` и `stop` общие. Сервис compose — на образе API, без портов и healthcheck, не
|
||||
реплика: вне `rolling-update.sh` и `restart.sh`. В консоли — `make run_worker`.
|
||||
- **Relay:** `python -m src.relay` → `src/relay/__main__.py` → `src/relay/main.py`
|
||||
→ `AttachmentRelayService`. Свой engine (пул 1) и `JobPublisher`; S3 и Pillow
|
||||
нет. Не в репликах (издатели и пароль у всех), не в worker (остановка worker на
|
||||
защите остановила бы публикацию), не в уборщике (сверка держала бы цикл). В
|
||||
консоли — `make run_relay`.
|
||||
- **Проход relay** — три шага, сигнал проверяется между ними: истёкшие аренды
|
||||
(`processing` → `queued`, причина `lease_expired`, задание и вложение одной
|
||||
транзакцией); потерянные (есть `queued` с `published_at` старше `[relay]
|
||||
republish_after_seconds` и ноль готовых сообщений — отметка снимается; не ноль —
|
||||
ничего: длинная очередь не обрастает копиями); публикация (`room =
|
||||
max_published_backlog - count_published()`, `FOR UPDATE SKIP LOCKED`, порядок —
|
||||
`COALESCE(next_attempt_at, created_at), id`, `publish_many`, отметка
|
||||
подтверждённых, COMMIT). Публикация внутри транзакции — осознанное исключение:
|
||||
блокировка строки и есть признак «это задание публикует другой relay», срок 2 с
|
||||
< шага 6 с < простоя транзакции 10 с. Worker, получивший сообщение раньше
|
||||
COMMIT, ждёт блокировку и видит отметку. Статусы в выборках — константой
|
||||
(`literal_execute`), иначе общий план — Seq Scan.
|
||||
- **Pillow** импортирует только `src/utils/image_variants.py`, его — только
|
||||
`src/worker/render.py`, отдельный процесс на задание. Ни реплики API, ни процесс
|
||||
worker декодер в память не загружают (проверка — `/proc/1/maps`).
|
||||
- **Процесс обработки** — `ImageRenderer` (`src/infra/render/client.py`):
|
||||
`python -m src.worker.render`, окружение только `PATH`,
|
||||
`PYTHONDONTWRITEBYTECODE`, `PYTHONUNBUFFERED`, `MALLOC_MMAP_THRESHOLD_`: секретов в
|
||||
нём нет. Лимиты — первыми строками, до импорта Pillow: `RLIMIT_AS`,
|
||||
`RLIMIT_CPU` (жёсткий на секунду больше), `RLIMIT_CORE = 0`. Коды 3 / 4 / 5 —
|
||||
не декодируется, память, пиксели; −SIGXCPU — CPU (всё постоянные, `ImageRejected`);
|
||||
срок родителя — `TimeoutError`, −SIGKILL и иное — `RenderInterrupted` (временные).
|
||||
`finally` клиента убивает процесс и ждёт его: отмена попытки процесс не оставит.
|
||||
Пик — `VmHWM`, не `ru_maxrss`: тот наследует пик родителя через fork. На macOS
|
||||
`setrlimit(RLIMIT_AS)` — `ValueError`: процесс продолжает, вывод отмечает это.
|
||||
- **Claim** (`_claim`, таблица решения 3): сообщение — подсказка, истина в строке
|
||||
задания. `succeeded`, `failed`, чужое, `queued` раньше срока, `processing` с живой
|
||||
арендой — ACK без записи и без новой попытки; `redelivered` только в журнал: брокер
|
||||
ставит его и после `nack`, живого от потерянного он не отличает. Истёкшая аренда
|
||||
и `queued` — взять, если бюджет не исчерпан (`attempt - attempt_base >=
|
||||
max_attempts` — `failed` `retry_exhausted`). Взятие: `attempt + 1`,
|
||||
`lease_expires_at = now + job_timeout + lease_margin`.
|
||||
- **Fencing:** `ready`, `failed` и возврат фиксирует только попытка, номер которой
|
||||
равен текущему у задания в `processing` (`_own_attempt`, условие
|
||||
`return_to_queued`), иначе `Skipped job message`, `superseded`, ACK. Поэтому `attempt`
|
||||
монотонен, а бюджет после replay — `attempt_base`.
|
||||
- **Аренда без пульса:** шаги попытки под `asyncio.timeout(job_timeout)`, процесс
|
||||
убивается, поэтому попытка не живёт дольше срока. Цена — после KILL следующая
|
||||
попытка ждёт истечения аренды (до 70 с).
|
||||
- **Ack — только после устойчивого эффекта:** `ready` или `failed` зафиксированы,
|
||||
задание возвращено в `queued` со сроком либо записывать нечего. Подтверждает
|
||||
`main.py` по `JobOutcome`. `REQUEUE` — только отказ PostgreSQL: пауза
|
||||
`reconnect_seconds`, попытка не считается, если не начата.
|
||||
- **Повтор:** временная ошибка — `queued`, `next_attempt_at = now + uniform(d/2, d)`,
|
||||
`d = min(max, base × 2^(N−1))`, `N` от последнего replay (`retry_delay`), ACK.
|
||||
Следующее сообщение публикует relay, пауза места конкуренции не занимает.
|
||||
- **Prefetch и конкуренция:** `set_qos(prefetch)`, каждая доставка — задача,
|
||||
`asyncio.Semaphore(concurrency)` вокруг `service.handle`: сообщение сверх
|
||||
конкуренции ждёт без взятия и аренды, после сигнала попытка не начинается.
|
||||
- **Подбор конкуренции и prefetch** (design change `track1-queue-overload`, решения
|
||||
5, 12): `concurrency ≤ min(CPU + ожидание, (лимит − база) / пик процесса)`,
|
||||
`prefetch = concurrency`. Сверх CPU конкуренция не ускоряет, а удлиняет процесс и
|
||||
умножает память; больше prefetch только прячет очередь от брокера и второго worker.
|
||||
Два ограничения сверху на `prefetch / потолок`: 30 мин (`consumer_timeout`
|
||||
брокера: дольше — закрытие канала) и `[relay] republish_after_seconds` 300 с (иначе
|
||||
копии потерянных). Конкуренция, которая не помещается в лимит памяти контейнера, —
|
||||
не только повторы `render_killed`: ядро может завершить и процесс 1, контейнер
|
||||
перезапускается, задания возвращаются по аренде (до 70 с). Защита — конкуренция, а
|
||||
не `oom_score_adj`. Числа и проверка правила — метка `evidence/queue/baseline4/`.
|
||||
- **Варианты:** одно декодирование, `fit_size` (округление вниз, не
|
||||
`Image.thumbnail`). `draft` у JPEG — под самый большой нужный размер. Основа 1280 —
|
||||
для optimized и thumbnail; crop — из основы, если её короткая сторона ≥ 256, иначе
|
||||
из декодированного (у 5000 × 10 основа 1280 × 2). Transpose на малых изображениях.
|
||||
Thumbnail и crop — JPEG `quality=85`, альфа на белый; optimized — WebP `quality=80`,
|
||||
`method=4`, прозрачность сохраняется. Метаданные в `save` не передаются: EXIF,
|
||||
XMP и ICC не пишутся, ориентация применена к пикселям. `FLIP_LEFT_RIGHT` равен 0:
|
||||
результат `.get` сравнивать с `None`.
|
||||
- **Replay:** `AttachmentReplayService`, `make replay` (`python -m src.relay replay`),
|
||||
только PostgreSQL. Транзакция: `lock_job`, `lock_attachment` (`FOR NO KEY UPDATE`),
|
||||
проверки (`not_found`, `already_ready`, `not_failed`, `source_gone` — отказ без
|
||||
изменений, код 3), `failed → queued`, `attempt_base = attempt`, запись
|
||||
`attachment_job_replays`. Сообщение публикует relay. С `--apply` выбор обязателен
|
||||
(код 2), `--attachment-id` и фильтр по коду вместе нельзя (код 2). HTTP-ручки нет.
|
||||
- **Остановка worker (S5):** `graceful_shutdown_seconds` ≤ 8, отмена задач 0,5,
|
||||
закрытие потребителя 0,5, engine и S3 — одним `gather` под сроком 0,5: 9,5 с < 10 с.
|
||||
Новые клиенты не добавляют срока. Задание, прерванное остановкой, получает
|
||||
следующую попытку по аренде: release на пути отмены ненадёжен.
|
||||
- **Телеметрия** (с лабы 6, design change `otel-telemetry`, решения 5, 11–13): исход доставки
|
||||
называет сервис — `JobDeliveryOutcome` (`ready`, `failed`, `retry`, `skipped`, `requeued`,
|
||||
`dropped`; `error` — непредвиденное исключение в `_handle`), действие с сообщением — его
|
||||
свойство `action`. Новая ветка `handle` возвращает исход, а не `JobOutcome`. Span `CONSUMER`
|
||||
`process <очередь>` и histogram `messenger.job.duration` — в `_handle` после места
|
||||
конкуренции (ожидание места — не работа), подтверждение внутри span. Span процесса обработки
|
||||
пишет `ImageRenderer.render` в worker: сам процесс SDK не запускает, его окружение прежнее.
|
||||
Закрытие SDK — в окне `gather` 0,5 с.
|
||||
- **Сквозная трасса и уровень 4** (design change `job-trace-propagation`, решения 2, 3, 7–9,
|
||||
11): `handle` возвращает `JobDeliveryResultDTO` — исход, взятая попытка (у `skipped` — из
|
||||
сообщения), причина у `retry` и `failed`, код у `failed`, `time_to_ready_seconds` только у
|
||||
`ready` с `attempt_base == 0` (от `attachment_jobs.created_at` до фиксации); новая ветка
|
||||
`handle` отдаёт DTO, а не исход. Consumer span — дочерний к `delivery.trace_context`
|
||||
(заголовки AMQP, разбор — клиент брокера) с link на него, без контекста — корень; точка входа
|
||||
пишет атрибуты итога и `messenger.job.time_to_ready` (`observation.finish(result=…)`). Счётчики
|
||||
`WorkerLoad` «ждут места» и «заняты» — вокруг `async with slots` в `_handle`, снимаются в
|
||||
`finally`. Relay: SDK по `[telemetry]` (`messenger-relay`), span producer — в
|
||||
`JobPublisher._publish_one` под сохранённым контекстом (`JobPublicationDTO` из строки
|
||||
задания: номер попытки, replay `attempt_base > 0`, причина — `last_error_code`), проходы span
|
||||
не создают; снимок очереди `queue_snapshot()` после успешного прохода не чаще 5 с, отказ
|
||||
PostgreSQL — пропуск; закрытие SDK — в окне `gather` 0,5 с, «Stopped relay» после него. Команда
|
||||
replay SDK не запускает: replay в трассе — следующая пара producer / consumer.
|
||||
- **Сообщение** — `src/schemas/jobs/attachment.py`, по `contracts/jobs.schema.json`:
|
||||
только id и служебные поля. Ключи, размер, SHA-256 и тип worker берёт из
|
||||
PostgreSQL. Не по схеме — `error` без содержимого, `reject(requeue=False)`.
|
||||
- **Порядок блокировок везде:** задание (`lock_job`), затем вложение; вызовов S3
|
||||
внутри блоков единицы работы у worker нет (тест `put` — `service-tests/unit`).
|
||||
Вложение `ready`, варианты и итог задания — один блок. Вспомогательные методы
|
||||
сервиса работают внутри открытого блока без параметра сессии.
|
||||
- **Ключ эффекта** `(attachment_id, pipeline_version, variant)` — первичный ключ
|
||||
`attachment_variants`; ключ объекта варианта из него следует.
|
||||
- **Журнал:** `request_id` — `job_id` (ставит сервис); `filename`, байтов, тел
|
||||
сообщений и секретов в записях нет (`logging.md`).
|
||||
- **Ограничения** называются в `REPORT.md`: восстановление после KILL по аренде,
|
||||
дубли сообщений, объект, дописанный прежней попыткой теми же байтами, профиль ICC,
|
||||
лимит памяти на macOS, цена процесса на задание, удаление очереди при работающем
|
||||
worker. Изоляция секретов неполная: в окружении процесса обработки их нет, но он
|
||||
идёт под тем же UID, что PID 1 worker, и после эксплойта декодера прочитает
|
||||
`/proc/1/environ` (ключи S3, пароли PostgreSQL и брокера); предложение
|
||||
`PR_SET_DUMPABLE=0` — `QUESTIONS.md`.
|
||||
@@ -0,0 +1,860 @@
|
||||
---
|
||||
name: run-mtusi-messenger
|
||||
description: Запустить, остановить, прогнать и подёргать API мессенджера MTUSI (FastAPI, PostgreSQL, Valkey; лаба 3 — HAProxy перед репликами API; лаба 4 — S3 на SeaweedFS; лаба 5 — RabbitMQ, relay и worker; лаба 6 — OTel Collector, Prometheus, Loki, Tempo и Grafana) — на хосте или в Docker. Use when asked to run / start / stop the server or the stand, check telemetry (find a request in Loki and Tempo, Grafana provisioning, Collector outage, stand from scratch), run the smoke test, `make test`, `make student_test`, `make test_isolated`, `make test-persistence` or `make test-failover`, `make s3_check`, check that the S3 bucket is private, run the defense scenario or its failure windows, check the broker, the worker or the relay process, show the pipeline state, stop or restore an API replica, show X-Instance-Id distribution, check that an API change works on a live server, send a request to an endpoint, reproduce a bug over HTTP, check the containers, or call services directly without HTTP.
|
||||
---
|
||||
|
||||
REST API мессенджера (пользователи, чаты, сообщения) — сервер на
|
||||
FastAPI/uvicorn, данные в PostgreSQL из compose, карточки чатов
|
||||
кэшируются в Valkey из compose, с лабы 4 есть S3 (SeaweedFS) для байтов
|
||||
вложений, с лабы 5 — RabbitMQ, relay и worker: загрузка отвечает 202, файл
|
||||
становится `ready` в фоне. Агент управляет им через
|
||||
`.claude/skills/run-mtusi-messenger/driver.py`: он поднимает Postgres,
|
||||
накатывает миграции, поднимает Valkey, S3 с bootstrap и брокер (`make
|
||||
upgrade start_cache start_s3 start_broker`),
|
||||
запускает свой экземпляр сервера, worker и relay в фоне, гоняет сценарий по HTTP,
|
||||
публичный smoke и собственные тесты, шлёт одиночные запросы и
|
||||
останавливает их. Против стенда compose (`make run_docker`:
|
||||
HAProxy на `APP_OUT_PORT` перед репликами API) работают те же команды
|
||||
драйвера, кроме `start`/`stop`, плюс `instances` — распределение одной
|
||||
сессии по репликам, `kill-inflight` — kill реплики с запросами в
|
||||
полёте, `idle-conns` — кто закрывает простаивающие соединения LB →
|
||||
реплика, `hang-key` — повтор ключа после зависшей реплики,
|
||||
`cache-check` и `auth-storage` — доказательства исключений сверки
|
||||
покрытия (кэш, хранение паролей и токенов), `s3-check` (`make
|
||||
s3_check`) — приватность bucket вне API, `attachment-failover` и
|
||||
`attachment-storage` — доказательства исключений `attachments`
|
||||
(остановка реплики, принявшей файл; где лежат байты),
|
||||
`upload-consistency` — согласованность БД и S3 (компенсация и уборщик
|
||||
незавершённых загрузок), `reconcile-cycle` и `reconcile-stress` — сверка
|
||||
bucket и БД (расхождения с обеих сторон, dry-run, `--apply`, повтор,
|
||||
возврат оригинала; `--apply` под загрузками), `defense-scenario` и
|
||||
`defense-faults` — сценарий защиты лабы 5 и его шаг 4, `broker-check`,
|
||||
`worker-process`, `relay-process` — брокер и процессы, `pipeline-state` — состояние
|
||||
конвейера, `worker-memory` — память контейнера worker, `freeze-sessions` и `freeze-lb`
|
||||
— заморозка PostgreSQL (раздел «Лаба 5: брокер, relay и worker»). `upload` и
|
||||
`download` — загрузка и скачивание вложения с SHA-256 на любом
|
||||
сервере. `stop-at-start` — остановка
|
||||
контейнеров образа во время старта, без стенда. Только
|
||||
стандартная библиотека Python 3.9+: `make instances` запускает драйвер
|
||||
системным `python3` (на macOS — 3.9), поэтому без `datetime.UTC`,
|
||||
`match` и прочего синтаксиса 3.10+.
|
||||
|
||||
Все пути — от корня репозитория. Проверено на macOS (arm64), uv 0.12,
|
||||
Python 3.12 из `.python-version`, Docker Desktop 29.8.
|
||||
|
||||
**Лаба 3.** Каждый ответ API несёт `X-Instance-Id` (hostname процесса,
|
||||
в compose — короткий ID контейнера), `POST` сообщения требует
|
||||
`Idempotency-Key`: повтор с тем же ключом и телом — тот же 201 и то же
|
||||
сообщение, другое тело — 409, без ключа — 400. Проект compose —
|
||||
`mtusi-lab6`, своя база. Стенд: HAProxy — единственная точка входа на
|
||||
`127.0.0.1:APP_OUT_PORT`, за ним `API_REPLICAS` (по умолчанию 2) реплик
|
||||
`api` без портов на хосте. Консольный `driver.py start` — один процесс
|
||||
без балансировщика: тесты реплик против него пропускаются.
|
||||
|
||||
Аутентификация лабы 2: регистрация с `password`, вход
|
||||
`POST /api/v1/auth/sessions` по `Authorization: Basic`, дальше —
|
||||
`Authorization: Bearer <token>`. `X-User-Id` доступа не даёт. Пароль —
|
||||
Argon2id, около 30 мс на регистрацию и вход в консоли и около 120 мс в
|
||||
контейнере с лимитом 1 CPU, поэтому `flow` и `student-tests` идут
|
||||
дольше, чем на лабе 1, а `make test_isolated` — около минуты.
|
||||
|
||||
## Setup
|
||||
|
||||
```bash
|
||||
uv sync --all-extras # venv с ruff и dev-группой (pytest, httpx, валидатор)
|
||||
make env_setup # .env (случайные POSTGRES_PASSWORD, VALKEY_PASSWORD, RABBITMQ_DEFAULT_PASS и секреты S3, печатает только имена) и config.toml, существующие не трогает
|
||||
```
|
||||
|
||||
Нужен запущенный Docker: Postgres, Valkey и S3 живут в compose. Без
|
||||
Postgres сервер стартует, но `/health/ready` отвечает 503; без Valkey
|
||||
всё работает, но мимо кэша (`warning` «Cache is unavailable» в логе);
|
||||
без S3 `/health/ready` — 200, а загрузка и скачивание байтов
|
||||
вложений — 503 (метаданные, сообщения и история работают). S3 нужен
|
||||
только путям вложений. Без брокера, relay и worker `/health/ready` — 200, загрузка —
|
||||
202 (брокера в пути запроса нет, задание ждёт в PostgreSQL), вложение остаётся
|
||||
`queued`, скачивание — 409.
|
||||
`driver.py start` сам делает `make upgrade start_cache
|
||||
start_s3 start_broker`. В `.env`, созданном до `membership-cache` или `s3-storage`,
|
||||
нет строк Valkey или S3: их переносят из `.env.example` руками, иначе
|
||||
compose падает с `… is empty, copy … lines from .env.example`.
|
||||
|
||||
## Run (agent path)
|
||||
|
||||
```bash
|
||||
D=.claude/skills/run-mtusi-messenger/driver.py
|
||||
python3 $D all # start → flow → tests/smoke.py → student-tests → stop
|
||||
```
|
||||
|
||||
По шагам, когда между ними нужно что-то сделать (поправить код,
|
||||
посмотреть лог, послать свой запрос):
|
||||
|
||||
```bash
|
||||
python3 $D start # make upgrade start_cache start_s3 start_broker, затем API, worker и relay в фоне; ждёт /health/ready, брокер и старт relay до 30 с
|
||||
python3 $D status # listeners: [pid reloader, pid worker], ready: True
|
||||
python3 $D flow # ~60 проверок: регистрация с паролем, вход, 409, неверный пароль,
|
||||
# 401 с WWW-Authenticate, X-User-Id игнорируется, чат, 5 сообщений,
|
||||
# пагинация limit=2 по курсору, чужой → 404, 400-е, повтор с ключом,
|
||||
# 409 на другое тело, без ключа → 400, вложение: загрузка fixture 202,
|
||||
# сообщение со ссылкой, опрос до ready, оригинал Бобу (SHA-256),
|
||||
# thumbnail (JPEG 256×160), 404 Еве; logout; X-Instance-Id везде
|
||||
python3 $D req POST /api/v1/users --data '{"username":"zoe_demo","display_name":"Зоя","password":"Zoe-password-1"}'
|
||||
python3 $D req POST /api/v1/auth/sessions --basic zoe_demo:Zoe-password-1
|
||||
python3 $D req GET /api/v1/users/me --token <token из ответа выше>
|
||||
python3 $D req POST /api/v1/chats/<chat>/messages --token <token> --data '{"text":"hi"}'
|
||||
# печатает idempotency-key; повтор той же отправки — тот же запрос с --key <ключ>
|
||||
python3 $D upload --token <token> --chat <chat> --file tests/fixtures/sample.png
|
||||
# 202, x-instance-id, снимок queued, SHA-256 файла и «sha256 matches: True»,
|
||||
# затем опрос до ready и итоговые метаданные
|
||||
python3 $D download --token <token> --attachment <id> [--out /tmp/x.png] [--variant thumbnail] [--wait]
|
||||
# 200, Content-Type, размер, SHA-256 полученного (99ea7533… у fixture),
|
||||
# у JPEG и WebP — размеры по байтам; не ready — 409, с --wait — сначала опрос
|
||||
python3 $D smoke # публичный tests/smoke.py против этого порта
|
||||
python3 $D student # make student_test BASE_URL=http://localhost:<port> — ~20 с
|
||||
python3 $D --port 8080 instances # стенд через LB: X-Instance-Id 12 запросов одной сессии
|
||||
python3 $D stop
|
||||
```
|
||||
|
||||
| команда | что делает |
|
||||
|---|---|
|
||||
| `start` | `make upgrade start_cache start_s3 start_broker`, затем `APP__RUN_MODE=console APP__PORT=<port> uv run python -m src`, `make run_worker` (ключи S3 worker) и `make run_relay` в одной группе процессов; готово — `/health/ready` 200, запись worker «Connected to broker» и запись «Started relay». Журналы — `/tmp/mtusi-worker-<port>.log`, `/tmp/mtusi-relay-<port>.log` |
|
||||
| `status` | кто слушает порт, отвечает ли `/health/ready`; код 1, если никого |
|
||||
| `flow` | сквозной сценарий; `[FAIL]` в строке и код 1 при провале; в конце печатает id alice/bob/eve/chat и синтетический токен alice |
|
||||
| `req METHOD PATH [--token T \| --basic USER:PASS] [--data JSON] [--key K \| --no-key]` | один запрос: статус, `x-request-id`, `x-instance-id`, `www-authenticate` у 401, тело; код 2 при статусе ≥ 400. `POST …/messages` без `--key` получает новый `Idempotency-Key` (он печатается), `--no-key` — без заголовка |
|
||||
| `smoke` | `tests/smoke.py --base-url http://localhost:<port>` |
|
||||
| `student` | `make student_test BASE_URL=http://localhost:<port>` (pytest по `student-tests/`); против своего процесса (есть pid-файл) — с `EXPECT_REPLICAS=1`, тесты реплик пропускаются с причиной; код 1, если каталога нет |
|
||||
| `instances [--count N]` | вход одним синтетическим пользователем, N (12) × `GET /api/v1/users/me` с одним токеном: `X-Instance-Id` каждого ответа и число ответов каждой реплики; токен не печатается. Его зовёт `make instances` |
|
||||
| `kill-inflight [--threads 8] [--seconds 4] [--after 1.5]` | только стенд с LB (`--port 8080`): потоки входят по Basic, через `--after` с `scripts/stop-one.sh` в режиме kill убивает реплику пробного запроса. Печатает статусы по репликам и ответы LB: оборванные входы — 502 в формате контракта без повтора, начатые после kill — 201 от другой реплики. Код 1, если оборванных нет. Реплика остаётся остановленной — `make replicas` |
|
||||
| `idle-conns [--threads 20] [--requests 50] [--keep-alive 60] [--lb C]` | только стенд с LB: всплеск `GET /health/live` через LB с keep-alive соединениями, клиенты остаются подключены и молчат; раз в секунду — установленные соединения на порт API внутри каждой реплики (`/proc/net/tcp`) и пул LB (`idle_conn_cur` + `safe_conn_cur`). Код 0, если реплики остались без соединений раньше `--keep-alive` (`[app] keep_alive_seconds`): закрыл LB по своему `timeout http-keep-alive`, а не реплика; иначе код 1 и «closed by the replica». `--lb C` — контейнер LB, если `--port` ведёт на временный LB с другим вариантом конфигурации перед теми же репликами (`evidence/failover/keep-alive.md`) |
|
||||
| `hang-key` | только стенд с LB: временный триггер `hang_probe_<метка>` задерживает вставку пробного сообщения на 2 с, реплика с этой транзакцией замораживается `docker pause`, повторы того же `Idempotency-Key` через LB до 201 (сначала 504 от LB или 503 по ожиданию блокировки), разморозка; печатает `idle_in_transaction_session_timeout` соединения приложения и строку журнала PostgreSQL о прерывании. Код 0 — повтор получил 201, в чате одно сообщение, обе реплики снова `UP`. Триггер удаляется и реплика размораживается при любом исходе, в том числе по Ctrl+C, SIGTERM и SIGHUP; если удалить не удалось — печатается SQL удаления и код 1 (от SIGKILL уборки нет) |
|
||||
| `cache-check [--require-test-keys]` | только стенд с LB (`--port 8080`): сценарии `chat-cache` «Чтение из кэша», «Срок записи», «Временная база». Два синтетических пользователя и чат; ключ `messenger:v1:<база>:chat:<id>` сразу после 201 (`EXISTS`, TTL ≤ `[cache] chat_ttl_seconds` из реплики, поля значения), `DEL`, через 11 с снимок `seq_scan + idx_scan` таблицы `chats` и `keyspace_hits` / `keyspace_misses`, 50 чтений через LB, через 11 с второй снимок; TTL до и после ещё 10 чтений; число ключей рабочей и тестовой (`test_<db>`) базы. Код 0 — чтений `chats` ≤ 1, hits ≥ +49, промахов ≤ 1, ответы равны ответу на создание, TTL не продлевается, ≥ 2 `X-Instance-Id`. Для «Временной базы» перед ней — `make test_isolated`: без ключей тестовой базы строка `PASS` заканчивается «temporary database: not checked», с `--require-test-keys` — код 1 (доказательство сценария снимается с флагом). На стенде в это время ничего другого не должно идти. Вывод — `evidence/cache/hits.md` |
|
||||
| `auth-storage` | только стенд с LB: сценарии `users` «Хэш в БД» и `sessions` «Токена нет в хранилище». Пароль P (с `:` и кириллицей) и токен T — только в памяти; через psql — префикс `$argon2id$…` до соли и длина у двух пользователей с одним P, неравенство хэшей, строка `sessions` с `token_hash` = SHA-256(T) (32 байта); `pg_dump --data-only` в память — нет ли T (текстом и в hex) и P. Код 0 — всё так. Вывод — `evidence/auth/passwords-and-tokens.md` |
|
||||
| `s3-check` | стенд compose (`make s3_check`), без приложения: спек `object-storage` «Проверка приватности вне API». `docker compose run --rm --no-deps s3-bootstrap check` — права ключа API (PUT/GET/HEAD объекта, 404 отсутствующего; 403 на список, создание и удаление bucket, политику и ACL bucket, публичный ACL объекта), права ключа уборщика (GET/HEAD/DELETE своего проверочного объекта, повторный DELETE и DELETE отсутствующего — 204; список с префиксами `<база>/attachments/` и `<база>/staging/` — 200, с change `track2-reconciler` и `pipeline-reliability`; 403 на запись, список всего bucket, префикса базы и с чужим префиксом, bucket, политику, ACL), временный чужой bucket (403 на всё обоим ключам), аноним изнутри сервера (403); анонимные запросы с хоста (`127.0.0.1:S3_OUT_PORT`) и из сети стенда (одноразовый контейнер образа S3), порты контейнера S3: слушающие сокеты из `netstat -tuln` в контейнере — вне loopback ровно API S3 и gRPC шлюза, а остальные слушающие порты из сети закрыты (`nc -z`); затем `s3-bootstrap cleanup` и `weed shell` — проверочных объектов и bucket не осталось. Строки списка уборщика по префиксам вложений, staging и базы обязательны: нет — код 1. Таблица «где → проверка → ожидаемо → получено» без секретов, код 1 при расхождении (печатает нарушенные). Вывод — `evidence/s3/privacy.md` |
|
||||
| `upload --token T --chat C --file F [--type …] [--filename …]` | загрузка файла сырыми байтами (`urllib`): статус (202), `x-instance-id`, снимок `Attachment`, размер и SHA-256 файла, совпал ли `sha256` ответа, затем опрос метаданных раз в 0,2 с до `ready` или `failed` (до 60 с) и итоговое тело. `--type` по умолчанию — по сигнатуре (PNG, JPEG, иначе `application/octet-stream`), `--filename` — имя файла. Код 2 при статусе ≥ 400, `failed` и сроке ожидания |
|
||||
| `download --token T --attachment A [--out F] [--variant …] [--wait]` | скачивание оригинала или варианта (`thumbnail`, `crop`, `optimized`): статус, `x-instance-id`, `Content-Type`, `Content-Length`, размер и SHA-256 полученного, у JPEG — размеры по SOF, у WebP — по заголовку; `--out` сохраняет байты. Код 2 при статусе ≠ 200 (тело ошибки печатается): не `ready` — 409 `conflict`, так его и показывают; `--wait` — сначала опрос до `ready` |
|
||||
| `defense-scenario` | только стенд с LB: сценарий защиты лабы 5, раздел «Лаба 5: брокер, relay и worker» |
|
||||
| `defense-faults` | только стенд с LB: шаг 4 защиты, окна отказа, тот же раздел |
|
||||
| `broker-check [--require-test-queue]` | стенд compose: брокер, тот же раздел |
|
||||
| `worker-process` | только стенд с LB: процесс worker, тот же раздел |
|
||||
| `relay-process` | только стенд с LB: процесс relay, тот же раздел |
|
||||
| `pipeline-state` | стенд compose, только чтение: JSON о конвейере, тот же раздел |
|
||||
| `worker-memory` | только стенд с LB: память контейнера worker на двух файлах разом, тот же раздел |
|
||||
| `freeze-sessions [--rounds 6] [--settle 15]` | стенд compose: сессии PostgreSQL и журнал пула после заморозки через TCP-прокси пробы, сервер не замораживается, тот же раздел |
|
||||
| `freeze-lb [--rounds 3]` | свой временный проект compose, `mtusi-lab6` — код 2: `docker pause` PostgreSQL и цепочка сроков через LB, тот же раздел |
|
||||
| `attachment-failover [--mode stop\|kill]` | только стенд с LB: спек `attachments` «Принявшая реплика остановлена». Синтетические Алиса, Боб, Ева и чат; загрузка `tests/fixtures/sample.png` через LB — 202 и ожидание `ready` (реплика A — `X-Instance-Id` ответа), сообщение со ссылкой, `scripts/stop-one.sh` с `TARGET_INSTANCE_ID=A` и `STOP_MODE`, Боб скачивает через LB (до 30 попыток), пока не ответит другая реплика: SHA-256 совпадает, метаданные равны метаданным `ready`; Ева — 404 на метаданные и байты. В `finally` — `make replicas`, затем ожидание, пока LB снова видит все реплики `UP`. Печатает `docker compose ps` до и после и таблицу «шаг → ожидаемо → получено → реплика» без токенов. Код 1 при расхождении, без LB (порт консольного процесса драйвера) — код 2. Вывод — `evidence/attachments/failover.md` |
|
||||
| `attachment-storage` | только стенд с LB: спек `attachments` «Байты не в БД и не на диске API» и `data-storage` «Ограничения обработки в схеме». Две загрузки fixture через LB, 202 и ожидание `ready`; psql — колонки `attachments`, `message_attachments`, `attachment_jobs`, `attachment_variants` и `attachment_job_replays` (из `bytea` только 32-байтные `sha256` вложения и варианта), `object_key` = `<база>/attachments/<id>/original` без `filename`, `staging_key` = `<база>/staging/<id>/original` или уже пуст: готовое вложение его теряет на проходе уборщика; `weed shell fs.ls -l` — объект и три варианта в bucket, размер; анонимный GET ключа и каждого варианта с `127.0.0.1:S3_OUT_PORT` — 403; скачивание участником — тот же SHA-256; пробы в откатываемой транзакции — второе задание той же версии, второй вариант того же имени, `error_code` у не `failed`, `attachment_job_replays` с неизвестным заданием: каждая вставка отклонена (SQLSTATE и имя ограничения), после проб одна строка задания и три варианта; `docker diff` каждой реплики и worker — ни одного файла оригинала. Код 1 с названной проверкой, без LB — код 2. Вывод — `evidence/attachments/storage.md` |
|
||||
| `upload-consistency` | только стенд с LB: спеки `attachments` «Порядок записи» и `storage-consistency` (design change `upload-consistency`, решение 11; `async-attachments`, решения 3 и 11). Синтетические Алиса, Боб и чат; вложение R — 202 и `ready`. Шаги: (1) `docker compose pause s3` → загрузка через LB — 503 за ~5 с → `unpause` в `finally`; новая строка `pending` по psql (`id`, статус, возраст, ключ); (2) триггер «перевод в `queued` падает» (SQLSTATE 08006) на рабочей базе только для уникального `filename` прогона → загрузка 503 → строка `pending`, объекта staging уже нет (компенсация), триггер снят (`finally`, и остаток прошлого прогона — в начале); (3) метаданные, байты и сообщение со ссылкой на обе строки — 404; (4) после grace прогона 30 с — `docker compose run --rm --no-deps -e CLEANER__PENDING_GRACE_SECONDS=30 cleaner --once`, его JSON-вывод; тот же проход убирает staging R: `staging_key` пуст, объекта нет, метаданные прежние; (5) psql и `weed shell fs.tree` (файлы `original`, а не каталоги, под `attachments/` и `staging/`) — ни строк, ни объектов обеих загрузок, объектов без строки под префиксом вложений рабочей базы нет; R скачивается с тем же SHA-256. Таблица «проверка → ожидаемо → получено» без токенов и секретов; код 1 при расхождении, без LB — код 2. ~45 с. Вывод — `evidence/attachments/consistency.md` |
|
||||
| `reconcile-cycle` | только стенд с LB: спеки `storage-consistency` (сверка bucket и БД) и `attachments` «Потерянный оригинал» (design change `track2-reconciler`, решение 12). (1) исходный dry-run с grace по умолчанию — расхождений нет, иначе код 2; (2) синтетические Алиса, Боб, чат, вложения A (в сообщении), B, C — 202 и `ready`; (3) объект O без строки и чужой ключ X — `docker exec` реплики (botocore образа её ключами), объект A удалён (`weed shell fs.rm`), строка B с заданием и вариантом удалена и размер C изменён (psql), P — триггер COMMIT перевода в `queued` на уникальный `filename` (503, строка `pending` и объект staging; находка называет ключ staging), S — объект staging без строки, Y — объект staging с ключом другого вида; (4) после grace 30 с dry-run со сроком хранения по умолчанию — S и Y свежие, не находки; dry-run со сроком хранения 30 с: таблица «класс → действие → ключ → `id` → возраст», снимки строк, объектов и пометок до и после совпали; ещё находки — три объекта вариантов B без строки, S — `orphan_staging`, Y — `unknown_object`; (5) байты A — 500; (6) свежий F, `--apply`: O, B, варианты B и S удалены, A, C помечены, P убрана, F не тронут, байты A — 404, метаданные A — 200 и равны ответу загрузки, история отдаёт A; (7) повтор — только чужие X и Y, код 3; оператор удаляет их — код 0; после grace F удалён; (8) A возвращён теми же байтами — «оригинал вернулся», байты 200 с тем же SHA-256, итоговый dry-run — код 0. Таблица «проверка → ожидаемо → получено» без токенов; код 1 при расхождении, без LB — код 2. ~2 мин. Вывод — `evidence/reconcile/cycle.md` |
|
||||
| `reconcile-stress [--seconds S] [--clients N]` | только стенд с LB: «Сверка под нагрузкой». Предусловие — dry-run с grace 20 с без расхождений (иначе код 2); два объекта без строки и два вложения без объекта; N клиентов (4) S секунд (40, больше grace) загружают PNG ~100 KiB из шума и отправляют сообщения, поток сверки — `--apply` с grace 20 с раз в ~3 с, затем ещё один проход. Итог: загрузки по кодам, сообщения, коды проходов, исправления по классам; проверки — внесённые исправлены (объекты удалены, новые пометки — ровно внесённые), каждое 202 дошло до `ready` и скачивается с тем же SHA-256, каждое сообщение отдаёт своё вложение, ни одного прерванного прохода, повтор dry-run — код 0. Проверка корректности, не замер. Вывод — `evidence/reconcile/stress.md` |
|
||||
| `reconcile-signal` | только не рабочий проект compose (выбор — окружением `COMPOSE_PROJECT_NAME`, `COMPOSE_FILE`, `COMPOSE_ENV_FILES`; `mtusi-lab6` — отказ, код 2): спек `graceful-shutdown`, разовый проход сверки, прерванный сигналом, — код 1 (design change `track2-reconciler`, «Уточнения apply», п. 23). Нужны запущенные `s3` и образ уборщика, LB и реплики не нужны. `docker compose pause s3` → `run -d --no-deps --name <проект>-reconcile-signal cleaner reconcile --apply` → через секунду после «Started cleaner» `docker stop` → код контейнера и журнал → `rm`, `unpause s3` в `finally`. Записи процесса (событие, уровень, операция, `interrupted_by`, `exit_code`) и таблица: код 1, `interrupted_by: stop`, «Stopped cleaner» с `exit_code` 1, записей «Fixed» 0, остановка быстрее 10 с; код 1 при расхождении. ~10 с. `--pace` (design change `track2-reconcile-cost`, решение 14): вместо `pause s3` — 8 объектов пробы под `<база>/attachments/pace-signal-*` мимо API (`docker compose run --rm --no-deps -T --entrypoint python api -`: botocore образа ключами API из окружения контейнера), `cleaner reconcile --max-objects-per-second 1` (dry-run), `docker stop` через 2 с после «Started cleaner» — во время паузы предела скорости; ожидание — код 1, `interrupted_by: stop`, «Stopped cleaner» с `exit_code` 1, остановка ≤ 1 с, `listed_objects` итога — 8 (ключи страницы перед паузой, verify W1); объекты пробы удаляются в `finally`. `--pace --apply` (verify W1, ~45 с): объекты пробы — `<база>/attachments/<uuid>/original` без строки, через 19 с (grace прохода 18 с, `-e CLEANER__PENDING_GRACE_SECONDS=18`) `reconcile --apply --max-objects-per-second 1`, `docker stop` через 19,5 с после «Started cleaner» — посреди удалений, в паузе после DELETE; перед уборкой — сколько объектов пробы осталось (HEAD); ожидание — то же и «Fixed» = `fixed.orphan_object` = удалённых > 0. Нужен ещё сервис `api` в конфигурации проекта (реплики не нужны). Вывод — раздел `evidence/reconcile/service.md` |
|
||||
| `s3-idle [--rounds 3] [--downloads 10] [--puts 12] [--size-mib 4] [--pause-ms 0.5]` | только стенд с LB: спеки `object-storage` «Вызов после простоя» и `attachments` «Загрузка после простоя S3» (design change `fix-upload-put-flake`, решение 4). Проба клиента S3 в первой работающей реплике `api`: `docker exec -i <реплика> python -` со скриптом из stdin — код, настройки и ключи образа, ключи в драйвер не попадают; uvloop, если есть. Два варианта по очереди, у каждого свой `ObjectStorage` и пул: `image` (как в образе) и `reference` (прежний `read_timeout` aiohttp = `[s3] timeout_seconds`, подменой `AioConfig` при создании клиента). Раунд: `--downloads` одновременных скачиваний объекта `--size-mib` MiB через `open` / `iter_chunks` с паузой `--pause-ms` после блока 64 KiB, простой `[s3] timeout_seconds + 0,5` с, `--puts` PUT по 128 KiB по одному. Таблица по раундам: `read_timeout` клиента, скачивания с тем же SHA-256, соединения пула со взведённым сроком чтения после скачиваний (`armed`) и с сохранённым исключением после простоя (`broken`) — закрытые поля aiohttp `_conns`, `_read_timeout_handle`, `_exception`, нет их — «n/a», тогда судят только по PUT; PUT прошло и упало, у упавших — цепочка исключений и мс; каждый записанный объект читается обратно (размер и SHA-256). Объекты — под `<база>/.s3-idle-probe/<uuid>/` (сверка этот префикс не читает), удаляются в `finally` отдельным клиентом; затем `weed shell fs.tree` — файлов пробы 0. Код 0 — у `image` ни испорченного соединения, ни упавшего PUT, ни расхождения байтов, все раунды пройдены и файлов не осталось; 1 — иначе (эталон может падать: так видно механизм); 2 — нет реплики или консольный процесс драйвера. Пул API не трогает (отдельный процесс), но на время команды берёт ~100 MiB и CPU реплики — без нагрузки на стенд. ~40 с при 3 раундах и `timeout_seconds` 5. Вывод — `evidence/s3/idle-connection.md` |
|
||||
| `lb-upload-timeouts [--config F] [--image ТЕГ]` | без стенда (рабочий стенд и проекты compose не трогает): спек `load-balancing` «Загрузки через балансировщик» и «Ошибки балансировщика в формате контракта» (design change `upload-memory`, решение 7). `haproxy -c` конфигурации F (по умолчанию `infra/haproxy/haproxy.cfg`) в закреплённом образе LB из `docker-compose.yml`, затем временная сеть `mtusi-lbto-<метка>`: заглушка реплики на образе API (по умолчанию `mtusi-messenger:lab6`, asyncio stdlib) под сетевым именем `api` и HAProxy с F и `API_PORT=8080` на свободном `127.0.0.1`; ожидание `UP` заглушки по `/health/ready` через LB. Пять случаев параллельно, у каждого своё соединение и свой `case` в строке запроса: заглушка молчит 12 с до чтения тела загрузки 10 MiB и после него — 202 от заглушки; 12 с на `GET /api/v1/users/me` — 504 LB через ~10 с; 32 с на пути загрузки — 504 LB через ~30 с; клиент отправил половину тела и молчит — 400 LB через ~30 с (`timeout client`). Ошибки LB — `application/json`, ровно `{"error": {"code", "message", "request_id"}}`, `code` по статусу, `request_id` = `X-Request-Id`. Таблица «случай → ожидаемо → получено → время», код 1 при расхождении. Сеть и контейнеры (метка `mtusi.lb-upload-timeouts`) удаляются при любом исходе, в том числе по Ctrl+C, SIGTERM, SIGHUP. ~35 с. На `haproxy.cfg` до change (`git archive f894040 infra/haproxy/haproxy.cfg \| tar -x -C <каталог>`, `--config <каталог>/infra/haproxy/haproxy.cfg`) — код 1: 502 и 504 через 10 с на пути загрузки, 400 в HTML. Вывод — `evidence/uploads/lb-timeouts.md` |
|
||||
| `stop-at-start [--image ТЕГ] [--delays 0.2,0.3,0.4,1.5,5] [--server-start 3]` | спек `graceful-shutdown` «Остановка во время старта»: контейнеры образа (по умолчанию `mtusi-messenger:lab6`) с лимитами реплики (1 CPU / 512 МиБ без swap), без сети и `config.toml`; `docker stop --timeout 10` через паузу после `docker run` и сразу по строке «Started server process». По потоку `docker events` и журналу: «сигнал через», время `docker stop`, «выход после сигнала», код выхода, этап (`import` / `server-start` / `running`), кто остановил (`early` / `uvicorn`). Код 0 — каждая попытка с кодом 0 и `docker stop` ≤ 1 с, есть `import`, остановленный ранним обработчиком, и `running`. Проекты compose не трогает, свои контейнеры удаляет по метке `mtusi.stop-at-start`. Вывод — `evidence/failover/stop-at-start.md` |
|
||||
| `stop` | SIGTERM всей группе; ждёт, пока порт освободится. Чужой сервер и контейнер не трогает |
|
||||
| `all` | всё подряд (`student` — если есть `student-tests/`), `stop` в `finally` |
|
||||
|
||||
- Порт по умолчанию **18080**, другой — `--port N` **перед** командой:
|
||||
`python3 $D --port 18081 start`.
|
||||
- Лог сервера (JSON, одна строка на запрос) — `/tmp/mtusi-api-<port>.log`,
|
||||
pid группы — `/tmp/mtusi-api-<port>.pid`.
|
||||
- `make test BASE_URL=http://localhost:18080` работает так же, как
|
||||
`driver.py smoke`.
|
||||
|
||||
## Run: стенд compose (HAProxy + реплики)
|
||||
|
||||
Проект `mtusi-lab6`, образ `mtusi-messenger:lab6`, compose-сервисы
|
||||
`postgres`, `valkey`, `s3` (SeaweedFS, API S3 на `127.0.0.1:S3_OUT_PORT`
|
||||
— 8334), `rabbitmq` (AMQP на `127.0.0.1:5673`, volume `rabbitmq_data`),
|
||||
`migrate` (одноразовые миграции), `s3-bootstrap` (одноразовый:
|
||||
приватный bucket, пользователи API, уборщика и worker), `api` × `API_REPLICAS`
|
||||
(по умолчанию 2, без портов на хосте и без настроек брокера), `relay` (`python -m
|
||||
src.relay`, публикует задания из PostgreSQL), `worker` (`python -m src.worker`), оба
|
||||
без портов и healthcheck, `cleaner` (уборщик незавершённых
|
||||
загрузок, без портов и healthcheck) и `haproxy` — единственный порт API
|
||||
на хосте, `127.0.0.1:APP_OUT_PORT` (8080). Конфиг LB —
|
||||
`infra/haproxy/haproxy.cfg`, правила — `balancer.md` и `docker.md`.
|
||||
|
||||
```bash
|
||||
make run_docker # build + up -d: postgres, valkey, s3, rabbitmq → migrate, s3-bootstrap → api × 2, relay, worker, cleaner → haproxy
|
||||
make s3_check # приватность bucket вне API: таблица проверок, код 0
|
||||
docker compose logs s3-bootstrap # bucket/user exists|created, checks passed
|
||||
docker compose run --rm s3-bootstrap # повтор bootstrap: «exists», код 0
|
||||
docker compose ps -a --format '{{.Name}} {{.ID}} {{.Ports}} {{.Status}}'
|
||||
make instances # ≥2 X-Instance-Id одной сессии через LB (шаг 1 защиты)
|
||||
make lb_stats # слоты HAProxy: адрес, UP/DOWN, запросы, повторы, перенаправления
|
||||
python3 $D --port 8080 flow # те же проверки через LB
|
||||
make test && make student_test # smoke и весь набор через LB, тесты реплик выполняются
|
||||
docker compose logs --no-log-prefix api | tail -5 # JSON всех реплик, реплика — поле instance_id; без -f
|
||||
docker compose logs --no-log-prefix haproxy | tail # LB: ошибки, повторы (+N), смена состояния реплик
|
||||
docker compose exec valkey sh -c 'valkey-cli -p "$VALKEY_PORT" --scan --pattern "messenger:*" | head'
|
||||
# ключи кэша; пароль — из VALKEYCLI_AUTH контейнера
|
||||
scripts/restart.sh # рестарт LB, всех реплик, Postgres, Valkey, S3 и брокера (~35 с): данные, токены, объекты и очередь остаются, кэш пуст; relay, worker и уборщик не трогает
|
||||
make test-persistence ACTION_SCRIPT=scripts/restart.sh # то же публичной проверкой
|
||||
make test-failover ACTION_SCRIPT=scripts/stop-one.sh # остановка реплики, обслужившей тест; ~20 с
|
||||
STOP_MODE=kill STOP_ONE_LOG=/tmp/stop-one.log make test-failover ACTION_SCRIPT=scripts/stop-one.sh
|
||||
# kill вместо graceful; журнал: какой TARGET_INSTANCE_ID и контейнер
|
||||
TARGET_INSTANCE_ID=<x-instance-id> scripts/stop-one.sh # остановить одну реплику руками
|
||||
python3 $D --port 8080 kill-inflight # kill реплики во время входов: 502 от LB без повтора
|
||||
python3 $D --port 8080 idle-conns # простаивающие соединения с репликами закрывает LB (~10 с), а не реплика (60 с)
|
||||
python3 $D --port 8080 hang-key # зависшая реплика держит ключ: повтор получает 201 после прерывания транзакции
|
||||
make test_isolated; python3 $D --port 8080 cache-check --require-test-keys # кэш карточки: одно чтение chats на 50, TTL, ключи двух баз; `;`, а не `&&`: при первой съёмке набор красный как раз без этого файла, а ключи временной базы остаются
|
||||
python3 $D --port 8080 auth-storage # Argon2id в users, SHA-256 токена в sessions, ни токена, ни пароля в pg_dump
|
||||
python3 $D --port 8080 attachment-failover --mode kill # реплика, принявшая файл, убита: скачивание через другую, тот же SHA-256
|
||||
python3 $D --port 8080 attachment-storage # байты только в приватном bucket: схема, ключ, объект, аноним 403, docker diff
|
||||
python3 $D --port 8080 upload-consistency # S3 заморожен и сбой ready: 503, pending не видны, компенсация, cleaner --once всё убрал
|
||||
make reconcile # разовая сверка bucket и БД, dry-run: код 0 — расхождений нет, 3 — остались
|
||||
make reconcile APPLY=1 [MAX_CHANGES=N] # то же с исправлением (предел изменений прохода — 100 или N)
|
||||
python3 $D --port 8080 reconcile-cycle # расхождения с обеих сторон: dry-run, --apply, 404/200, повтор = 0, возврат оригинала; ~2 мин
|
||||
python3 $D --port 8080 reconcile-stress # --apply раз в 3 с под загрузками 4 клиентов 40 с: все 202 доходят до ready и скачиваются с тем же SHA-256
|
||||
COMPOSE_PROJECT_NAME=<временный> python3 $D reconcile-signal # pause s3 + docker stop разового --apply: код 1, interrupted_by stop; не на mtusi-lab6
|
||||
COMPOSE_PROJECT_NAME=<временный> python3 $D reconcile-signal --pace # docker stop во время паузы предела скорости: код 1, ≤ 1 с
|
||||
COMPOSE_PROJECT_NAME=<временный> python3 $D reconcile-signal --pace --apply # то же посреди удалений: каждое удалённое — «Fixed»
|
||||
python3 $D --port 8080 s3-idle # клиент S3 после скачиваний и простоя: у образа 0 испорченных соединений и упавших PUT, эталон портит; ~40 с
|
||||
python3 $D lb-upload-timeouts # сроки LB пути загрузки на заглушке: 202 после 12 с молчания, 504 через 10/30 с, 400 в формате контракта; ~35 с
|
||||
python3 $D --port 8080 defense-scenario # защита лабы 5: worker стоит, 202, 201, 409, 201, сообщение в очереди, рестарт, worker, ready, оригинал и три варианта; ~1,5 мин
|
||||
python3 $D --port 8080 defense-faults # шаг 4 защиты: crash до фиксации и до ack, relay убит до публикации и до отметки, replay; ~4 мин
|
||||
make bench_telemetry_quick VARIANTS=off,full,tail # шаг защиты «для 5» лабы 6: цена наблюдаемости, ~10 мин (рабочий стенд — make stop); разбор — evidence/telemetry-cost/baseline2/summary.md
|
||||
make bench_queue_quick # шаг защиты «для 5» лабы 5: очередь под перегрузкой, ~11 мин (рабочий стенд — make stop); метка baseline4 — в репозитории лабы 5
|
||||
python3 $D broker-check # брокер: образ, volume, порт, предел памяти, очередь, пароль только у rabbitmq, relay, worker, остановка с кодом 0; ~30 с
|
||||
python3 $D --port 8080 worker-process # процесс worker: PID 1, лимиты, Pillow, журнал, неверные настройки, остановка, рестарт хранилищ, остановка под нагрузкой; ~5 мин
|
||||
python3 $D --port 8080 relay-process # процесс relay: то же, окружение без S3 и Valkey; ~2 мин
|
||||
python3 $D --port 8080 worker-memory # два файла разом на границах контракта: memory.peak контейнера, render_peak, OOM нет; ~35 с
|
||||
python3 $D --port 8080 freeze-sessions # заморозка через TCP-прокси пробы: 503 за срок плюс закрытие, сессий сверх пула нет; сервер не трогается; ~2,5 мин
|
||||
python3 $D freeze-lb # docker pause PostgreSQL на временном проекте со своими данными в tmpfs: 503 через LB за ~8 с, 504 нет; ~1,5 мин
|
||||
python3 $D pipeline-state # JSON: задания по состояниям, due, ждут срока, опубликованы и не взяты, истёкшие аренды, очередь
|
||||
make replay # реестр failed, только показ; APPLY=1 ATTACHMENT=<id> — вернуть в работу, код 3 — есть отказы
|
||||
docker compose logs --no-log-prefix relay | tail -3 # relay: Started relay, Relay pass, Recovered expired lease
|
||||
docker compose logs --no-log-prefix worker | tail -3 # worker: Started worker, Connected to broker, задания
|
||||
docker compose logs --no-log-prefix cleaner | tail -3 # уборщик: Started cleaner (60/900/100), проходы, отказы
|
||||
docker compose run --rm --no-deps cleaner --once # разовый проход уборщика (grace 900 с): код 0 — проход дошёл до конца
|
||||
python3 $D stop-at-start # docker stop стартующей реплики: ~0,06 с и код 0 (раньше 10 с и 137)
|
||||
make bench_failover_quick # отказ каждой реплики под нагрузкой на своём стенде mtusi-bench, ~2 мин
|
||||
make rolling_update # новый код на реплики без простоя: сборка, миграции один раз, по одной: новая UP → старая drain → stop → rm
|
||||
make rolling_update COMMIT=<commit> MIGRATE=0 # откат на образ прежнего commit (git archive), схема остаётся новой
|
||||
make bench_rollout_quick # замена под нагрузкой на своём стенде mtusi-bench с образа прежнего commit, ~2 мин
|
||||
make bench_scaling_quick # самопроверка серий трека 1: две ячейки, открытая модель, поиск R*, сэмплер, ~5 мин
|
||||
make replicas # вернуть остановленные реплики (те же ID), ждать healthy
|
||||
make replicas API_REPLICAS=3 # разово 3 реплики; LB видит новую за 1–3 с без правки конфига
|
||||
make down # удалить контейнеры, volume с данными остаётся
|
||||
make wipe_data # удалить и данные: только после ввода yes
|
||||
```
|
||||
|
||||
`make run_docker` сам создаёт недостающие `.env` и `config.toml`
|
||||
(`env_setup`) и монтирует `config.toml` только для чтения. Готовность —
|
||||
`healthy` у `haproxy` (`docker compose ps haproxy`): LB отвечает на
|
||||
`/lb/ready` 200, пока есть хотя бы одна готовая реплика. Между прогонами
|
||||
`make test-failover` — `make replicas`: иначе следующий прогон увидит
|
||||
одну реплику и упадёт на `less than two API instances observed`.
|
||||
|
||||
Новый код — `make rolling_update`, а не `make down` + `make run_docker`:
|
||||
скрипт меняет реплики по одной без простоя (`balancer.md`). Он требует
|
||||
штатного стенда (ровно `API_REPLICAS` реплик, все `UP`, ни одной
|
||||
остановленной — иначе код 2 и подсказка `make replicas`; слот в ручном
|
||||
`drain` / `maint` от прерванной замены — код 2 и команда `set server …
|
||||
state ready`) и runtime API LB: после правки `haproxy.cfg` LB
|
||||
пересоздают `docker compose up -d --force-recreate --no-deps haproxy`.
|
||||
Прерванная замена оставляет `API_REPLICAS` готовых реплик, повторный
|
||||
запуск доводит её. После отката (`COMMIT=… MIGRATE=0`) не запускать
|
||||
`docker compose up` без сборки: `migrate` прежнего образа упадёт на
|
||||
новой ревизии; вперёд — `make rolling_update`.
|
||||
|
||||
Тест останавливает реплику, ответившую на его первую отправку, а число
|
||||
запросов до неё постоянно. При round-robin по двум репликам после `make
|
||||
replicas` он снова выберет ту же. Чтобы остановить другую, очередь LB
|
||||
сдвигают одним запросом перед тестом: `curl -s -o /dev/null
|
||||
http://127.0.0.1:8080/health/live`.
|
||||
|
||||
## Лаба 5: брокер, relay и worker
|
||||
|
||||
Design change `async-attachments`, решение 17, и `pipeline-reliability`, решения 8, 14,
|
||||
17. Команды останавливают сервисы рабочего стенда, поэтому идут одни, без параллельных
|
||||
загрузок и тестов на нём (кроме `pipeline-state`: она только читает). Вывод — без
|
||||
токенов и секретов.
|
||||
|
||||
**`defense-scenario`** (`--port <LB>`; спек `student-tests`, «Сценарий защиты
|
||||
автоматизирован»; ~1,5 мин). Синтетические Алиса, Боб, Ева и чат, затем:
|
||||
|
||||
1. `docker compose stop worker`;
|
||||
2. загрузка `tests/fixtures/sample.png` — 202, снимок `queued`, `id` вложения;
|
||||
3. сообщение с вложением — 201, `id` сообщения;
|
||||
4. скачивание Бобом — 409;
|
||||
5. текстовое сообщение — 201;
|
||||
6. опрос (до 20 с): в очереди ≥ 1 сообщение, его публикует relay, он не останавливается;
|
||||
0 потребителей;
|
||||
7. `scripts/restart.sh`, ожидание LB, сообщение всё ещё в очереди, прежний токен
|
||||
читает метаданные: `queued`;
|
||||
8. `docker compose start worker`, опрос до `ready` (до 60 с);
|
||||
9. оригинал — 200 и тот же SHA-256; три варианта — 200, тип, размеры по самим байтам (без
|
||||
Pillow, стандартной библиотекой), SHA-256 равен метаданным: `thumbnail` JPEG 256×160,
|
||||
`crop` JPEG 128×128, `optimized` WebP 320×200;
|
||||
10. история отдаёт оба сообщения; `StartedAt` всех реплик `api` и `rabbitmq` до и
|
||||
после — разный, у relay — тот же.
|
||||
|
||||
Коды: 0 — всё сошлось; 1 — расхождение (таблица «проверка → ожидаемо →
|
||||
получено»); 130 — прерван сигналом; 2 — нет стенда на порту или консольный процесс
|
||||
драйвера. Вывод — `evidence/attachments/defense.md`.
|
||||
|
||||
**`defense-faults`** (`--port <LB>`; спек `student-tests`, «Шаг 4 на рабочем стенде»;
|
||||
~4 мин, из них аренда 70 с). Порядок — тот же, что `test_defense_faults` на стенде
|
||||
отказов. Триггеры `driver_df_*` срабатывают только на уникальный `filename` прогона:
|
||||
|
||||
1. **после записи объектов до COMMIT:** триггер `pg_sleep(4)` на перевод в `ready`,
|
||||
загрузка 202, сессия worker в `PgSleep` на `UPDATE attachments` (объекты записаны),
|
||||
`docker kill worker`; `processing`, `attempt` 1, SHA-256 трёх объектов до сбоя, снятие
|
||||
триггера, запуск; `ready` не раньше истечения аренды (срок попытки 60 с + запас 10 с),
|
||||
те же SHA-256 в S3 и метаданных, `attempt` 2;
|
||||
2. **после COMMIT до ack:** отложенный триггер `pg_sleep(3)` в COMMIT, `docker kill -s
|
||||
STOP worker` (контейнер `running`, не `paused`: KILL проходит), `succeeded` при
|
||||
замороженном клиенте, `docker kill worker`, сообщение вернулось в очередь, запуск —
|
||||
запись «Skipped job message» `finished` по этому заданию, новых попыток 0, тот же
|
||||
`updated_at`, метаданные те же, `attempt` 1, очередь пуста;
|
||||
3. **после COMMIT `queued` до публикации:** `docker kill relay`, контейнер не вернулся,
|
||||
загрузка 202, `published_at` пуст, сообщений 0, запуск relay, `ready`, `attempt` 1;
|
||||
4. **после подтверждения до отметки:** worker остановлен, триггер `pg_sleep(3)` на
|
||||
`published_at`, загрузка 202, сессия relay в `PgSleep` на `UPDATE attachment_jobs`,
|
||||
`docker kill relay`, сообщение в очереди, `published_at` пуст, запуск relay — два
|
||||
сообщения при остановленном worker, запуск worker, `ready`, `attempt` 1, очередь пуста;
|
||||
5. **replay `failed`:** worker остановлен, загрузка 202, объект staging заменён другими
|
||||
байтами того же размера, запуск worker — `failed` `processing_failed`, причина
|
||||
`source_corrupted`; реестр `relay replay --error-code processing_failed` называет
|
||||
задание и ничего не меняет; объект возвращён; `relay replay --attachment-id … --apply
|
||||
--operator driver-defense-faults` — код 0, `ready`, оригинал с тем же SHA-256, то же
|
||||
задание, `attempt` 2, `attempt_base` 1, запись аудита;
|
||||
6. **replay готового:** новое `ready`, `--apply` — код 3, отказ `already_ready`,
|
||||
метаданные и задание те же, аудита нет.
|
||||
|
||||
Каждое вложение проверяется скачиванием трёх вариантов. Вывод — строки по окнам и шагам, в
|
||||
конце таблица «окно → действие → `id` задания → начатых попыток → итог» и таблица «проверка →
|
||||
ожидаемо → получено». В конце `pg_trigger` без `driver_df_*`. Коды: 0; 1 — расхождение; 130 —
|
||||
прерван сигналом; 2 — нет стенда на порту или консольный процесс драйвера. Вывод —
|
||||
`evidence/attachments/defense-faults.md`.
|
||||
|
||||
**`broker-check [--require-test-queue]`** (спек `message-broker`; ~30 с, порт не
|
||||
нужен). Таблица «проверка → ожидаемо → получено»: образ `rabbitmq:X.Y.Z@sha256:…` в
|
||||
`docker compose config`, `healthy`, volume `<проект>_rabbitmq_data` на
|
||||
`/var/lib/rabbitmq`, `docker port` — ровно AMQP на `127.0.0.1`, лимит контейнера 512
|
||||
МиБ и `vm_memory_high_watermark_limit` меньше него (`rabbitmqctl -q status --formatter
|
||||
json`), пароль брокера в `docker compose config` — только у `rabbitmq`, `relay`, `worker`
|
||||
(имена переменных, значения не печатаются), у `api` нет `BROKER__*`, рабочая очередь
|
||||
`<база>.attachment.process.v1` durable (`rabbitmqctl -q list_queues … --formatter json`).
|
||||
С флагом — ещё очередь `test_<база>.attachment.process.v1`, без неё код 1, без флага —
|
||||
строка «not checked». Затем `docker compose stop rabbitmq` — код 0 раньше срока 20 с, код
|
||||
контейнера 0; `up -d --wait --no-recreate rabbitmq` (при любом исходе), очередь на месте,
|
||||
worker снова потребляет (если потреблял), relay пережил отказ (прежний `StartedAt`). Коды: 0,
|
||||
1 — расхождение, 130 — сигнал. Вывод — `evidence/broker/stand.md`.
|
||||
|
||||
**`worker-process`** (`--port <LB>`; спеки `container-run`, `graceful-shutdown`,
|
||||
`service-configuration`; ~2 мин). PID 1 — `python -m src.worker`, healthcheck `NONE`, лимиты
|
||||
1 CPU и 1 ГБ; `_imaging` нет в `/proc/1/maps` ни реплик API, ни процесса 1 worker (декодер —
|
||||
только в процессе обработки); версия Pillow в образе равна `uv.lock`; последняя запись
|
||||
«Started worker» со всеми значениями, значения по умолчанию (конкуренция 2, prefetch 2, 5
|
||||
попыток, срок 60 с, запас аренды 10 с, пауза 5 и 300 с, процесс обработки 40 с, 15 с CPU, 450
|
||||
МиБ, остановка 8 с, соединение 2 с); `WORKER__CONCURRENCY=0`, `WORKER__PREFETCH=0`,
|
||||
`WORKER__MAX_ATTEMPTS=abc`, `WORKER__GRACEFUL_SHUTDOWN_SECONDS=9`,
|
||||
`WORKER__RENDER_MEMORY_LIMIT_MIB=0`, `WORKER__RENDER_TIMEOUT_SECONDS=120` (`docker compose
|
||||
run --rm --no-deps -e … worker`) — код 2, запись называет поле, значения в ней нет; подмена
|
||||
окружением в одноразовом контейнере (`WORKER__CONCURRENCY=3`, `WORKER__RECONNECT_SECONDS=1`);
|
||||
`docker compose stop worker` — код контейнера 0, быстрее 10 с, «Stopped worker» с `exit_code`
|
||||
0, затем `start`; `docker stop` контейнера образа (без сети, лимиты сервиса) через 0,2–0,4 с
|
||||
после `docker run` — код 0, не дольше 1 с, «Stopped worker before startup» хотя бы в одной
|
||||
попытке; `scripts/restart.sh` — у worker прежний `StartedAt`, `RestartCount` 0, новая
|
||||
загрузка `ready`; остановка под нагрузкой: два дорогих JPEG в обработке (генератор
|
||||
`student-tests/images.py` в контейнере образа), `docker stop` быстрее 9,5 с, код 0, без OOM,
|
||||
«Stopped worker» последней записью — сначала при живых хранилищах, затем при замороженных
|
||||
PostgreSQL и брокере; все четыре задания после этого доходят по аренде до `failed`, `limit_cpu`
|
||||
(до 200 с, поэтому вся команда ~5 мин). Коды: 0, 1 — расхождение, 130 — сигнал, 2 — нет стенда.
|
||||
Вывод — `evidence/worker/process.md`.
|
||||
|
||||
**`relay-process`** (`--port <LB>`; те же спеки; ~2 мин). Те же шаги о сервисе `relay`: PID 1 —
|
||||
`python -m src.relay`, healthcheck `NONE`, лимиты 0,25 CPU и 256 МБ; в окружении нет `S3__`,
|
||||
`S3_`, `CACHE__`, `VALKEY` (только имена переменных); `_imaging` нет ни у реплик, ни у relay;
|
||||
«Started relay» со всеми значениями, значения по умолчанию (опрос 0,25 с, пакет 100, предел 1000,
|
||||
порог потерянного 300 с, пауза отказа 2 с); `RELAY__BATCH_SIZE=0`,
|
||||
`RELAY__MAX_PUBLISHED_BACKLOG=-1`, `RELAY__POLL_INTERVAL_SECONDS=abc` — код 2, поле, без
|
||||
значения; подмена окружением (`RELAY__BATCH_SIZE=7`, `RELAY__POLL_INTERVAL_SECONDS=1`);
|
||||
`docker compose stop relay` — код контейнера 0, быстрее 10 с, «Stopped relay» с `exit_code` 0;
|
||||
`docker stop` на старте — «Stopped relay before startup»; `scripts/restart.sh` — прежний
|
||||
`StartedAt`, `RestartCount` 0, новая загрузка `ready`; `docker stop relay` при замороженном брокере
|
||||
с намерением в работе — быстрее 10 с, код 0, «Stopped relay» последней записью, после запуска relay
|
||||
вложение `ready`. Коды те же. Вывод — `evidence/relay/process.md`.
|
||||
|
||||
**`pipeline-state`** (решение 8; порт не нужен, только чтение, идёт и под нагрузкой). JSON:
|
||||
`jobs_by_state` (`queued`, `processing`, `succeeded`, `failed`), `due` (`queued` без отметки, срок
|
||||
прошёл: публикует следующий проход relay), `waiting_for_time` (`queued`, срок впереди),
|
||||
`published_not_taken` (`queued` с отметкой), `expired_leases` (`processing`, аренда истекла:
|
||||
вернёт relay), `oldest_queued_age_seconds` (старейшее `queued`, `null` — таких нет), `queue`:
|
||||
`name`, `available`, `exists`, `durable`, `messages_ready`, `messages_unacknowledged`, `consumers`.
|
||||
Коды: 0, в том числе при недоступном брокере (`available: false`, ожидание до 15 с); 1 — нет
|
||||
PostgreSQL или конфигурации стенда, причина в stderr. `python3 $D pipeline-state | jq .due`.
|
||||
|
||||
**`worker-memory`** (`--port <LB>`; спек `attachment-processing`, «Изображение в лимите
|
||||
пикселей»; design change `pipeline-reliability`, решение 7; ~35 с). Девять случаев: PNG из шума
|
||||
10 MiB, шесть типов PNG на 40 Мпкс, RGBA и серый 16 бит на обеих границах контракта разом (файлы
|
||||
— генераторы `student-tests/images.py` в контейнере образа без сети). На случай: `docker stop`
|
||||
worker, две одинаковые загрузки, `docker start` (новая cgroup: `memory.peak` с нуля), оба `ready`
|
||||
(до 90 с), затем `/proc/1/status`, `memory.peak`, `memory.events`, `docker inspect`, записи журнала
|
||||
«Started job attempt» и «Attachment became ready». Строка таблицы на случай и таблица «проверка →
|
||||
ожидаемо → получено»: все 18 `ready`, задания пересеклись во всех случаях, `oom` и `oom_kill` 0,
|
||||
`OOMKilled` false, рестартов нет, наибольший `render_peak` меньше `render_memory_limit_mib`,
|
||||
`memory.peak` и сумма пиков `VmHWM + 2 × render_peak` меньше лимита контейнера. `memory.peak` одного
|
||||
случая плавает на сотни МиБ: зависит от совпадения пиков двух процессов. Коды: 0; 1 — расхождение;
|
||||
130 — сигнал (worker и relay запускаются при любом исходе); 2 — нет стенда или есть незавершённые
|
||||
задания: они добавили бы свой пик. Вывод — `evidence/worker/memory.md`.
|
||||
|
||||
**`freeze-sessions [--rounds 6] [--settle 15]`** (спек `unit-of-work`; design change `unit-of-work`,
|
||||
уточнения 17 и 18; порт не нужен; ~2,5 мин). Заморозка без заморозки сервера: одноразовый контейнер
|
||||
`api` (`docker compose run --rm --no-deps -T --name <проект>-freeze-sessions --entrypoint python
|
||||
api -`, скрипт через stdin, настройки и код образа, ключи в драйвер не попадают), приложение в его
|
||||
процессе без lifespan, вызовы ASGI напрямую (httpx в образе нет), PostgreSQL только через TCP-прокси
|
||||
пробы, закрытые ворота прокси — и есть заморозка. Срок `[database] request_timeout_seconds` 2 с. Режимы:
|
||||
`second-block` (пул 2, ворота закрываются между блоком входа и `GET /chats`), `before-requests`
|
||||
(пачка из четырёх `GET /users/me`, пул 2 и пул 4). После разморозки на раунд: сессии через прокси,
|
||||
занятые соединения, четыре следующих запроса, записи логгера `sqlalchemy.pool`; в конце — занятые
|
||||
соединения, снимок сессий через `--settle` с. Таблица: 503 в срок 2–4,5 с, сессии в пределах пула
|
||||
сразу и после паузы, следующие запросы 200, записей пула 0, сессий брошенной проверки (запрос `;`) 0.
|
||||
Контейнер удаляется при любом исходе, в базе остаётся по одному синтетическому пользователю на режим.
|
||||
Коды: 0; 1 — расхождение; 130 — сигнал; 2 — PostgreSQL проекта не работает. Вывод —
|
||||
`evidence/storage/freeze-sessions.md`.
|
||||
|
||||
**`freeze-lb [--rounds 3]`** (та же запись verify; порт не нужен; ~1,5 мин). Только временный проект
|
||||
compose: `COMPOSE_PROJECT_NAME` или `mtusi-lab6-freeze`, `mtusi-lab6` — отказ, код 2; перед `docker
|
||||
pause` метка проекта контейнера сверяется ещё раз. Команда сама поднимает стенд и убирает его при любом
|
||||
исходе, нужен только образ `mtusi-messenger:lab6` (`make run_docker`, иначе код 2): во временном каталоге
|
||||
файл окружения из `.env.example` со случайными секретами и override — без портов PostgreSQL, Valkey и S3,
|
||||
данные PostgreSQL, Valkey и S3 в tmpfs (volumes нет), `config_example.toml`, порт LB свободный. `up -d
|
||||
--no-build haproxy`, ожидание двух реплик через LB, прогрев пула, синтетические пользователи и чат. На
|
||||
заморозку: сессии `pg_stat_activity`, `docker pause` PostgreSQL, шесть одновременных запросов (`GET
|
||||
/users/me`, история, `POST` сообщения, `GET /chats`, вход, метаданные вложения), `unpause` в `finally`,
|
||||
время до первого 200, через 11 с — снова сессии. Таблица: все ответы 503 `unavailable`, 504 от LB нет,
|
||||
каждый раньше `timeout server` 10 с, восстановление, сессий не больше пулов (20) и не растёт, сессий `;`
|
||||
нет, контейнеров и volumes проекта после `down` 0. Коды: 0; 1 — расхождение; 130 — сигнал; 2 — рабочий
|
||||
проект или нет образа. Вывод — раздел `evidence/storage/freeze-sessions.md`.
|
||||
|
||||
Gotchas:
|
||||
|
||||
- **Сигнал во время `defense-scenario`, `defense-faults`, `worker-process`, `relay-process`.**
|
||||
SIGINT, SIGTERM, SIGHUP прерывают сценарий с кодом 130. Начатый `restart.sh` (своя сессия)
|
||||
доводится до конца, триггеры снимаются, замороженный worker добивается, worker и relay
|
||||
запускаются, повторные сигналы на это время игнорируются: выход может занять до минуты. От
|
||||
SIGKILL защиты нет: `docker compose start worker relay` руками, триггеры — следующий прогон
|
||||
`defense-faults` или `DROP TRIGGER` по `pg_trigger` с `driver_df_`.
|
||||
- **Прерванный `defense-faults` оставляет работу в строках, а не только в триггерах:** зависшая
|
||||
попытка вернётся по аренде через ≤ 70 с, строка `failed` окна replay остаётся в реестре.
|
||||
- **`docker kill` не перезапускает контейнер** при `restart: unless-stopped`: `docker start` делает
|
||||
сам драйвер (тот же контейнер, те же журнал и `StartedAt` следующего запуска).
|
||||
- **`broker-check --require-test-queue` имеет смысл только во время `make test_isolated`:**
|
||||
после прогона очереди временной базы нет (спек «Очереди разных баз разделены»), поэтому отдельный
|
||||
запуск — код 1, и это верно. Флаг запускают из другого терминала посреди прогона.
|
||||
- **На время `broker-check` загрузки стенда — по-прежнему 202:** брокера в пути запроса нет.
|
||||
Брокер остановлен ~5–10 с, задания ждут в PostgreSQL, relay пишет «Broker is unavailable» и
|
||||
публикует их после возврата.
|
||||
- **Без `--port` у `defense-scenario`, `defense-faults`, `worker-process`, `relay-process` — код 2**
|
||||
(«no stand on port 18080»): стенд на 8080, а порт драйвера по умолчанию 18080.
|
||||
- **Подмена окружением.** Одноразовый контейнер `worker-process` — такой же потребитель рабочей
|
||||
очереди, у `relay-process` — такой же издатель; живёт секунды и убирается `docker rm -f`: задание
|
||||
worker вернётся по аренде, дубль relay — no-op.
|
||||
- **Staging готового вложения исчезает на проходе уборщика (до 60 с, `staging_key` становится
|
||||
`NULL`):** `attachment-storage` принимает оба вида. У `failed` объект живёт сутки: без него
|
||||
replay откажет `source_gone`. Сверка видит staging: объект без строки и ключ другого вида моложе
|
||||
срока хранения — свежие, старше — `orphan_staging` и `unknown_object`. `reconcile-cycle`
|
||||
задаёт срок хранения прогона 30 с. У него строка B удаляется вместе с заданием и вариантами (FK без
|
||||
каскада), три объекта вариантов становятся находками, а её staging драйвер убирает сам.
|
||||
- **Консольный `driver.py start` и стенд делят очередь и строки заданий:** имя очереди — от имени
|
||||
базы, база та же. Если контейнеры `worker` и `relay` стенда запущены, задания консольного API могут
|
||||
взять они (результат тот же). Worker и relay в консоли не перезагружаются при правке `src/`:
|
||||
`driver.py stop`, затем `start`.
|
||||
- **`pipeline-state` считает задания прежнего уровня как есть:** строка с отметкой без сообщения —
|
||||
`published_not_taken`, пока relay не снимет отметку по порогу `republish_after_seconds`.
|
||||
|
||||
## Лаба 6: телеметрия
|
||||
|
||||
Design change `otel-telemetry`, решение 21, и `job-trace-propagation`, решение 16; правило
|
||||
`.claude/rules/telemetry.md`. На стенде compose телеметрия включена у `api`, `worker` и `relay`;
|
||||
Grafana — `http://127.0.0.1:${GRAFANA_OUT_PORT}` (по умолчанию 3000), пользователь `admin`,
|
||||
пароль — `GRAFANA_ADMIN_PASSWORD` в `.env` (не печатать). Консольный `driver.py start` — без
|
||||
телеметрии.
|
||||
|
||||
```sh
|
||||
python3 .claude/skills/run-mtusi-messenger/driver.py --port 8080 telemetry-check # ~2 мин
|
||||
python3 .claude/skills/run-mtusi-messenger/driver.py --port 8080 telemetry-outage # ~3 мин
|
||||
python3 .claude/skills/run-mtusi-messenger/driver.py --port 8080 trace-chain # ~5 мин
|
||||
python3 .claude/skills/run-mtusi-messenger/driver.py stand-from-scratch --runs 2 # ~1 мин на прогон
|
||||
make alerts_test # секунды, без стенда
|
||||
python3 .claude/skills/run-mtusi-messenger/driver.py --port 8080 alerts-check # ~25 мин
|
||||
python3 .claude/skills/run-mtusi-messenger/driver.py --port 8080 backend-outage # ~18 мин
|
||||
```
|
||||
|
||||
- **`make alerts_test`** (design change `slo-alerts`, решение 11) — правила Prometheus без стенда
|
||||
и сети: `tar` файлов `infra/otel/prometheus/` в одноразовый контейнер образа Prometheus из
|
||||
`docker-compose.yml` (`--network none`), `promtool check config`, `check rules`, `test rules
|
||||
rules.test.yml`; затем у каждого оповещения есть `runbook_url`, и файл runbook есть в git.
|
||||
- **`alerts-check`** — учения на рабочем стенде, всё через HTTP API Grafana (источник-прокси
|
||||
Prometheus: `/api/v1/rules` раз в 5 с — моменты pending, firing и снятия). Предусловия: группы
|
||||
`messenger-sli`, `messenger-slo`, `messenger-alerts`, `telemetry-alerts` загружены без ошибок,
|
||||
правила видны в Grafana (`/api/prometheus/prometheus/api/v1/rules`), правка через ruler Grafana
|
||||
отклонена, адресов доставки нет; оповещений в pending и firing нет 5 мин — иначе код 2 «stand is
|
||||
not quiet». Фоновая нагрузка драйвера (`DriverLoad`: 6 потоков отправки сообщения с новым ключом
|
||||
раз в 0,25 с и 1 чтения истории раз в 1 с, ответы по классам и `X-Instance-Id` на стороне
|
||||
клиента).
|
||||
Шаги: 1) `docker compose stop worker`, 3 загрузки — `MessengerQueueLagHigh` ≤ 4 мин, глубина
|
||||
`outbox` + `published` +3, consumer span после остановки нет, последняя запись worker в Loki;
|
||||
worker стоит не меньше 130 с (ряды процесса ушли), `docker start` — все `ready`, снято ≤ 2 мин,
|
||||
счёт `messenger_job_time_to_ready_seconds_count` по точкам (без экстраполяции, первая точка —
|
||||
ноль времени начала нового процесса) +3; 2) `docker compose stop relay` — ряды глубины и
|
||||
возраста очереди уходят ≤ 2 мин, `MessengerQueueMetricsMissing` ≤ 5 мин, `docker start` — снято
|
||||
≤ 2 мин; 3) сессия psql
|
||||
`application_name = mtusi-alerts-check` циклами держит `LOCK TABLE messages IN SHARE MODE` 2 с с
|
||||
паузой 0,2 с — `MessengerSlowRequests` ≤ 4 мин, медиана доли span PostgreSQL в медленных трассах
|
||||
отправки > 0,5, пул занят больше, чем до шагов, CPU реплик < 0,5 предела; сессия завершена
|
||||
(`pg_terminate_backend`) — снято ≤ 4 мин; 4) 3 потока входят по Basic 45 с — медиана доли span
|
||||
PostgreSQL в трассах входа < 0,2, свободное место в пуле ждать не пришлось (доля занятых < 1,
|
||||
отказов по сроку 0; `pending` — наблюдение), p95 входа > 0,25 с,
|
||||
`MessengerSlowRequests` не стало pending; 5) `docker compose stop postgres` —
|
||||
`MessengerNoReadyReplicas` и `MessengerHighErrorRate` ≤ 3 мин, готовых реплик 0, 5xx LB больше
|
||||
5xx API и не меньше 503 самого LB у клиента, доля 5xx LB = доля клиента ± 5 п. п.; `docker
|
||||
compose start postgres` — сняты ≤ 4 мин (`MessengerQueueMetricsMissing` в pending допустим);
|
||||
6) SLI за 7 суток в [0, 1], за час — по рядам правил и по исходным счётчикам: сумма
|
||||
`increase(…[5m])` на время каждой точки `messenger-slo` (≤ 1 п. п.), у доступности и задержки —
|
||||
и `increase` за час одним окном (≤ 1 п. п.; у времени до `ready` — наблюдение), число окон за
|
||||
час (пока Prometheus стоял, окон нет), перед шагами — 20 загрузок
|
||||
при работающем worker (хорошие события времени до `ready`), SLI за окно учений, запросы панелей с id от 25 с данными,
|
||||
панель истории состояний показывает firing всех шагов; пики памяти Prometheus и Collector. На
|
||||
каждом шаге — момент pending рядом с каждой строкой firing и «other alerts firing» (лишних нет). В `finally` — нагрузка остановлена, сессия
|
||||
блокировки завершена, PostgreSQL запущен, worker и relay — `docker start` тех же контейнеров, LB
|
||||
готов. Код 0 / 1 / 2.
|
||||
- **`backend-outage`** — та же нагрузка и опрос правил; память раз в 2 с (`memory.current` реплик
|
||||
через `docker exec … cat`, Collector — `docker stats`: в образе нет оболочки). Loki и Tempo по
|
||||
очереди: 10 с (свой запрос находится в хранилище после возврата, счётчики `send_failed` /
|
||||
`enqueue_failed` экспортёра не выросли) и 120 с (`make test` PASS, 5xx у клиента 0, очередь
|
||||
экспорта ≤ ёмкости, память Collector ниже лимита, `TelemetryTargetDown{job=…}` ≤ 110 с,
|
||||
`TelemetryDataLoss` firing, потери Collector > 0 и видны на панели потерь (запрос A панели 40,
|
||||
`job="otel-collector"`), новые сигналы после возврата, оба сняты ≤ 4 мин); Prometheus 60 с (5xx 0, приращение счёта запросов API между точками до и после не меньше
|
||||
запросов нагрузки); Collector 120 с (`make test` PASS, `TelemetryTargetDown` firing, память
|
||||
каждой реплики: максимум последней трети окна не выше первой больше чем на 16 МиБ и ниже
|
||||
лимита, `MessengerQueueMetricsMissing` не pending; после возврата — снято, счётчики потерь SDK
|
||||
реплик выросли и видны на панели потерь (`job="messenger-api"`: ряд правила процесса SDK
|
||||
начинается с нуля), ёмкость очередей SDK span и журнала 2048, записей Loki в окне меньше stdout). В конце — пики
|
||||
памяти Collector, Prometheus и реплик по cgroup (`memory.peak`, `anon` + `kernel` + `shmem`,
|
||||
`file`, лимит — для бюджета). В `finally` — сервисы телеметрии запущены, worker и relay. Код 0 /
|
||||
1 / 2.
|
||||
|
||||
- **`trace-chain`** — сквозная трасса загрузки и сигналы уровня 4, всё через HTTP API Grafana:
|
||||
1) предусловие — глубина очереди 0 в Prometheus за 120 с (не дождались — код 2 «stand is not
|
||||
quiet»: незавершённые задания других прогонов), `docker compose stop worker`, три загрузки —
|
||||
`outbox` + `published` в
|
||||
`messenger_queue_depth{job="messenger-relay"}` = 3, возраст старейшего не меньше времени с
|
||||
первой загрузки минус 35 с и растёт; `docker start` worker — все `ready`, глубина и возраст 0;
|
||||
2) worker остановлен, загрузка F (её `X-Request-Id` R), задание опубликовано (PostgreSQL,
|
||||
только чтение), `pause s3`, worker запущен, «Retrying job» F в stdout worker, `unpause s3`, F
|
||||
`ready`; Loki «Uploaded attachment» R → `trace_id` T, записи worker F — с T; трасса T: корень
|
||||
— server span загрузки `messenger-api`, два span producer `messenger-relay` — дети корня,
|
||||
попытки 1 и 2, у второго `retry_reason` `storage_unavailable`, `service.instance.id` = relay;
|
||||
два consumer span `messenger-worker` — parent и link на свой producer, `retry` (попытка 1,
|
||||
span S3 с ошибкой) и `ready` (попытка 2, `S3.PutObject` ≥ 4, процесс обработки, `COMMIT`);
|
||||
3) недекодируемый JPEG → `failed`, `docker compose run --rm --no-deps relay replay
|
||||
--attachment-id … --apply` → снова `failed`; в трассе загрузки producer с
|
||||
`messenger.job.replayed` и второй consumer span `failed`; 4) `docker compose stop relay`,
|
||||
загрузка, `UPDATE attachment_jobs SET traceparent = NULL, tracestate = NULL` по
|
||||
`attachment_id` (одна строка своего вложения), `docker start` relay — `ready`, у worker другой
|
||||
`trace_id`, корень — consumer span, span producer нет; 5) пулы (10 у реплик, 2 у worker, 1 у
|
||||
relay; занятых не больше), ёмкость worker 2, ряды очереди только у relay, пределы контейнеров
|
||||
= `docker inspect` (`NanoCpus`, `Memory`), память меньше предела, CPU каждого контейнера
|
||||
вырос за прогон (`increase(container_cpu_time_seconds_total[…])` > 0), нет `docker.sock` в
|
||||
`docker compose config`, запросы панелей уровня 4 без ошибок и с данными, время до `ready`
|
||||
выросло на число загрузок без replay (счётчики двух процессов worker: после перезапуска
|
||||
Prometheus не видит сброса, если новый процесс насчитал больше), сумма — не меньше 3 × время
|
||||
остановки worker. В `finally` — `unpause s3`, worker и relay запущены. Код 0 / 1, 2 — нет
|
||||
стенда или Grafana либо стенд не тихий. Рабочий стенд, ~5 мин; `docker start`, а не `compose start`: тот поднял
|
||||
бы зависимости, в том числе замороженный S3.
|
||||
|
||||
- **`telemetry-check`** — всё через HTTP API Grafana (источники-прокси Prometheus, Loki, Tempo):
|
||||
вход 401 / 401 / 200, порт только на `127.0.0.1`, источники по uid и их проверка, dashboard
|
||||
provisioned и отказ его сохранения, цели Prometheus `up`, метрики LB; панель потерь (id 40) на
|
||||
тихом стенде — все три запроса 0, `TelemetryDataLoss` неактивно (ждёт до 330 с: окно `rate()`
|
||||
панели 5 мин, время ожидания печатается); затем «тихая» база счётчиков (35 с без
|
||||
изменений), свой пользователь, сообщение, 10 GET чата, 401, 404, `PROPFIND` и `GET` к
|
||||
неизвестному пути с UUID (ряды `_OTHER` и `GET` без `http_route` выросли на 1; `BREW` —
|
||||
только 400 парсера, ограничение), `traceparent`, загрузка и недекодируемый JPEG (12 бит,
|
||||
генератор тестов в образе API). Сверяет stdout ↔ Loki ↔ Tempo по `X-Request-Id`, переходы лог
|
||||
↔ трасса источников Grafana (derived field Loki → `tempo`; запрос `tracesToLogsV2` источника
|
||||
Tempo с подстановкой span трассы возвращает её записи), трассу worker по `attachment_id` —
|
||||
это трасса загрузки (`trace_id` записи «Uploaded attachment»; с change `job-trace-propagation`
|
||||
шаги задания — по consumer span `ready` в ней, а не по корню: его родитель — span producer
|
||||
`messenger-relay`, `service.instance.id` = `instance_id` relay; запись прохода relay в Loki =
|
||||
stdout, без `trace_id`; корней-span relay в Tempo нет), `service.instance.id` worker =
|
||||
`instance_id` его stdout, рост счётчиков ровно на свои запросы
|
||||
и задания по обеим репликам, нет рядов `http_route=~"/health.*"` за срок хранения, span S3 с
|
||||
ошибкой при `docker
|
||||
compose pause s3` (`unpause` в `finally`), отсутствие трасс health и чужих корней, сети
|
||||
хранилищ из `api`, `worker` и `relay`, разовый контейнер API с `OTEL_SDK_DISABLED=true` и
|
||||
чужим адресом,
|
||||
пробу приватности (U, P, T, M, K, F, `Bearer `, `Basic ` по всем записям Loki, трассам Tempo и
|
||||
меткам Prometheus окна), затем `docker compose restart` Collector и хранилищ — те же запись,
|
||||
трасса и значение ряда. Код 0 / 1, 2 — нет стенда или Grafana.
|
||||
- **`telemetry-outage`** — Collector `stop`, затем `pause`: `make test`, загрузка до `ready`, число
|
||||
записей логгеров `opentelemetry.*` в stdout за окно (не больше одной на логгер в минуту),
|
||||
возврат Collector — новые запись, трасса (и span producer relay) и ряды API, worker и relay при
|
||||
прежних `StartedAt` и `RestartCount` всех контейнеров `api`, `worker` и `relay` (без
|
||||
перезапусков, verify W2); затем Collector снова недоступен тем же способом, `make test`,
|
||||
`docker stop` одной реплики, `docker compose stop worker` и `docker stop` relay (время меньше
|
||||
10 с, код 0, «Stopped API», «Stopped worker», «Stopped relay»), `make replicas`, worker и
|
||||
relay снова запущены, возврат Collector; затем все сервисы телеметрии остановлены — `docker compose
|
||||
restart api worker relay` («Started relay» с телеметрией), `make test`, возврат. В `finally` —
|
||||
`unpause`, `start` телеметрии, `make replicas`, worker и relay.
|
||||
- **`stand-from-scratch`** — только свой одноразовый проект: `--project` принимает лишь имя
|
||||
`^mtusi-lab6-scratch(-[a-z0-9]+)?$` (по умолчанию `mtusi-lab6-scratch`), иное — `mtusi-lab6`,
|
||||
`mtusi-lab5`, `mtusi-lab6-failures` — код 2 до любых вызовов docker: команда сама делает `down
|
||||
-v` своего проекта. Затем `make run_docker` с `COMPOSE_PROJECT_NAME` и свободными портами хоста, затем
|
||||
состояния, `RestartCount`, `eacces` / `permission denied` в журналах, provisioning Grafana,
|
||||
`make test` через свой LB; `down -v` своего проекта в начале, после каждого прогона и при
|
||||
Ctrl+C. Рабочий стенд лучше остановить заранее (`make stop`): два стенда — 14 ГиБ лимитов на ВМ
|
||||
7,75 ГиБ; ID его контейнеров команда сверяет. После — `docker compose start`, а не `up`:
|
||||
`make run_docker` проекта scratch пересобирает общий тег `mtusi-messenger:lab6`, и `up`
|
||||
пересоздал бы реплики рабочего стенда.
|
||||
- **Gotchas:** Tempo 3.1 на неизвестный trace-id отвечает 200 с пустой трассой; трасса без
|
||||
корня — ещё не вся (дочерние span приходят раньше); итоговая запись о запросе пишется после
|
||||
отправки ответа — ждать её опросом. `BREW` не доходит до приложения (`KNOWN_ISSUES.md`).
|
||||
|
||||
## Direct invocation (без HTTP)
|
||||
|
||||
Для правок в `src/core/` сервисы вызываются поверх единицы работы, сервер не
|
||||
нужен, но Postgres с миграциями нужен (`make upgrade`). Ветки сервисов без
|
||||
хранилищ — `make service_test`.
|
||||
`APP__LOG_LEVEL=WARNING` убирает JSON-логи сервисов из вывода:
|
||||
|
||||
```bash
|
||||
make upgrade
|
||||
APP__LOG_LEVEL=WARNING uv run python - <<'EOF'
|
||||
import asyncio
|
||||
import uuid
|
||||
from src.config import settings
|
||||
from src.core.services import SessionService, UserService
|
||||
from src.infra.db.session import engine, session_factory
|
||||
from src.infra.db.uow import SqlAlchemyUnitOfWork
|
||||
|
||||
async def main():
|
||||
uow = SqlAlchemyUnitOfWork(
|
||||
session_factory,
|
||||
timeout_seconds=settings.database.request_timeout_seconds,
|
||||
)
|
||||
username = f"alice_{uuid.uuid4().hex[:6]}"
|
||||
await UserService(uow=uow).register(
|
||||
username=username,
|
||||
display_name="Alice",
|
||||
password="Alice-password-1",
|
||||
)
|
||||
sessions = SessionService(uow=uow)
|
||||
issued = await sessions.login(username=username, password="Alice-password-1")
|
||||
print(await sessions.authenticate(token=issued.token))
|
||||
await engine.dispose()
|
||||
|
||||
asyncio.run(main())
|
||||
EOF
|
||||
```
|
||||
|
||||
`ChatService` и `MessageService` создаются с кэшем вторым параметром:
|
||||
`ChatService(uow=uow, cache=cache)`, где `cache` — из
|
||||
`src.infra.cache.instance` (`await cache.aclose()` в конце, нужен
|
||||
`make start_cache`). Все методы keyword-only, commit делает сам сервис. Ошибки — доменные
|
||||
исключения из `src.core.exceptions` (базовый `DomainError`), не
|
||||
HTTP-коды: `authenticate(token="x")` бросает `Unauthenticated`, неверный
|
||||
пароль в `login` — `InvalidCredentials`. Созданное так остаётся в рабочей
|
||||
базе.
|
||||
|
||||
## Run (human path)
|
||||
|
||||
```bash
|
||||
make run_dev # Postgres + миграции, Valkey, S3 + bootstrap, затем 127.0.0.1:8080, reload по src/; Ctrl-C
|
||||
```
|
||||
|
||||
Блокирует терминал — агенту не подходит, используй `driver.py start`.
|
||||
|
||||
## Test
|
||||
|
||||
```bash
|
||||
make check # офлайн-структура skeleton
|
||||
make test_isolated # образ на временной базе: smoke + student-tests, уборка
|
||||
make failure_checks # проверки отказов (~45 с) на отдельном стенде <рабочий>-failures
|
||||
make failure_checks FAULT_ARGS='-k valkey' # только часть проверок отказов
|
||||
python3 $D all # живой сервер + flow + smoke + student-tests
|
||||
make lint # ruff; затрагивает и driver.py
|
||||
```
|
||||
|
||||
Ожидаемо: `PASS: offline skeleton structure...`, `FAILED: none` у
|
||||
`flow`, smoke — `PASS: lab5 public API scenario...`, student — все
|
||||
прошли (тесты `fault` — `deselected`), `All checks passed!`; `all`,
|
||||
`test_isolated` и `failure_checks` — код 0. Пока файлы `evidence/`, на
|
||||
которые ссылаются исключения сверки покрытия, не сняты на стенде лабы
|
||||
(AGENTS.md, «Переход в следующую лабу»), красный только
|
||||
`test_exclusion_evidence_exists` — он называет сценарий и путь.
|
||||
|
||||
Проверки отказов (`student-tests/test_failures.py`, маркер `fault`)
|
||||
останавливают и замораживают Postgres, Valkey и S3, поэтому идут только на
|
||||
своём стенде: `make failure_checks` поднимает проект compose
|
||||
`<рабочий>-failures` со своими хранилищами и volume и удаляет его после
|
||||
прогона. Рабочий стенд на 8080 при этом не трогается. `pytest -m fault`
|
||||
напрямую останавливается с кодом 2: нет hook стенда.
|
||||
|
||||
## Gotchas
|
||||
|
||||
- **На 8080 обычно уже работает стенд `make run_docker` (HAProxy) или
|
||||
`make run_dev` пользователя.** Поэтому драйвер по умолчанию на 18080.
|
||||
`driver.py --port 8080 stop` чужой сервер не убьёт (нет pid-файла →
|
||||
`left running`, код 1) — и не надо: это процесс пользователя.
|
||||
- **`make student_test` против одного процесса без `EXPECT_REPLICAS=1`
|
||||
падает на тестах реплик** (`saw 1 X-Instance-Id ... EXPECT_REPLICAS=2`):
|
||||
по умолчанию набор ждёт `API_REPLICAS` реплик за `BASE_URL`. Против
|
||||
`make run_dev` — `make student_test EXPECT_REPLICAS=1`; `driver.py
|
||||
student` и `make test_isolated` передают его сами.
|
||||
- **Загрузка отвечает 202, а не 201 (с лабы 5):** все команды вложений ждут
|
||||
`ready` опросом метаданных раз в 0,2 с, до 60 с. Сообщение можно отправить и
|
||||
с `queued`, а скачивание до `ready` — 409.
|
||||
- **Порт отдельной реплики на хосте не опубликован.** Запрос мимо LB —
|
||||
только изнутри сети: `docker compose exec --index 2 api python -c
|
||||
"import urllib.request as u; print(u.urlopen('http://127.0.0.1:8080/health/ready').headers['X-Instance-Id'])"`.
|
||||
`docker compose exec api` без `--index` берёт первую реплику; если она
|
||||
остановлена `stop-one.sh`, команда падает.
|
||||
- **Номера слотов HAProxy (`api-1`, `api-2` в `make lb_stats`) не
|
||||
совпадают с именами контейнеров** (`mtusi-lab6-api-1`): слот получает
|
||||
адрес из DNS. Связь — по адресу: `docker inspect -f '{{range
|
||||
.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' <id>`.
|
||||
- **Экземпляр драйвера пишет в ту же рабочую базу**, что `make run_dev` и
|
||||
`make run_docker`: тестовые пользователи и чаты там остаются. Чистый
|
||||
прогон — `make test_isolated` (временная база `test_<db>`), чистый
|
||||
стенд — `make wipe_data`.
|
||||
- **Правка файла в `src/` перезапускает worker** (`WatchFiles detected
|
||||
changes ... Reloading...`), задевает и `make run_dev` на 8080. Данные
|
||||
и сессии в Postgres остаются, прежние токены работают.
|
||||
- **`lsof` на порт показывает два PID** — reloader и worker делят один
|
||||
сокет. Убивать по `lsof -t | xargs kill` бессмысленно: reloader
|
||||
поднимет worker снова. Драйвер шлёт SIGTERM группе процессов; SIGTERM
|
||||
на обёртку `uv run` тоже гасит всё дерево.
|
||||
- **`uv run` и `uv sync` без `--all-extras` удаляют ruff из `.venv`**
|
||||
(`Would uninstall ruff`): ruff в extra `dev`. `make lint` берёт
|
||||
глобальный ruff, PyCharm — из `.venv`: после `make upgrade` или
|
||||
`driver.py start` при необходимости `uv sync --all-extras`.
|
||||
- **`make lint` форматирует и `.claude/skills/`** — ruff в
|
||||
`pyproject.toml` исключает только `tests` и `scripts`. Драйвер написан
|
||||
под 79 колонок и COM812; при правке проверять
|
||||
`ruff format --check .claude/skills/run-mtusi-messenger/driver.py`.
|
||||
- **`.env` задаёт `APP__PORT=8080`, но драйвер его перекрывает**:
|
||||
`start` передаёт `APP__PORT=<port>` в окружении, а окружение важнее
|
||||
`.env`. `APP_OUT_PORT` приложение не читает — это порт публикации
|
||||
контейнера.
|
||||
- **`driver.py stop` стенд не останавливает** (`not ours (no pid
|
||||
file)`, код 1) — это правильно, гасить его `make down`. `status` для
|
||||
стенда показывает один PID — процесс Docker Desktop, а не HAProxy.
|
||||
- **`make logs` висит** (`logs -f`) — агенту нужен
|
||||
`docker compose logs --no-log-prefix api` без `-f`. Строки всех
|
||||
реплик перемешаны, реплику называет поле `instance_id`.
|
||||
- **`req` без `--token` на защищённом пути даёт 401 `unauthorized`** с
|
||||
`www-authenticate: Bearer realm="messenger"` — это не сломанный
|
||||
сервер, а контракт: аутентификация раньше доступа. Токен — из ответа
|
||||
`req POST /api/v1/auth/sessions --basic USER:PASS` или последняя строка
|
||||
`flow`.
|
||||
- **Короткий срок сессии для проверки истечения** — окружением
|
||||
`AUTH__SESSION_TTL_SECONDS=2 python3 $D start`: окружение важнее
|
||||
`.env` и `config.toml`. Так же короткий срок ключа идемпотентности —
|
||||
`IDEMPOTENCY__TTL_SECONDS=2`.
|
||||
- **`POST` сообщения без ключа — 400 раньше проверки доступа**: посторонний
|
||||
без `Idempotency-Key` получит 400, а не 404. Порядок 401 → 400 → 404 →
|
||||
409 — штатный для FastAPI (`api-contract.md`). Ключ в журнал сервера не
|
||||
пишется: повтор виден по `"replayed": true` и `message_id`.
|
||||
- **Ранний 413 на большой загрузке `urllib` напрямую к процессу
|
||||
теряет.** API отвечает 413 (и 404, 415), не дочитывая тело; uvicorn
|
||||
закрывает соединение, а `urllib` всё ещё пишет тело и получает
|
||||
`BrokenPipe` / `ConnectionReset` вместо ответа. Через LB ответ
|
||||
доходит (HAProxy дочитывает тело сам), httpx и `curl` получают его и
|
||||
напрямую. Поэтому `driver.py upload` большие тела проверять через
|
||||
`--port 8080`, а в консоли — `curl -H 'Content-Type: image/png'
|
||||
--data-binary @big.png`.
|
||||
- **Скачивание через LB может прийти не от той реплики, что загрузку**
|
||||
— это и есть проверка «байты не на диске API»: оригинал отдаёт любая
|
||||
реплика из S3. `X-Instance-Id` ответа загрузки — у `upload`.
|
||||
- **`upload-consistency`: grace разового прохода — не меньше 18 с.**
|
||||
Уборщик не стартует (код 2), если grace не больше границы живой
|
||||
загрузки `2 × request_timeout_seconds + s3 timeout_seconds` = 17 с;
|
||||
драйвер берёт 30 с. Уборщик сервиса (grace 900 с) строки прогона за
|
||||
это время не трогает, а разовый проход и сервис друг другу не мешают
|
||||
(`FOR UPDATE SKIP LOCKED`).
|
||||
- **На время `pause` S3 (~5 с) вложения всего стенда отвечают 503** —
|
||||
загрузка и скачивание, в том числе чужие запросы; текст и метаданные
|
||||
работают. Не запускать `upload-consistency` параллельно с тестами,
|
||||
которые качают вложения.
|
||||
- **Разовый проход уборщика — `docker compose run --rm --no-deps cleaner
|
||||
--once`**: у сервиса `cleaner` точка входа `python -m src.cleaner`, а
|
||||
не `command`, поэтому аргументы после имени сервиса — флаги уборщика.
|
||||
Так же разовая сверка — `… cleaner reconcile [--apply]` (`make
|
||||
reconcile`).
|
||||
- **`reconcile-cycle` и `reconcile-stress` меняют рабочий стенд**
|
||||
(design change `track2-reconciler`, решение 12): синтетические
|
||||
пользователи, чаты и вложения остаются в рабочей базе, в том числе
|
||||
вложения, помеченные потерянными (`lost_at`): у одного изменён размер,
|
||||
у другого удалён объект; их байты — 404, метаданные — 200. Объекты мимо
|
||||
API (без строки, чужой ключ, свежий) драйвер удаляет сам — сверкой или
|
||||
`weed shell fs.rm` в `finally`. Триггер COMMIT — на уникальный
|
||||
`filename` прогона, снимается в `finally` и в начале следующего. Перед
|
||||
прогоном стенд должен быть сведён: исходный dry-run с расхождениями —
|
||||
код 2 и «run make reconcile first». Grace прогона — 30 с (цикл) и 20 с
|
||||
(стресс), больше границы живой загрузки 17 с. Нужен стенд на коде
|
||||
change: новая политика S3 уборщика (`docker compose up -d
|
||||
s3-bootstrap`), колонка `lost_at` (миграция) и образ уборщика с
|
||||
командой `reconcile`; на прежнем — сверка падает (`AccessDenied` на
|
||||
списке или нет колонки). Evidence — `evidence/reconcile/cycle.md`,
|
||||
`evidence/reconcile/stress.md`.
|
||||
- **Строки `s3-check` о списке уборщика** («cleaner key list attachments
|
||||
prefix», «… staging prefix» — 200, «… objects», «… database prefix», «…
|
||||
other prefix», «… other bucket» — 403) печатает сам bootstrap в режиме
|
||||
`check`. Драйвер требует строки трёх префиксов: на прежнем `bootstrap.sh`
|
||||
— код 1 и «no row from s3-bootstrap check».
|
||||
- **Пустой каталог `<id>/` в bucket после удаления объекта** SeaweedFS
|
||||
убирает лишь через ~2 мин: `fs.ls` его показывает, список S3 — нет.
|
||||
Объекты считать по файлам `original` (`fs.tree`), а не по каталогам.
|
||||
- **`X-Instance-Id` в консоли — hostname машины**, в контейнере —
|
||||
короткий ID контейнера (начало `docker compose ps -q api`, по нему
|
||||
`scripts/stop-one.sh` находит реплику). Другое значение —
|
||||
`APP__INSTANCE_ID=... python3 $D start`; в `config.toml`, `.env` и
|
||||
compose его не задавать: у реплик значение должно различаться.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- **`port 8080 is not ours (no pid file); left running`** — `stop` на
|
||||
порту, который поднимал не драйвер. Свой экземпляр гасить `stop` на его
|
||||
порту; чужой не трогать. Чей он — `lsof -nP -iTCP:8080 -sTCP:LISTEN`,
|
||||
затем `ps -o pid,ppid,etime,command -p <pid>`.
|
||||
- **`make upgrade failed` в `start`** — не запущен Docker или занят порт
|
||||
Postgres `POSTGRES_OUT_PORT` (5433): `docker ps`, `lsof -nP
|
||||
-iTCP:5433 -sTCP:LISTEN`.
|
||||
- **Через LB 503 `No API replica is available` без `X-Instance-Id`** —
|
||||
ответ самого HAProxy: готовых реплик нет (все остановлены или ещё не
|
||||
прошли 2 проверки `/health/ready`). `make lb_stats`, затем `make
|
||||
replicas`. Ответ 502/504 от LB — реплика оборвала ответ или не уложилась
|
||||
в 10 с.
|
||||
- **`/health/ready` отвечает 503, `/health/live` — 200** — Postgres
|
||||
недоступен: `docker compose ps postgres`, `make start_db`. Запросы к
|
||||
API в это время получают 503 `unavailable`, после возврата Postgres
|
||||
проходят без рестарта сервера. Так отвечает один процесс (консоль).
|
||||
Через LB реплики без Postgres не проходят проверку `/health/ready`, и
|
||||
через 2–3 с на всё, включая `/health/live`, отвечает сам HAProxy: 503
|
||||
`No API replica is available`. После возврата Postgres реплики
|
||||
возвращаются через 2 проверки.
|
||||
- **В логе `warning` «Cache is unavailable»** — Valkey остановлен или
|
||||
завис (рестарт Valkey отказом не считается: клиент один раз
|
||||
переоткрывает соединение): `docker compose ps valkey`, `make
|
||||
start_cache`. Ответы при этом те же (из Postgres), `/health/ready` —
|
||||
200; через `[cache] retry_after_seconds` (5 с) после возврата Valkey —
|
||||
`info` «Cache is available again».
|
||||
- **`VALKEY_PASSWORD is empty, copy Valkey lines from .env.example`** у
|
||||
любой команды compose — `.env` создан до `membership-cache`: перенести
|
||||
строки `VALKEY_*` и `CACHE__*` из `.env.example`, пароль — `openssl
|
||||
rand -hex 16`.
|
||||
- **`S3_… is empty, copy S3 lines from .env.example`** — `.env` создан
|
||||
до `s3-storage`: перенести блок S3 из `.env.example`, пять пустых
|
||||
секретов — `openssl rand -hex 32` каждый; затем `make run_docker`.
|
||||
- **`s3-bootstrap: FAILED: <шаг>`, реплики не стартуют** — bootstrap
|
||||
назвал шаг: `docker compose logs s3-bootstrap`. Недопустимое имя
|
||||
`S3__BUCKET` — «bucket create»; анонимный доступ или права не те —
|
||||
`FAILED: … is not denied`. Повтор — `docker compose up -d
|
||||
s3-bootstrap` (или `make run_docker`).
|
||||
- **`make stop` и `restart.sh` дольше на ~15 с** — SeaweedFS
|
||||
останавливается плавно ~15 с (`stop_grace_period: 20s`), это не
|
||||
зависание.
|
||||
File diff suppressed because it is too large
Load Diff
@@ -18,3 +18,27 @@ __pycache__
|
||||
node_modules
|
||||
evidence
|
||||
.DS_Store
|
||||
|
||||
# свои: Dockerfile копирует только pyproject.toml, uv.lock, src/,
|
||||
# alembic.ini и migrations/
|
||||
# паттерн без **/ действует только в корне контекста
|
||||
**/__pycache__
|
||||
**/*.py[cod]
|
||||
**/.DS_Store
|
||||
config.toml
|
||||
.claude
|
||||
openspec
|
||||
graphify-out
|
||||
tests
|
||||
student-tests
|
||||
service-tests
|
||||
bench
|
||||
contracts
|
||||
scripts
|
||||
examples
|
||||
infra
|
||||
*.md
|
||||
Makefile
|
||||
.ruff_cache
|
||||
.idea
|
||||
.python-version
|
||||
|
||||
+155
-29
@@ -1,30 +1,156 @@
|
||||
# Copy to .env for your LOCAL synthetic test environment; never commit .env.
|
||||
# These are logical interface suggestions; map actual framework names in REPORT.md.
|
||||
APP_HOST=0.0.0.0
|
||||
APP_PORT=8080
|
||||
APP_ENV=lab
|
||||
SESSION_TTL_SECONDS=3600
|
||||
# Choose credentials locally. File paths contain no secret values.
|
||||
DATABASE_URL_FILE=/run/secrets/database_url
|
||||
# Optional on 3, required use on 4 in lab2; Redis OR Valkey:
|
||||
SESSION_STORE=postgres
|
||||
CACHE_URL_FILE=/run/secrets/cache_url
|
||||
# Шаблон .env: `make env_setup` создаёт из него .env и подставляет
|
||||
# случайные значения в пустые POSTGRES_PASSWORD, VALKEY_PASSWORD,
|
||||
# RABBITMQ_DEFAULT_PASS, секреты S3 (S3_ROOT_*, S3_JWT_SIGNING_KEY,
|
||||
# S3_API_*, S3_CLEANER_*, S3_WORKER_*) и GRAFANA_ADMIN_PASSWORD.
|
||||
# Существующий .env он не перезаписывает, а дописывает в конец
|
||||
# переменные шаблона, которых в нём нет: секреты — случайными, остальные
|
||||
# — значениями шаблона; печатает только имена.
|
||||
# .env не коммитить. .env читают compose, Makefile и приложение
|
||||
# (pydantic-settings); в контейнеры он не попадает.
|
||||
# Параметры приложения — в формате настроек SECTION__FIELD, без секции —
|
||||
# только то, что приложение не читает. Комментарии — только отдельными
|
||||
# строками: make оставляет хвостовой комментарий частью значения.
|
||||
# Соответствие переменным skeleton (APP_HOST, APP_PORT, APP_ENV,
|
||||
# SESSION_TTL_SECONDS, DATABASE_URL_FILE, SESSION_STORE, CACHE_URL_FILE,
|
||||
# с lab3 — API_REPLICAS, IDEMPOTENCY_TTL_SECONDS, с lab4 — S3_ENDPOINT,
|
||||
# S3_REGION, S3_BUCKET, S3_ACCESS_KEY_ID_FILE, S3_SECRET_ACCESS_KEY_FILE,
|
||||
# MAX_UPLOAD_BYTES, MAX_IMAGE_PIXELS) — в REPORT.md, «Архитектура и
|
||||
# решения». Имена skeleton S3_* буквально не заводятся: S3 настраивают
|
||||
# строки блока S3 ниже.
|
||||
# С lab5 — BROKER_URL_FILE: [broker] мостами из RABBITMQ_* ниже (значения, а
|
||||
# не файл); WORKER_CONCURRENCY: [worker] concurrency; JOB_MAX_ATTEMPTS:
|
||||
# [worker] max_attempts; JOB_TIMEOUT_SECONDS: [worker] job_timeout_seconds;
|
||||
# STAGING_RETENTION_SECONDS: [cleaner] staging_retention_seconds.
|
||||
# С lab6 — имена OTEL_* skeleton настройками не являются, SDK их не читает
|
||||
# (процесс с включённой телеметрией удаляет их из окружения и пишет warning):
|
||||
# OTEL_SERVICE_NAME — константа точки входа (messenger-api,
|
||||
# messenger-worker, messenger-relay); OTEL_EXPORTER_OTLP_ENDPOINT — [telemetry]
|
||||
# otlp_endpoint, в compose — TELEMETRY__OTLP_ENDPOINT у api, worker и relay;
|
||||
# OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf — постоянно (установлен только
|
||||
# экспортёр OTLP/HTTP protobuf); OTEL_RESOURCE_ATTRIBUTES — [telemetry]
|
||||
# environment (deployment.environment.name), service.* вычисляет код.
|
||||
# Стандартные имена выбора трасс тоже не настройки: OTEL_TRACES_SAMPLER —
|
||||
# постоянно parentbased_traceidratio (при доле 1 — parentbased_always_on),
|
||||
# OTEL_TRACES_SAMPLER_ARG — [telemetry] trace_sample_ratio.
|
||||
# Включает телеметрию compose (TELEMETRY__ENABLED у api, worker и relay), в .env её
|
||||
# нет: консоль — без телеметрии.
|
||||
|
||||
# порт сервиса ([app] port): на нём слушает приложение, его же
|
||||
# публикует compose, на нём же healthcheck
|
||||
APP__PORT=8080
|
||||
# порт на 127.0.0.1 хоста, куда публикуется балансировщик HAProxy —
|
||||
# единственная точка входа; приложение его не читает
|
||||
APP_OUT_PORT=8080
|
||||
# число реплик сервиса api за балансировщиком (имя skeleton); читают
|
||||
# compose (deploy.replicas) и Makefile, приложение — нет. Разовая
|
||||
# подмена — make replicas API_REPLICAS=N
|
||||
API_REPLICAS=2
|
||||
IDEMPOTENCY_TTL_SECONDS=86400
|
||||
S3_ENDPOINT=http://s3:9000
|
||||
S3_REGION=us-east-1
|
||||
S3_BUCKET=messenger-attachments
|
||||
S3_ACCESS_KEY_ID_FILE=/run/secrets/s3_access_key_id
|
||||
S3_SECRET_ACCESS_KEY_FILE=/run/secrets/s3_secret_access_key
|
||||
MAX_UPLOAD_BYTES=10485760
|
||||
MAX_IMAGE_PIXELS=40000000
|
||||
BROKER_URL_FILE=/run/secrets/broker_url
|
||||
WORKER_CONCURRENCY=2
|
||||
JOB_MAX_ATTEMPTS=5
|
||||
JOB_TIMEOUT_SECONDS=60
|
||||
STAGING_RETENTION_SECONDS=86400
|
||||
OTEL_SERVICE_NAME=messenger-api
|
||||
# Worker must set a distinct service.name.
|
||||
OTEL_EXPORTER_OTLP_ENDPOINT=http://otel-collector:4318
|
||||
OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
|
||||
OTEL_RESOURCE_ATTRIBUTES=deployment.environment.name=lab
|
||||
|
||||
# PostgreSQL. POSTGRES_USER, POSTGRES_PASSWORD и POSTGRES_DB читает и
|
||||
# образ postgres; пароль задаётся только при первом создании volume.
|
||||
# Пустой пароль образ postgres не принимает: make env_setup подставляет
|
||||
# случайный
|
||||
POSTGRES_USER=messenger
|
||||
POSTGRES_PASSWORD=
|
||||
POSTGRES_DB=messenger
|
||||
# адрес и порт Postgres внутри сети compose: по ним ходят API и миграции
|
||||
# в docker, порт слушает сам сервер (PGPORT)
|
||||
POSTGRES_HOST=postgres
|
||||
POSTGRES_PORT=5432
|
||||
# порт на 127.0.0.1 хоста, куда публикуется Postgres: к нему подключается
|
||||
# приложение в console
|
||||
POSTGRES_OUT_PORT=5433
|
||||
# мосты для console: приложение на хосте берёт значения отсюда, в docker
|
||||
# их задаёт environment compose
|
||||
DATABASE__HOST=127.0.0.1
|
||||
DATABASE__PORT=${POSTGRES_OUT_PORT}
|
||||
DATABASE__USER=${POSTGRES_USER}
|
||||
DATABASE__PASSWORD=${POSTGRES_PASSWORD}
|
||||
DATABASE__NAME=${POSTGRES_DB}
|
||||
|
||||
# Valkey — кэш карточек чатов. Пароль читают и сервер (--requirepass), и
|
||||
# приложение; пустой make env_setup заменяет случайным
|
||||
VALKEY_PASSWORD=
|
||||
# адрес и порт Valkey внутри сети compose: по ним ходит API в docker,
|
||||
# порт слушает сам сервер
|
||||
VALKEY_HOST=valkey
|
||||
VALKEY_PORT=6379
|
||||
# порт на 127.0.0.1 хоста, куда публикуется Valkey: к нему подключается
|
||||
# приложение в console
|
||||
VALKEY_OUT_PORT=6380
|
||||
# мосты для console: в docker их задаёт environment compose
|
||||
CACHE__HOST=127.0.0.1
|
||||
CACHE__PORT=${VALKEY_OUT_PORT}
|
||||
CACHE__PASSWORD=${VALKEY_PASSWORD}
|
||||
|
||||
# S3 (SeaweedFS) — байты вложений. Шесть пустых секретов make env_setup
|
||||
# заменяет случайными hex; без них compose не стартует. Кто какой секрет
|
||||
# получает — docker-compose.yml, якоря x-s3-*
|
||||
# имя bucket: читают приложение ([s3] bucket) и bootstrap S3, который его
|
||||
# создаёт; 3–63 символа: строчные буквы, цифры, точка и дефис
|
||||
S3__BUCKET=messenger
|
||||
# административные ключ и секрет S3: только сервер s3 (без учётной
|
||||
# записи он открыт анониму), ни API, ни bootstrap их не получают
|
||||
S3_ROOT_ACCESS_KEY=
|
||||
S3_ROOT_SECRET_KEY=
|
||||
# ключ подписи служебных вызовов SeaweedFS (gRPC шлюза, IAM filer):
|
||||
# сервер s3 и bootstrap
|
||||
S3_JWT_SIGNING_KEY=
|
||||
# ключи пользователя API (только объекты своего bucket): bootstrap
|
||||
# заводит пользователя с ними, реплики API ходят с ними в S3. Новый
|
||||
# секрет вступает в силу при следующем bootstrap (make run_docker)
|
||||
S3_API_ACCESS_KEY=
|
||||
S3_API_SECRET_KEY=
|
||||
# ключи пользователя уборщика незавершённых загрузок (только чтение и
|
||||
# удаление объектов своего bucket): bootstrap заводит пользователя с
|
||||
# ними, сервис cleaner ходит с ними в S3; реплики API их не получают
|
||||
S3_CLEANER_ACCESS_KEY=
|
||||
S3_CLEANER_SECRET_KEY=
|
||||
# ключи пользователя worker (только чтение и запись объектов своего
|
||||
# bucket): bootstrap заводит пользователя с ними, сервис worker и make
|
||||
# run_worker ходят с ними в S3; реплики API их не получают
|
||||
S3_WORKER_ACCESS_KEY=
|
||||
S3_WORKER_SECRET_KEY=
|
||||
# адрес и порт API S3 внутри сети compose: по ним ходит API в docker,
|
||||
# порт слушает сам сервер и проверяет bootstrap
|
||||
S3_HOST=s3
|
||||
S3_PORT=8333
|
||||
# порт на 127.0.0.1 хоста, куда публикуется API S3: к нему подключается
|
||||
# приложение в console (консоль и UI SeaweedFS не публикуются)
|
||||
S3_OUT_PORT=8334
|
||||
# мосты для console: в docker их задаёт environment compose
|
||||
S3__HOST=127.0.0.1
|
||||
S3__PORT=${S3_OUT_PORT}
|
||||
S3__ACCESS_KEY_ID=${S3_API_ACCESS_KEY}
|
||||
S3__SECRET_ACCESS_KEY=${S3_API_SECRET_KEY}
|
||||
|
||||
# RabbitMQ — брокер заданий обработки вложений. Пользователя и пароль читает
|
||||
# и образ брокера: учётная запись создаётся при первом старте на пустом
|
||||
# volume. Пустой пароль make env_setup заменяет случайным
|
||||
RABBITMQ_DEFAULT_USER=messenger
|
||||
RABBITMQ_DEFAULT_PASS=
|
||||
# адрес и порт AMQP внутри сети compose: по ним ходят API и worker в docker,
|
||||
# порт слушает сам брокер
|
||||
RABBITMQ_HOST=rabbitmq
|
||||
RABBITMQ_PORT=5672
|
||||
# порт на 127.0.0.1 хоста, куда публикуется AMQP: к нему подключаются
|
||||
# приложение и worker в console; другие порты брокера не публикуются
|
||||
RABBITMQ_OUT_PORT=5673
|
||||
# мосты для console: в docker их задаёт environment compose
|
||||
BROKER__HOST=127.0.0.1
|
||||
BROKER__PORT=${RABBITMQ_OUT_PORT}
|
||||
BROKER__USER=${RABBITMQ_DEFAULT_USER}
|
||||
BROKER__PASSWORD=${RABBITMQ_DEFAULT_PASS}
|
||||
|
||||
# Grafana — интерфейс телеметрии (с lab6). Пароль администратора получает
|
||||
# только сервис grafana (GF_SECURITY_ADMIN_PASSWORD); состояние Grafana —
|
||||
# tmpfs, пароль из .env действует на каждом старте. Пустой make env_setup
|
||||
# заменяет случайным
|
||||
GRAFANA_ADMIN_PASSWORD=
|
||||
# порт на 127.0.0.1 хоста, куда публикуется Grafana; порты Collector,
|
||||
# Prometheus, Loki и Tempo не публикуются
|
||||
GRAFANA_OUT_PORT=3000
|
||||
|
||||
# make test_isolated: порт на 127.0.0.1, куда публикуется тестовый
|
||||
# контейнер API
|
||||
TEST_APP_PORT=18088
|
||||
|
||||
@@ -0,0 +1,153 @@
|
||||
# Стенд в CI: docker-compose.yml + этот файл (COMPOSE_FILE job
|
||||
# application, .github/workflows/application.yml). Раннер Gitea
|
||||
# (act_runner) запускает job в контейнере рядом со стендом, на том же
|
||||
# Docker. Файлы рабочего каталога есть только в контейнере job, а bind
|
||||
# mount ищет их на хосте раннера; порты на 127.0.0.1 хоста из job не
|
||||
# видны и на общем хосте заняли бы чужие. Поэтому отличия от рабочего
|
||||
# стенда только такие:
|
||||
# - конфиги — configs из переменных окружения (их выставляет
|
||||
# .github/ci/stand-env.sh): compose копирует содержимое в контейнер при
|
||||
# создании, пути на хосте не нужно;
|
||||
# - портов на хосте нет: job подключается к сети стенда и ходит на
|
||||
# haproxy по имени;
|
||||
# - образ API — с тегом прогона: тег mtusi-messenger:lab6 на общем хосте
|
||||
# раннера может собрать и чужой job.
|
||||
# Остальное — сервисы, лимиты, volumes, секреты по сервисам — как в
|
||||
# рабочем стенде. Нужен Compose ≥ 2.24 (!reset).
|
||||
|
||||
services:
|
||||
postgres:
|
||||
ports: !reset []
|
||||
|
||||
valkey:
|
||||
ports: !reset []
|
||||
volumes: !reset []
|
||||
configs:
|
||||
- source: valkey_conf
|
||||
target: /usr/local/etc/valkey/valkey.conf
|
||||
|
||||
s3:
|
||||
ports: !reset []
|
||||
|
||||
s3-bootstrap:
|
||||
volumes: !reset []
|
||||
configs:
|
||||
- source: s3_bootstrap
|
||||
target: /opt/s3/bootstrap.sh
|
||||
|
||||
rabbitmq:
|
||||
ports: !reset []
|
||||
# !override: bind mount конфига заменяют configs, volume данных остаётся
|
||||
volumes: !override
|
||||
- rabbitmq_data:/var/lib/rabbitmq
|
||||
configs:
|
||||
- source: rabbitmq_conf
|
||||
target: /etc/rabbitmq/conf.d/90-messenger.conf
|
||||
|
||||
migrate:
|
||||
image: &ci-image mtusi-messenger:${CI_IMAGE_TAG:?CI_IMAGE_TAG is not set}
|
||||
volumes: !reset []
|
||||
configs: &config-toml
|
||||
- source: config_toml
|
||||
target: /app/config.toml
|
||||
|
||||
api:
|
||||
image: *ci-image
|
||||
volumes: !reset []
|
||||
configs: *config-toml
|
||||
|
||||
cleaner:
|
||||
image: *ci-image
|
||||
volumes: !reset []
|
||||
configs: *config-toml
|
||||
|
||||
relay:
|
||||
image: *ci-image
|
||||
volumes: !reset []
|
||||
configs: *config-toml
|
||||
|
||||
worker:
|
||||
image: *ci-image
|
||||
volumes: !reset []
|
||||
configs: *config-toml
|
||||
|
||||
haproxy:
|
||||
ports: !reset []
|
||||
volumes: !reset []
|
||||
configs:
|
||||
- source: haproxy_cfg
|
||||
target: /usr/local/etc/haproxy/haproxy.cfg
|
||||
|
||||
# наблюдаемость (design change otel-telemetry, решение 20): те же сервисы,
|
||||
# конфиги — configs; у хранилищ остаётся только именованный volume, у
|
||||
# Grafana — tmpfs (не volumes) и ни одного порта на хосте
|
||||
otel-collector:
|
||||
volumes: !reset []
|
||||
configs:
|
||||
- source: otel_collector
|
||||
target: /etc/otelcol-contrib/config.yaml
|
||||
|
||||
prometheus:
|
||||
volumes: !override
|
||||
- prometheus_data:/prometheus
|
||||
configs:
|
||||
- source: prometheus_yml
|
||||
target: /etc/prometheus/prometheus.yml
|
||||
# правила записи и оповещения (design change slo-alerts, решение 3)
|
||||
- source: prometheus_rules
|
||||
target: /etc/prometheus/rules.yml
|
||||
|
||||
loki:
|
||||
volumes: !override
|
||||
- loki_data:/loki
|
||||
configs:
|
||||
- source: loki_yaml
|
||||
target: /etc/loki/loki.yaml
|
||||
|
||||
tempo:
|
||||
volumes: !override
|
||||
- tempo_data:/var/tempo
|
||||
configs:
|
||||
- source: tempo_yaml
|
||||
target: /etc/tempo/tempo.yaml
|
||||
|
||||
grafana:
|
||||
ports: !reset []
|
||||
volumes: !reset []
|
||||
configs:
|
||||
- source: grafana_datasources
|
||||
target: /etc/grafana/provisioning/datasources/datasources.yaml
|
||||
- source: grafana_dashboards
|
||||
target: /etc/grafana/provisioning/dashboards/dashboards.yaml
|
||||
- source: grafana_dashboard_overview
|
||||
target: /etc/grafana/dashboards/messenger-overview.json
|
||||
|
||||
# файлы по умолчанию 0444 и root: непривилегированные пользователи
|
||||
# контейнеров читают, но не меняют — как read_only у bind mount
|
||||
configs:
|
||||
config_toml:
|
||||
environment: CI_CONFIG_TOML
|
||||
valkey_conf:
|
||||
environment: CI_VALKEY_CONF
|
||||
s3_bootstrap:
|
||||
environment: CI_S3_BOOTSTRAP
|
||||
rabbitmq_conf:
|
||||
environment: CI_RABBITMQ_CONF
|
||||
haproxy_cfg:
|
||||
environment: CI_HAPROXY_CFG
|
||||
otel_collector:
|
||||
environment: CI_OTEL_COLLECTOR
|
||||
prometheus_yml:
|
||||
environment: CI_PROMETHEUS_YML
|
||||
prometheus_rules:
|
||||
environment: CI_PROMETHEUS_RULES
|
||||
loki_yaml:
|
||||
environment: CI_LOKI_YAML
|
||||
tempo_yaml:
|
||||
environment: CI_TEMPO_YAML
|
||||
grafana_datasources:
|
||||
environment: CI_GRAFANA_DATASOURCES
|
||||
grafana_dashboards:
|
||||
environment: CI_GRAFANA_DASHBOARDS
|
||||
grafana_dashboard_overview:
|
||||
environment: CI_GRAFANA_DASHBOARD_OVERVIEW
|
||||
@@ -0,0 +1,52 @@
|
||||
# Окружение шага job application (.github/workflows/application.yml),
|
||||
# подключается через «.» из корня репозитория после make env_setup.
|
||||
# Содержимое конфигов — в переменные для configs override
|
||||
# .github/ci/compose.yml. $(cat …) срезает перевод строки в конце файла,
|
||||
# поэтому он возвращается: копия побайтно равна файлу, а HAProxy без него
|
||||
# конфиг не принимает («Missing LF on last line»). Значения не печатаются.
|
||||
nl='
|
||||
'
|
||||
CI_CONFIG_TOML="$(cat config.toml)$nl"
|
||||
CI_VALKEY_CONF="$(cat infra/valkey/valkey.conf)$nl"
|
||||
CI_S3_BOOTSTRAP="$(cat infra/s3/bootstrap.sh)$nl"
|
||||
CI_HAPROXY_CFG="$(cat infra/haproxy/haproxy.cfg)$nl"
|
||||
CI_RABBITMQ_CONF="$(cat infra/rabbitmq/rabbitmq.conf)$nl"
|
||||
export CI_CONFIG_TOML CI_VALKEY_CONF CI_S3_BOOTSTRAP CI_HAPROXY_CFG CI_RABBITMQ_CONF
|
||||
# наблюдаемость (design change otel-telemetry, решение 20)
|
||||
CI_OTEL_COLLECTOR="$(cat infra/otel/collector.yaml)$nl"
|
||||
CI_PROMETHEUS_YML="$(cat infra/otel/prometheus/prometheus.yml)$nl"
|
||||
CI_LOKI_YAML="$(cat infra/otel/loki/loki.yaml)$nl"
|
||||
CI_TEMPO_YAML="$(cat infra/otel/tempo/tempo.yaml)$nl"
|
||||
CI_GRAFANA_DATASOURCES="$(cat infra/otel/grafana/datasources.yaml)$nl"
|
||||
CI_GRAFANA_DASHBOARDS="$(cat infra/otel/grafana/dashboards.yaml)$nl"
|
||||
CI_GRAFANA_DASHBOARD_OVERVIEW="$(cat infra/otel/grafana/dashboards/messenger-overview.json)$nl"
|
||||
# правила Prometheus (design change slo-alerts, решение 3)
|
||||
CI_PROMETHEUS_RULES="$(cat infra/otel/prometheus/rules.yml)$nl"
|
||||
export CI_OTEL_COLLECTOR CI_PROMETHEUS_YML CI_LOKI_YAML CI_TEMPO_YAML \
|
||||
CI_GRAFANA_DATASOURCES CI_GRAFANA_DASHBOARDS CI_GRAFANA_DASHBOARD_OVERVIEW \
|
||||
CI_PROMETHEUS_RULES
|
||||
|
||||
# готовность стенда через LB: /health/ready отвечает 200 от API_REPLICAS
|
||||
# (из .env, по умолчанию 2) разных реплик — X-Instance-Id. Срок 60 с:
|
||||
# make replicas ждёт healthy контейнеров, а слот LB включается ещё через
|
||||
# rise проверок
|
||||
wait_replicas() {
|
||||
want=$(sed -n 's/^API_REPLICAS=//p' .env)
|
||||
want=${want:-2}
|
||||
seen=""
|
||||
deadline=$(($(date +%s) + 60))
|
||||
while [ "$(date +%s)" -lt "$deadline" ]; do
|
||||
reply=$(curl -s -o /dev/null -w '%{http_code} %header{x-instance-id}' \
|
||||
"$BASE_URL/health/ready" || true)
|
||||
case "$reply" in
|
||||
"200 "?*) seen=$(printf '%s\n%s\n' "$seen" "${reply#200 }" | sort -u | grep .) ;;
|
||||
esac
|
||||
if [ "$(printf '%s\n' "$seen" | grep -c .)" -ge "$want" ]; then
|
||||
echo "LB ready: $(printf '%s ' $seen)"
|
||||
return 0
|
||||
fi
|
||||
sleep 0.5
|
||||
done
|
||||
echo "LB: $(printf '%s\n' "$seen" | grep -c .) of $want replicas ready in 60 s" >&2
|
||||
return 1
|
||||
}
|
||||
@@ -0,0 +1,150 @@
|
||||
# Job приложения (CONTRIBUTING.md, «CI»): сборка образа, стенд и его
|
||||
# готовность через LB, make check и make test, затем проверки, которым
|
||||
# хватает сети стенда: приватность bucket для анонима, make validate,
|
||||
# собственные тесты, сохранность после рестарта и отказ реплики. Workflow
|
||||
# skeleton contracts.yml проверяет только контракт и не меняется.
|
||||
# Раннер Gitea (act_runner) запускает job в контейнере на том же Docker,
|
||||
# что и стенд: конфиги и порты — override .github/ci/compose.yml, к LB job
|
||||
# ходит по сети стенда. Секретов CI не получает: пароли и ключи — случайные
|
||||
# из make env_setup и живут только в прогоне. pull_request_target не
|
||||
# используется (CONTRIBUTING.md). Нет make s3_check, test_isolated и
|
||||
# failure_checks: им нужны порты на хосте; их результат — evidence/.
|
||||
name: Application
|
||||
on: [push, pull_request, workflow_dispatch]
|
||||
permissions:
|
||||
contents: read
|
||||
# прогоны репозитория по очереди и без отмены: отменённый посреди прогона
|
||||
# job оставил бы стенд на общем хосте раннера, а уборка хвостов не должна
|
||||
# задеть стенд соседнего прогона
|
||||
concurrency:
|
||||
group: application-${{ github.repository }}
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
application:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 40
|
||||
env:
|
||||
# свой проект, volumes и образ у каждого прогона
|
||||
COMPOSE_PROJECT_NAME: mtusi-lab6-safronov-ci-${{ github.run_id }}
|
||||
COMPOSE_FILE: docker-compose.yml:.github/ci/compose.yml
|
||||
CI_IMAGE_TAG: safronov-ci-${{ github.run_id }}
|
||||
# LB по имени сервиса в сети стенда, порт — APP__PORT из .env.example
|
||||
BASE_URL: http://haproxy:8080
|
||||
steps:
|
||||
- name: Checkout
|
||||
# ровно commit прогона; репозиторий публичный, токен не нужен.
|
||||
# Адрес Gitea — литералом: github.server_url здесь внутренний
|
||||
# http://gitea:3000, и контейнер job его не резолвит
|
||||
run: |
|
||||
git init -q .
|
||||
git remote add origin "https://gitea.privcloud.tech/${{ github.repository }}.git"
|
||||
git fetch -q --depth=1 origin "${{ github.sha }}"
|
||||
git checkout -q --detach FETCH_HEAD
|
||||
git log --oneline -1
|
||||
|
||||
- name: Runner
|
||||
run: |
|
||||
docker info --format 'docker {{.ServerVersion}}, {{.OSType}}/{{.Architecture}}, {{.NCPU}} CPU, {{.MemTotal}} B'
|
||||
docker compose version
|
||||
python3 -V
|
||||
|
||||
- name: Remove stands of interrupted runs
|
||||
# только проекты этого workflow: прогон, прерванный без уборки
|
||||
# (сбой раннера), оставил бы их на хосте
|
||||
run: |
|
||||
for p in $(docker ps -a --format '{{.Label "com.docker.compose.project"}}' | grep '^mtusi-lab6-safronov-ci-' | sort -u || true); do
|
||||
echo "remove leftover stand $p"
|
||||
docker ps -aq --filter "label=com.docker.compose.project=$p" | xargs -r docker rm -f >/dev/null
|
||||
docker volume ls -q --filter "label=com.docker.compose.project=$p" | xargs -r docker volume rm >/dev/null
|
||||
docker network ls -q --filter "label=com.docker.compose.project=$p" | xargs -r docker network rm >/dev/null || true
|
||||
done
|
||||
|
||||
- name: Build and start the stand
|
||||
run: |
|
||||
make env_setup
|
||||
. .github/ci/stand-env.sh
|
||||
docker compose config --quiet
|
||||
make run_docker
|
||||
make replicas
|
||||
docker network connect "${COMPOSE_PROJECT_NAME}_default" "$HOSTNAME"
|
||||
wait_replicas
|
||||
docker compose ps -a --format 'table {{.Service}}\t{{.Status}}'
|
||||
|
||||
- name: make check and make test
|
||||
run: |
|
||||
make check
|
||||
make test
|
||||
|
||||
- name: Bucket is closed to anonymous requests
|
||||
# без подписи: список bucket и объектов — 403. Полная проверка
|
||||
# приватности — make s3_check (evidence/s3/privacy.md)
|
||||
run: |
|
||||
s3="http://s3:$(sed -n 's/^S3_PORT=//p' .env)"
|
||||
bucket=$(sed -n 's/^S3__BUCKET=//p' .env)
|
||||
for url in "$s3/" "$s3/$bucket" "$s3/$bucket?list-type=2"; do
|
||||
code=$(curl -s -o /dev/null -w '%{http_code}' "$url")
|
||||
echo "anonymous GET $url -> $code"
|
||||
test "$code" = 403
|
||||
done
|
||||
|
||||
- name: Install uv
|
||||
# та же версия, что в Dockerfile
|
||||
run: |
|
||||
python3 -m venv "$RUNNER_TEMP/uv"
|
||||
"$RUNNER_TEMP/uv/bin/pip" install -q uv==0.12.17
|
||||
echo "$RUNNER_TEMP/uv/bin" >> "$GITHUB_PATH"
|
||||
|
||||
- name: make validate
|
||||
# полная проверка OpenAPI и примеров, как в contracts.yml skeleton:
|
||||
# на этом раннере он не доходит до проверок — actions/checkout
|
||||
# берёт внутренний адрес Gitea (http://gitea:3000)
|
||||
run: |
|
||||
uv sync -q
|
||||
make validate PYTHON=.venv/bin/python
|
||||
|
||||
- name: make service_test
|
||||
# без хранилищ и docker: фейки; service_test_db нужен порт PostgreSQL
|
||||
# на хосте, в CI его нет (design change unit-of-work, решение 13)
|
||||
run: make service_test
|
||||
|
||||
- name: make alerts_test
|
||||
# правила Prometheus без стенда и без сети (design change slo-alerts,
|
||||
# решение 11): файлы — tar в одноразовый контейнер образа Prometheus,
|
||||
# bind mount job не видит
|
||||
run: make alerts_test
|
||||
|
||||
- name: make student_test
|
||||
# через LB: тесты реплик выполняются, проверки отказов — нет
|
||||
run: make student_test
|
||||
|
||||
- name: make test-persistence
|
||||
run: |
|
||||
. .github/ci/stand-env.sh
|
||||
make test-persistence ACTION_SCRIPT=scripts/restart.sh
|
||||
wait_replicas
|
||||
|
||||
- name: make test-failover, stop and kill
|
||||
# остановленную реплику возвращает make replicas (те же ID)
|
||||
run: |
|
||||
. .github/ci/stand-env.sh
|
||||
log="$RUNNER_TEMP/stop-one.log"
|
||||
STOP_ONE_LOG="$log" make test-failover ACTION_SCRIPT=scripts/stop-one.sh
|
||||
make replicas
|
||||
wait_replicas
|
||||
STOP_ONE_LOG="$log" STOP_MODE=kill make test-failover ACTION_SCRIPT=scripts/stop-one.sh
|
||||
make replicas
|
||||
wait_replicas
|
||||
cat "$log"
|
||||
|
||||
- name: Stand logs
|
||||
if: failure()
|
||||
run: |
|
||||
if [ -f .env ]; then docker compose ps -a; docker compose logs --no-color --tail=200; fi
|
||||
|
||||
- name: Remove the stand
|
||||
if: always()
|
||||
run: |
|
||||
docker network disconnect "${COMPOSE_PROJECT_NAME}_default" "$HOSTNAME" 2>/dev/null || true
|
||||
if [ -f .env ]; then docker compose down -v --remove-orphans; fi
|
||||
docker image rm "mtusi-messenger:$CI_IMAGE_TAG" >/dev/null 2>&1 || true
|
||||
+28
@@ -2,6 +2,7 @@
|
||||
.env
|
||||
.env.*
|
||||
!.env.example
|
||||
config.toml
|
||||
secrets/
|
||||
certs/private/
|
||||
*.key
|
||||
@@ -28,5 +29,32 @@ coverage/
|
||||
.DS_Store
|
||||
.idea/
|
||||
.vscode/
|
||||
graphify-out/
|
||||
# make bench_quick: самопроверка стенда, не результат
|
||||
evidence/bench/quick-*/
|
||||
# make bench_failover_quick: то же для профиля отказа реплик
|
||||
evidence/failover/quick-*/
|
||||
# make bench_rollout_quick: то же для профиля поочерёдной замены
|
||||
evidence/rollout/quick-*/
|
||||
# make bench_uploads_quick: то же для профиля загрузок
|
||||
evidence/uploads/quick-*/
|
||||
# make bench_reconcile_quick: то же для профиля сверки
|
||||
evidence/reconcile/quick-reconcile-*/
|
||||
# make bench_queue_quick: то же для профиля очереди
|
||||
evidence/queue/quick-*/
|
||||
# make bench_telemetry_quick: то же для профиля цены телеметрии
|
||||
evidence/telemetry-cost/quick-*/
|
||||
# сравнения пробных меток
|
||||
evidence/compare/*quick-*
|
||||
# make bench_plots на пробных метках
|
||||
evidence/plots/quick-*/
|
||||
# блокировка стенда bench/ (один прогон любого профиля)
|
||||
bench/.bench.lock
|
||||
# рабочий каталог прогона bench/ (файлы k6, fixture.json с токенами): после
|
||||
# процесса, убитого до уборки, остаётся в каталоге метки
|
||||
evidence/**/.work/
|
||||
# журналы меток (LB, скрипт замены, 5xx серий): небольшие, без секретов,
|
||||
# на них ссылается REPORT.md; у пробных quick-* каталог исключён выше
|
||||
!evidence/**/raw/*.log
|
||||
# Keep small, sanitized evidence summaries in evidence/ under version control.
|
||||
# Inspect git diff --cached: ignore rules are not a secret scanner.
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
# Исключения из графа graphify, синтаксис gitignore, поверх .gitignore
|
||||
# (.env, config.toml, .venv и кэши он уже убирает). В графе остаются
|
||||
# код src/, свои файлы запуска и конфигурации и документы, которые
|
||||
# описывают код: AGENTS.md, .claude/rules/, openspec/specs/, contracts/
|
||||
# README.md и openapi.json. Состав — openspec, capability
|
||||
# code-knowledge-graph. Ведущий / привязывает паттерн к корню: без него
|
||||
# README.md выкинул бы и contracts/README.md.
|
||||
|
||||
# проверки, скрипты и заготовки skeleton
|
||||
/tests/
|
||||
/scripts/
|
||||
/examples/
|
||||
/Dockerfile.example
|
||||
/lab.json
|
||||
/requirements-dev.txt
|
||||
/contracts/examples.json
|
||||
/contracts/infrastructure.json
|
||||
|
||||
# инструментарий агента. settings.local.json git игнорирует через
|
||||
# глобальный excludesfile, а его graphify не читает
|
||||
/.claude/commands/
|
||||
/.claude/skills/
|
||||
/.claude/settings.local.json
|
||||
|
||||
# изменения OpenSpec, текущие и архивные: поведение — в openspec/specs/
|
||||
/openspec/changes/
|
||||
|
||||
# отчёт, доказательства и документы курса
|
||||
/REPORT.md
|
||||
/evidence/
|
||||
/README.md
|
||||
/COURSE.md
|
||||
/CONTRIBUTING.md
|
||||
/MAINTAINERS.md
|
||||
/.github/
|
||||
|
||||
# артефакты самого graphify
|
||||
/graphify-out/
|
||||
@@ -0,0 +1 @@
|
||||
3.12
|
||||
@@ -0,0 +1,945 @@
|
||||
# MTUSI Messenger
|
||||
|
||||
REST API мессенджера (пользователи, чаты, история сообщений). Этот код
|
||||
переносится через все семь лабораторных курса и на каждой обрастает
|
||||
инфраструктурой. Текущая работа — **лаба 6** (`lab.json`): наблюдаемость —
|
||||
SDK OpenTelemetry в API и worker, отдельный OTel Collector, хранилища
|
||||
метрик, логов и трасс, Grafana с provisioning из git; бизнес-API не
|
||||
меняется (`README.md`, `contracts/observability.md`,
|
||||
`contracts/infrastructure.json`, `infra/otel/README.md`). Цель — оценка 5,
|
||||
трек 1 «Цена наблюдаемости»; хранилища — Prometheus (метрики), Loki
|
||||
(логи), Tempo (трассы), интерфейс — Grafana (решения пользователя
|
||||
2026-11-11). Рабочий план лабы (`PLAN.md`) удалён после закрытия всех changes и
|
||||
последнего шага: итоги — в `REPORT.md`, последняя версия плана — `git show
|
||||
db3340d:PLAN.md`. Решения, принятые
|
||||
без пользователя, и открытые вопросы —
|
||||
`QUESTIONS.md`. Первое изменение лабы, наблюдаемость (уровень 3) — change
|
||||
`otel-telemetry` (заархивирован 2026-11-11,
|
||||
`openspec/changes/archive/2026-11-11-otel-telemetry/`, новая capability
|
||||
`observability`): SDK в
|
||||
API и worker (секция `[telemetry]`, `src/infra/telemetry/`), Collector
|
||||
contrib, Prometheus, Loki, Tempo и Grafana в compose (`infra/otel/`, сеть
|
||||
`telemetry`, наружу — только Grafana на `127.0.0.1:GRAFANA_OUT_PORT`), сигналы
|
||||
уровня 3, healthcheck брокера от его пользователя (стенд с нуля одной
|
||||
командой), команды драйвера `telemetry-check`, `telemetry-outage`,
|
||||
`stand-from-scratch` (правило `telemetry.md`). Второе изменение лабы, первая
|
||||
часть уровня 4 — change `job-trace-propagation` (заархивирован 2026-11-11,
|
||||
`openspec/changes/archive/2026-11-11-job-trace-propagation/`, capability
|
||||
`observability`, изменены ещё `graceful-shutdown`, `service-configuration`,
|
||||
`service-logging`):
|
||||
контекст W3C загрузки в `attachment_jobs.traceparent` / `tracestate`
|
||||
(ревизия `e4b8c2d17f90`), SDK в relay (`messenger-relay`), span producer
|
||||
relay и consumer span worker (parent и link) — одна трасса на загрузку, с
|
||||
повторами и replay; заголовки AMQP — carrier, тело сообщения прежнее;
|
||||
`ParentBased(ALWAYS_ON)`; ленивый импорт SDK; метрики уровня 4 — время до
|
||||
`ready`, очередь и возраст (снимок relay), пул `db.client.connection.*`
|
||||
(`CountingQueuePool`), насыщение worker, CPU и память контейнеров из cgroup
|
||||
(без `docker.sock`); панели уровня 4 в том же dashboard; команда драйвера
|
||||
`trace-chain`. Код — commit `72cfa9a`, evidence снято на нём:
|
||||
`evidence/telemetry/check.md`, `queue-snapshot.md`, раздел change в
|
||||
`budget.md`, `evidence/migrations/job-trace-context.md`; правки verify —
|
||||
commit `72e2598`, на нём пересняты `evidence/telemetry/trace-chain.md` и
|
||||
`collector-outage.md` (`check.md`, `trace-chain.md` и `collector-outage.md` ещё раз
|
||||
пересняты на `15ea156`, change `slo-alerts`). Третье изменение лабы, вторая часть уровня 4 —
|
||||
change `slo-alerts` (заархивирован 2026-11-14,
|
||||
`openspec/changes/archive/2026-11-14-slo-alerts/`, изменяет `observability` и `load-balancing`):
|
||||
SLI и SLO (доступность на LB 99,5 %, задержка «лёгких» ручек ≤ 0,25 с 99 %,
|
||||
время до `ready` ≤ 30 с 99 %, окно 7 суток), метрики HAProxy (`/metrics` на
|
||||
порту статистики, забирает только Collector), правила записи и семь
|
||||
оповещений Prometheus в `infra/otel/prometheus/rules.yml` с тестами
|
||||
`rules.test.yml` (`make alerts_test`, шаг CI) и runbooks
|
||||
`infra/otel/runbooks/`, без Alertmanager; очереди экспорта Collector по байтам
|
||||
и повторы 30 с, срок рядов экспортёра 1 мин, время начала рядов по protobuf
|
||||
(`created-timestamp-zero-ingestion`); внутренние метрики SDK и учёт потерь
|
||||
(`telemetry:lost_items:total`); панели SLO, LB и конвейера; команды драйвера
|
||||
`alerts-check` и `backend-outage`. ВМ Docker Desktop с 2026-11-11 — 12 CPU /
|
||||
11 902 МиБ. Код — commit `15ea156`, evidence снято на нём (2026-11-13):
|
||||
`evidence/alerts/rules-test.md`, `evidence/alerts/check.md`,
|
||||
`evidence/telemetry/backend-outage.md`, пересняты `evidence/telemetry/check.md`,
|
||||
`trace-chain.md`, `collector-outage.md`, раздел change в `budget.md`. Правки verify
|
||||
(ноль ряда потерь процесса SDK, описания оповещений с текущим значением, панель потерь
|
||||
в проверках, pending на каждом шаге, сверка SLI одним окном) — commit `ef60b47`, на нём
|
||||
пересняты (2026-11-14) `rules-test.md`, `alerts/check.md` и `backend-outage.md`;
|
||||
`evidence/telemetry/check.md` — на `4a2f9c9` (тот же код и правила, драйвер ждёт в Loki все записи
|
||||
прохода relay). Четвёртое изменение лабы, уровень 5, трек 1 «Цена наблюдаемости» — change
|
||||
`track1-telemetry-cost` (заархивирован 2026-11-15,
|
||||
`openspec/changes/archive/2026-11-15-track1-telemetry-cost/`, изменяет
|
||||
`observability`, `service-configuration`, `load-benchmark`): выбор трасс в голове и наборы границ
|
||||
histogram — поля `[telemetry] trace_sample_ratio`, `metric_buckets` (по умолчанию прежнее
|
||||
поведение), счёт начатых span `otel.sdk.span.started`, запись о старте с долей, набором и
|
||||
интервалом; телеметрия на стенде `bench/` — профиль `make bench_telemetry` (варианты `off`,
|
||||
`full`, `full-aa`, `head`, `tail`, `metrics`, `balanced`, редкие события с известным счётом,
|
||||
`evidence/telemetry-cost/<метка>/`) и выключатель `TELEMETRY=on` у `bench_uploads` и
|
||||
`bench_queue`; сбалансированная конфигурация — `bench/otel/` (рабочий стенд остаётся со всеми
|
||||
трассами); гипотезы H1–H8 и критерии B1–B5 — `REPORT.md`, «Цена наблюдаемости (трек 1)».
|
||||
Гипотезы — commit `509afca`, метка `evidence/telemetry-cost/baseline2/` снята на коде `68e14b6`
|
||||
(каталог — commit `0f5dbfc`), правки verify — commit `56132c7`. Последний шаг лабы (без
|
||||
change, ветка `feat/lab6-final`): метки `make bench_uploads TELEMETRY=on` →
|
||||
`evidence/uploads/baseline/` и `make bench_queue TELEMETRY=on QUEUE_LABEL=baseline4` →
|
||||
`evidence/queue/baseline4/` (код `b3a5ab8`, каталоги — commit `db3340d`; у очереди
|
||||
`dirty: true` — `QUESTIONS.md`, `## Последний шаг`), файлы исключений сверки покрытия и
|
||||
полные проверки на `db3340d` (`evidence/cache/`, `auth/`, `attachments/`, `broker/`,
|
||||
`idempotency/`, `replicas/`, `failover/`, `tests/`), проверка из чистого clone, CI на Gitea,
|
||||
`REPORT.md` целиком; `make student_test` через LB зелёный.
|
||||
Код перенесён из лабы 5 (репозиторий
|
||||
`mtusi2026lab5-safronov`, ветка `solution/bvt2301-safronov`, commit
|
||||
`046ec9e`) по разделу «Переход в следующую лабу»; отчёт и evidence лабы 5
|
||||
остались в её репозитории. Дальше — что досталось от лабы 5: брокер
|
||||
RabbitMQ 4, отдельный worker, состояния вложения `queued` / `processing` /
|
||||
`ready` / `failed` и преобразование изображений; загрузка отвечает `202`
|
||||
(`COURSE.md`, переход 4 → 5, `contracts/README.md`, «Фоновая обработка (с
|
||||
lab5)», `contracts/attachment-states.md`, `contracts/jobs.schema.json`).
|
||||
Предупреждения о хосте, которые явно не влияют на результат замера, прогон
|
||||
не останавливают (указание пользователя 2026-10-31). Фоновая обработка
|
||||
(уровень 3) — change `async-attachments` (заархивирован 2026-10-31,
|
||||
`openspec/changes/archive/2026-10-31-async-attachments/`): загрузка — 202
|
||||
после staging, задания в PostgreSQL и подтверждения брокера, worker на
|
||||
образе API, thumbnail, очередь RabbitMQ 4, новые capability
|
||||
`attachment-processing` и `message-broker`. Надёжность конвейера
|
||||
(уровень 4) — change `pipeline-reliability` (заархивирован 2026-10-31,
|
||||
`openspec/changes/archive/2026-10-31-pipeline-reliability/`, новая capability `job-outbox`): outbox и
|
||||
relay вместо публикации в запросе, варианты `crop` и `optimized`, лимиты в процессе
|
||||
обработки на задание, backoff с jitter, реестр `failed` и replay, аренда и fencing,
|
||||
prefetch, очистка staging. Единица работы — change `unit-of-work` (заархивирован 2026-11-01,
|
||||
`openspec/changes/archive/2026-11-01-unit-of-work/`, полный UoW по Cosmic Python, решение
|
||||
пользователя, новая capability `unit-of-work`): сервисы на абстракциях
|
||||
`src/core/ports/`, соединение на шаг, быстрые тесты `service-tests/`. Очередь под
|
||||
перегрузкой (уровень 5) — change `track1-queue-overload` (заархивирован 2026-11-02,
|
||||
`openspec/changes/archive/2026-11-02-track1-queue-overload/`, новая capability
|
||||
`queue-overload`): предел незавершённых заданий на входе API, профиль `make bench_queue`,
|
||||
гипотезы H1–H9 в `REPORT.md` лабы 5; основная метка `baseline4` — в репозитории лабы 5. В
|
||||
лабу 5 код пришёл из лабы 4 (репозиторий `mtusi2026lab4-safronov`, ветка
|
||||
`solution/bvt2301-safronov`, commit `2546deb`); отчёт и evidence лабы 4
|
||||
остались в её репозитории. Дальше — что досталось от лабы 4. S3 в стенде — change `s3-storage` (заархивирован
|
||||
2026-10-20, `openspec/changes/archive/2026-10-20-s3-storage/`):
|
||||
SeaweedFS с приватным bucket, bootstrap и клиент `src/infra/s3/`.
|
||||
Вложения — change `attachments` (заархивирован 2026-10-21,
|
||||
`openspec/changes/archive/2026-10-21-attachments/`): ручки загрузки,
|
||||
метаданных и скачивания, структурная проверка PNG/JPEG,
|
||||
`attachment_ids` в сообщениях, таблицы `attachments` и
|
||||
`message_attachments`. Согласованность БД и S3 — change
|
||||
`upload-consistency` (заархивирован 2026-10-21,
|
||||
`openspec/changes/archive/2026-10-21-upload-consistency/`): компенсация
|
||||
в загрузке (удаление объекта при известном исходе, 503 вместо 500),
|
||||
уборщик незавершённых загрузок — сервис `cleaner` (`python -m
|
||||
src.cleaner`, grace 900 с, свой пользователь S3 «чтение и удаление»),
|
||||
частичный индекс строк `pending`, новая capability
|
||||
`storage-consistency`. Память и сроки загрузки — change
|
||||
`upload-memory` (заархивирован 2026-10-22,
|
||||
`openspec/changes/archive/2026-10-22-upload-memory/`): места загрузки на
|
||||
процесс API (`[uploads]`: 4 места, очередь 16, ожидание 5 с, затем 429
|
||||
`rate_limited` с `Retry-After`), срок тела 30 с (400), одна копия тела
|
||||
при PUT, буферы сокетов реплики 512 KiB и LB 256 / 128 KiB, `timeout server`
|
||||
LB пути загрузки 30 с, дренаж замены 90 с, профиль `uploads` стенда
|
||||
`bench/`. Сверка bucket и БД (трек 2) — change `track2-reconciler`
|
||||
(заархивирован 2026-10-22,
|
||||
`openspec/changes/archive/2026-10-22-track2-reconciler/`): сверка в
|
||||
процессе уборщика (`make reconcile [APPLY=1]` и плановая), классы
|
||||
расхождений, пометка потерянного оригинала `lost_at`, список по
|
||||
префиксу у ключа уборщика. Изредка 503 на загрузке — change
|
||||
`fix-upload-put-flake` (заархивирован 2026-10-23,
|
||||
`openspec/changes/archive/2026-10-23-fix-upload-put-flake/`): у клиента
|
||||
S3 нет срока чтения aiohttp (он переживал ответ и портил соединение в
|
||||
пуле), срок — только `asyncio.timeout` вызова и блока; четвёртый API
|
||||
стенда отказов со сроком S3 1 с (`test_upload_after_idle_s3`), проба
|
||||
`driver.py s3-idle`. Стоимость сверки (трек 2) — change
|
||||
`track2-reconcile-cost` (заархивирован 2026-10-23,
|
||||
`openspec/changes/archive/2026-10-23-track2-reconcile-cost/`): стратегия «HEAD на строку» и
|
||||
глубокая сверка (класс «другой SHA-256», пометку снимает только тот же
|
||||
SHA-256) в разовом проходе, предел скорости `[reconciler]
|
||||
max_objects_per_second` (2000 объектов S3/с), отказ по пределу без
|
||||
лишних перепроверок, стоимость прохода в его итоге, профиль `reconcile`
|
||||
стенда `bench/`. Рабочий план лабы 4 (`PLAN.md`) удалён после закрытия
|
||||
всех changes: итоги — в `REPORT.md` репозитория лабы 4, открытые вопросы
|
||||
преподавателю — в его разделе «Открытые вопросы преподавателю», последняя
|
||||
версия плана — там же, `git show fd03b84:PLAN.md`. Из лабы 2: PostgreSQL
|
||||
как источник истины, вход по Basic → Bearer-сессия, Valkey — кэш
|
||||
карточек чатов. Из лабы 3: HAProxy перед ≥2 репликами API
|
||||
(`replicas-lb`), `X-Instance-Id` и обязательный `Idempotency-Key`
|
||||
(`instance-id-idempotency`), замеренная цепочка таймаутов
|
||||
(`graceful-failover`), поочерёдная замена реплик `make rolling_update`
|
||||
(`rolling-update`), ранний обработчик SIGTERM (`fix-known-issues`),
|
||||
строгие курсор и UUID на входе (`strict-id-validation`). Стенд `bench/`
|
||||
— трек 2 лабы 2 (план запроса и восстановление), профили `failover` и
|
||||
`rollout`, серии трека 1 лабы 3 (`scaling-bench`, `scaling-improvement`,
|
||||
`profile-resources`). Changes лаб 2 и 3 и `s3-storage`, `attachments`,
|
||||
`upload-consistency`, `upload-memory`, `track2-reconciler`,
|
||||
`fix-upload-put-flake`, `track2-reconcile-cost` лабы 4, `async-attachments`,
|
||||
`pipeline-reliability`, `unit-of-work` и `track1-queue-overload` лабы 5 и
|
||||
`otel-telemetry`, `job-trace-propagation`, `slo-alerts` и `track1-telemetry-cost` лабы 6 — в
|
||||
`openspec/changes/archive/`, активных нет (новые
|
||||
capability: с `s3-storage` —
|
||||
`object-storage`, с `attachments` — `attachments`, с
|
||||
`upload-consistency` — `storage-consistency`, с `async-attachments` —
|
||||
`attachment-processing`, `message-broker`, с `pipeline-reliability` — `job-outbox`,
|
||||
с `unit-of-work` — `unit-of-work`, с `track1-queue-overload` — `queue-overload`, с
|
||||
`otel-telemetry` — `observability`);
|
||||
в `KNOWN_ISSUES.md` одиннадцать открытых записей (запись о первом старте RabbitMQ на
|
||||
пустом volume закрыта change `otel-telemetry`; с него же — 400 текстом uvicorn на
|
||||
нестандартный метод HTTP; смесь версий при замене реплик на первый
|
||||
релиз с обработкой; bootstrap после удаления
|
||||
bucket; уборщик
|
||||
удаляет объект зависшей загрузки по ключу вне своего префикса; 408 LB на медленные заголовки текстом HAProxy; поля `float` настроек принимают `inf`; 504 LB на метаданных и скачивании вложения при зависшем PostgreSQL; ложный FAIL `driver.py reconcile-cycle` на наполненном стенде; память S3 на долго живущем стенде; граница живой загрузки уборщика без закрытия соединения; остановка API при замороженном PostgreSQL дольше срока контейнера). Отчёт, evidence и рабочий план лабы 3 остались в её
|
||||
репозитории (`REPORT.md`, `evidence/`, `git show 063eedb:PLAN.md`).
|
||||
Стек: Python 3.12, uv, FastAPI, pydantic v2, pydantic-settings,
|
||||
structlog (JSON в stdout), redis-py (клиент Valkey), aiobotocore
|
||||
(клиент S3).
|
||||
|
||||
Репозиторий — fork skeleton преподавателя. Задание, контракт и публичные
|
||||
проверки уже лежат в нём. Реализацию, Dockerfile, compose, собственные
|
||||
тесты и `REPORT.md` пишем мы.
|
||||
|
||||
## Обязательные правила
|
||||
|
||||
- Контракт и skeleton не менять: `contracts/`, `tests/`, `scripts/`
|
||||
(кроме своих `scripts/restart.sh` и `scripts/stop-one.sh` по образцам
|
||||
`restart.example.sh` и `stop-one.example.sh`),
|
||||
`lab.json`, `README.md`, `COURSE.md`, `CONTRIBUTING.md`,
|
||||
`MAINTAINERS.md`, `.github/` (кроме своего CI job по `CONTRIBUTING.md`,
|
||||
«CI»: `.github/workflows/application.yml` и `.github/ci/`),
|
||||
`compose.example.yaml`,
|
||||
`infra/README.md`, цели `check` / `validate` / `test` / `load` /
|
||||
`test-persistence` / `test-failover` в `Makefile`. Если публичный тест упал, чиним
|
||||
приложение, а не тест. Если в контракте противоречие — сказать
|
||||
пользователю (это вопрос преподавателю), не выбирать трактовку самому.
|
||||
Ответ преподавателя записать в «Согласования с преподавателем».
|
||||
- Git не трогать без явной просьбы: никаких commit, push, checkout,
|
||||
reset, stash. Смотреть можно (`git status`, `git diff`, `git log`).
|
||||
Замер или evidence для отчёта снимается с закоммиченного кода, но
|
||||
коммит — только после подтверждения пользователя: показать изменения,
|
||||
предложить сообщение, ждать ок (`.claude/rules/bench.md`, «Измеренное
|
||||
состояние — commit»).
|
||||
- Перед завершением задачи с кодом — `make lint`. Правки API проверять на
|
||||
запущенном сервере (`make run_dev` или контейнер, затем `make test` и
|
||||
`make student_test`), а не «на глаз».
|
||||
- Тесты пишем: black-box по HTTP в `student-tests/`
|
||||
(`.claude/rules/student-tests.md`), в bp_proxies тесты были запрещены,
|
||||
здесь они часть рубрики уровня 4; быстрые тесты сервисов на фейках и настоящая
|
||||
единица работы — только в `service-tests/` вне образа
|
||||
(`.claude/rules/service-tests.md`).
|
||||
- Единица работы (change `unit-of-work`, `service-layer.md`): работа сервиса с
|
||||
PostgreSQL — `async with self.uow:`, один блок — одна транзакция, явный
|
||||
`await self.uow.commit()`, выход без него — откат. Вложенный блок и repo вне
|
||||
блока или после фиксации — ошибка. В сервисах нет `AsyncSession`, SQLAlchemy,
|
||||
реализаций repo и глобалов хранилищ: они зависят от `src/core/ports/`, реализации
|
||||
выбирают точки входа. Экземпляр — на задачу: запрос, доставка worker, сервис в
|
||||
последовательных процессах. Соединение занято на шаг, вход и операция — разные
|
||||
блоки; `[database] request_timeout_seconds` — срок блока с откатом, а на
|
||||
JSON-роутерах ещё и общий срок запроса (`request_deadline`). Новый метод repo —
|
||||
порт, SQL, фейк и строка `service-tests/repo_contract.py`.
|
||||
- Упавший тест — сначала разбор, потом правка. Воспроизвести падение,
|
||||
прочитать вывод и назвать причину: дефект приложения, ошибка в самом
|
||||
тесте или стенд (чужой сервис на порту, старый образ, не тот
|
||||
`BASE_URL`). Только после этого что-то менять, а в итоге задачи
|
||||
сказать, в чём была причина.
|
||||
- Если тест упал, чинится код, а не тест. Упавший тест из
|
||||
`student-tests/` правится только в крайнем случае:
|
||||
- поведение меняется намеренно: так записано в дельте спека
|
||||
OpenSpec change или в контракте новой лабы. Тест правится вместе со
|
||||
спеком;
|
||||
- тест ошибочен сам: противоречит спеку или контракту либо зависит от
|
||||
случайного (порядок тестов, время, чужие данные на стенде). В итоге
|
||||
задачи назвать, чему именно он противоречит.
|
||||
|
||||
«Тест красный» — не причина его править. Нельзя ослаблять проверку,
|
||||
подгонять ожидание под фактический ответ, ставить `skip` / `xfail`
|
||||
или удалять тест, чтобы прогон позеленел. Дефект приложения вне
|
||||
текущей задачи записывается в `KNOWN_ISSUES.md` (правило ниже), а
|
||||
тест остаётся как есть. Если причина неясна или правка теста спорная —
|
||||
остановиться и спросить.
|
||||
- Лаба 2: источник истины — PostgreSQL, SQLite его не заменяет.
|
||||
Пользователи, чаты, участники, сообщения и ещё действующие сессии
|
||||
переживают рестарт API и хранилищ без удаления volumes. Basic — только
|
||||
на `POST /auth/sessions`, остальное — Bearer; `X-User-Id` доступа не
|
||||
даёт; пароли — только через password KDF (`auth.md`). Valkey — на
|
||||
«4», кэш карточки чата: источник истины — PostgreSQL, отказ Valkey —
|
||||
обход кэша, а не ошибка (`infra.md`). Всё это сохраняется в лабах
|
||||
3–6.
|
||||
- Лаба 3: ≥2 взаимозаменяемые реплики `api` за HAProxy — единственной
|
||||
публичной точкой входа; порты реплик наружу не публикуются, sticky
|
||||
session нет. В памяти процесса нет ничего, от чего зависит
|
||||
корректность: сессии, данные и ключи идемпотентности — в Postgres,
|
||||
Valkey — общий кэш неизменяемых карточек, S3 — байты вложений. В
|
||||
каждом ответе API —
|
||||
`X-Instance-Id`. `POST` сообщения требует `Idempotency-Key`; ключ и
|
||||
сообщение пишутся в одной транзакции (`api-contract.md`,
|
||||
`service-layer.md`). Миграции — однократно, отдельным сервисом, не
|
||||
репликами, и только расширяют схему: старые реплики работают на новой
|
||||
(`migrations.md`). Новый код доходит до реплик без простоя через `make
|
||||
rolling_update`. Стенд и отказы — `balancer.md`. В каждом процессе
|
||||
uvicorn по-прежнему один worker: масштабирование — числом реплик.
|
||||
Всё это сохраняется в лабах 4–6.
|
||||
- Лаба 4, S3 (change `s3-storage`): SeaweedFS в стенде, образ
|
||||
закреплён тегом и digest, volume `s3_data`. Bucket приватен с первой
|
||||
секунды: административная пара — только у сервера, служебные
|
||||
серверы — на loopback контейнера, gRPC шлюза закрыт ключом подписи.
|
||||
Bucket, политику и пользователя API создаёт одноразовый
|
||||
`s3-bootstrap` (идемпотентно, сам проверяет приватность), реплики ждут
|
||||
его, как миграций. У API — только ключи своего пользователя (чтение,
|
||||
запись, удаление объектов своего bucket). Срок вызова клиента S3 —
|
||||
только `asyncio.timeout` вызова и блока, `read_timeout` aiohttp
|
||||
выключен (change `fix-upload-put-flake`, `infra.md`). `/health/ready`
|
||||
S3 не проверяет. Приватность вне API — `make s3_check` (`docker.md`,
|
||||
`infra.md`, design change `s3-storage`).
|
||||
- Лаба 4, согласованность БД и S3 (change `upload-consistency`): строка
|
||||
`pending` с ключом — до PUT; после записанного объекта сбой до
|
||||
отправки COMMIT `ready` — объект удаляется до ответа 503, исход COMMIT
|
||||
неизвестен — объект не трогается (`service-layer.md`). Незавершённые
|
||||
загрузки убирает только уборщик — отдельный сервис `cleaner` на образе
|
||||
API, а не реплики: строки `pending` старше `[cleaner]
|
||||
pending_grace_seconds` (900 с; больше границы живой загрузки 17 с по
|
||||
формуле, с закрытием соединения до 21 с, иначе уборщик не стартует) под `FOR UPDATE SKIP LOCKED`, в два шага:
|
||||
пометка строки (`updated_at`) отдельной транзакцией, затем объект и
|
||||
строка одной транзакцией под блокировкой (объект раньше строки);
|
||||
помеченную строку `mark_queued` в `queued` не переводит,
|
||||
`queued`, `processing`, `ready` и `failed` уборщик не трогает, удаляет
|
||||
`staging_key`, а у строки прежней версии `object_key`. У уборщика свой пользователь S3 — только
|
||||
чтение и удаление объектов своего bucket, ключи `S3_CLEANER_*` только
|
||||
у него и bootstrap (`docker.md`, `settings.md`).
|
||||
- Лаба 4, сверка bucket и БД (change `track2-reconciler`, трек 2): её
|
||||
делает процесс уборщика — разовая `make reconcile [APPLY=1]` (по
|
||||
умолчанию dry-run; коды 0 / 3 / 1 / 2) и плановая в сервисе `cleaner`
|
||||
при старте и раз в `[reconciler] interval_seconds` (3600 с) с
|
||||
исправлением. Удаляется только объект без строки старше grace и
|
||||
зависшая загрузка (шагом уборщика); строки `ready`, объект, на который
|
||||
ссылается строка, и чужой ключ — никогда; строку с ключом вне
|
||||
`<база>/attachments/` сверка только называет (чужой объект): её объект
|
||||
не читает, строку не помечает и не убирает. Сигнал — перед каждым
|
||||
вызовом хранилища (остановка ждёт ≤ 5 с S3 или ≤ 6 с шага БД). Grace — тот же `[cleaner]
|
||||
pending_grace_seconds`, по `LastModified` объекта и времени строки;
|
||||
перед каждым действием — перепроверка в БД и HEAD, отсутствие объекта —
|
||||
только при живом bucket; больше `[reconciler] max_changes` (100)
|
||||
изменений — ни одного и код 3. Потерянный оригинал помечается
|
||||
(`attachments.lost_at`): скачивание — 404, метаданные — 200, ссылка —
|
||||
201 (вопрос преподавателю, `TEACHER_QUESTIONS.md` — локальный, не в
|
||||
git). Уборщику разрешён список только
|
||||
с префиксом `<база>/attachments/` (`S3_CLEANER_LIST_PREFIX` у
|
||||
bootstrap). На время восстановления базы уборщик останавливают
|
||||
(`docker.md`). С change `track2-reconcile-cost`: проход затрагивает в
|
||||
среднем не больше `[reconciler] max_objects_per_second` (2000; 0 — без
|
||||
предела) объектов S3 в секунду, паузу прерывает сигнал; разовый проход
|
||||
— ещё `--strategy head` (выборка строки на объект, HEAD на строку, без
|
||||
множества ключей) и `--deep` (GET и SHA-256: «другой SHA-256» помечается
|
||||
потерянным), плановая — всегда `batch`, поверхностная; «оригинал
|
||||
вернулся» — только тот же SHA-256; с `--apply`, как только
|
||||
подтверждённых изменений больше предела, остальные кандидаты не
|
||||
перепроверяются (`unchecked`); итог называет стоимость — объекты и
|
||||
запросы S3, байты, сеансы, длительность шагов (`service-layer.md`).
|
||||
- Лаба 4, память загрузок (change `upload-memory`): память загрузок
|
||||
реплики ограничена числом мест, а не числом клиентов. Место берётся
|
||||
после проверок 401/400/404/415/413 и до чтения тела, держится до
|
||||
ответа и освобождается при любом исходе; без места — очередь процесса
|
||||
до `[uploads] max_waiting` не дольше `wait_timeout_seconds`, затем 429
|
||||
с `Retry-After` без строки и объекта. Тело — не дольше
|
||||
`body_timeout_seconds` с момента места (иначе 400), в PUT уходит тот же
|
||||
`BytesIO` без второй копии (`service-layer.md`). Ожидание, тело и
|
||||
проверка — до строки `pending`: граница B уборщика прежняя (17 с по
|
||||
формуле, с закрытием соединения до 21 с: `KNOWN_ISSUES.md`).
|
||||
Буфер приёма сокетов `api` — 512 KiB (`sysctls`), буфер отправки LB к
|
||||
реплике — 256 KiB, буфер приёма LB от клиента — 128 KiB; `timeout server` пути загрузки 30 с, остальных — 10
|
||||
с; `ROLLOUT_DRAIN_TIMEOUT` 90 с (`balancer.md`, `docker.md`).
|
||||
- Лаба 5, фоновая обработка (change `async-attachments`, `worker.md`): ответ 202
|
||||
— только после оригинала в staging (`<база>/staging/<id>/original`) и `queued` с
|
||||
заданием одной транзакцией. Ack — после устойчивого эффекта, повтор — те же
|
||||
ключи, ключ эффекта `(attachment_id, pipeline_version, variant)`. Брокер, relay и
|
||||
worker не входят в `/health/ready`, без них работают загрузка (202), текст,
|
||||
история, метаданные и готовые байты. Очередь — `<база>.attachment.process.v1`,
|
||||
durable, сообщения persistent, в них только id и служебные поля
|
||||
(`contracts/jobs.schema.json`).
|
||||
- Лаба 5, надёжность конвейера (change `pipeline-reliability`, `worker.md`):
|
||||
брокера в пути запроса нет, у реплик API ни клиента, ни пароля; намерения
|
||||
(`attachment_jobs`, `state = 'queued' AND published_at IS NULL`) публикует
|
||||
relay (`python -m src.relay`, отдельный сервис) с подтверждением, отметка — только
|
||||
подтверждённым; доставка at least once, дубль — no-op. Сообщение — подсказка, истина
|
||||
в строке: дубль при живой аренде и сообщение раньше срока подтверждаются без
|
||||
эффекта, номер попытки — fencing. Аренда `job_timeout + lease_margin` без пульса,
|
||||
истёкшую возвращает relay. Следующую попытку публикует relay по `next_attempt_at`
|
||||
(backoff с jitter), пауза места конкуренции не занимает. Декодирует и делает три
|
||||
варианта только отдельный процесс на задание (`src/worker/render.py`, лимиты CPU и
|
||||
адресного пространства, без секретов в окружении): Pillow нет ни в репликах, ни в
|
||||
процессе worker. Постоянная ошибка — `failed` сразу, реестр — строки `failed`, возврат
|
||||
— `make replay` с записью аудита и новым бюджетом (`attempt_base`). Staging убирает
|
||||
только уборщик: у `ready` — следующим проходом, у `failed` — по `[cleaner]
|
||||
staging_retention_seconds` вместе с частично записанными объектами, блокировка `FOR
|
||||
NO KEY UPDATE`; сверка находит `orphan_staging`. Лимиты 0,25 CPU / 256 МБ у relay, пул
|
||||
1. Цепочка LB — 26 с и 73 с (`balancer.md`).
|
||||
- Лаба 5, предел принятой работы (change `track1-queue-overload`, спек `queue-overload`,
|
||||
`service-layer.md`): загрузка при `[uploads] max_unfinished_jobs` (250, 0 — без предела)
|
||||
и больше незавершённых заданий стенда (`queued`, `processing`) получает 429
|
||||
`rate_limited` с `Retry-After: 5`, без тела и места, ни строки, ни объекта. Порядок: 404
|
||||
→ 415 → 413 → 429 предела → 429 мест. Считает все реплики по PostgreSQL одним запросом
|
||||
в первом блоке (три частичных индекса с `LIMIT` на группу, `count_unfinished`), шаг
|
||||
с БД не прибавляется, цепочка LB прежняя. Предел мягкий: превышение — только загрузки в
|
||||
полёте. Текст, история, метаданные, готовые байты и `/health/ready` от него не
|
||||
зависят. Профиль `uploads` и четыре прежних API стенда отказов — с пределом 0.
|
||||
- `.env`, `config.toml`, секреты, токены и реальные данные не попадают ни
|
||||
в git, ни в образ. В `evidence/` и `REPORT.md` — только обезличенные
|
||||
выводы команд.
|
||||
- Найденный попутно дефект не чинить без просьбы: записать в
|
||||
`KNOWN_ISSUES.md` (завести при первой находке) с путём и предложением
|
||||
правки.
|
||||
- OpenSpec: если команде `/opsx:*` подходит больше одного изменения
|
||||
(change) — несколько активных в `openspec/changes/`, имя совпало
|
||||
частично, из контекста подходят несколько, — не выполнять её для всех
|
||||
подряд и не выбирать самому. Спросить, для какого изменения запустить:
|
||||
варианты — каждое по имени, последним — «все». То же при нескольких
|
||||
подходящих спеках (capability).
|
||||
|
||||
## Согласования с преподавателем
|
||||
|
||||
Договорённости, которых нет в skeleton. Каждую упомянуть в `REPORT.md`
|
||||
и перенести в следующую лабу вместе с этим файлом, если она ещё
|
||||
действует.
|
||||
|
||||
| Дата | Договорённость | Где учтено |
|
||||
|---|---|---|
|
||||
| 2026-09-26 | Лабы можно делать на FastAPI, несмотря на расхождения с контрактом (лишний 422, другой порядок кодов ошибок). Публичный smoke при этом должен проходить | `.claude/rules/api-contract.md`, раздел «FastAPI» |
|
||||
| 2026-09-29 | Конфиг через pydantic-settings: окружение → `.env` → `config.toml` → дефолты. `config.toml` не в git и не в образе, монтируется read-only при запуске. Это подходит под «конфигурация приходит из окружения» (README лабы 1, п. 3) и п. 6 `Dockerfile.example`. Требование «только env» — упрощение курса, `config.toml` можно использовать | `.claude/rules/settings.md`, `.claude/rules/docker.md` |
|
||||
| 2026-10-20 | Лаба 4: «пустой текст» сообщения — это и `""`, и текст только из пробельных символов. Допустимы: вложение + непустой текст, без вложения + непустой текст, вложение + пустой текст. Значит, `" "` с хотя бы одним вложением — 201, без вложений — 400 | спек `messages` (change `attachments`, сценарий «Пробелы с вложением»), design `attachments`, решение 8; `.claude/rules/api-contract.md` |
|
||||
|
||||
## Задание и контракт: важные файлы
|
||||
|
||||
| Файл | Что в нём |
|
||||
|---|---|
|
||||
| `README.md` | задание лабы: рубрика 3/4/5, сценарий и вопросы защиты, что приложить к PR |
|
||||
| `COURSE.md` | карта семи лаб, три объявленных перехода API (1→2, 2→3, 4→5), правила честных измерений |
|
||||
| `contracts/openapi.json` | нормативный OpenAPI 3.1: пути, схемы, коды ответов |
|
||||
| `contracts/README.md` | нормативная семантика: формат ошибок, валидация, пагинация, Basic → Bearer-сессии, TTL и отзыв, с lab3 — `Idempotency-Key` и `X-Instance-Id`, с lab4 — вложения: сырые bytes PNG/JPEG ≤10 MiB и ≤40 млн пикселей, на лабе 4 `201 Attachment` (`ready`), с лабы 5 — `202` (`queued`), `attachment_ids` в сообщении, download только участникам; пустой текст (в том числе из пробелов) — только с вложением (согласование 2026-10-20); разделы lab5+ — на будущее; как это сделано — `api-contract.md`, «Вложения (лаба 4)» |
|
||||
| `contracts/examples.json`, `infrastructure.json` | примеры тел (проверяет `make validate`); роли инфраструктуры лабы: api ×2+ без локального состояния, postgres, load_balancer, s3 (одно из MinIO, SeaweedFS, RustFS; приватный bucket, persistent volume); Redis/Valkey — необязательно; внутренние порты реплик в обход LB не публикуются; с лабы 6 — `otel_collector` (metrics, logs, traces), `telemetry_storage` (три сигнала, например Prometheus, Loki, Tempo; persistent volume) и `grafana` (provisioning в git) |
|
||||
| `contracts/observability.md` | с лабы 6: логические сигналы по уровням (HTTP requests и duration, jobs и их duration, логи с `trace_id` / `span_id`, трассы API и worker; на 4 — queue depth и возраст старейшей job, пул БД и saturation worker, сквозная связь upload → publish → consume, время до `ready`), resource attributes, запрещённые labels и данные в telemetry, определение error ratio, что лежит в git (Collector, backends, provisioning, dashboard JSON, alert rules), три контролируемых инцидента уровня 4 |
|
||||
| `lab.json` | номер лабы (6); по нему `tests/client.py` выбирает профиль (с лабы 2 — Basic при входе, дальше Bearer; с лабы 3 — идемпотентность; с лабы 4 — вложение, 201 вместо 202 с лабы 5; у лабы 6 — как у лабы 5) |
|
||||
| `tests/smoke.py`, `tests/client.py` | публичный сквозной сценарий `make test`; с лабы 4 — загрузка `tests/fixtures/sample.png`, сообщение с `attachment_ids`, SHA-256 скачанного оригинала, 404 постороннему; что он проверяет и чего нет — `tests/README.md` |
|
||||
| `tests/fixtures/`, `tests/image_probe.py` | синтетический PNG 320×200 и его SHA-256 (`tests/fixtures/README.md`); размеры JPEG без внешних библиотек (thumbnail — с лабы 5) |
|
||||
| `tests/resilience.py` | `make test-persistence`: данные, прежний токен и с лабы 4 — тот же оригинал вложения после restart hook; `make test-failover`: ≥2 реплики, запись во время остановки одной, повтор с тем же ключом, без дублей |
|
||||
| `tests/load.py` | closed-loop нагрузка POST сообщений (`make load`); для трека 5 одного его мало |
|
||||
| `scripts/check_contract.py`, `scripts/validate_openapi.py` | `make check` / `make validate` |
|
||||
| `scripts/restart.example.sh` | образец restart hook; свой — `scripts/restart.sh`: перезапуск API и всех хранилищ без удаления volumes |
|
||||
| `scripts/stop-one.example.sh` | образец failover hook; свой — `scripts/stop-one.sh`: остановить одну API-реплику по `TARGET_INSTANCE_ID` и оставить её остановленной |
|
||||
| `compose.example.yaml` | список ролей с пустым `services`, не стенд; свой стенд — свой compose-файл |
|
||||
| `infra/README.md` | куда класть конфигурации сервисов и что сопоставить в `REPORT.md` |
|
||||
| `infra/otel/README.md` | с лабы 6: что положить — `collector.yaml` (receivers, processors, exporters, bind endpoints, memory limits / batch, поведение при backpressure), конфиги хранилищ, provisioning datasources и dashboards Grafana, dashboard JSON; на 4 — alert rules и runbooks; OTLP, metrics и административные порты наружу не публиковать; сделано — `infra/otel/` (change `otel-telemetry`, карта кода; alert rules, тесты и runbooks — change `slo-alerts`: `infra/otel/prometheus/rules.yml`, `rules.test.yml`, `infra/otel/runbooks/`), правило `telemetry.md` |
|
||||
| `REPORT.md` | отчёт: запуск из чистого clone, архитектура, доказательства по каждому критерию, эксперименты, ИИ и источники |
|
||||
| `evidence/` | сохранённые выводы проверок и измерений (что можно класть — `evidence/README.md`) |
|
||||
| `CONTRIBUTING.md` | fork/PR, имя ветки, что переносить в следующую лабу |
|
||||
| `.github/pull_request_template.md` | шаблон PR; CI `workflows/contracts.yml` проверяет только контракт, приложение не запускает; сборку, стенд и `make test` — свой job `workflows/application.yml` (карта кода) |
|
||||
| `Dockerfile.example` | опорные шаги Dockerfile, не рабочий файл |
|
||||
| `.env.example` | шаблон `.env`; «логические» имена skeleton (lab2, lab3 `API_REPLICAS`, `IDEMPOTENCY_TTL_SECONDS` и новые lab4 `S3_*`, `MAX_UPLOAD_BYTES`, `MAX_IMAGE_PIXELS`, lab5 `BROKER_URL_FILE` и др.) перечислены в шапке, их соответствие — в `REPORT.md` (`settings.md`); имена lab6 `OTEL_*` настройками не являются — их соответствие `[telemetry]` и константам кода в шапке шаблона и в `REPORT.md`; `GRAFANA_ADMIN_PASSWORD` (случайный от `make env_setup`) и `GRAFANA_OUT_PORT` |
|
||||
| `examples/requests.http` | ручные запросы для HTTP-клиента IDE |
|
||||
|
||||
## Где лежат инструкции
|
||||
|
||||
Четыре уровня, не дублировать их друг в друге:
|
||||
|
||||
- **`AGENTS.md`** (этот файл): инварианты, команды, карта кода.
|
||||
`CLAUDE.md` импортирует его.
|
||||
- **`.claude/rules/*.md`**: правила по слоям. Подгружаются автоматически,
|
||||
когда открыт файл из `paths:` во фронтматтере. Проект пишется с нуля,
|
||||
а при создании файла через Write правило само не подгрузится. Поэтому
|
||||
перед созданием первого файла слоя его правило нужно прочитать руками.
|
||||
|
||||
| Файл | Действует на |
|
||||
|---|---|
|
||||
| `api-contract.md` | `src/api/**`, `src/core/**`, `src/schemas/**`, `student-tests/**`: что требует контракт и где FastAPI по умолчанию его нарушает |
|
||||
| `api-layer.md` | `src/api/**`, `src/main.py`: роутеры, зависимости, middlewares, обработчики ошибок |
|
||||
| `service-layer.md` | `src/core/services/**`: единица работы, транзакции, порядок действий |
|
||||
| `repo-layer.md` | `src/core/repos/**`, `src/core/ports/**`: порты и repo-классы |
|
||||
| `dto.md` | `src/schemas/**` |
|
||||
| `infra.md` | `src/infra/**`: логгер, PostgreSQL (engine, пул, таймауты), readiness, кэш Valkey (повтор только на обрыв, срок на команду, обход при отказе), клиент S3 (без повторов, срок на вызов, перевод ошибок) и другие клиенты |
|
||||
| `auth.md` | `src/**/session.py`, сервис пользователей, `dependencies.py`, `errors.py`, идентификация в `student-tests/`: пароль и KDF, разбор Basic, токен, срок и отзыв сессии |
|
||||
| `logging.md` | сервисы, API, инфраструктура, `src/main.py`: где и как логировать, чего в логах быть не должно |
|
||||
| `settings.md` | `src/config/**`, `.env.example`, `config_example.toml`: источники настроек, что куда класть |
|
||||
| `run-modes.md` | точки входа, `Makefile`, compose, шаблоны конфигов: console и docker, uvicorn, SIGTERM |
|
||||
| `docker.md` | `Dockerfile`, `docker-compose.yml`, `.dockerignore`, `scripts/restart.sh`, `infra/**`, `.github/ci/**`, `.github/workflows/application.yml`: мультистейдж, non-root, пины, healthcheck, стенд compose, S3 и bootstrap, секреты по сервисам, volumes, restart hook |
|
||||
| `balancer.md` | `docker-compose.yml`, `infra/haproxy/**`, `scripts/stop-one.sh`, `scripts/rolling-update.sh`: реплики за HAProxy, проверки и цепочка таймаутов, повторы LB, failover hook, поочерёдная замена, лимиты и пулы (с лабы 3) |
|
||||
| `student-tests.md` | `student-tests/**`: обязательные проверки уровня 4, black-box по HTTP, особый стенд |
|
||||
| `service-tests.md` | `service-tests/**`: быстрые тесты на фейках, контракт repo на фейке и на SQL, временная база |
|
||||
| `worker.md` | `src/worker/**`, `src/relay/**`, `src/infra/render/**`, `src/core/services/attachment_processing.py`, `attachment_relay.py`, `attachment_replay.py`, `src/utils/image_variants.py`: worker, relay, процесс обработки, claim и fencing, аренда, бюджет, лимиты, варианты, replay |
|
||||
| `bench.md` | `bench/**`: нагрузочный стенд на Postgres (проект compose `mtusi-bench`), что не меняется между метками замеров, граница чёрного ящика и планы запроса, сравнение меток, коммиты измеренных состояний |
|
||||
| `migrations.md` | `migrations/**`, `alembic.ini`, `src/infra/db/models/**`: схема до запросов, ограничения, индексы, повторный запуск миграций |
|
||||
| `telemetry.md` | `src/infra/telemetry/**`, `infra/otel/**` (с лабы 6): SDK только из `[telemetry]` и без `OTEL_*`, правило корня, запреты атрибутов, журнал через хуки, закрытие со сроком, конфигурации Collector, хранилищ и Grafana файлами для CI, сети и healthcheck |
|
||||
|
||||
- **`openspec/`** (схема `spec-driven`, язык артефактов — русский, см.
|
||||
`openspec/config.yaml`): что система делает и зачем.
|
||||
`specs/<capability>/spec.md` — текущее поведение, `changes/<change>/` —
|
||||
предложения (`proposal.md`, `design.md`, `tasks.md`, дельты спеков),
|
||||
`changes/archive/` — внедрённые. Крупную работу ведут командами
|
||||
`/opsx:propose` → `/opsx:apply` → `/opsx:verify` → `/opsx:archive`
|
||||
(ещё `explore`, `update`, `sync`). Команды в `.claude/commands/opsx/`
|
||||
ставит `openspec update`, руками их не править. Спеки не пересказывают
|
||||
контракт и правила: в `tasks.md` ссылаться на `contracts/` и
|
||||
`.claude/rules/`, а не копировать их.
|
||||
- **Граф кода** (`graphify-out/`, CLI graphify; локальный, не в git и
|
||||
не в образе, состав — `.graphifyignore`): для вопросов о структуре и
|
||||
связях — где используется, кто вызывает, что затронет правка.
|
||||
Команды: `graphify query "<вопрос>"`, `graphify path "A" "B"`,
|
||||
`graphify explain "X"`, `graphify affected "X"`. Граф — подсказка, а
|
||||
не источник правды: до обновления он отстаёт от кода.
|
||||
- Перед правкой — Read файла, как без графа: иначе правило слоя из
|
||||
`.claude/rules/` не подгрузится. Граф этого не заменяет.
|
||||
- Граф строится без LLM: код — по AST, markdown — по структуре
|
||||
(разделы становятся узлами). Раздел правила или спеки связан
|
||||
(`references`, INFERRED) с символами кода, упомянутыми в его тексте
|
||||
в обратных кавычках. Полной карты «правило → код» в графе нет — она
|
||||
в таблице выше и в `paths:` правил.
|
||||
- `query` ищет узлы по подстроке метки. В запрос — имена символов
|
||||
кода (`"ChatService ChatNotFound chat"`), а не пересказ вопроса:
|
||||
тогда в ответе и код, и разделы правил и спек.
|
||||
- В граф не попадают `.json` / `.yaml` / `.yml` (`contracts/openapi.json`,
|
||||
`docker-compose.yml`), `Dockerfile`, `Makefile` и шаблоны конфигов:
|
||||
их CLI не разбирает. По ним — `grep`.
|
||||
- Только CLI `graphify update .`. Не запускать скилл `/graphify` и
|
||||
`graphify extract`: семантический разбор документов через LLM
|
||||
стоит сотни тысяч токенов, а следующий `graphify update .` всё равно
|
||||
заменяет его структурным. Не запускать `graphify install`,
|
||||
`graphify claude install`, `graphify hook install` и `graphify
|
||||
watch`: первые два пишут секцию в `CLAUDE.md` и PreToolUse-хук на
|
||||
Read, остальные пересобирают граф без спроса.
|
||||
|
||||
## Окружение и команды
|
||||
|
||||
- Python 3.12 (`.python-version`), зависимости через uv (`uv sync`,
|
||||
`uv run ...`), lock в `uv.lock`. ruff глобальный
|
||||
(`/opt/homebrew/bin/ruff`, им же пользуется PyCharm), в проекте он в
|
||||
extra `dev`.
|
||||
- Конфиг: `.env` (то, что читают compose и контейнеры зависимостей) +
|
||||
`config.toml` (то, что читает только приложение). Читает их
|
||||
`src/config/settings.py` (pydantic-settings), все поля — в секциях.
|
||||
Приоритет: окружение > `.env` > `config.toml` > дефолты. Параметры
|
||||
приложения в `.env` пишутся в формате настроек (`APP__PORT`), без
|
||||
секции — только то, что приложение не читает (`APP_OUT_PORT`).
|
||||
`config.toml` в образ не копируется, а монтируется на старте. Режим
|
||||
`APP__RUN_MODE` (`console` / `docker`) в `.env` не хранится.
|
||||
Подробно — `settings.md`, `docker.md` и `run-modes.md`.
|
||||
- Точка входа: `python -m src` (`src/__main__.py` → `src/main.py`), порт
|
||||
8080.
|
||||
- `make test` ходит на `http://localhost:8080`. Если там отвечает чужой
|
||||
сервис, smoke упадёт с 404 на `/health/live` вместо ошибки соединения.
|
||||
Проверить, кто занял порт: `lsof -nP -iTCP:8080 -sTCP:LISTEN`,
|
||||
`docker ps`.
|
||||
- Стенд — проект compose `mtusi-lab6` со своей базой. После `make
|
||||
rolling_update` реплики называются `api-N` с растущим номером
|
||||
(compose нумерует новые контейнеры сервиса по возрастанию): штатные
|
||||
цели с ними работают, `make down` + `make run_docker` снова дают
|
||||
`api-1`, `api-2` (`balancer.md`).
|
||||
- `make instances` и публичные проверки skeleton запускаются системным
|
||||
`python3` (3.9+ на macOS), без uv: драйвер скилла — только stdlib и
|
||||
синтаксис 3.9.
|
||||
- graphify (граф кода, «Где лежат инструкции») — вне проекта, в
|
||||
`uv tool`, версия закреплена:
|
||||
- CLI: `uv tool install --python 3.12 'graphifyy==0.9.72'`. Без
|
||||
`--python 3.12` uv берёт free-threaded 3.14t, и установка падает на
|
||||
сборке `tree-sitter-rust`.
|
||||
- Сборка и обновление — одна команда `graphify update .` в корне:
|
||||
без LLM и токенов, около секунды, работает и в чистом clone. Граф
|
||||
обновляется вручную, после заметной работы (новый слой, закрыт
|
||||
change). Попутно `update` кладёт копию прошлого графа в
|
||||
`graphify-out/<дата>/` и называет кластеры по центральному узлу.
|
||||
|
||||
| Команда | Что делает |
|
||||
|---|---|
|
||||
| `make check` | офлайн-проверка структуры skeleton, JSON и синтаксиса Python-проверок |
|
||||
| `make validate PYTHON=.venv/bin/python` | полная валидация OpenAPI и примеров (валидатор стоит в dev-группе uv) |
|
||||
| `make test [BASE_URL=...]` | публичный smoke против запущенного сервера |
|
||||
| `make load` | нагрузка из `tests/load.py`; параметры — `tests/README.md` |
|
||||
| `make test-persistence ACTION_SCRIPT=scripts/restart.sh` | сохранность: создаёт данные и сессию, вызывает restart hook, проверяет те же данные прежним токеном (`tests/README.md`) |
|
||||
| `make test-failover ACTION_SCRIPT=scripts/stop-one.sh` | отказ одной API-реплики через LB: 15 с записи параллельно hook, восстановление записи ≤10 с, без дублей (`tests/README.md`). `STOP_MODE=kill` — без graceful, `STOP_ONE_LOG=<файл>` — какой `TARGET_INSTANCE_ID` и контейнер остановлен. Между прогонами — `make replicas` |
|
||||
| `make run_dev` | `make upgrade` (Postgres из compose и миграции), `make start_cache` и `make start_s3`, затем `APP__RUN_MODE=console uv run python -m src`: 127.0.0.1:8080, reload |
|
||||
| `make lint` | `ruff format` + `ruff check --fix`, дважды: так нужно из-за COM812; `tests/` и `scripts/` skeleton исключены в `[tool.ruff]` |
|
||||
| `make env_setup` | `.env.example` → `.env` со случайными `POSTGRES_PASSWORD`, `VALKEY_PASSWORD` и шестью секретами S3, `config_example.toml` → `config.toml`; существующие файлы не перезаписывает, но в существующий `.env` дописывает переменные шаблона, которых в нём нет (секреты — случайными, прежние строки не меняются); печатает только имена |
|
||||
| `make run_docker` | `make env_setup` (недостающие файлы и переменные) + `docker compose build` + `up -d`: postgres, valkey, s3 → migrate, s3-bootstrap → api × `API_REPLICAS` (2) и cleaner → haproxy на `127.0.0.1:APP_OUT_PORT`; рядом, без зависимостей приложения от них, — otel-collector, prometheus, loki, tempo и grafana на `127.0.0.1:GRAFANA_OUT_PORT` (пароль `admin` — `GRAFANA_ADMIN_PASSWORD` из `.env`); на пустых volumes — с первой попытки; `config.toml`, `infra/valkey/valkey.conf`, `infra/haproxy/haproxy.cfg` и `infra/s3/bootstrap.sh` монтируются read-only. Реплики с изменённым образом пересоздаются все разом; без простоя — `make rolling_update` |
|
||||
| `make stop` / `make down` | остановить / удалить контейнеры compose; volumes с данными остаются; S3 останавливается плавно ~15 с |
|
||||
| `make logs` | журнал всех реплик API, каждая строка — JSON (`--no-log-prefix`), реплика — поле `instance_id` |
|
||||
| `make replicas [API_REPLICAS=N]` | вернуть остановленные реплики (те же ID) и выставить их число, ждать `healthy` (`balancer.md`) |
|
||||
| `make instances` | вход одним синтетическим пользователем, 12 × `GET /users/me` через LB: `X-Instance-Id` каждого ответа и итог по репликам |
|
||||
| `driver.py upload` / `download` | загрузка файла и скачивание оригинала с SHA-256 на любом сервере (`.claude/skills/run-mtusi-messenger/SKILL.md`) |
|
||||
| `driver.py --port <LB> attachment-failover [--mode stop\|kill]` | вложение через LB, `stop-one.sh` принявшей реплики, скачивание через другую (тот же SHA-256), 404 постороннему, затем `make replicas`; доказательство исключения `attachments` «Принявшая реплика остановлена» |
|
||||
| `driver.py --port <LB> attachment-storage` | схема таблиц вложений, вид `object_key`, объект в bucket, анонимный GET — 403, `docker diff` реплик; доказательство исключения «Байты не в БД и не на диске API» |
|
||||
| `driver.py --port <LB> upload-consistency` | согласованность БД и S3 на рабочем стенде (~45 с): загрузка при `pause` S3 и со сбоем фиксации `ready` (триггер на `filename` прогона) — 503, строки `pending` не видны, компенсация удалила объект; `cleaner --once` с grace 30 с убирает обе, объектов без строки нет, готовое вложение цело; `evidence/attachments/consistency.md` |
|
||||
| `driver.py lb-upload-timeouts [--config F]` | сроки LB пути загрузки без стенда (~35 с): `haproxy -c`, временная сеть, HAProxy закреплённого образа с F (по умолчанию `infra/haproxy/haproxy.cfg`) и заглушка реплики `api` на образе API; молчание 12 с до и после тела загрузки — 201, 12 с на другом пути — 504 через ~10 с, 32 с на пути загрузки — 504 через ~30 с, клиент молчит посреди тела — 400 в формате контракта; уборка при любом исходе, код 1 при расхождении; `evidence/uploads/lb-timeouts.md` |
|
||||
| `driver.py --port <LB> s3-idle [--rounds 3]` | клиент S3 после простоя (~40 с, change `fix-upload-put-flake`): проба в реплике стенда (`docker exec -i … python -`, код и ключи образа), варианты «образ» и «эталон» с прежним `read_timeout` aiohttp; раунд — 10 одновременных медленных скачиваний 4 MiB, простой срока вызова + 0,5 с, 12 PUT; взведённые и испорченные соединения пула, PUT прошло и упало (цепочка ошибки, мс), чтение обратно; объекты под `<база>/.s3-idle-probe/` удаляются в `finally`; код 0 — у образа ни порчи, ни упавших PUT, 1 — иначе, 2 — нет стенда; `evidence/s3/idle-connection.md` |
|
||||
| `make reconcile [APPLY=1] [MAX_CHANGES=N] [STRATEGY=head] [DEEP=1] [RATE=R]` | разовая сверка bucket и БД в контейнере уборщика (`docker compose run --rm --no-deps cleaner reconcile [--apply] [--max-changes N] [--strategy batch\|head] [--deep] [--max-objects-per-second R]`): по умолчанию dry-run — записи «Found storage discrepancy» по классам и итог со стоимостью прохода; `APPLY=1` — исправить; `STRATEGY=head` — HEAD на строку, `DEEP=1` — SHA-256 содержимого, `RATE` — предел скорости (0 — без него); 0 — расхождений нет, 3 — остались (чужие объекты, отказ по пределу), 1 — прервана, 2 — конфигурация |
|
||||
| `driver.py --port <LB> reconcile-cycle` | сверка на рабочем стенде (~2 мин): исходный dry-run без расхождений (иначе код 2), расхождения с обеих сторон, dry-run без изменений, 500 → `--apply` → 404 и 200, повтор, удаление чужого объекта, свежий объект после grace, возврат оригинала; `evidence/reconcile/cycle.md` |
|
||||
| `driver.py --port <LB> reconcile-stress [--seconds S] [--clients N]` | `--apply` раз в ~3 с под загрузками и отправками N клиентов S секунд (4 × 40 с): внесённое исправлено, каждое 201 скачивается с тем же SHA-256, повтор — 0; `evidence/reconcile/stress.md` |
|
||||
| `driver.py reconcile-signal [--pace [--apply]]` | только не рабочий проект compose (`COMPOSE_PROJECT_NAME` и др., `mtusi-lab6` — код 2): `pause s3`, разовый `reconcile --apply` отдельным контейнером, `docker stop` через секунду после «Started cleaner» — код 1, `interrupted_by: stop`, «Stopped cleaner» с `exit_code` 1, быстрее 10 с; `unpause` в `finally`. `--pace` (change `track2-reconcile-cost`) — вместо `pause s3` объекты пробы мимо API и `reconcile --max-objects-per-second 1`, `docker stop` через 2 с во время паузы предела скорости — остановка ≤ 1 с, `listed_objects` — ключи страницы; `--pace --apply` (verify W1) — объекты пробы без строки, grace 18 с, `reconcile --apply`, `docker stop` посреди удалений: записей «Fixed» и `fixed` столько же, сколько удалено; объекты удаляются в `finally`; `evidence/reconcile/service.md` |
|
||||
| `make bench_reconcile [RECONCILE_LABEL=...]` | трек 2, стоимость сверки (~50 мин, метка `baseline`; change `track2-reconcile-cost`): стенд `mtusi-bench` с LB, двумя репликами, PostgreSQL, Valkey и S3 с лимитами рабочего стенда, порт метрик шлюза S3 на loopback; наполнение мимо API (`\copy` метаданных, PUT объектов загрузчиком `bench/fill_objects.py`), 1 000 × 1 MiB и 10k → 30k → 100k × 4 KiB с 0,25 % расхождений каждого класса; разовые проходы уборщика (0,25 CPU / 256 МБ, управляемый опыт — 1 CPU): `batch`, `head`, глубокая, фоновая нагрузка с пределом скорости и без, отказ по пределу на образе `Profile.reconcile_before` (`9cc6c0c`, commit переноса лабы 5 в лабу 6: ранний отказ уже есть, `bench.md`) и checkout; 3 повтора, найденное сверяется с моделью (иначе отказ), счёт сверки — с метриками шлюза; `evidence/reconcile/<метка>/` (`passes.csv`, `windows.csv`, `summary.md` с H1–H4 и S4, SVG). Перед запуском — проверка хоста (`bench.md`), рабочий стенд — `make stop` |
|
||||
| `make bench_reconcile_quick` | то же на 2 000 × 4 KiB, по одному проходу каждого вида, окна 5 с, S4 с 300 кандидатами (~4 мин: 3,7 мин на шумном хосте), метка `quick-reconcile-<время>`, в git не идёт |
|
||||
| `docker compose run --rm --no-deps cleaner --once` | разовый проход уборщика незавершённых загрузок (grace — `[cleaner]` или `-e CLEANER__PENDING_GRACE_SECONDS=…`, не меньше 18 с): 0 — проход дошёл до конца, 1 — прерван отказом, 2 — неверная конфигурация; журнал сервиса — `docker compose logs --no-log-prefix cleaner` |
|
||||
| `make lb_stats` | слоты HAProxy: адрес, состояние проверки (`DRAIN`, `MAINT` при замене), запросы, повторы, перенаправления (CSV статистики изнутри контейнера LB) |
|
||||
| `make rolling_update [COMMIT=...] [MIGRATE=0]` | поочерёдная замена реплик без простоя (`scripts/rolling-update.sh`, `balancer.md`): сборка из рабочего дерева (или файлов `COMMIT` через `git archive`), миграции один раз, затем по одной — новая `healthy` и `UP` в LB, старая `drain` → запросов в полёте 0 → `maint` → stop → rm → слот `ready`. Нужен штатный стенд (`make replicas`) без слотов LB в ручном `drain` / `maint` (иначе код 2 и команда `set server … state ready`); сбой и Ctrl+C — `API_REPLICAS` готовых реплик, повтор доводит; `MIGRATE=0` — откат на прежний образ (после него `docker compose up` без сборки не запускать: `migrate` прежнего образа упадёт на новой ревизии) |
|
||||
| `make run_worker` | worker в консоли (`python -m src.worker`, тот же `.env`, ключи `S3_WORKER_*` в окружении процесса, рецепт без эха); рядом с `make run_dev` |
|
||||
| `make run_relay` | relay в консоли (`python -m src.relay`, те же мосты `.env`); рядом с `make run_dev`: без него задания ждут в PostgreSQL |
|
||||
| `make replay [ATTACHMENT=…] [ERROR_CODE=…] [REASON=…] [LIMIT=…] [APPLY=1] [OPERATOR=…]` | реестр `failed` и возврат работы (`docker compose run --rm --no-deps relay replay …`): без `APPLY=1` только показ; с ним выбор обязателен, иначе код 2; 0 — выполнено или показано, 3 — есть отказы, 1 — отказ PostgreSQL |
|
||||
| `make start_broker` / `make stop_broker` | брокер стенда: `up -d --wait rabbitmq` / `stop rabbitmq` |
|
||||
| `driver.py --port <LB> defense-scenario` | сценарий защиты на рабочем стенде: worker остановлен → 202 → сообщение 201 → 409 → текст 201 → `scripts/restart.sh` → worker → `ready`, оригинал и thumbnail; `id` и `StartedAt`, worker запускается при любом исходе; `evidence/attachments/defense.md` |
|
||||
| `driver.py --port <LB> broker-check [--require-test-queue]` | образ и digest, volume, порт, предел памяти, очередь, остановка брокера; `evidence/broker/stand.md`, `evidence/broker/isolated.md` |
|
||||
| `driver.py --port <LB> worker-process` | PID 1, лимиты, остановка, неверные `WORKER__*`, рестарт хранилищ, остановка на двух дорогих JPEG (быстрее 9,5 с, в том числе при замороженных PostgreSQL и брокере), ~5 мин; `evidence/worker/process.md` |
|
||||
| `driver.py --port <LB> relay-process` | то же у relay: PID 1, нет healthcheck, лимиты, запись о старте, неверные `RELAY__*`, остановка простаивающего, на старте и при замороженном брокере, рестарт хранилищ; `evidence/relay/process.md` |
|
||||
| `driver.py --port <LB> defense-faults` | шаг 4 защиты на рабочем стенде (~4 мин: аренда 70 с): crash после записи объектов и после фиксации до ack, relay убит до публикации и после подтверждения до отметки, replay неудачного и отказ replay готового; триггеры на `filename` прогона снимаются, worker и relay запускаются при любом исходе; `evidence/attachments/defense-faults.md` |
|
||||
| `driver.py --port <LB> pipeline-state` | только чтение, JSON: задания по состояниям, due, ждущие срока, опубликованные и не взятые, истёкшие аренды, возраст старейшего, очередь |
|
||||
| `driver.py --port <LB> worker-memory` | память контейнера worker (~35 с): на девять случаев в пределах контракта два одинаковых файла разом, новая cgroup на случай; `memory.peak`, `VmHWM`, `render_peak`, OOM, сумма пиков меньше 1 ГБ; worker и relay запускаются при любом исходе; `evidence/worker/memory.md` |
|
||||
| `driver.py freeze-sessions [--rounds 6] [--settle 15]` | сессии PostgreSQL и журнал пула после заморозки (~2,5 мин), работает и на рабочем стенде: приложение в процессе одноразового контейнера `api`, PostgreSQL только через TCP-прокси пробы, заморожен прокси, а не сервер; режимы — между блоками и до запросов при пуле 2 и 4; `evidence/storage/freeze-sessions.md` |
|
||||
| `driver.py --port <LB> telemetry-check` | телеметрия рабочего стенда через HTTP API Grafana с паролем из `.env` (~2 мин, change `otel-telemetry`): вход, порт, источники, dashboard provisioned и неизменяем, цели Prometheus, метрики LB, панель потерь на тихом стенде — 0 (ожидание до 330 с); свой запрос → stdout → Loki → Tempo, traceparent, нестандартный метод, 401, 404; загрузка → трасса worker, недекодируемый JPEG → `failed`; рост счётчиков по репликам и исходам; S3 заморожен → span S3 с ошибкой (`unpause` в `finally`); сети хранилищ из api и worker, разовый контейнер с `OTEL_*`, проба приватности, рестарт Collector и хранилищ; `evidence/telemetry/check.md` |
|
||||
| `driver.py --port <LB> telemetry-outage` | Collector `stop` и `pause` (~3,5 мин): `make test`, загрузка до `ready`, записи SDK в stdout; возврат Collector — запись, трасса, span producer и ряды API, worker и relay при прежних `StartedAt` и `RestartCount` их контейнеров; второе окно того же вида — `make test`, `docker stop` реплики, worker и relay быстрее 10 с с кодом 0; все сервисы телеметрии остановлены — рестарт api, worker и relay, `make test`; сигналы (и span producer relay) снова приходят; стенд возвращается в `finally`; `evidence/telemetry/collector-outage.md` |
|
||||
| `make alerts_test` | правила Prometheus без стенда и сети (change `slo-alerts`): `tar` файлов `infra/otel/prometheus/` в одноразовый контейнер образа Prometheus из compose (`--network none`) — `promtool check config`, `check rules`, `test rules rules.test.yml`; затем у каждого оповещения `runbook_url` на существующий файл; шаг CI; `evidence/alerts/rules-test.md` |
|
||||
| `driver.py --port <LB> alerts-check` | учения оповещений на рабочем стенде (~25 мин, change `slo-alerts`), через HTTP API Grafana: правила загружены, доставки нет, тихий стенд (иначе код 2); фоновая нагрузка драйвера; worker остановлен — `MessengerQueueLagHigh` и счёт времени до готовности по точкам; relay остановлен — `MessengerQueueMetricsMissing`; блокировка таблицы сообщений — `MessengerSlowRequests`, доля span PostgreSQL, пул, CPU; входы по Basic — без оповещения; PostgreSQL остановлен — `MessengerNoReadyReplicas` и `MessengerHighErrorRate`, 5xx LB против API; на каждом шаге моменты pending, firing и снятия; SLI двумя путями (у доступности и задержки — и одним окном часа), новые панели и история состояний; в `finally` — нагрузка, сессия блокировки, PostgreSQL, worker, relay, LB; `evidence/alerts/check.md` |
|
||||
| `driver.py --port <LB> backend-outage` | отказ хранилищ телеметрии под нагрузкой (~18 мин, change `slo-alerts`): Loki и Tempo 10 с и 120 с, Prometheus 60 с, Collector 120 с — `make test`, 5xx у клиента, очереди и память Collector, память реплик, учёт потерь и панель потерь (Collector и SDK реплик), `TelemetryTargetDown` и `TelemetryDataLoss`, пики памяти по cgroup; сервисы телеметрии запускаются в `finally`; `evidence/telemetry/backend-outage.md` |
|
||||
| `driver.py --port <LB> trace-chain` | сквозная трасса и сигналы уровня 4 на рабочем стенде (~5 мин, change `job-trace-propagation`), через HTTP API Grafana: предусловие — глубина очереди 0 за 120 с (иначе код 2 «stand is not quiet»); очередь и её возраст при остановленном worker и спад до 0; загрузка с повтором при замороженном S3 — одна трасса: server span API, два span producer relay, два consumer span worker (parent и link, span S3 с ошибкой, запись оригинала и вариантов); replay в той же трассе; задание без контекста (`UPDATE` колонок своей строки) — корень worker; время до `ready`, пулы, ёмкость worker, пределы контейнеров = `docker inspect` и рост CPU каждого за прогон, нет сокета Docker, панели уровня 4 с данными; `unpause s3`, worker и relay — в `finally`; `evidence/telemetry/trace-chain.md` |
|
||||
| `driver.py stand-from-scratch [--runs 2]` | `make run_docker` на пустых volumes своим проектом `mtusi-lab6-scratch` (рабочий — код 2) на свободных портах (~1 мин на прогон): код 0, состояния, `RestartCount` брокера и телеметрии 0, нет `eacces`, provisioning, `make test`; проект удаляется с volumes при любом исходе, ID контейнеров рабочего стенда прежние; `evidence/stand/from-scratch.md` |
|
||||
| `driver.py freeze-lb [--rounds 3]` | только не рабочий проект compose (`COMPOSE_PROJECT_NAME`, по умолчанию `mtusi-lab6-freeze`; `mtusi-lab6` — код 2): сама поднимает стенд с данными в tmpfs (volumes нет) на образе `mtusi-messenger:lab6` и убирает его при любом исходе; `docker pause` PostgreSQL, шесть запросов через LB — 503 за ~8 с, 504 нет, `unpause` в `finally`, сессий не больше пулов (~1,5 мин); раздел `evidence/storage/freeze-sessions.md` |
|
||||
| `make start_db` / `make stop_db` | Postgres стенда: `up -d --wait postgres` / `stop postgres` |
|
||||
| `make start_cache` / `make stop_cache` | Valkey стенда: `up -d --wait valkey` / `stop valkey`; volume нет, кэш после рестарта пуст |
|
||||
| `make start_s3` / `make stop_s3` | S3 стенда: `up -d --wait s3`, затем `up --no-deps --exit-code-from s3-bootstrap s3-bootstrap` (код bootstrap — код цели: `--wait` одноразовый сервис не ждёт) / `stop s3` |
|
||||
| `make s3_check` | приватность bucket вне API на запущенном стенде (`driver.py s3-check`): bootstrap в режиме `check` (права ключей API и уборщика, чужой временный bucket, административные запросы), анонимные запросы с хоста и из сети стенда, порты контейнера S3 из сети, затем `cleanup`; таблица «где → проверка → ожидаемо → получено», код 1 при нарушении |
|
||||
| `make upgrade` | `start_db` + `uv run alembic upgrade head` с хоста (`127.0.0.1:POSTGRES_OUT_PORT`) |
|
||||
| `make revision` | `upgrade` + `alembic revision --autogenerate`, сообщение спрашивает `read -p` |
|
||||
| `make wipe_data` | `down -v` — удалить данные стенда (volumes Postgres, S3, брокера и хранилищ телеметрии называются в запросе) и кэш; только после ввода `yes` |
|
||||
| `make service_test` | быстрые тесты сервисов на фейках (`service-tests/unit`): ветки всех сервисов, архитектура (импорты, сигнатуры порт — реализация — фейк), контракт repo на фейке; без PostgreSQL, Valkey, S3, брокера, docker и сети, секунды (`service-tests.md`) |
|
||||
| `make service_test_db` | `start_db` и `service-tests/db` на временной базе `test_uow_<db>`: настоящая единица работы, тот же контракт repo на SQL, соединение на шаг и общий срок JSON-запроса в процессе (S3 и кэш — фейки), замороженный сервер — TCP-прокси; база удаляется при любом исходе, имя не по шаблону — код 2 |
|
||||
| `make test_isolated [KEEP_TEST_DB=1]` | образ на временной базе `test_<db>` с Valkey и S3 стенда (ключи кэша и объектов разделены именем базы): сборка, миграции, отдельный контейнер API на `TEST_APP_PORT`, `make test` + `make student_test EXPECT_REPLICAS=1` (тесты реплик пропускаются с причиной), уборка при любом исходе — база и объекты под префиксом `test_<db>/` (`student-tests.md`) |
|
||||
| `make student_test [BASE_URL=...] [EXPECT_REPLICAS=...]` | собственные тесты `student-tests/` (pytest) против запущенного сервера, кроме проверок отказов (`-m 'not fault'`); `EXPECT_REPLICAS` (по умолчанию `API_REPLICAS`) — сколько реплик за `BASE_URL`, против одного процесса — 1; сервер недоступен — код 2 и одна строка с адресом |
|
||||
| `make failure_checks [FAULT_ARGS=...]` | проверки отказов (`pytest -m fault`, 147 проверок, ~39 мин) на отдельном стенде: проект `<рабочий>-failures` со своими Postgres, Valkey и S3 (с bootstrap), уборщик (grace 20 с, интервал 1 с), пять API — обычный, «тесный» (срок 2 с, пул 1), «узкий по загрузкам», «с коротким сроком S3» (1 с) и «узкий по заданиям» (предел 3; у прочих предел выключен), hook `student-tests/fault_hook.py`; после тестов — журнал PostgreSQL стенда: сводка (`crash markers`, «too many clients», «administrator command») и ненулевой код при признаках аварийного перезапуска; стенд и его volumes удаляются при любом исходе, рабочий не трогается (`student-tests.md`) |
|
||||
| `make bench [BENCH_LABEL=...]` | полная матрица 10k / 100k / 500k читаемого чата плюс 100 000 сообщений в 1 110 фоновых чатах разного размера (~35 мин, оценка по `bench_quick`) на своём проекте compose `mtusi-bench` (HAProxy и одна реплика API, Postgres, Valkey с лимитами, без портов хоста и без `.env` рабочего стенда; k6 ходит через LB); на каждый размер — свежий стенд, `VACUUM (ANALYZE)`, планы запроса истории (`auto_explain`) по уровням чатов с вариантами индекса и запроса, в конце — пробы стоимости записи по вариантам. Результаты в `evidence/bench/<метка>/`, занятая метка — отказ. Перед запуском — подготовка хоста (`bench.md`) |
|
||||
| `make bench_quick` | самопроверка стенда на 1k / 5k / 10k и 3 500 фоновых сообщений (~3 мин), метка `quick-<время>`, в git не идёт |
|
||||
| `make bench_restore [RESTORE_LABEL=...]` | трек 2, восстановление (~20 мин, метка `restore` по умолчанию): тот же стенд и данные, без матрицы прогонов; на каждый размер — `pg_dump` во время записи через HTTP, активность после backup, `pg_restore -j` в новый контейнер Postgres на новом volume, сверка обеих баз построчно, переключение API, проверки через HTTP до и после `FLUSHALL`; время dump / restore / RTO и потерянные сообщения — в `summary.md` |
|
||||
| `make bench_restore_quick` | то же на 1k / 5k / 10k (~1,5 мин), метка `quick-restore-<время>`, в git не идёт; сценарий защиты трека 2 |
|
||||
| `make bench_failover [FAILOVER_LABEL=...]` | уровень 4, отказ реплик под нагрузкой (~6 мин, метка `baseline` по умолчанию): стенд `mtusi-bench` с HAProxy и двумя репликами с лимитами рабочего стенда, k6 — 100 записей с ключом и 100 чтений в секунду; каждая реплика в режимах `stop`, `kill`, `pause` с возвратом. Посекундная шкала, время исключения из LB и восстановления, сверка записей после повтора с тем же ключом, CPU и память каждого компонента по окнам фазы (сэмплер `scan`, `resources.csv`, `samples.csv`; CPU на запрос — только до действия) — `evidence/failover/<метка>/`. Перед запуском — проверка хоста (`bench.md`): питание, давление памяти, `Swapouts` без роста; сумма лимитов на пике больше CPU ВМ — код 2 |
|
||||
| `make bench_failover_quick` | то же короче, режимы `stop` и `kill` (~2 мин), с ресурсами, метка `quick-failover-<время>`, в git не идёт |
|
||||
| `make bench_rollout [ROLLOUT_LABEL=...]` | уровень 4, поочерёдная замена под нагрузкой (~3 мин, метка `baseline` по умолчанию): стенд `mtusi-bench` как у `bench_failover`, реплики на образе прежнего commit (`Profile.rollout_from`, `git archive`; сейчас `9cc6c0c` — commit переноса лабы 5 в лабу 6, правило выбора — `bench.md`; commit вне истории — код 2 до стенда, отладка `--from`), та же нагрузка; посреди неё `scripts/rolling-update.sh` меняет их на образ текущего checkout. Посекундная шкала с ответами старых и новых реплик, шаги по репликам, контейнеры, образы и ревизия до и после, сверка записей, CPU и память каждой старой и новой реплики, миграции и остальных компонентов по окнам до / подготовка / замена / после (CPU на запрос — до и после) — `evidence/rollout/<метка>/`. Перед запуском — проверка хоста (`bench.md`) |
|
||||
| `make bench_rollout_quick` | то же с короткими окнами (~2 мин), с ресурсами, метка `quick-rollout-<время>`, в git не идёт |
|
||||
| `make bench_scaling SERIES=a\|b\|pool\|ab\|db\|db4 [SCALING_LABEL=...] [RESUME=1]` | уровень 5, трек 1: серия на стенде `mtusi-bench` (метка `scaling-<серия>` по умолчанию). `a` — бюджет 4 CPU: 1 × 4, 2 × 2, 4 × 1 (~50 мин); `b` — 1…6 реплик по 1 CPU (~100 мин); `pool` — 4 реплики при `max_connections` 100 и 50 (~35 мин); `ab` — 1 × 1 и 6 × 1 для «до/после» и A/A (~35 мин); `db` — 1, 2, 4 реплики при PostgreSQL 0,5 CPU и контроль 4 × 1 при 2 CPU (~50 мин); `db4` — только 4 × 1 при 0,5 и 2 CPU (~25 мин, «до/после» `scaling-improvement`); `db_quick` — самопроверка серии `db` (~4 мин, метка `quick-*`). Ячейка — конфигурация × повтор (3), свежий стенд; открытая модель 70/20/10, фиксированные 250 и 500/с и поиск R* по SLO; сэмплер контейнеров, ВМ, LB и PostgreSQL. `RESUME=1` — продолжить прерванную метку на том же commit. Перед запуском — проверка хоста, рабочий стенд — `make stop`; метку коммитить до следующей серии (`bench.md`) |
|
||||
| `make bench_scaling_quick` | самопроверка серий: 1 × 1 и 2 × 1 при `max_connections` 50, короткие окна (~4 мин), метка `quick-scaling-<время>`, в git не идёт |
|
||||
| `make bench_uploads [UPLOADS_LABEL=...]` | уровень 4, память при одновременных загрузках (~50 мин, метка `baseline` по умолчанию; change `upload-memory`): стенд `mtusi-bench` с LB, одной репликой 1 CPU / 512 МБ без swap, PostgreSQL, Valkey и S3 рабочего стенда; варианты «до» (`Profile.uploads_before` — `9cc6c0c`, commit переноса лабы 5 в лабу 6: места загрузки уже есть, успех 202, `bench.md`; `git archive`; commit вне истории — код 2), «без лимита» (1000 мест, без очереди) и «с лимитом» (по умолчанию) × тела PNG ~1 и ~10 MiB × 1 / 10 / 20 / 40 клиентов × 3 повтора, на прогон — новые реплика и volume S3; пик `memory.peak` окна со сбросом (сэмплер `peak`), `anon`, `sock`, OOM, ответы по кодам, загрузок/с, p50/p95/p99, пики S3 и LB, H1–H4 в сводке — `evidence/uploads/<метка>/`. Перед запуском — проверка хоста (`bench.md`), рабочий стенд — `make stop`, гипотезы закоммичены раньше |
|
||||
| `make bench_uploads_quick` | то же короче (~4,5 мин): «без лимита» и «с лимитом», 10 MiB, 1 / 10 / 40 клиентов, один повтор, метка `quick-uploads-<время>`, в git не идёт |
|
||||
| `make bench_queue [QUEUE_LABEL=...] [RESUME=1]` | уровень 5, трек 1, очередь под перегрузкой (~2 ч 10 мин, метка `baseline` по умолчанию; заняты `baseline`…`baseline4`, основная — `baseline4`, новый прогон — со своей `QUEUE_LABEL`; change `track1-queue-overload`): стенд `mtusi-bench` с S3, брокером, relay, worker и уборщиком, настройки (1, 1), (2, 2), (4, 4), (2, 256) × классы `s`, `m`, `lj`, `lp` × 3 повтора и блоки предела, приёма, второго worker, KILL worker, рестарта брокера; на ячейку — свежий стенд, открытая модель, контрольный поток, разбор очереди, обход метаданных; `evidence/queue/<метка>/` (`meta.json`, `cells.csv`, `timeline.csv`, `summary.md` с H1–H9 и рекомендацией, SVG). Рабочий стенд — `make stop`, гипотезы закоммичены раньше метки |
|
||||
| `make bench_queue_quick` | то же короче (~11 мин): `s` (2, 2), `lp` (4, 4), предел 40 и без него, `kill-worker`, `w2-p256`, один повтор, метка `quick-queue-<время>`, в git не идёт; шаг защиты «для 5» лабы 5 |
|
||||
| `TELEMETRY=on` у `make bench_uploads`, `bench_uploads_quick`, `bench_queue`, `bench_queue_quick` | выключатель телеметрии стенда (change `track1-telemetry-cost`, по умолчанию `off` — методика прежняя): Collector, Prometheus, Loki и Tempo рабочего стенда (`bench/telemetry.compose.yml`, без Grafana) и SDK реплик, worker и relay с настройками рабочего стенда; режим — в паспорте и сводке, `RESUME=1` — только в том же режиме; у очереди — столбцы `tel_*` в конце `cells.csv` и предупреждение о сумме лимитов CPU (12,25 при 12 у ВМ) вместо кода 2; у других профилей `--telemetry on` — код 2 до стенда |
|
||||
| `make bench_telemetry [TELEMETRY_LABEL=...] [RESUME=1] [VARIANTS=...]` | уровень 5, трек 1 «Цена наблюдаемости» (~1 ч 25 мин, метка по умолчанию `baseline`: её первая попытка не снята, каталог удалён; основная — `baseline2`, код `68e14b6`, метка в `0f5dbfc`; change `track1-telemetry-cost`): проверка конфигураций до стенда (лимиты телеметрии против `docker-compose.yml`, слои Collector `validate` и `print-config`, `prometheus-lean.yml` построчно и `promtool`) — иначе код 2; стенд `mtusi-bench` профиля очереди и, в вариантах с телеметрией, сервисы телеметрии рабочего стенда; варианты `off`, `full`, `full-aa`, `head` (доля 0,1), `tail` (типовой tail sampling), `metrics` (30 с, `coarse`, отбор рядов), `balanced` × 3 повтора кругами, свежий стенд на прогон; открытая нагрузка `k6/telemetry.js` (окна 30 + 90 + 30 с) и редкие события: 500 вложения без объекта, недекодируемый JPEG, регистрация, медленные записи под блокировкой; выборка из Tempo, Loki и Prometheus (`telemetry_lookup.py`), сэмплер `cost`, размер volume; вариант не применён (записи о старте, слои) — отказ; `evidence/telemetry-cost/<метка>/` (`meta.json`, `runs.csv`, `components.csv`, `classes.csv`, `summary.md` с H1–H8 и B1–B5, SVG, `raw/`); `VARIANTS` — отладка. Рабочий стенд — `make stop`, гипотезы закоммичены раньше метки |
|
||||
| `make bench_telemetry_quick [VARIANTS=...]` | то же короче (~20 мин): шесть вариантов без `full-aa`, один повтор, окна 10 + 30 + 15 с, метка `quick-telemetry-<время>`, в git не идёт; калибровка до гипотез; шаг защиты «для 5» — `VARIANTS=off,full,tail` (~10 мин) |
|
||||
| `make bench_plots LABELS="..." [PLOTS=scaling]` | графики SVG и сводка серий трека 1 из меток: R* от числа реплик, p95 от интенсивности, CPU по компонентам, эффективность и точка насыщения — `evidence/plots/<PLOTS>/` |
|
||||
| `make bench_ab BEFORE=... AFTER=... REAPPLY=<commit> [SERIES=...]` | «до» и «после» одного изменения подряд (два прогона `bench`): `bench` для `BEFORE`, commit доказательств, `git revert` commit отката `REAPPLY`, `bench` для `AFTER`; с `SERIES` — серия трека 1 вместо матрицы (`make bench_scaling`). Нужно чистое рабочее дерево; сама делает два коммита |
|
||||
| `make bench_compare BEFORE=... AFTER=... [AA=...] [CHANGE=...]` | дельта двух меток `make bench` по ячейкам матрицы, у серий трека 1 — по общим конфигурациям (R*, задержки на фиксированных уровнях, CPU на запрос) и таблица PostgreSQL на R* и первой нарушившей ступени (CPU на запрос, новые сессии, соединения); `CHANGE` — change в шапке сравнения серий (по умолчанию `scaling-bench`); метки с разной методикой не сравнивает (в том числе метку без LB с меткой стенда на LB и серию с матрицей); с `AA` (метка того же кода, что `BEFORE`) отделяет эффект от шума. Результат в `evidence/compare/<до>__<после>.md` |
|
||||
|
||||
Разовая подмена внешнего порта — аргументом make:
|
||||
`make run_docker APP_OUT_PORT=8090`, затем
|
||||
`make test BASE_URL=http://localhost:8090`. Префикс окружения
|
||||
(`APP_OUT_PORT=8090 make ...`) не работает: Makefile подключает `.env`
|
||||
(`run-modes.md`, Troubleshooting).
|
||||
|
||||
## Карта кода
|
||||
|
||||
Файлы домена называются одинаково во всех слоях (`user`, `chat`,
|
||||
`message`, `session`, `idempotency` и т.д.).
|
||||
|
||||
```
|
||||
src/
|
||||
__main__.py # python -m src: early_stop.install() до импорта приложения → main.main()
|
||||
main.py # FastAPI app: lifespan, middlewares, обработчики ошибок, uvicorn.run
|
||||
worker/__main__.py # python -m src.worker: early_stop.install("worker") до импорта → main(); неверные настройки — запись без значений и код 2; os._exit в конце
|
||||
worker/main.py # worker обработки вложений: свои engine, S3 и потребитель; цикл соединений с паузой, задачи доставок (prefetch) под семафором concurrency, сервис и SqlAlchemyUnitOfWork на доставку, ack / requeue / drop по итогу, SIGTERM — начатые ждут в срок, закрытие клиентов одним gather; с лабы 6 — телеметрия messenger-worker, consumer span и histogram по исходу доставки (JobDeliveryOutcome, error — на исключении) после места конкуренции, закрытие SDK в окне gather; с change job-trace-propagation — consumer span дочерний к delivery.trace_context с link, итог handle — JobDeliveryResultDTO (атрибуты попытки и причины, messenger.job.time_to_ready), счётчики WorkerLoad «ждут места» и «заняты» вокруг семафора и observe_worker
|
||||
worker/render.py # процесс обработки: python -m src.worker.render, лимиты первыми строками (RLIMIT_AS, RLIMIT_CPU, RLIMIT_CORE), затем Pillow; stdin — байты, stdout — строка JSON и варианты, коды 0/3/4/5
|
||||
relay/__main__.py # python -m src.relay: early_stop.install("relay") до импорта → main(); неверные настройки — запись без значений и код 2; os._exit в конце
|
||||
relay/main.py # relay: свои engine, SqlAlchemyUnitOfWork и издатель, цикл проходов с паузами, отказ брокера и PostgreSQL не роняет, SIGTERM — текущий шаг и выход 0; replay — разовая команда реестра, коды 0/3/1/2 (без SDK); с change job-trace-propagation — телеметрия messenger-relay после disarm, instrument_engine, QueueSnapshots и observe_queue (снимок после успешного прохода не чаще 5 с, отказ PostgreSQL — пропуск), закрытие SDK в окне gather 0,5 с
|
||||
cleaner/__main__.py # python -m src.cleaner [--once]: early_stop.install("cleaner") до импорта → main(); неверные настройки — запись без значений и код 2
|
||||
cleaner/main.py # уборщик незавершённых загрузок: проверка grace > 2 × request_timeout + s3 timeout (иначе код 2), свой engine, SqlAlchemyUnitOfWork на сервис и клиент S3, цикл с интервалом и плановой сверкой (при старте и раз в [reconciler] interval_seconds), SIGTERM — довести текущий шаг и выйти 0, --once — коды 0/1/2; reconcile [--apply] [--max-changes N] [--strategy batch|head] [--deep] [--max-objects-per-second R] — разовая сверка, коды 0/3/1/2; плановая — batch, поверхностная, предел скорости из настроек
|
||||
config/settings.py # Settings (pydantic-settings), экземпляр settings; [app] instance_id (пусто → hostname) и keep_alive_seconds, [database] pool_size 10 и max_overflow 0 (постоянный пул без переполнения), idle_in_transaction_timeout_ms, [s3] адрес, bucket (валидатор имени), ключи API, регион, сроки, пул и endpoint_url, [idempotency] ttl_seconds, [uploads] max_concurrent 4, max_waiting 16, wait_timeout_seconds 5, body_timeout_seconds 30 (места загрузок процесса API), max_unfinished_jobs 250 (предел незавершённых заданий стенда; 0 — без него), [cleaner] interval_seconds 60, pending_grace_seconds 900, batch_size 100, [reconciler] interval_seconds 3600, page_size 1000, max_changes 100, max_objects_per_second 2000 (предел скорости сверки; 0 — без него); [telemetry] enabled, otlp_endpoint, environment, trace_sample_ratio 1 (доля корней в голове, change track1-telemetry-cost), metric_buckets default|coarse, metric_export_interval_seconds 15 (≤ 30), очереди и сроки SDK
|
||||
api/
|
||||
routers/health.py # /health/live, /health/ready: вне версии, без идентификации
|
||||
routers/v1/<domain>.py # ручки под /api/v1, сборка в routers/v1/__init__.py; Idempotency-Key — параметр POST сообщения (message.py); attachment.py — один роутер с двумя префиксами: загрузка (тело через request.stream(), схема — openapi_extra, строгий UTF-8 filename по scope["query_string"]), метаданные, байты StreamingResponse
|
||||
schemas/<domain>.py # pydantic-модели запросов и ответов = схемы контракта; common.py — UuidIn: UUID от клиента (путь, тело) только в записи 8-4-4-4-12; attachment.py — DisplayFilename (отказ на / \ Cc и пробелы) и Attachment; message.py — CreateMessage с attachment_ids и валидатором пустого текста
|
||||
dependencies.py # get_uow (SqlAlchemyUnitOfWork на запрос), request_deadline (общий срок JSON-запроса), фабрики сервисов на UowDep (с кэшем; вложения — ещё S3 и места), разбор Basic, текущая сессия по Bearer, пагинация; TraceContextDep — контекст W3C server span для задания загрузки (change job-trace-propagation)
|
||||
errors.py # доменное исключение → статус + code (+ WWW-Authenticate), формат ошибки контракта; RETRY_AFTER — Retry-After у 429 занятых мест загрузки и предела заданий (UploadBacklogFull, 5 с); у 500 — X-Request-Id и X-Instance-Id
|
||||
middlewares/ # X-Request-Id, X-Instance-Id и access-лог; с лабы 6 — server span и histogram http.server.request.duration (не для health), итоговая запись внутри span
|
||||
core/
|
||||
ports/uow.py # AbstractUnitOfWork: блок, commit, rollback, blocks_opened, правила вложенного входа и repo вне блока, UnitOfWorkError; реальные шаги — _open, _close, _commit, _rollback реализации; Repositories
|
||||
ports/<domain>.py # Abstract<Domain>Repository: абстрактные методы, докстринг — контракт (None, False, условие перехода); импорты — только DTO, enum, src.utils
|
||||
repos/<domain>.py # SqlAlchemy<Domain>Repository: одна атомарная операция на метод; chat_cache и attachment_object — модульные функции над клиентом
|
||||
repos/idempotency.py # ключ идемпотентности: захват ON CONFLICT DO UPDATE WHERE просрочен, чтение сохранённого результата
|
||||
repos/chat_cache.py # карточка чата в Valkey: ключ с именем базы, JSON ↔ ChatFullDTO
|
||||
repos/attachment_job.py # задание вложения: вставка, lock_job FOR UPDATE, start_attempt, return_to_queued своей попытки, finish_job; count_unfinished (предел принятой работы: сумма трёх count с LIMIT по частичным индексам); relay — lock_due_jobs (SKIP LOCKED, порядок срока), count_published, mark_published пакета, recover_expired_leases, has_published_before, reset_published_before; replay_job, list_failed; с change job-trace-propagation — колонки traceparent и tracestate во вставке и выборках, queue_snapshot (стадии scheduled / outbox / published / processing и LEAST трёх min(created_at) одним выражением по частичным индексам)
|
||||
repos/attachment_job_replay.py # журнал replay: вставка записи аудита, чтение по заданию
|
||||
repos/attachment_variant.py # варианты: вставка ON CONFLICT DO NOTHING по ключу эффекта, варианты вложения, один по имени
|
||||
repos/attachment.py # строки вложений: вставка pending (created_at = updated_at), mark_queued (pending и непомеченная → queued RETURNING), mark_processing, return_to_queued, return_group_to_queued, replay_failed, lock_attachment (FOR NO KEY UPDATE), commit_ready, commit_failed, чтение одной и до 10; очистке staging — get_staging_candidates, lock_staging_candidate, clear_staging_key; уборщику — get_stale_pending (keyset по частичному индексу), lock_stale_pending (FOR UPDATE SKIP LOCKED), mark_removing (пометка updated_at), delete_attachment; сверке — get_attachments_for_objects (id = ANY OR object_key = ANY), get_ready_page (keyset ready по id), find_attachment_reference, mark_lost / clear_lost (условный UPDATE lost_at)
|
||||
repos/attachment_object.py # объекты в S3: staging_key <база>/staging/<id>/original, variant_key и parse_variant_key <база>/attachments/<id>/v<N>-<имя>, оригинал <база>/attachments/<id>/original, put_original (поток BytesIO и size, без копии тела), open, delete_original; сверке — originals_prefix, is_own_key (ключ под префиксом вложений своей базы), parse_original_key, list_originals, probe_originals (bucket на месте), head_original, staging_prefix, is_own_staging_key, parse_staging_key, list_staging; variant_keys — ключи вариантов всех имён
|
||||
repos/message.py # MESSAGE_COLUMNS с ARRAY(подзапрос attachment_ids по position), вставка связей одной вставкой
|
||||
services/<domain>.py # <Domain>Service(uow, …): логика, проверки доступа, id и время, логи; чаты и сообщения — с кэшем, require_member внутри чужого блока; отправка — ключ, сообщение и связи с вложениями одним блоком
|
||||
services/attachment.py # AttachmentService(uow, cache, storage, slots): загрузка (проверки в первом блоке и там же предел заданий count_unfinished, 429 UploadBacklogFull → место загрузки, 429 → тело со счётчиком и сроком в BytesIO, 400 по сроку → структура и SHA-256 в потоке над getvalue() → del → pending → PUT в staging тем же BytesIO → queued и задание, ответ 202; сбой до COMMIT или пропавшая строка — удаление объекта и 503; брокера в пути нет; место — до ответа), метаданные с вариантами, отдача потоком
|
||||
services/attachment_processing.py # AttachmentProcessingService(uow, storage, renderer, stop): разбор сообщения, claim с арендой и бюджетом, GET staging и сверка, PUT оригинала, варианты через ImageRenderer, PUT вариантов, фиксация ready с fencing одной транзакцией; временные ошибки — queued со сроком (retry_delay, jitter) и ACK, постоянные — failed; JobOutcome; итог handle — JobDeliveryResultDTO (исход, попытка, причина, код, время до ready без replay)
|
||||
services/attachment_relay.py # AttachmentRelayService(uow, publisher): проход — истёкшие аренды, потерянные сообщения, публикация с подтверждением и отметка пакета внутри транзакции SKIP LOCKED, предел опубликованных; RelayPassDTO; элементы JobPublicationDTO (publication: попытка, replay, причина, контекст задания), queue_snapshot — один блок
|
||||
services/attachment_replay.py # AttachmentReplayService(uow): реестр failed, replay одной транзакцией с аудитом и новым бюджетом, отказы not_found / already_ready / not_failed / source_gone; ReplayPassDTO
|
||||
services/attachment_cleanup.py # AttachmentCleanupService(uow, storage): проход уборщика — кандидаты keyset, каждая строка в два шага (remove_stale_pending): блокировка и пометка (commit) → блокировка, DELETE объекта и DELETE строки (commit); отказ S3 или БД прерывает проход, SIGTERM — после текущего шага; CleanupPassDTO; clean_staging — очистка staging ready и failed по сроку под FOR NO KEY UPDATE SKIP LOCKED, StagingCleanupPassDTO
|
||||
services/attachment_reconcile.py # AttachmentReconcileService(uow, storage): сверка bucket и БД — S3 → БД (страницы списка, выборка на страницу, множество ключей), БД → S3 (keyset ready; ключ строки вне префикса вложений — чужой объект без HEAD; строка с ключом <id>/original другого вложения — HEAD её объекта, verify W2), зависшие, перепроверка в БД и HEAD (bucket — probe), сигнал — перед каждым вызовом хранилища, предел изменений, действия с apply (зависшие шагом уборщика → объекты без строки → объекты staging без строки → пометки → снятия); журнал Found / Fixed / Finished; ReconcilePassDTO. С change pipeline-reliability: шаг _list_staging, orphan_staging, listed_staging. С change track2-reconcile-cost: strategy head (выборка строки на объект, HEAD на строку, без множества), deep (GET и SHA-256 потоком, checksum_mismatch; «оригинал вернулся» — тот же SHA-256), предел скорости после каждого вызова S3 (_pace, куски 0,2 с; сигнал прекращает паузу, останавливает следующий check_stop — verify W1), ранний отказ по пределу (unchecked), счёт сеансов — uow.blocks_opened, стоимость в итоге (storage_objects, s3_requests, read_bytes, db_sessions, phase_ms)
|
||||
exceptions/<domain>.py # доменные исключения, реэкспорт в __init__.py; storage.py — ObjectStorageUnavailable (503) и StoredObjectMissing; attachment.py — 404, 413, 415, 400 обрыва и срока тела (UploadTimedOut), 429 занятых мест (UploadsBusy), 429 предела заданий (UploadBacklogFull), 500 пропавшего объекта
|
||||
infra/
|
||||
early_stop.py # ранний обработчик SIGTERM/SIGINT (только stdlib): до старта сервера — запись «Stopped <процесс> before startup» (API, cleaner) и выход 0; disarm() — первая строка lifespan; write_record — запись мимо structlog
|
||||
logger.py # structlog, get_logger(), contextvar-ы request_id / user_id, instance_id в каждой записи; с лабы 6 — хуки телеметрии (export_to_telemetry, add_trace_fields: trace_id и span_id активного span) в обеих цепочках и RateLimitFilter записей opentelemetry.* (одна в минуту на логгер); SDK не импортирует
|
||||
telemetry/ # change otel-telemetry и job-trace-propagation (telemetry.md): core.py — только opentelemetry-api: start (SDK загружает модуль sdk.py, ресурс из четырёх атрибутов), remove_otel_environment, begin_shutdown / wait_closed / shutdown (daemon-потоки и срок), child_span (правило корня, ошибка — класс без текста), server_span / finish_request (span SERVER и histogram http.server.request.duration), PROPAGATOR (W3C без baggage), current_trace_context, remote_context, Exporters (in-memory для тестов); sdk.py — единственный импорт SDK, экспортёра и requests: провайдеры только из [telemetry], ParentBased(ALWAYS_ON), cumulative, View границ трёх histogram, без exemplars и atexit, otlp_metric_reader / otlp_span_exporter / otlp_log_exporter; с change slo-alerts — сначала MeterProvider, затем процессоры и экспортёры span и журнала с ним внутри _internal_metrics (внутренние метрики SDK otel.sdk.*, переменная SDK только на время сборки), гистограммы SDK — DropAggregation; messaging.py — producer_span (PRODUCER publish <очередь> под сохранённым контекстом, заголовки), consumer_span (CONSUMER дочерний к контексту сообщения с link, без него — корень) и JobObservation (итог доставки: атрибуты, messenger.job.duration и time_to_ready); metrics.py — observe_pool (db.client.connection.* по текущему пулу engine), WorkerLoad / observe_worker, observe_queue (gauge по последнему снимку, старше 30 с — ничего); container.py — cgroup v2 (cpu.stat, memory.current, cpu.max, memory.max); db.py — instrument_engine (слушатели before/after_cursor_execute, handle_error, метрики пула), commit_span; logs.py — экспорт записи structlog в логгер SDK и trace_ids, install_log_hooks; setup.py — start_process_telemetry(<service.name>, cgroup_root=…): OTEL_* с warning, провайдеры, метрики контейнера (нет cgroup — одна запись), хуки; с change track1-telemetry-cost — sdk.sampler (доля 1 — ParentBased(ALWAYS_ON), иначе ParentBased(TraceIdRatioBased)), границы по набору metric_buckets, TracerProvider с meter_provider и Tracer в окне внутренних метрик (otel.sdk.span.started; otel.sdk.span.live — DropAggregation), setup.startup_fields — поля телеметрии записи о старте API, worker и relay
|
||||
password.py # Argon2id в потоке со своим лимитом, фиктивный хэш для неизвестного username
|
||||
broker/client.py # aio-pika: JobPublisher relay (соединение лениво, publish_many с confirm и общим сроком, ready_messages, сброс после любой ошибки), JobConsumer worker (своё соединение, prefetch), JobDelivery, queue_name <база>.attachment.process.v1; с change job-trace-propagation — span producer и заголовки traceparent / tracestate в _publish_one, JobDelivery.trace_context из заголовков (trace_context_from_headers)
|
||||
render/client.py # ImageRenderer: процесс обработки на задание, окружение без секретов, срок и kill в finally, разбор вывода, коды в ImageRejected / RenderInterrupted; span render attachment variants (размер входа, исход, код выхода, пик)
|
||||
upload_slots.py # UploadSlots (asyncio.Semaphore по порядку прихода, счётчик ожидающих, срок ожидания; slot() — UploadsBusy или ожидание в мс, место в finally) и глобал upload_slots из [uploads]; импортирует только dependencies.py
|
||||
db/engine.py # фабрики engine и сессий, BoundedCloseConnection, ping; _ping_once — проверка соединения при выдаче одним обменом; CountingQueuePool (poolclass engine, change job-trace-propagation): connect() со счётом ожидающих и отказов по сроку, pending(), timeouts()
|
||||
db/session.py # глобалы engine и session_factory процесса API
|
||||
db/scope.py # session_scope(factory, timeout_seconds): сессия на блок, срок вместе с откатом, отмена и отказ БД → invalidate, warning, ServiceUnavailable; deadline_scope — общий срок JSON-запроса без сессии, внутри него таймер блока той же задачи не взводится
|
||||
db/uow.py # SqlAlchemyUnitOfWork(factory, timeout_seconds) поверх session_scope, repo на блок; импортируют только точки входа; span COMMIT в _commit
|
||||
db/errors.py # is_db_unavailable: какие ошибки драйвера — 503
|
||||
db/models/ # модели SQLAlchemy (Base с created_at и to_dict); idempotency.py — ключи, FK на сообщение отложен до commit; attachment.py — Attachment (частичный индекс pending по (created_at, id), lost_at — пометка потерянного оригинала) и MessageAttachment (порядок position, FK без каскада)
|
||||
cache/client.py # create_cache (redis-py: повтор только на обрыв, блокирующий пул), Cache: срок на команду, отказ — промах и пропуск; span GET / SET без ключа с messenger.cache.result
|
||||
cache/instance.py # глобал cache процесса API
|
||||
s3/client.py # create_object_storage (aiobotocore: path-адресация, без повторов, пул), ObjectStorage: put (поток read/seek/tell и size) / head / open (чтение блоками) / delete / list_page (ListObjectsV2 по префиксу, нет bucket — ошибка), срок на вызов и блок — единственный срок клиента (read_timeout aiohttp выключен: переживал ответ и портил соединение в пуле, change fix-upload-put-flake), ошибки → ObjectStorageUnavailable / StoredObjectMissing; StoredObjectInfo (с last_modified, у open — тоже), StoredObject, StoredObjectPage; счётчики попыток по операциям, ключей списка и прочитанных байт — stats() → StorageStats (change track2-reconcile-cost); span S3.<Операция> в _call без ключа (нет объекта у HEAD и DELETE — исход missing, не ошибка)
|
||||
s3/instance.py # глобал object_storage процесса API, namespace — имя базы; start() и aclose() в lifespan
|
||||
schemas/
|
||||
jobs/attachment.py # AttachmentJobMessage (pydantic по contracts/jobs.schema.json) и build_job_body
|
||||
dataclasses/<domain>.py # DTO между repo → service → api
|
||||
enums/<domain>.py # StrEnum доменов, RunModeEnum; attachment.py — AttachmentStatus, ImageType, ReconcileFinding, ReconcileAction, ReconcileStrategy (batch, head), JobDeliveryOutcome (исход доставки worker → JobOutcome)
|
||||
utils/
|
||||
image_variants.py # render_variants: thumbnail, crop, optimized из одного декодирования, fit_size вниз своим расчётом, EXIF orientation, alpha на белый у JPEG, InvalidImage; импортирует Pillow, поэтому только src/worker/render.py
|
||||
constants.py # лимиты контракта (с лабы 4 — 10 MiB, 40 млн пикселей, filename, 10 вложений), размер страницы, префиксы путей, имя bucket S3, разделитель и части ключа объекта, keep-alive клиента S3
|
||||
image.py # inspect_image: структурная проверка PNG/JPEG без декодирования пикселей (stdlib), тип, размеры, UnsupportedImage / DamagedImage / TooManyPixels; у JPEG ещё таблицы DQT/DHT, компоненты и полоса скана, определённые к скану таблицы (0 и 1 Хаффмана непрогрессивного кадра — необязательны), данные скана Хаффмана — условия отказа djpeg
|
||||
utc.py # utcnow() (aware UTC), формат RFC 3339 с Z
|
||||
cursor.py # непрозрачный keyset-курсор: кодирование и разбор; поля проверяются по отдельности, незнакомые игнорируются, смена формата — новая CURSOR_VERSION
|
||||
student-tests/ # black-box тесты по HTTP (уровень 4): make student_test
|
||||
conftest.py # BASE_URL, EXPECT_REPLICAS и фикстура replicas (пропуск против одного процесса), проверка доступности, фикстуры alice/bob/eve/chat и stand/tight_api/uploads_api/s3_api/backlog_api, сбор маркеров spec, стоп без hook
|
||||
api_client.py # Api поверх httpx; Actor.headers() — единственное место идентификации; post_message/send_message (с attachment_ids) — с Idempotency-Key; post_attachment/upload, attachment_meta, attachment_content, attachment_content_slowly (потоком с паузой после блока)
|
||||
contract.py # тела по схемам contracts/openapi.json, форматы id, attachment_ids и времени, X-Instance-Id, assert_error (с 413, 415 и 429 — Retry-After положительное целое), assert_errors (статусы всех вариантов запроса разом), assert_content (байты, тип, nosniff, без Location и x-amz-*), assert_replicas
|
||||
images.py # изображения для тестов: PNG на stdlib (любые IHDR, Adam7, точный размер, бомба, огромные размеры, порча байта, шум RGB ~1 MiB от зерна — png_noise), JPEG через Pillow (dev): разновидности, подмена размеров, без таблиц, изменённый заголовок скана и пустой скан (jpeg_undecodable); обрезка и хвост
|
||||
test_attachment_processing.py # спек attachment-processing по HTTP: готовность, thumbnail, варианты, failed от недекодируемого JPEG
|
||||
test_attachments.py # спек attachments: загрузка, лимиты, тип и целостность, filename, доступ, метаданные, оригинал, variant, повтор, 10 одновременных загрузок, другая реплика
|
||||
test_idempotency.py # спек idempotency: ключ, повтор, 409, область, порядок кодов, повтор через другую реплику (гонка — test_race.py, отказы — test_failures.py)
|
||||
test_load_balancing.py # спек load-balancing (вне сверки покрытия): одна сессия на разных репликах, запись видна через другую реплику
|
||||
spec_coverage.py # исключения (сценарии, которые не проверить по HTTP) и сверка покрытия; missing_evidence — файл evidence по ссылке исключения должен быть в репозитории
|
||||
test_rubric.py, test_race.py # обязательные сценарии и гонки уровня 4
|
||||
test_<capability>.py # сценарии основных спеков, маркер @pytest.mark.spec
|
||||
test_failures.py # проверки отказов (маркер fault): только make failure_checks
|
||||
run_isolated.py # make test_isolated: образ на временной базе test_<db>, уборка базы и префикса test_<db>/ в S3 (weed shell fs.rm, затем проверка fs.ls: код 0 weed shell успеха не значит; префикс только из проверенного имени) (stdlib)
|
||||
run_failures.py # make failure_checks: стенд <рабочий>-failures (Postgres, Valkey, S3 + bootstrap, уборщик с grace 20 с и интервалом 1 с без плановой сверки → FAULT_CLEANER_*, FAULT_RECONCILER_INTERVAL_S; уборщик с плановой сверкой <проект>-cleaner-scheduled убирается вместе с API), пять API (обычный, «тесный», «узкий по загрузкам» с UPLOADS_ENV → FAULT_UPLOADS_BASE_URL / FAULT_UPLOADS_ENV, «с коротким сроком S3» с S3_ENV → FAULT_S3_BASE_URL / FAULT_S3_ENV, «узкий по заданиям» с BACKLOG_ENV → FAULT_BACKLOG_BASE_URL / FAULT_BACKLOG_ENV; у первых четырёх предел заданий выключен, NO_BACKLOG_ENV), pytest -m fault, журнал PostgreSQL стенда (сводка, признаки аварии — ненулевой код), журналы API и уборщика при падении, уборка (stdlib)
|
||||
fault_hook.py # hook стенда отказов: stop/start/pause/unpause postgres|valkey|s3, кэш, триггеры сбоя участников, сообщений и вложений (fail-attachments insert|ready|stall|commit|outlive|undeletable: сбой вставки, перевода в ready до и на COMMIT, задержка, строка «старше grace» с ожиданием уборщика, неудаляемая строка), заполнение слотов max_connections, счётчик сессий PostgreSQL db-sessions, attachment-ids, last-pending, object-ids (файлы original по fs.tree), kill-api / start-api; расхождения и сверка (change track2-reconciler): put-object (тело — stdin, botocore в контейнере API его ключами) / delete-object (weed fs.rm) только под <база>/attachments/, delete-row, set-size, age-row, set-key (object_key строки под <база>/), lost-ids, fail-attachments mark, reconcile dry-run|apply [предел] [--strategy batch|head] [--deep] [--max-objects-per-second R] (аргументы по списку, записи и exit_code=), stop|start cleaner, run-cleaner <с> (stdlib)
|
||||
failures.compose.yml # override стенда отказов: relay (опрос 0,2 с, restart "no"), worker и уборщик с короткими сроками change pipeline-reliability, без публикации портов (Postgres, Valkey, S3, LB), уборщик с CLEANER__* 20 / 1, RECONCILER__INTERVAL_SECONDS 0 и restart "no", stop_grace_period 2 с у S3, healthcheck PostgreSQL — на служебную базу postgres (не добавляет сессий в базу приложения), init: true у PostgreSQL (сирот psql из fill-connections подбирает init, а не postmaster)
|
||||
service-tests/ # быстрые тесты сервисов (вне образа и вне student-tests), service-tests.md
|
||||
pytest.ini # настройки pytest этого каталога: pyproject.toml здесь не применяется
|
||||
builders.py # DTO для тестов: явное время, PASSWORD_HASH по виду CHECK
|
||||
repo_contract.py # один набор условий repo: на фейке и на настоящем SQL
|
||||
fakes/ # FakeDatabase (таблицы, снимок, events, held, fail_on), FakeUnitOfWork на базовом классе порта, фейки девяти repo, FakeCache, FakeObjectStorage, FakeJobPublisher, FakeImageRenderer
|
||||
unit/ # make service_test: test_unit_of_work, test_architecture, test_repo_contract, test_<service> на каждый сервис, test_worker_deliveries (одновременные доставки), test_telemetry (in-memory экспортёры SDK: выключено, OTEL_*, ресурс, middleware, журнал, правило корня, Valkey и S3, закрытие со сроком, исход доставки; с change job-trace-propagation — контекст загрузки, span producer и consumer, невыбранный контекст, время до готовности, пул, насыщение, очередь, cgroup, ресурс relay, заголовки доставки, модули SDK без телеметрии в отдельном интерпретаторе); conftest подставляет поля settings
|
||||
db/ # make service_test_db: conftest (временная база, TcpProxy, «тесный» API окружением до импорта src), test_uow, test_repo_contract_sql, test_request_flow, test_telemetry_db (span запросов и COMMIT под родителем, без родителя — ни одного), test_pool_counts (CountingQueuePool: ожидающий и отказ по сроку, класс после dispose)
|
||||
bench/ # нагрузочный стенд на HAProxy + N реплик API + Postgres + Valkey: make bench / bench_quick / bench_restore / bench_failover / bench_rollout / bench_scaling / bench_uploads (с S3)
|
||||
run.py # оркестратор: стенд compose, реплики и готовность по LB, фоновые чаты и расписание наполнения, матрица, обслуживание БД, планы и варианты, пробы записи, backup и восстановление во второе хранилище со сверкой, фазы профиля failover (события цели — поток docker events по контейнеру, а не буфер демона), профиль rollout (образ прежнего commit через git archive, scripts/rolling-update.sh против проекта стенда, поток событий Docker с exec_start), ресурсы профилей failover и rollout (Profile.sample_resources: сэмплер scan, карта контейнеров по меткам compose, окна, бюджет на пике, сторож), серии трека 1 (профили scaling_*, ячейки на свежем стенде, ступени k6 и поиск R*, сэмплер, продолжение RESUME, блокировка bench/.bench.lock), метрики (сумма по репликам), runs.csv / phases.csv / searches.csv / samples.csv / summary.md / meta.json; профиль uploads (S3 и bootstrap на стенде, на прогон — новый volume S3 и реплика с окружением варианта через .work/variant.compose.yml, образ «до» — тег bench-from, сэмплер peak), в паспорте всех профилей stand.api_tcp_rmem и docker.kernel; профиль reconcile (S3 с портом метрик через .work/s3-metrics.compose.yml, наполнение \copy и загрузчиком, разовые проходы mtusi-bench-reconcile-<n> с лимитом CPU варианта, «до» — .work/cleaner-before.compose.yml, метрики шлюза и pg_stat_database до и после, блок H4 с k6 background.js, отказ по пределу S4)
|
||||
scaling.py # серии трека 1 без docker: лестница и автомат поиска R*, разбор итога k6 и строк сэмплера, агрегаты окна, вердикт SLO и брака генератора, признаки узкого места (THRESHOLDS), предельный CPU на запрос, сводка серии; --selftest
|
||||
plots.py # make bench_plots: SVG на stdlib (R* от числа реплик, p95 от интенсивности, CPU по компонентам) и сводка с точкой насыщения; render_series — графики в каталоге метки
|
||||
sampler.sh # сэмплер (только в контейнере mtusi-bench-sampler на образе PostgreSQL, --cgroupns host): режим list (серии) — cpu.stat, память и PSI заданных контейнеров, /proc/stat и PSI ВМ, статистика HAProxy, psql \watch по pg_stat_activity / database / wal / io; режим scan (failover, rollout) — обход cgroup всех контейнеров и /proc/stat, без сети, psql и LB; режим peak (uploads) — сброс memory.peak реплики, S3 и LB через свой дескриптор (perl), чтение пика в конце окна, выборка current / anon / sock / oom_kill раз в 0,2 с (--user 0, cgroupfs rw, без сети); режим queue — scan с mp, mq и psql \watch заданий; режим cost (telemetry) — scan и строки mp, без сети
|
||||
uploads.py # профиль uploads без docker: тела PNG из шума от зерна, план кругами, разбор строк k6 и сэмплера peak, строка runs.csv, пометки oom / host_swap / peak_sampled / s3_down, summary.md (медиана и min–max по ячейкам, сценарии спеков, H1–H4); --selftest
|
||||
reconcile.py # профиль reconcile без docker (change track2-reconcile-cost): модель набора (id, содержимое и класс по номеру и зерну, строки CSV для \copy, ожидаемое по классам), план кругами, разбор записей уборщика, метрик шлюза S3, строк bg k6 и сэмплера, окна и r / a H4, passes.csv и windows.csv, вердикты H1–H4 и S4, summary.md и SVG (plots.Svg); --selftest
|
||||
overload.py # профиль queue без docker (change track1-queue-overload): план кругами, разбор строк q/qs/qv, jobs, mq, mp и журналов, жизни контейнера, строка cells.csv и timeline.csv, пометки, вердикты H1–H9, правило рекомендации, summary.md и SVG; --selftest
|
||||
make_images.py # файлы классов s, m, lj, lp профиля queue и bad профиля telemetry (s с 12 битами точности в SOF: 202, затем failed): только в контейнере mtusi-bench-images на образе стенда (Pillow образа, --network none), зерно из аргумента, JSON с размерами и SHA-256, больше лимита контракта — код 1
|
||||
telemetry_cost.py # профиль telemetry без docker (change track1-telemetry-cost): таблица вариантов и override прогона, план кругами, ожидание отправок, проверки слоя Collector (print-config) и копии Prometheus (построчно вне bench-lean), записи о старте и слои, разбор строк k6 t и сэмплера cost, компоненты, строки runs.csv / components.csv / classes.csv, потери по звеньям, пометки, правило шума, биномиальный интервал, вердикты H1–H8 и B1–B5, summary.md и четыре SVG; --selftest
|
||||
telemetry_lookup.py # выборка профиля telemetry: только в контейнере mtusi-bench-lookup на образе стенда (stdlib urllib, сеть mtusi-bench-telemetry); wait-ready и collect — трассы по request_id и цепочки загрузок (TraceQL), записи журнала и переход к трассе, счётчики Prometheus, status/tsdb и config, квантили buckets против журнала; результат, равный пределу, — отказ
|
||||
telemetry.compose.yml # второй -f при включённой телеметрии стенда: TELEMETRY__ENABLED true и адрес Collector у api, worker, relay
|
||||
otel/ # слои вариантов профиля telemetry (не infra/otel/): tail-typical.yaml и tail-balanced.yaml — второй --config Collector (только tail_sampling и процессоры pipeline трасс), prometheus-lean.yml — копия prometheus.yml с блоками # bench-lean (отбор собственных рядов хранилищ)
|
||||
queue.compose.yml # третий -f только профиля queue: плагин метрик брокера и статистика в секунду (bench/rabbitmq/), restart: unless-stopped у worker
|
||||
rabbitmq/ # enabled_plugins и 91-bench.conf профиля queue
|
||||
fill_objects.py # загрузчик объектов профиля reconcile: только в контейнере mtusi-bench-fill на образе стенда (botocore образа, bench/ на чтение, ключи API из окружения), процессы × потоки PUT по модели reconcile.py
|
||||
resources.py # ресурсы профилей failover и rollout без docker: интервалы контейнеров (сброс при новой cgroup, заморозка, новые контейнеры с момента запуска), окна, CPU / троттлинг / память по компонентам и ВМ, CPU на запрос в установившихся окнах, resources.csv / samples.csv, разделы summary.md; --selftest
|
||||
failover.py # профиль failover без docker: строки k6 о запросах, статистика и журнал HAProxy, события Docker, посекундная шкала, величины фазы, summary.md
|
||||
rollout.py # профиль rollout без docker: строки скрипта замены, события контейнеров проекта, состояния слотов LB (UP, drain, maint, ready), шаги по репликам, шкала со старыми и новыми ответами, окна до / во время / после, summary.md
|
||||
bench.compose.yml # override стенда mtusi-bench: имена, BENCH_API_REPLICAS реплик api без container_name, haproxy с лимитами BENCH_LB_*, лимиты BENCH_* (deploy.resources), без портов и config.toml, auto_explain; s3 (лимиты BENCH_S3_*, swap = память) запускают профили uploads и reconcile, cleaner (mtusi-bench-cleaner, без порта, лимиты BENCH_CLEANER_* без swap) — только разовыми проходами профиля reconcile; буфер приёма реплики — sysctls основного compose; с change track1-telemetry-cost — otel-collector, prometheus, loki, tempo (mtusi-bench-<сервис>, лимиты BENCH_COLLECTOR_* / _PROMETHEUS_* / _LOKI_* / _TEMPO_* без swap, сеть mtusi-bench-telemetry; запускают профиль telemetry и TELEMETRY=on), grafana без порта и не запускается
|
||||
bench.env # подстановки compose стенда вместо .env рабочего стенда (без паролей и секретов S3: их генерирует run.py)
|
||||
k6/ # сценарии k6 (через LB http://haproxy:8080): prepare (вход по Basic, фоновые чаты), prefill (по расписанию), cursors, plan_cursors (страницы плана фоновых чатов), explain, read, tail, write, after_backup и restore_check (этап восстановления), failover (постоянная интенсивность записи и чтения, строка на запрос) и retry (повтор неуспешных записей с тем же ключом), mixed (ступень серии трека 1: ramping-arrival-rate 70/20/10, тег окна, распределение по X-Instance-Id, досрочный выход), uploads (constant-vus загрузок тела из /work, пауза Retry-After на 429 и 1 с на прочие ошибки, строка на запрос, WARMUP — одна загрузка), background (профили reconcile и queue: constant-arrival-rate скачиваний, записи и чтения истории, строка bg на запрос, остановка SIGINT), queue (окна constant-arrival-rate загрузок, VU заранее, ответ не повторяется, строка q на загрузку; WARM — разогрев) и queue_sweep (метаданные каждого принятого вложения, SHA-256 выборки, строки qs и qv), telemetry (профиль цены телеметрии: девять классов constant-arrival-rate — чтение, запись, /users/me, карточка, скачивание, загрузка s и bad, вложение без объекта, регистрация; строка t с X-Request-Id на запрос); lib.js — Bearer, messageHeaders (новый или заданный Idempotency-Key) и хелперы
|
||||
compare.py # make bench_compare: дельта двух меток (ячейки матрицы или общие конфигурации серий), уровень шума, эффект или шум; отказ при разной методике, в том числе метке без LB и серии против матрицы
|
||||
ab.py # make bench_ab: прогоны «до» и «после» одного изменения подряд, с --series — серии трека 1
|
||||
migrations/, alembic.ini # ревизии alembic, async env.py; применяет одноразовый сервис compose; 739b8f04d5fb — частичный индекс pending CONCURRENTLY в autocommit_block; 5c3e1f0a9b7d — attachments.lost_at (NULL, SET LOCAL lock_timeout); c7e2f1a04b56 — attempt_base и attachment_job_replays; d3f9a6b2c1e7 — индексы outbox, аренды и очистки staging CONCURRENTLY; e4b8c2d17f90 — attachment_jobs.traceparent и tracestate (NULL, CHECK NOT VALID, SET LOCAL lock_timeout)
|
||||
infra/ # конфигурации сервисов стенда; README.md — skeleton
|
||||
valkey/valkey.conf # лимит памяти и LRU, persistence выключен
|
||||
rabbitmq/rabbitmq.conf # предел памяти брокера 400 МиБ: лимит контейнера он не видит
|
||||
otel/collector.yaml # Collector contrib (change otel-telemetry): OTLP HTTP :4318, memory_limiter и batch, экспортёры prometheus :8889, otlp_http/loki, otlp_http/tempo, свои метрики :8888; с change slo-alerts — приёмник prometheus/haproxy (haproxy:8404/metrics, frontend и backend, отбор имён), batch/logs 256, очереди экспорта по байтам 16 / 8 МиБ и повторы 30 с, metric_expiration 1m
|
||||
otel/prometheus/prometheus.yml # scrape Collector (honor_labels), Collector, Loki, Tempo и себя раз в 15 с; срок и объём — флаги compose; с change slo-alerts — rule_files, protobuf первым у otel-collector-exporter (время начала рядов), глобально прежний текстовый список
|
||||
otel/loki/loki.yaml # монолит filesystem, schema v13, compactor, срок 168h, без отчётов
|
||||
otel/tempo/tempo.yaml # монолит 3.1, OTLP HTTP :4318, local, block_retention 168h у scheduler и worker, без отчётов
|
||||
otel/grafana/ # datasources.yaml (uid prometheus, loki, tempo; лог ↔ трасса; с change slo-alerts — manageAlerts у Prometheus), dashboards.yaml (папка Messenger, без правок из UI), dashboards/messenger-overview.json (панели уровня 3; с change job-trace-propagation — p99 и строки «Pipeline» и «Saturation» уровня 4; с change slo-alerts — строки «SLO and alerts» сверху, «Load balancer» и «Telemetry pipeline», id с 25)
|
||||
otel/prometheus/rules.yml # change slo-alerts: группы messenger-sli (окна 2 мин, telemetry:lost_items:total), messenger-slo (приращения SLI за 5 мин), messenger-alerts и telemetry-alerts — семь оповещений с for, severity, summary, description, runbook_url
|
||||
otel/prometheus/rules.test.yml # promtool test rules: срабатывание, порог, без трафика, снятие, правила записи (make alerts_test, в контейнер не монтируется)
|
||||
otel/runbooks/ # change slo-alerts: <оповещение>.md — значение, панели, диагностика по сохранённым наблюдениям (PromQL, LogQL, TraceQL), действия, восстановление, связанные
|
||||
rollback/broker.compose.yml # override отката реплик на образ до pipeline-reliability (прежний код публикует сам): адрес и пароль брокера только на время отката
|
||||
s3/bootstrap.sh # bootstrap S3 (ещё пользователь worker: чтение и запись объектов; сервис s3-bootstrap, network_mode: service:s3): apply — bucket, анонимный доступ none, политики api-objects и cleaner-objects (у уборщика — ещё список только с префиксом S3_CLEANER_LIST_PREFIX = <база>/attachments/), пользователи api и cleaner с ключами из .env, проверки приватности обоих ключей; check (и строки ключа уборщика) и cleanup — для make s3_check; секреты — stdin weed shell и файл curl на tmpfs
|
||||
haproxy/haproxy.cfg # LB рабочего стенда и bench/: реплики через DNS Docker (8 слотов), проверки /health/ready (inter, fastinter, формулы обнаружения), цепочка таймаутов, http-reuse never (простаивающее соединение закрывает LB), повтор только на conn-failure, ответы LB в формате контракта (400, 502, 503, 504), timeout server 30 с пути загрузки (set-timeout, остальные 10 с), tune.sndbuf.server 256 KiB и tune.rcvbuf.client 128 KiB, мониторинг :8404 (с change slo-alerts — ещё /metrics экспортёра Prometheus для Collector), runtime API на 127.0.0.1:9999 внутри контейнера (drain / maint / ready при замене)
|
||||
scripts/restart.sh # restart hook для make test-persistence, по restart.example.sh: LB, все реплики api, postgres, valkey, s3 (~25 с); ожидание хранилищ — up --wait --no-recreate (Compose 5.4 иначе пересоздаёт контейнеры, чьи образы скачивались при первом up, и s3-bootstrap не стартует); start api повторяет migrate и s3-bootstrap (no-op); уборщика не трогает — рестарт хранилищ он переживает сам
|
||||
scripts/stop-one.sh # failover hook для make test-failover: TARGET_INSTANCE_ID → реплика api этого проекта, STOP_MODE stop или kill, STOP_ONE_LOG
|
||||
scripts/rolling-update.sh # make rolling_update: предусловия (в том числе слоты LB без ручного состояния), сборка (или COMMIT через git archive), миграции один раз в контейнере сервиса migrate, по одной: новая UP в LB → старая drain (до 90 с: дольше загрузки) → maint → stop (код выхода в строке) → rm → слот ready; trap при сбое и Ctrl+C; тот же скрипт — профиль rollout стенда bench/
|
||||
Dockerfile # builder (uv sync --locked) → runtime: .venv + src + миграции, UID 10001, healthcheck, MALLOC_MMAP_THRESHOLD_ (буфер загрузки растёт без копии)
|
||||
docker-compose.yml # проект mtusi-lab6: postgres, valkey, s3 (SeaweedFS, служебное на loopback, API S3 на 127.0.0.1:S3_OUT_PORT), rabbitmq, migrate, s3-bootstrap, relay и worker (пароль брокера только у них и rabbitmq), api × API_REPLICAS без портов (sysctls: буфер приёма сокетов до 512 KiB), cleaner (уборщик: точка входа python -m src.cleaner, пул 1, ключи S3_CLEANER_*, без healthcheck), haproxy — единственный порт API; с лабы 6 — otel-collector (сети default и telemetry), prometheus, loki, tempo, grafana (сеть telemetry, наружу — только Grafana на 127.0.0.1:GRAFANA_OUT_PORT), x-telemetry-env у api и worker, healthcheck брокера через gosu rabbitmq; адреса и порты из .env, volumes postgres_data, s3_data, rabbitmq_data, prometheus_data, loki_data, tempo_data, лимиты у всех, окружение и секреты по сервисам (x-db-env, x-cache-env, x-s3-env, x-s3-api-keys-env)
|
||||
.dockerignore
|
||||
config_example.toml, .env.example
|
||||
evidence/broker/ # change async-attachments: stand.md (driver.py broker-check), isolated.md (очередь временной базы)
|
||||
evidence/worker/ # change async-attachments: process.md (driver.py worker-process), logs.md (журнал задания); memory.md (driver.py worker-memory)
|
||||
evidence/attachments/ # change async-attachments: defense.md (driver.py defense-scenario); change attachments: smoke.md, failover.md (driver.py attachment-failover stop и kill), storage.md (driver.py attachment-storage), slow-transfer.md (10 MiB через LB дольше 6 с); change upload-consistency: consistency.md (driver.py upload-consistency и журналы API и уборщика), cleaner-process.md (старт, отказ конфигурации, остановка, окно 0, рестарт хранилищ, отказ S3 во время прохода); по замечанию ревьюера: jpeg-structure.md (варианты JPEG — прежняя и новая проверка, Pillow, djpeg; регрессия на 301 JPEG; время; красный и зелёный прогоны test_undecodable_jpeg)
|
||||
evidence/s3/ # privacy.md — make s3_check на текущем коде; change s3-storage: bootstrap.md (первый запуск, повтор, смена секрета, ошибка шага, до bootstrap), privacy.md (make s3_check, нарушение и исправление, порты, секреты по сервисам), grpc-admin.md (gRPC шлюза без токена), restart.md (restart.sh и SIGKILL S3), client.md (операции, pause/stop, неверный секрет, журнал), memory.md (20 × 10 MiB PUT); change upload-consistency: cleaner-key.md (пользователь уборщика в bootstrap, смена секрета, make s3_check с ключом уборщика, секреты по сервисам); change track2-reconciler: cleaner-list.md (bootstrap с политикой списка по префиксу, неверный префикс, make s3_check со строками списка уборщика, окружение s3-bootstrap)
|
||||
evidence/reconcile/ # change track2-reconciler: cycle.md (driver.py reconcile-cycle), stress.md (driver.py reconcile-stress), service.md (Started cleaner с параметрами сверки, плановая сверка при старте, docker stop во время сверки при pause s3, код 1 разового прохода по сигналу — driver.py reconcile-signal, отказ старта на RECONCILER__*, коды 3 и 0; с change track2-reconcile-cost — остановка во время паузы предела скорости, driver.py reconcile-signal --pace)
|
||||
evidence/reconcile/<метка>/ # результаты make bench_reconcile (change track2-reconcile-cost): meta.json (раздел reconcile: план, этапы и модели, commit и образы «до», аргументы S3), passes.csv, windows.csv, summary.md (H1–H4 и S4), cost-by-n.svg, requests-by-n.svg, background-p95.svg, raw/ (записи уборщика по проходам, итог k6 блока H4)
|
||||
evidence/telemetry/ # change otel-telemetry: budget.md (пики и лимиты сервисов телеметрии, реплик и worker с телеметрией и без); на commit 15ea156 change slo-alerts переснято: collector-outage.md (driver.py telemetry-outage), trace-chain.md (driver.py trace-chain), раздел change slo-alerts в budget.md; на ef60b47 (правки verify slo-alerts): backend-outage.md (driver.py backend-outage, с панелью потерь); на 4a2f9c9 (тот же код, гонка relay_pass_records в драйвере): check.md (driver.py telemetry-check, с метриками LB, новыми панелями и панелью потерь на тихом стенде); на 72cfa9a (change job-trace-propagation): queue-snapshot.md (EXPLAIN снимка очереди), раздел change в budget.md (relay с SDK, уборщик после ленивого импорта)
|
||||
evidence/migrations/ # change job-trace-propagation: job-trace-context.md — ревизия e4b8c2d17f90 (временная база: с нуля, повтор, откат, CHECK, lock_timeout; --sql; рабочий стенд: откат реплик на ff0073e с MIGRATE=0, ревизия до и после make rolling_update)
|
||||
evidence/stand/ # change otel-telemetry: from-scratch.md (driver.py stand-from-scratch --runs 2)
|
||||
evidence/alerts/ # change slo-alerts (commit ef60b47, правки verify; первая съёмка — 15ea156): rules-test.md (make alerts_test и контроли), check.md (driver.py alerts-check); там же — evidence/telemetry/backend-outage.md (driver.py backend-outage) и раздел change в budget.md (15ea156)
|
||||
evidence/storage/ # отказы БД, пул, statement_timeout, рестарт, порты Postgres, свежий clone; connection-cost.md — цена нового соединения и пинга; freeze-sessions.md — change unit-of-work: сессии и журнал пула после заморозки PostgreSQL (driver.py freeze-sessions и freeze-lb)
|
||||
evidence/migrations/ # миграции с нуля и повторно, ошибка миграции; лаба 4: pending-index.md (ревизия 739b8f04d5fb с нуля, повтор, откат, EXPLAIN общего плана кандидатов уборщика на рабочей базе с откатом, rollout_quick), lost-at.md (ревизия 5c3e1f0a9b7d колонки lost_at: с нуля, повтор, откат, --sql с lock_timeout, make rolling_update с ревизией до и после)
|
||||
evidence/auth/ # passwords-and-tokens.md — driver.py auth-storage на стенде текущей лабы: Argon2id в users, SHA-256 токена в sessions, ни токена, ни пароля в pg_dump (исключения сверки покрытия)
|
||||
evidence/cache/ # hits.md — make test_isolated + driver.py cache-check на стенде текущей лабы: одно чтение chats на 50 через LB, TTL, ключи двух баз (исключения сверки покрытия)
|
||||
evidence/tests/ # последний шаг лабы 6 (db3340d): service-tests.md (make service_test и service_test_db), test-isolated.md, student-test-lb.md, failure-checks.md, final-checks.md (check, validate, lint, alerts_test), secrets.md, clean-clone.md (git clone, make run_docker своим проектом на нестандартных портах), ci-application.md (прогон .github/workflows/application.yml на Gitea); файлы этих проверок лаб 3–5 — в их репозиториях
|
||||
evidence/idempotency/ # повтор, 409, гонка, таблица ключей, X-Instance-Id
|
||||
evidence/replicas/ # стенд с LB: порты, лимиты и их цена для Argon2id, окружение, распределение, ответы LB (нет реплик, зависшая, без PostgreSQL), test-persistence, чистый clone на нестандартных портах
|
||||
evidence/failover/ # make test-failover для каждой реплики (stop и kill), отказы stop-one.sh; замер обнаружения, keep-alive, зависшая реплика и ключ; stop-at-start.md — docker stop стартующей реплики «до/после» раннего обработчика и ветка сбоя rolling-update.sh
|
||||
evidence/failover/<метка>/ # результаты make bench_failover: паспорт, phases.csv, посекундная timeline.csv, summary.md, итоги k6 и журнал LB по фазам; с change profile-resources (метка resources и новые) — resources.csv (фаза × окно × компонент) и samples.csv (посекундно от действия)
|
||||
evidence/rollout/ # совместимость старого образа с новой схемой, make rolling_update и жизненный цикл стенда после замены, отказы скрипта (Ctrl+C, слоты, lock_timeout миграции)
|
||||
evidence/rollout/<метка>/ # результаты make bench_rollout: паспорт с контейнерами, образами и ревизией до и после, rollout.csv, replicas.csv, timeline.csv, summary.md, строки скрипта, журнал LB; с change profile-resources (метка resources и новые) — resources.csv (окно × компонент) и samples.csv (посекундно от начала замены)
|
||||
evidence/bench/<метка>/ # результаты make bench / bench_restore: паспорт, прогоны, наполнение, сводка (планы, стоимость записи, восстановление), планы explain-<размер>.txt, сырые итоги k6
|
||||
evidence/bench/scaling-*/ # серии трека 1 (a, b, pool, A/A scaling-aa, db — насыщение PostgreSQL; db4 — «до/после» пула без переполнения: scaling-db-aa*, -before*, -nooverflow*, окончательные — с суффиксом 2): паспорт с планом, бюджетом и лимитами по конфигурациям, runs.csv (строка на ступень), searches.csv (строка на ячейку), samples.csv (посекундно в окнах), summary.md, p95-by-rate.svg, cpu-by-component.svg, итоги k6 ступеней и журналы 5xx
|
||||
evidence/plots/scaling/ # make bench_plots по сериям a и b: графики SVG и summary.md (R*, эффективность, точка насыщения, цена запроса, память)
|
||||
evidence/plots/scaling-db/ # make bench_plots по серии db: R* по лимитам PostgreSQL и раздел «Насыщение PostgreSQL»
|
||||
evidence/queue/<метка>/ # результаты make bench_queue (change track1-queue-overload): meta.json (классы, план, окна, app_env по конфигурациям), cells.csv, timeline.csv, summary.md (H1–H9, рекомендация), SVG, raw/ — итоги k6; в лабе 6 — baseline4 с TELEMETRY=on (код b3a5ab8, dirty: true — QUESTIONS.md, «Последний шаг»)
|
||||
evidence/telemetry-cost/<метка>/ # результаты make bench_telemetry (change track1-telemetry-cost): meta.json (варианты с SHA-256 слоёв, план, интенсивности, окна, блокировки, app_env по вариантам, stand и stand_telemetry, limits_by_mode), runs.csv, components.csv, classes.csv, summary.md (H1–H8, B1–B5), cpu-by-group.svg, latency-light.svg, ingest.svg, traces-by-class.svg, raw/ — итоги k6 и выборки
|
||||
evidence/uploads/ # change upload-memory: <метка>/ — make bench_uploads (meta.json, runs.csv, summary.md, raw/; в лабе 6 — baseline с TELEMETRY=on, код b3a5ab8), lb-timeouts.md — driver.py lb-upload-timeouts, rollout-upload.md — медленная загрузка во время make rolling_update
|
||||
evidence/bench/unit-of-work-*/ # change unit-of-work, профиль quick с именной меткой (идёт в git): before и aa на b2fb88f, after на 6ba74b1
|
||||
evidence/rollout/unit-of-work*/ # change unit-of-work: unit-of-work (замена с Profile.rollout_from), unit-of-work-previous (--from b2fb88f: CPU на запрос старых и новых реплик)
|
||||
evidence/compare/ # таблицы make bench_compare: <до>__<после>.md; unit-of-work-before__unit-of-work-after.md и unit-of-work-aa__unit-of-work-after.md — цена шага от двух меток одного кода
|
||||
.github/workflows/application.yml # свой CI job (CONTRIBUTING.md, «CI»; contracts.yml — skeleton): checkout commit прогона (адрес Gitea литералом: github.server_url — внутренний http://gitea:3000, из job не резолвится; по той же причине contracts.yml на этом раннере падает на actions/checkout), сборка и стенд под проектом mtusi-lab6-safronov-ci-<run_id>, job подключается к сети стенда, готовность — обе реплики через LB, make check / test, аноним в S3 — 403, make validate, make student_test, test-persistence, test-failover stop и kill, уборка при любом исходе; без s3_check, test_isolated и failure_checks (порты хоста). Раннер Gitea (act_runner) запускает job в контейнере на том же Docker, что стенд
|
||||
.github/ci/compose.yml # override стенда в CI: конфиги — configs из переменных окружения вместо bind mount (файлов job нет на хосте раннера), без портов на хосте, образ API с тегом прогона; у Prometheus, Loki и Tempo — только именованный volume, у Collector и Grafana — ни одного (tmpfs Grafana остаётся)
|
||||
.github/ci/stand-env.sh # «.» в шагах job: содержимое конфигов в CI_* для configs (с переводом строки в конце: без него HAProxy конфиг не принимает), wait_replicas — /health/ready 200 от API_REPLICAS разных реплик через LB за 60 с
|
||||
KNOWN_ISSUES.md # найденные попутно дефекты, не исправленные без просьбы
|
||||
```
|
||||
|
||||
`evidence/` в лабу 6 не переносился: здесь только снятое на её стенде, а
|
||||
файлы и метки лаб 3–5 остались в репозиториях `mtusi2026lab3-safronov`,
|
||||
`mtusi2026lab4-safronov` и `mtusi2026lab5-safronov`. Записи карты о changes
|
||||
лаб 3–5 говорят, что
|
||||
такой каталог содержит, когда он снят: каталоги появляются заново по мере
|
||||
changes, а файлы исключений сверки покрытия снимаются заново на стенде
|
||||
текущей лабы (раздел «Переход в следующую лабу»).
|
||||
|
||||
## Архитектура в двух словах
|
||||
|
||||
- Поток однонаправленный. Роутер (зависимости, модели API) → сервис
|
||||
(логика, проверки доступа, id и время, логи) → единица работы и repo за портами
|
||||
`src/core/ports/` (одна атомарная операция над хранилищем, отдаёт DTO) →
|
||||
PostgreSQL через `SqlAlchemyUnitOfWork` (`src/infra/db/`). Сервисы знают только
|
||||
порты; реализации выбирают точки входа. Подробности — в правилах слоёв.
|
||||
- Отличия от bp_proxies. Из `core/` вынесены инфраструктура
|
||||
(`src/infra/`: логгер, хранилища, клиенты), утилиты (`src/utils/`),
|
||||
настройки (`src/config/` вместо `src/data/`) и HTTP-модели
|
||||
(`src/api/schemas/` вместо `schemas/pydantic/`). В `core/` остались
|
||||
доменные слои: repos, services, exceptions. Бота, loader и контроллера
|
||||
нет; фоновая работа с лабы 5 — отдельный worker (`src/worker/`).
|
||||
- Ошибки: сервис бросает доменное исключение. `src/api/errors.py` одной
|
||||
таблицей переводит его в статус и `code` и отдаёт тело
|
||||
`{"error": {...}}` с `request_id`. `HTTPException` в сервисах и ручках
|
||||
не используется.
|
||||
- Конкурентность: все ручки и зависимости — `async def`, один event
|
||||
loop, один worker в процессе, процессов — `API_REPLICAS` за HAProxy.
|
||||
Атомарность и защиту от гонок, в том числе между репликами, дают
|
||||
транзакции и ограничения Postgres (уникальность, `ON CONFLICT`),
|
||||
транзакцией управляет сервис блоком единицы работы. Повтор `POST` сообщения через другую
|
||||
реплику находит тот же ключ идемпотентности в Postgres. На лабе 1 ту же роль играло отсутствие `await`
|
||||
внутри repo-функции над `MemoryStore`. KDF пароля — в потоке, чтобы
|
||||
не останавливать event loop.
|
||||
- Request id генерирует middleware. Тот же id уходит в заголовок
|
||||
`X-Request-Id`, в `request_id` тела ошибки и в каждую строку лога.
|
||||
|
||||
## Соглашения по коду
|
||||
|
||||
- ruff: 79 символов, py312, набор правил в `pyproject.toml` (isort,
|
||||
bugbear, comprehensions, unused-arguments, pyupgrade, simplify,
|
||||
quotes). Кавычки как в файле (quote-style preserve), trailing comma
|
||||
обязательна.
|
||||
- Типизация везде: `X | None`, `list[...]`, `UUID` и `datetime` вместо
|
||||
строк. Методы сервисов keyword-only (`*,`); repo и сервисы вызываются
|
||||
только именованными аргументами.
|
||||
- Комментарии и докстринги короткие, на русском. Сообщения логов и
|
||||
тексты ошибок API (`error.message`) — на английском.
|
||||
- Константы (лимиты контракта, размер страницы, пути) — в
|
||||
`src/utils/constants.py`, не литералами в коде.
|
||||
- Время только через `utcnow()` из `src/utils/utc.py`: aware UTC. В
|
||||
bp_proxies был naive UTC, здесь контракт требует `...Z`, а с лабы 2 —
|
||||
`timestamptz`.
|
||||
- Коммиты (когда попросят): английский, conventional style
|
||||
(`feat: ...`, `fix: ...`, `refactor: ...`).
|
||||
|
||||
## Дорожная карта лаб
|
||||
|
||||
Каждая лаба — отдельный skeleton-репозиторий; переходы API — `COURSE.md`
|
||||
нового skeleton. Что меняется в коде:
|
||||
|
||||
| Лаба | Что появляется | Где в коде |
|
||||
|---|---|---|
|
||||
| 1 | in-memory API, Dockerfile | `infra/memory.py`, `X-User-Id` в `get_current_user` |
|
||||
| 2 | PostgreSQL, Basic → Bearer-сессия; Valkey на «4» | `infra/db/`, `migrations/`, repo на `AsyncSession`; `password` при регистрации (KDF); `get_current_user` на Bearer; `SESSION_TTL_SECONDS`; кэш карточки чата — `infra/cache/`, `repos/chat_cache.py` |
|
||||
| 3 | балансировщик, ≥2 реплики, идемпотентность | middleware `X-Instance-Id`; `Idempotency-Key` на POST сообщения; никакого состояния в памяти процесса |
|
||||
| 4 | приватный S3, вложения | клиент в `infra/`, домен `attachment` |
|
||||
| 5 | брокер, worker, превью | отдельная точка входа worker; загрузка отвечает 202 |
|
||||
| 6 | OTel Collector, Grafana | телеметрия в `infra/` |
|
||||
| 7 | Argon2id, TLS/mTLS, OpenBao | HTTPS, секреты из OpenBao |
|
||||
|
||||
## Переход в следующую лабу
|
||||
|
||||
По `CONTRIBUTING.md`: fork нового skeleton, ветка
|
||||
`solution/<group>-<surname>`, затем перенести своё.
|
||||
|
||||
- Переносить: `src/`, `student-tests/`, `service-tests/`, `migrations/`, `alembic.ini`,
|
||||
`Dockerfile`, `docker-compose.yml`, `infra/valkey/`,
|
||||
`infra/haproxy/`, `infra/s3/`, `infra/rabbitmq/`, `infra/rollback/` и
|
||||
конфигурации наблюдаемости лабы 6 в `infra/` (без `infra/README.md` и
|
||||
`infra/otel/README.md` skeleton), свои
|
||||
`scripts/restart.sh`, `scripts/stop-one.sh` и
|
||||
`scripts/rolling-update.sh` (без примеров и проверок skeleton в
|
||||
`scripts/`), `pyproject.toml`, `uv.lock`, `.python-version`,
|
||||
`config_example.toml`, `AGENTS.md`, `CLAUDE.md`, `.claude/`,
|
||||
`openspec/`, `.graphifyignore`, `bench/`, `KNOWN_ISSUES.md`, свой CI
|
||||
job `.github/workflows/application.yml` и `.github/ci/` (остальное в
|
||||
`.github/` — из нового skeleton). В job поменять номер лабы в префиксе
|
||||
проекта `mtusi-lab6-safronov-ci-` (и в шаге уборки хвостов), в
|
||||
override — новые сервисы и конфиги нового стенда; Actions в новом fork
|
||||
включить в его настройках.
|
||||
- Сливать, а не копировать поверх: `Makefile`, `.env.example`,
|
||||
`.gitignore`, `.dockerignore`. Берём версию нового skeleton (в ней
|
||||
новые цели и проверки) и дописываем свои секции.
|
||||
- Не копировать: `.git`, `.env`, `config.toml`, volumes, `README.md`,
|
||||
`COURSE.md`, `tests/`, `contracts/`, `lab.json`, `REPORT.md`,
|
||||
`evidence/` (доказательства остаются в репозитории своей лабы),
|
||||
`graphify-out/` (граф собирается заново).
|
||||
- Доказательства исключений сверки покрытия снять заново на стенде новой
|
||||
лабы, иначе `make student_test` красный (`test_exclusion_evidence_exists`
|
||||
называет сценарий и путь): `make test_isolated`, затем `driver.py
|
||||
--port <LB> cache-check --require-test-keys` →
|
||||
`evidence/cache/hits.md`; `driver.py --port
|
||||
<LB> auth-storage` → `evidence/auth/passwords-and-tokens.md`; `make
|
||||
test-persistence ACTION_SCRIPT=scripts/restart.sh` →
|
||||
`evidence/replicas/test-persistence.md` (или путь, который назовёт
|
||||
исключение); повтор отправки с ключом после `docker compose up -d
|
||||
--force-recreate api` → `evidence/idempotency/replay-after-restart.md`;
|
||||
с лабы 4 ещё `driver.py --port <LB> attachment-failover` (оба режима)
|
||||
→ `evidence/attachments/failover.md` и `driver.py --port <LB>
|
||||
attachment-storage` → `evidence/attachments/storage.md`; с лабы 5 —
|
||||
`driver.py --port <LB> broker-check` (`--require-test-queue` после
|
||||
`make test_isolated`) → `evidence/broker/stand.md` и
|
||||
`evidence/broker/isolated.md`, `make bench_uploads` →
|
||||
`evidence/uploads/baseline/summary.md` (~50 мин), `make bench_queue` →
|
||||
`evidence/queue/<метка>/summary.md` (~2 ч 10 мин; метку называет
|
||||
исключение `queue-overload`) — всего 10 файлов при переносе 5 → 6
|
||||
(`QUESTIONS.md`) (`student-tests.md`). Файлы `evidence/` этой лабы в новую лабу не
|
||||
копировать, даже эти: сверка проверяет только наличие файла и с
|
||||
копией останется зелёной без пересъёмки.
|
||||
- `Profile.rollout_from` в `bench/run.py` (профили `rollout`,
|
||||
`rollout_quick`) поменять на commit новой лабы до изменения, которое
|
||||
должна показать замена: commit этой лабы в истории новой нет, и
|
||||
команда откажет до стенда (`bench.md`, профиль `rollout`). Так же
|
||||
`Profile.uploads_before` (профиль `uploads`, вариант «до»): commit новой
|
||||
лабы до изменения, которое показывает профиль.
|
||||
- Сначала прочитать переходы API в `COURSE.md` и `contracts/README.md`
|
||||
нового skeleton, потом править код. Обновить этот файл: номер лабы,
|
||||
таблицу важных файлов, новые правила.
|
||||
|
||||
## Ветки и PR
|
||||
|
||||
Git — только по просьбе. Когда просят, порядок такой:
|
||||
|
||||
- Работа идёт в ветке `solution/bvt2301-safronov` от ветки skeleton.
|
||||
- PR — в исходный репозиторий преподавателя. Заголовок
|
||||
`ЛР N — Группа — Фамилия — на 3/4/5`, тело — по
|
||||
`.github/pull_request_template.md`. Перед PR выполнить `make check`,
|
||||
`make test` на собранном из чистого clone образе и заполнить
|
||||
`REPORT.md`, включая использование ИИ.
|
||||
@@ -0,0 +1,5 @@
|
||||
@AGENTS.md
|
||||
|
||||
Правила по слоям лежат в `.claude/rules/` и подгружаются сами только при
|
||||
чтении файла из их `paths:`. Проект пишется с нуля: перед созданием
|
||||
первого файла слоя прочитать его правило руками (таблица в AGENTS.md).
|
||||
+61
@@ -0,0 +1,61 @@
|
||||
# Образ API мессенджера (лаба 2): сервер и миграции. Правила —
|
||||
# .claude/rules/docker.md.
|
||||
# Пины: тег + digest индекса (amd64 и arm64). Обновление версии — новый
|
||||
# тег и digest из `docker buildx imagetools inspect <тег>`.
|
||||
|
||||
# builder: зависимости строго по uv.lock в /app/.venv
|
||||
FROM python:3.12.14-slim-trixie@sha256:f77ac9e44ae96ef2c90b8053ea08c31f8be030f824196b0ae4db6d462c84e51f AS builder
|
||||
|
||||
COPY --from=ghcr.io/astral-sh/uv:0.12.17@sha256:10787c682e4184e4f290de1171fd4703dc63de99221f10fe1c99002ce7fa9acc /uv /bin/uv
|
||||
|
||||
ENV UV_COMPILE_BYTECODE=1 \
|
||||
UV_LINK_MODE=copy \
|
||||
UV_PYTHON_DOWNLOADS=never \
|
||||
UV_PROJECT_ENVIRONMENT=/app/.venv
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
COPY pyproject.toml uv.lock ./
|
||||
# --locked: lock не совпадает с pyproject.toml — сборка падает;
|
||||
# --no-install-project: src/ сюда не копируется, запуск из /app
|
||||
RUN --mount=type=cache,target=/root/.cache/uv \
|
||||
uv sync --locked --no-dev --no-install-project
|
||||
|
||||
|
||||
# runtime: интерпретатор базового образа, .venv и src/, без uv
|
||||
FROM python:3.12.14-slim-trixie@sha256:f77ac9e44ae96ef2c90b8053ea08c31f8be030f824196b0ae4db6d462c84e51f AS runtime
|
||||
|
||||
RUN groupadd --system --gid 10001 app \
|
||||
&& useradd --system --uid 10001 --gid app --no-create-home \
|
||||
--home-dir /nonexistent --shell /usr/sbin/nologin app
|
||||
|
||||
# MALLOC_MMAP_THRESHOLD_: блоки от 128 KiB всегда в mmap, и буфер тела
|
||||
# загрузки растёт через mremap без копии. Без него glibc после первой
|
||||
# загрузки поднимает порог, буфер растёт в куче, и realloc на миг держит
|
||||
# два тела (design change `attachments`, решение 6)
|
||||
ENV PATH=/app/.venv/bin:$PATH \
|
||||
PYTHONUNBUFFERED=1 \
|
||||
PYTHONDONTWRITEBYTECODE=1 \
|
||||
MALLOC_MMAP_THRESHOLD_=131072 \
|
||||
APP__RUN_MODE=docker
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
# код и .venv принадлежат root: пользователю app — только чтение
|
||||
COPY --from=builder /app/.venv /app/.venv
|
||||
COPY src ./src
|
||||
# сервис migrate compose запускает этот же образ: alembic upgrade head
|
||||
COPY alembic.ini ./
|
||||
COPY migrations ./migrations
|
||||
|
||||
USER app
|
||||
|
||||
EXPOSE 8080
|
||||
|
||||
# порт — тот же APP__PORT, что слушает приложение (по умолчанию 8080)
|
||||
HEALTHCHECK --interval=10s --timeout=3s --start-period=10s \
|
||||
--start-interval=1s --retries=3 \
|
||||
CMD ["python", "-c", "import os, urllib.request; urllib.request.urlopen('http://127.0.0.1:%s/health/ready' % os.environ.get('APP__PORT', '8080'), timeout=2)"]
|
||||
|
||||
# exec-форма: сервер — PID 1 и сам получает SIGTERM
|
||||
CMD ["python", "-m", "src"]
|
||||
+213
@@ -0,0 +1,213 @@
|
||||
# Известные дефекты
|
||||
|
||||
Найдены попутно, не исправлены без отдельной просьбы (AGENTS.md).
|
||||
Исправленные удаляются отсюда, история — в git.
|
||||
|
||||
## Смесь версий при замене реплик на первый релиз с обработкой
|
||||
|
||||
- **Где:** `make rolling_update` с прежней версии (design change
|
||||
`async-attachments`, решение 14), `AttachmentStatus` прежнего образа.
|
||||
- **Что:** на время замены прежняя реплика отвечает 201 `ready` и даёт 500 на
|
||||
чтении строки нового статуса (`ValueError` в `_to_dto`), а новая — 202. То же
|
||||
после отката: незавершённые `queued` и `processing` дают 500 на прежней версии.
|
||||
- **Чем грозит:** окно замены ограничено, переход 201 → 202 всё равно несовместим
|
||||
для клиента на это окно; названо в `REPORT.md`.
|
||||
- **Предложение:** не лечить: объявленный переход контракта. Новые статусы в
|
||||
будущих версиях добавлять так, чтобы прежняя версия читала строку.
|
||||
|
||||
## Bootstrap после удаления bucket на маленьком диске: «api key wait (code 500)»
|
||||
|
||||
- **Где:** `infra/s3/bootstrap.sh` (режим `apply`) и сервер `s3`
|
||||
(`docker-compose.yml`: entrypoint образа добавляет `-volume.max=0
|
||||
-master.volumeSizeLimitMB=1024`), SeaweedFS 4.48.
|
||||
- **Что:** после удаления bucket мимо bootstrap (`s3.bucket.delete`)
|
||||
повторный bootstrap пишет «bucket created», затем «FAILED: api key wait
|
||||
(code 500)». Найдено в правках по verify change `s3-storage`
|
||||
(2026-10-20); воспроизведено и объяснено пробой design change
|
||||
`track2-reconciler` (Context, 2026-10-22, проект `rcprobe`).
|
||||
- **Причина:** не повторное имя bucket, а слоты томов. С `-volume.max=0`
|
||||
число слотов считается по свободному месту диска / 1 ГиБ. Удаление
|
||||
bucket удаляет тома его коллекции, но на маленьком диске слоты уже
|
||||
заняты томами коллекции по умолчанию (журналы filer), и новых томов для
|
||||
`messenger` выделить некуда: в журнале S3 — «No writable volumes and no
|
||||
free volumes left for collection:messenger», PUT получает 500.
|
||||
- **Условие:** диск, на котором `-volume.max=0` даёт мало слотов, — tmpfs
|
||||
проб, а не volume стендов проекта. Проба: tmpfs 4 ГБ — 3 слота из 3
|
||||
заняты, ошибка дважды подряд; tmpfs 16 ГБ — 15 слотов, повтор
|
||||
bootstrap прошёл за 2 с. Рабочий стенд (volume на диске ВМ) — 417
|
||||
слотов, 403 свободны (`weed shell volume.list`): удаление bucket и
|
||||
повтор bootstrap этим не падают. Стенды проекта не затронуты.
|
||||
- **Чем грозит:** только временным стендам на маленьком tmpfs: после
|
||||
удаления bucket повтор bootstrap не проходит. Сверка bucket и БД
|
||||
bucket не создаёт и не удаляет: на `NoSuchBucket` она прерывает проход
|
||||
без изменений (design change `track2-reconciler`, решение 14).
|
||||
- **Предложение:** на маленьких дисках — `-master.volumeSizeLimitMB`
|
||||
меньше 1024 (больше слотов на тот же объём) или явный `-volume.max`;
|
||||
для стендов проекта не нужно. Запись остаётся открытой.
|
||||
|
||||
## Уборщик удаляет объект зависшей загрузки по ключу вне своего префикса
|
||||
|
||||
- **Где:** `src/core/services/attachment_cleanup.py`
|
||||
(`remove_stale_pending`: `delete_original` по `object_key` строки) и
|
||||
политика `cleaner-objects` в `infra/s3/bootstrap.sh` (`s3:DeleteObject`
|
||||
на `<bucket>/*`).
|
||||
- **Что:** сервис уборки (`python -m src.cleaner`, `--once`) убирает
|
||||
строку `pending` старше grace вместе с объектом по ключу из этой
|
||||
строки, не проверяя, что ключ под `<база>/attachments/`. Ключ вне
|
||||
префикса API не пишет; он бывает в базе, восстановленной под другим
|
||||
именем (её строки ведут к объектам исходной базы), или после ручной
|
||||
правки. Тогда уборщик удаляет объект чужого префикса — другой базы.
|
||||
Найдено в правках по verify change `track2-reconciler` (замечание W2,
|
||||
2026-10-22): сверка такую строку теперь только называет «чужим
|
||||
объектом» и не убирает (design, «Уточнения apply», п. 19), а сервис
|
||||
уборки — поведение change `upload-consistency` — не менялся.
|
||||
- **Чем грозит:** только при строке с чужим ключом: потерей объекта
|
||||
другой базы того же bucket. Стенды проекта таких строк не содержат.
|
||||
- **Предложение:** в `remove_stale_pending` (или в `lock_stale_pending`)
|
||||
— та же проверка `attachment_object_repo.is_own_key`: строку с чужим
|
||||
ключом убирать без DELETE объекта (или пропускать с `warning`), сценарий
|
||||
в требовании «Уборщик незавершённых загрузок» и тест на стенде отказов
|
||||
(`set-key` hook уже есть); при желании — сузить `s3:DeleteObject`
|
||||
политики до `<bucket>/<база>/attachments/*`, переделав проверки
|
||||
bootstrap, которые удаляют свои объекты ключом уборщика.
|
||||
|
||||
## LB отвечает 408 на медленные заголовки текстом HAProxy
|
||||
|
||||
- **Где:** `infra/haproxy/haproxy.cfg`, `defaults`: `timeout
|
||||
http-request 10s`, HAProxy 3.4.6.
|
||||
- **Что:** клиент, который присылает заголовки запроса дольше 10 с,
|
||||
получает от LB 408 со страницей HAProxy в HTML, а не ошибку в формате
|
||||
контракта (`{"error": {...}}` с `request_id` = `X-Request-Id`).
|
||||
`http-error status 408 … lf-string` его не меняет: такой ответ HAProxy
|
||||
строит до потока запроса, где `http-error` уже не действует. Проба
|
||||
change `upload-memory` (design, Context, п. 4; таблица «HAProxy,
|
||||
сроки»): заголовки за 12 с — 408 HTML и с `http-error status 408`, и
|
||||
без него. 400 посреди тела после change идёт в формате контракта.
|
||||
- **Чем грозит:** клиент с медленной сетью на заголовках получает ответ
|
||||
вне формата контракта. Путь загрузки и остальные пути API не
|
||||
затронуты: заголовки приходят за миллисекунды.
|
||||
- **Предложение:** `errorfile 408` со статичным JSON не годится:
|
||||
`request_id` в нём один на все ответы, а контракт требует тот же id,
|
||||
что в `X-Request-Id`, и уникальный. Варианты для разбора: проверить
|
||||
`http-errors` / `errorloc` и Lua-ответ в новых версиях HAProxy 3.x;
|
||||
либо поднять `timeout http-request` и назвать ограничение в
|
||||
`REPORT.md` (уже названо в спеке `load-balancing`, «Ошибки
|
||||
балансировщика в формате контракта»).
|
||||
|
||||
## Поля `float` настроек принимают `inf`
|
||||
|
||||
- **Где:** `src/config/settings.py` — все поля `float` с `gt=0` или
|
||||
`ge=0`, кроме `[reconciler] max_objects_per_second`: сроки `[database]`,
|
||||
`[cache]`, `[s3]`, `[uploads]`, `[cleaner] interval_seconds`,
|
||||
`[reconciler] interval_seconds`. Найдено verify change
|
||||
`track2-reconcile-cost` (S2) на `max_objects_per_second`; там исправлено
|
||||
(`allow_inf_nan=False`), остальные поля — вне change.
|
||||
- **Что:** pydantic принимает `inf` (`RECONCILER__INTERVAL_SECONDS=inf`,
|
||||
`UPLOADS__WAIT_TIMEOUT_SECONDS=inf`): `inf > 0` верно. `nan` отсекают
|
||||
`gt` и `ge`. Записи старта («Started API», «Started cleaner») выводят
|
||||
значение как `Infinity` — это не JSON, и разбор журнала по строкам
|
||||
ломается.
|
||||
- **Чем грозит:** оператор, ошибившийся в значении, получает срок без
|
||||
конца (ожидание места загрузки, вызов S3 без срока, плановая сверка,
|
||||
которая не наступит) и журнал, который не разбирается как JSON.
|
||||
Значения по умолчанию и `config_example.toml` не затронуты.
|
||||
- **Предложение:** `allow_inf_nan=False` у каждого поля `float` (или
|
||||
`model_config = ConfigDict(allow_inf_nan=False)` у секций), сценарий в
|
||||
требовании «Некорректное значение останавливает запуск» спека
|
||||
`service-configuration` и проверка `uv run python -c` с `inf` по полям.
|
||||
|
||||
## `driver.py reconcile-cycle` на наполненном стенде: свежий F стареет раньше проверки
|
||||
|
||||
- **Где:** `.claude/skills/run-mtusi-messenger/driver.py`, строка «exit code after X
|
||||
and Y are removed» (grace пробы `RC_GRACE_S` 30 с). Найдено прогоном change
|
||||
`unit-of-work` (задача 11.5); от кода не зависит.
|
||||
- **Что:** на стенде с 11 тыс. объектов (накоплены `make student_test`) каждый проход
|
||||
сверки длится ~5,8 с из-за предела скорости 2000 объектов/с, и за шесть проходов
|
||||
объект F становится старше 30 с раньше этой проверки: dry-run находит `orphan_object`
|
||||
и даёт код 3 вместо 0. Остальные проверки цикла совпадают, итог команды — код 1.
|
||||
- **Чем грозит:** ложный FAIL сценария на долго живущем стенде, на чистом стенде его нет.
|
||||
- **Предложение:** в этой проверке считать допустимой находку F или записывать F позже,
|
||||
непосредственно перед ожиданием grace; либо передавать пробам `RATE=0`.
|
||||
|
||||
## Метаданные и скачивание вложения: 504 от LB вместо 503 при зависшем PostgreSQL
|
||||
|
||||
- **Где:** `GET /api/v1/attachments/{id}` и `GET …/content`
|
||||
(`src/api/routers/v1/attachment.py`), `infra/haproxy/haproxy.cfg`. Найдено
|
||||
пробами change `unit-of-work` (design, решение 6).
|
||||
- **Что:** вход и блок сервиса — два блока по сроку `[database]
|
||||
request_timeout_seconds`, то есть до `2T` = 12 с, а `timeout server` этих путей
|
||||
— 10 с; общего срока у роутера вложений нет (передача дольше срока блока).
|
||||
Дефект прежний: `CurrentUserBrief` и `db_scope` тоже были двумя шагами. Путь
|
||||
загрузки не затронут: его `timeout server` 30 с.
|
||||
- **Чем грозит:** при зависшем PostgreSQL клиент получает 504 от LB через 10 с
|
||||
вместо 503 реплики; данные не страдают.
|
||||
- **Предложение:** общий срок `request_deadline` на этих двух ручках на шаг до
|
||||
начала потока (вход и блок метаданных, без передачи байтов): отдельной
|
||||
зависимостью сложно, поток идёт после неё. Проще свой путь в
|
||||
`http-request set-timeout server` LB для `GET /attachments/…`. Не чинится в
|
||||
change `unit-of-work`: ручки вложений там без общего срока (решение 6).
|
||||
|
||||
## S3 на долго живущем стенде: лимит памяти при всплеске загрузок у границы байтов
|
||||
|
||||
- **Где:** сервис `s3` (`docker-compose.yml`: лимит 512 МБ, `GOMEMLIMIT=400MiB`,
|
||||
`-s3.concurrentUploadLimitMB=64`), SeaweedFS 4.48. Найдено пробой change
|
||||
`track1-queue-overload` (design, Context, проект `q1probe`, 2026-11-01).
|
||||
- **Что:** на стенде, который ~80 мин принимал пробы без пересоздания volume (~9 200
|
||||
заданий), `docker stats` показывал у S3 330–415 МиБ; при 12 загрузках 10 MiB в секунду
|
||||
ядро его убило (`exit 137`, `OOMKilled: true`, один случай). На свежем стенде те же 12 и
|
||||
15 загрузок в секунду — 322–399 МиБ и `oom_kill` 0. Зависит ли это от числа объектов,
|
||||
проба не проверяла.
|
||||
- **Чем грозит:** пока S3 лежит, загрузка и скачивание — 503. На рабочем стенде его
|
||||
возвращает `restart: unless-stopped`; в пробе (`restart: "no"`) все 229 незавершённых
|
||||
заданий за ~85 с исчерпали бюджет: `failed`, `retry_exhausted`, возврат — `make replay`.
|
||||
Принятая работа не потеряна, реестр её называет.
|
||||
- **Предложение:** замерить рост памяти S3 с числом объектов (профиль с накоплением, без
|
||||
пересоздания volume); при подтверждении — лимит 768 МБ или меньше `GOMEMLIMIT`. Метка
|
||||
`make bench_queue` этого не покажет: её ячейки идут на свежих volume.
|
||||
|
||||
## Граница живой загрузки уборщика не учитывает закрытие соединения
|
||||
|
||||
- **Где:** `src/cleaner/main.py`, `live_upload_bound_seconds`; `openspec/specs/load-balancing/spec.md`
|
||||
и `openspec/specs/service-configuration/spec.md` («17 с»). Найдено verify change
|
||||
`track1-queue-overload` (S9).
|
||||
- **Что:** формула `2 × request_timeout_seconds + [s3] timeout_seconds` = 17 с не считает закрытие
|
||||
соединения на зависшем сервере (`DB_CLOSE_TIMEOUT_SECONDS`, 2 с: возврат соединения идёт вне срока
|
||||
блока). Оценка сверху — 2 × (6 + 2) + 5 = 21 с. То же у молчания реплики до тела: 21 с вместо 17, но
|
||||
оба меньше `timeout server` 30 с, поэтому цепочка LB верна.
|
||||
- **Чем грозит:** проверка старта пропускает grace от 18 до 21 с. При 900 с по умолчанию разницы нет,
|
||||
запас огромный. На стенде отказов grace 20 с: при зависшем PostgreSQL уборщик может взять строку ещё
|
||||
живой загрузки, но данные не страдают: `mark_queued` помеченную строку не переводит, клиент получает
|
||||
503, объект удаляется.
|
||||
- **Предложение:** прибавить `2 × DB_CLOSE_TIMEOUT_SECONDS` в формулу и поднять grace стенда отказов до
|
||||
22 с и больше, отдельным change; там же поправить «17 с» в спеках. Правка меняет код уборщика и стенд
|
||||
отказов, в `track1-queue-overload` не входит.
|
||||
|
||||
## Нестандартный метод HTTP: 400 текстом uvicorn, мимо приложения
|
||||
|
||||
- **Где:** HTTP-парсер uvicorn (httptools, выбирается автоматически), `src/main.py`
|
||||
(`uvicorn.run` без `http=`). Найдено apply change `otel-telemetry` (`driver.py
|
||||
telemetry-check`, сценарий `observability` «Необычный метод и неизвестный путь»).
|
||||
- **Что:** запрос с методом, которого нет в списке llhttp (`BREW`), отклоняется парсером до
|
||||
ASGI-приложения: `400 Bad Request`, `content-type: text/plain`, тело «Invalid HTTP request
|
||||
received.», без `X-Request-Id`, `X-Instance-Id` и тела ошибки контракта; ни итоговой записи, ни
|
||||
span, ни метрики. Метод из списка llhttp, но вне стандартного набора (`PROPFIND`, `PURGE`)
|
||||
доходит до приложения: 404 в формате контракта и ряд `_OTHER`. HAProxy такой запрос передаёт.
|
||||
- **Чем грозит:** ответ API не в формате контракта на экзотический метод; сценарий спека с
|
||||
методом `BREW` по HTTP не воспроизводится — `telemetry-check` проверяет `_OTHER` на `PROPFIND`, а
|
||||
у `BREW` — только отсутствие метода и UUID в метках.
|
||||
- **Предложение:** `uvicorn.run(..., http="h11")` (h11 принимает любой токен метода) — после
|
||||
замера цены на трек 1, — или правило HAProxy, отвечающее 400 в формате контракта на методы вне
|
||||
списка; затем поправить сценарий спека. Отдельный change.
|
||||
|
||||
## Остановка API при замороженном PostgreSQL дольше срока контейнера
|
||||
|
||||
- **Где:** `src/main.py`, `await engine.dispose()` в lifespan без общего срока. Найдено
|
||||
повторным verify change `unit-of-work` (S3); дефект прежний, правкой не вызван.
|
||||
- **Что:** простаивающие соединения закрываются по очереди, каждое до
|
||||
`DB_CLOSE_TIMEOUT_SECONDS` (2 с). Замер `dispose` на замороженном сервере: пул 10 —
|
||||
20,05 с; пул 4 — 8,02 с и на `d8fe2e8`, и на `9efab79`. `docker stop` на замороженном
|
||||
PostgreSQL не проверялся: то, что контейнер получит SIGKILL после 10 с, — расчёт.
|
||||
- **Чем грозит:** только при замороженном PostgreSQL во время остановки реплики:
|
||||
журнал без «Stopped API»; данные не страдают, незафиксированное откатит сервер.
|
||||
- **Предложение:** общий срок на закрытие в lifespan, как `_CLOSE_TIMEOUT_SECONDS` у
|
||||
worker и relay, и сценарий в спеке `graceful-shutdown`.
|
||||
@@ -28,3 +28,580 @@ test-persistence:
|
||||
test-failover:
|
||||
@test -n "$(ACTION_SCRIPT)" || (echo "Set ACTION_SCRIPT to your implemented executable stop-one hook"; exit 2)
|
||||
$(PYTHON) tests/resilience.py --mode failover --action-script "$(ACTION_SCRIPT)" --base-url "$(BASE_URL)" $(TLS_ARGS)
|
||||
|
||||
|
||||
# -------------------------
|
||||
# Приложение на хосте (свои цели; цели skeleton выше не менять)
|
||||
# -------------------------
|
||||
|
||||
# Postgres из compose и миграции, Valkey и S3 с bootstrap из compose,
|
||||
# затем сервис на хосте: 127.0.0.1:APP__PORT, reload по src/
|
||||
.PHONY: run_dev
|
||||
run_dev: upgrade start_cache start_s3 start_broker
|
||||
APP__RUN_MODE=console uv run python -m src
|
||||
|
||||
# worker в консоли: тот же .env, адреса на хосте; ключи worker — в окружение
|
||||
# процесса (мост S3__* в .env — ключи API). @: значения в вывод не попадают
|
||||
.PHONY: run_worker
|
||||
run_worker:
|
||||
@S3__ACCESS_KEY_ID="$(S3_WORKER_ACCESS_KEY)" S3__SECRET_ACCESS_KEY="$(S3_WORKER_SECRET_KEY)" APP__RUN_MODE=console uv run python -m src.worker
|
||||
|
||||
# relay публикации заданий в консоли: без него консольный API принимает файлы, а
|
||||
# задания ждут в PostgreSQL. Брокер поднимает make run_dev; те же мосты .env
|
||||
.PHONY: run_relay
|
||||
run_relay:
|
||||
@APP__RUN_MODE=console uv run python -m src.relay
|
||||
|
||||
# реестр failed и replay (design change pipeline-reliability, решение 5): без
|
||||
# APPLY=1 только показ; с APPLY=1 выбор обязателен (ATTACHMENT, ERROR_CODE или
|
||||
# REASON), иначе код 2. Коды: 0 — выполнено или показано, 3 — есть отказы, 1 —
|
||||
# отказ PostgreSQL. ATTACHMENT — id вложения, можно несколько через пробел
|
||||
OPERATOR ?= $(USER)
|
||||
.PHONY: replay
|
||||
replay:
|
||||
@$(DC) run --rm --no-deps relay replay$(foreach id,$(ATTACHMENT), --attachment-id $(id))$(if $(ERROR_CODE), --error-code $(ERROR_CODE))$(if $(REASON), --reason $(REASON))$(if $(LIMIT), --limit $(LIMIT))$(if $(filter 1,$(APPLY)), --apply)$(if $(OPERATOR), --operator $(OPERATOR))
|
||||
|
||||
# шаблоны копируются только если файла ещё нет: локальные значения
|
||||
# не затираются. В .env подставляются случайные пароли Postgres и
|
||||
# Valkey и секреты S3: в шаблоне они пустые, общего секрета стенда в git
|
||||
# нет. В существующий .env дописываются переменные шаблона, которых в нём
|
||||
# нет (секреты — случайными, остальные — значениями шаблона), прежние
|
||||
# строки не меняются (design change upload-consistency). Печатаются
|
||||
# только имена, значения — нет
|
||||
ENV_SECRETS = POSTGRES_PASSWORD VALKEY_PASSWORD RABBITMQ_DEFAULT_PASS S3_ROOT_ACCESS_KEY S3_ROOT_SECRET_KEY S3_JWT_SIGNING_KEY S3_API_ACCESS_KEY S3_API_SECRET_KEY S3_CLEANER_ACCESS_KEY S3_CLEANER_SECRET_KEY S3_WORKER_ACCESS_KEY S3_WORKER_SECRET_KEY GRAFANA_ADMIN_PASSWORD
|
||||
# шаблон с подставленными секретами — в поток, не в вывод команды
|
||||
ENV_FILLED = sed \
|
||||
-e "s/^POSTGRES_PASSWORD=$$/POSTGRES_PASSWORD=$$(openssl rand -hex 16)/" \
|
||||
-e "s/^VALKEY_PASSWORD=$$/VALKEY_PASSWORD=$$(openssl rand -hex 16)/" \
|
||||
-e "s/^S3_ROOT_ACCESS_KEY=$$/S3_ROOT_ACCESS_KEY=$$(openssl rand -hex 10)/" \
|
||||
-e "s/^S3_ROOT_SECRET_KEY=$$/S3_ROOT_SECRET_KEY=$$(openssl rand -hex 20)/" \
|
||||
-e "s/^S3_JWT_SIGNING_KEY=$$/S3_JWT_SIGNING_KEY=$$(openssl rand -hex 32)/" \
|
||||
-e "s/^S3_API_ACCESS_KEY=$$/S3_API_ACCESS_KEY=$$(openssl rand -hex 10)/" \
|
||||
-e "s/^S3_API_SECRET_KEY=$$/S3_API_SECRET_KEY=$$(openssl rand -hex 20)/" \
|
||||
-e "s/^S3_CLEANER_ACCESS_KEY=$$/S3_CLEANER_ACCESS_KEY=$$(openssl rand -hex 10)/" \
|
||||
-e "s/^S3_CLEANER_SECRET_KEY=$$/S3_CLEANER_SECRET_KEY=$$(openssl rand -hex 20)/" \
|
||||
-e "s/^S3_WORKER_ACCESS_KEY=$$/S3_WORKER_ACCESS_KEY=$$(openssl rand -hex 10)/" \
|
||||
-e "s/^S3_WORKER_SECRET_KEY=$$/S3_WORKER_SECRET_KEY=$$(openssl rand -hex 20)/" \
|
||||
-e "s/^RABBITMQ_DEFAULT_PASS=$$/RABBITMQ_DEFAULT_PASS=$$(openssl rand -hex 16)/" \
|
||||
-e "s/^GRAFANA_ADMIN_PASSWORD=$$/GRAFANA_ADMIN_PASSWORD=$$(openssl rand -hex 16)/" \
|
||||
.env.example
|
||||
# строки NAME=… шаблона, имени которых в .env нет, — в конец .env под
|
||||
# комментарием; в вывод — только имена
|
||||
ENV_APPEND_MISSING = awk -F= ' \
|
||||
BEGIN { \
|
||||
while ((getline line < ".env") > 0) \
|
||||
if (line ~ /^[A-Za-z_][A-Za-z0-9_]*=/) { split(line, kv, "="); have[kv[1]] = 1 }; \
|
||||
close(".env"); \
|
||||
} \
|
||||
/^[A-Za-z_][A-Za-z0-9_]*=/ && !($$1 in have) { \
|
||||
if (!added++) printf "\n\# added by make env_setup from .env.example\n" >> ".env"; \
|
||||
print >> ".env"; names = names " " $$1 \
|
||||
} \
|
||||
END { if (added) print "added to existing .env:" names }'
|
||||
.PHONY: env_setup
|
||||
env_setup:
|
||||
@if [ ! -f .env ]; then \
|
||||
$(ENV_FILLED) > .env; \
|
||||
echo "new .env with random $(ENV_SECRETS)"; \
|
||||
else \
|
||||
$(ENV_FILLED) | $(ENV_APPEND_MISSING); \
|
||||
fi
|
||||
@test -f config.toml || cp config_example.toml config.toml
|
||||
@echo "env ready: .env, config.toml"
|
||||
|
||||
|
||||
# -------------------------
|
||||
# Docker targets
|
||||
# -------------------------
|
||||
|
||||
# порты — из того же .env, что читает compose; без .env — 8080
|
||||
-include .env
|
||||
APP__PORT ?= 8080
|
||||
APP_OUT_PORT ?= 8080
|
||||
# число реплик api за HAProxy — то же, что deploy.replicas в compose
|
||||
API_REPLICAS ?= 2
|
||||
# сколько реплик за BASE_URL ждут тесты реплик student-tests: против
|
||||
# стенда с LB — API_REPLICAS, против одного процесса — 1 (их пропуск)
|
||||
EXPECT_REPLICAS ?= $(API_REPLICAS)
|
||||
DC=docker compose
|
||||
|
||||
# стенд: postgres, valkey, s3, rabbitmq -> migrate, s3-bootstrap -> api ×
|
||||
# API_REPLICAS, cleaner, worker -> haproxy; телеметрия — otel-collector,
|
||||
# prometheus, loki, tempo, grafana (приложение их не ждёт)
|
||||
# (единственный порт API на хосте — у haproxy). env_setup создаёт
|
||||
# недостающие .env и config.toml из шаблонов: без config.toml compose не
|
||||
# запустится (bind с create_host_path: false), без паролей — тоже.
|
||||
# Реплики, чей образ изменился, пересоздаются все разом (простой); новый
|
||||
# код без простоя — make rolling_update
|
||||
.PHONY: run_docker
|
||||
run_docker: env_setup
|
||||
DOCKER_BUILDKIT=1 $(DC) build
|
||||
$(DC) up -d
|
||||
|
||||
.PHONY: stop
|
||||
stop:
|
||||
$(DC) stop
|
||||
|
||||
# контейнеры удаляются, volume с данными остаётся (удаление — wipe_data)
|
||||
.PHONY: down
|
||||
down:
|
||||
$(DC) down
|
||||
|
||||
# журнал всех реплик api без префикса "api-1 |": каждая строка — JSON,
|
||||
# реплику называет поле instance_id
|
||||
.PHONY: logs
|
||||
logs:
|
||||
$(DC) logs -f --no-log-prefix api
|
||||
|
||||
|
||||
# -------------------------
|
||||
# PostgreSQL и миграции
|
||||
# -------------------------
|
||||
|
||||
# Postgres стенда; --wait ждёт его healthcheck
|
||||
.PHONY: start_db
|
||||
start_db: env_setup
|
||||
$(DC) up -d --wait postgres
|
||||
|
||||
.PHONY: stop_db
|
||||
stop_db:
|
||||
$(DC) stop postgres
|
||||
|
||||
# миграции с хоста: 127.0.0.1:POSTGRES_OUT_PORT из .env
|
||||
.PHONY: upgrade
|
||||
upgrade: start_db
|
||||
uv run alembic upgrade head
|
||||
|
||||
# новая ревизия autogenerate; база сначала доводится до head, иначе
|
||||
# autogenerate сравнит модели не с той схемой
|
||||
.PHONY: revision
|
||||
revision: upgrade
|
||||
@read -p "Сообщение миграции (англ., прошедшее время): " msg; \
|
||||
uv run alembic revision --autogenerate -m "$$msg"
|
||||
|
||||
# удалить контейнеры стенда и volumes с данными: только после ввода yes
|
||||
.PHONY: wipe_data
|
||||
wipe_data:
|
||||
@project=$$($(DC) config | sed -n 's/^name: //p'); \
|
||||
volumes=$$($(DC) config --volumes | sed "s/^/$${project}_/" | paste -sd ' ' -); \
|
||||
read -p "Удалить все данные стенда (volumes Postgres, S3, брокера и хранилищ телеметрии: $$volumes)? Введите yes: " answer; \
|
||||
if [ "$$answer" = "yes" ]; then \
|
||||
$(DC) down -v --remove-orphans; \
|
||||
else \
|
||||
echo "cancelled, nothing removed"; exit 1; \
|
||||
fi
|
||||
|
||||
|
||||
# -------------------------
|
||||
# Valkey (кэш карточек чатов)
|
||||
# -------------------------
|
||||
|
||||
# Valkey стенда; --wait ждёт его healthcheck. Volume нет: кэш после
|
||||
# рестарта пуст, данные — в PostgreSQL
|
||||
.PHONY: start_cache
|
||||
start_cache: env_setup
|
||||
$(DC) up -d --wait valkey
|
||||
|
||||
.PHONY: stop_cache
|
||||
stop_cache:
|
||||
$(DC) stop valkey
|
||||
|
||||
|
||||
# -------------------------
|
||||
# S3 (SeaweedFS, байты вложений)
|
||||
# -------------------------
|
||||
|
||||
# S3 стенда и его bootstrap: --wait ждёт healthcheck сервера, но
|
||||
# одноразовый сервис считает готовым уже запущенным, поэтому bootstrap —
|
||||
# отдельным up с его кодом выхода (как миграции в rolling-update.sh)
|
||||
.PHONY: start_s3
|
||||
start_s3: env_setup
|
||||
$(DC) up -d --wait s3
|
||||
$(DC) up --no-deps --exit-code-from s3-bootstrap s3-bootstrap
|
||||
|
||||
# плавная остановка ~15 с (stop_grace_period 20 с)
|
||||
.PHONY: stop_s3
|
||||
stop_s3:
|
||||
$(DC) stop s3
|
||||
|
||||
# брокер стенда: --wait ждёт healthcheck; данные — в volume rabbitmq_data
|
||||
.PHONY: start_broker
|
||||
start_broker: env_setup
|
||||
$(DC) up -d --wait rabbitmq
|
||||
|
||||
.PHONY: stop_broker
|
||||
stop_broker:
|
||||
$(DC) stop rabbitmq
|
||||
|
||||
# проверка приватности bucket вне API на запущенном стенде: права ключа
|
||||
# API, чужой bucket и административные запросы (bootstrap в режиме check),
|
||||
# анонимные запросы с хоста и из сети стенда, порты контейнера S3 из сети;
|
||||
# таблица «проверка → ожидаемо → получено», проверочные объекты и bucket
|
||||
# удаляются. Код 1 — нарушение
|
||||
.PHONY: s3_check
|
||||
s3_check:
|
||||
$(PYTHON) .claude/skills/run-mtusi-messenger/driver.py s3-check
|
||||
|
||||
# разовая сверка bucket и БД в контейнере уборщика (образ собирает
|
||||
# make run_docker): по умолчанию dry-run — отчёт без изменений; APPLY=1 —
|
||||
# исправить, MAX_CHANGES=N — предел изменений прохода вместо [reconciler]
|
||||
# max_changes; STRATEGY=head — HEAD на строку вместо страниц, DEEP=1 —
|
||||
# глубокая (SHA-256 содержимого), RATE=R — предел скорости, объектов S3 в
|
||||
# секунду (0 — без предела) вместо [reconciler] max_objects_per_second.
|
||||
# Код 0 — расхождений нет, 3 — остались, 1 — прерван, 2 — конфигурация
|
||||
# (design change track2-reconciler, решения 1 и 8; track2-reconcile-cost,
|
||||
# решения 4–6)
|
||||
.PHONY: reconcile
|
||||
reconcile:
|
||||
$(DC) run --rm --no-deps cleaner reconcile$(if $(filter 1,$(APPLY)), --apply)$(if $(MAX_CHANGES), --max-changes $(MAX_CHANGES))$(if $(STRATEGY), --strategy $(STRATEGY))$(if $(filter 1,$(DEEP)), --deep)$(if $(RATE), --max-objects-per-second $(RATE))
|
||||
|
||||
|
||||
# -------------------------
|
||||
# Реплики за балансировщиком (HAProxy)
|
||||
# -------------------------
|
||||
|
||||
# вернуть остановленные реплики (scripts/stop-one.sh) и выставить их
|
||||
# число: остановленные контейнеры запускаются с теми же ID, недостающие
|
||||
# создаются, лишние удаляются; ждёт healthcheck реплик. Разовая подмена —
|
||||
# make replicas API_REPLICAS=3, следующий make run_docker вернёт число
|
||||
# из .env
|
||||
.PHONY: replicas
|
||||
replicas:
|
||||
$(DC) up -d --no-deps --no-recreate --wait --scale api=$(API_REPLICAS) api
|
||||
|
||||
# поочерёдная замена реплик на новый образ без простоя
|
||||
# (scripts/rolling-update.sh): сборка, миграции один раз, затем по одной —
|
||||
# новая реплика UP в LB, старая выводится из LB (drain), дорабатывает
|
||||
# запросы, останавливается и удаляется. COMMIT=<commit> — образ из файлов
|
||||
# commit (git archive, рабочее дерево не трогается), MIGRATE=0 — без
|
||||
# миграций (откат на прежний образ: схема только расширялась). Нужен
|
||||
# штатный стенд: API_REPLICAS реплик, все UP (make replicas)
|
||||
COMMIT ?=
|
||||
MIGRATE ?= 1
|
||||
.PHONY: rolling_update
|
||||
rolling_update:
|
||||
API_REPLICAS=$(API_REPLICAS) ROLLOUT_COMMIT="$(COMMIT)" ROLLOUT_MIGRATE=$(MIGRATE) scripts/rolling-update.sh
|
||||
|
||||
# распределение запросов одной сессии через LB: вход одним синтетическим
|
||||
# пользователем, серия GET /users/me с одним токеном, X-Instance-Id каждого
|
||||
# ответа и число ответов каждой реплики
|
||||
.PHONY: instances
|
||||
instances:
|
||||
$(PYTHON) .claude/skills/run-mtusi-messenger/driver.py --port $(APP_OUT_PORT) instances
|
||||
|
||||
# состояние реплик глазами HAProxy: занятые слоты, адрес, статус проверки,
|
||||
# соединения, запросы, ошибки соединения, повторы и перенаправления. CSV
|
||||
# статистики читается изнутри контейнера LB: порт 8404 наружу не
|
||||
# опубликован, curl в образе нет, bash есть
|
||||
LB_STATS_FIELDS = svname addr status check_status scur stot econ wretr wredis hrsp_5xx
|
||||
.PHONY: lb_stats
|
||||
lb_stats:
|
||||
@$(DC) exec -T haproxy bash -c 'exec 3<>/dev/tcp/127.0.0.1/8404 && printf "GET /stats;csv HTTP/1.0\r\n\r\n" >&3 && cat <&3' \
|
||||
| awk -F, -v fields="$(LB_STATS_FIELDS)" ' \
|
||||
/^# pxname/ { sub(/^# /, ""); for (i = 1; i <= NF; i++) col[$$i] = i; \
|
||||
n = split(fields, f, " "); for (j = 1; j <= n; j++) printf "%s\t", f[j]; print ""; next } \
|
||||
$$1 != "api" { next } \
|
||||
$$2 != "BACKEND" && $$(col["addr"]) == "" && $$(col["status"]) == "MAINT (resolution)" { free++; next } \
|
||||
{ for (j = 1; j <= n; j++) { v = $$(col[f[j]]); printf "%s\t", (v == "" ? "-" : v) }; print "" } \
|
||||
END { printf "free slots: %d\n", free }' \
|
||||
| column -t -s "$$(printf '\t')"
|
||||
|
||||
|
||||
# -------------------------
|
||||
# Load benchmark
|
||||
# -------------------------
|
||||
|
||||
BENCH_LABEL ?= baseline
|
||||
# macOS не засыпает на время замера (сон ставит ВМ Docker на паузу посреди
|
||||
# прогона): -u будит из DarkWake полностью, -i и -s не дают уснуть до
|
||||
# конца; на других ОС caffeinate нет, и префикс пустой
|
||||
KEEP_AWAKE := $(shell command -v caffeinate >/dev/null 2>&1 && echo caffeinate -isu)
|
||||
|
||||
# полная матрица на своём проекте compose mtusi-bench (API, PostgreSQL,
|
||||
# Valkey, без портов хоста), с фоновыми чатами разного размера, вариантами
|
||||
# плана и пробами записи, ~35 мин; метка не должна существовать;
|
||||
# результаты и планы запроса истории — evidence/bench/$(BENCH_LABEL)/,
|
||||
# ход — строки в терминале и progress.json
|
||||
.PHONY: bench
|
||||
bench:
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile full --label $(BENCH_LABEL)
|
||||
|
||||
# самопроверка стенда на малых размерах, ~3 мин; результат в git не идёт
|
||||
.PHONY: bench_quick
|
||||
bench_quick:
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile quick --label quick-$(shell date -u +%Y%m%dT%H%M%SZ)
|
||||
|
||||
RESTORE_LABEL ?= restore
|
||||
|
||||
# трек 2: backup под записью, восстановление в новое хранилище, сверка БД и
|
||||
# через HTTP, кэш до и после FLUSHALL — на 10k / 100k / 500k с фоновыми
|
||||
# чатами, без матрицы прогонов, ~20 мин; результат —
|
||||
# evidence/bench/$(RESTORE_LABEL)/
|
||||
.PHONY: bench_restore
|
||||
bench_restore:
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile restore --label $(RESTORE_LABEL)
|
||||
|
||||
# то же на малых размерах (самопроверка, сценарий защиты), ~1,5 мин; в git
|
||||
# не идёт
|
||||
.PHONY: bench_restore_quick
|
||||
bench_restore_quick:
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile restore_quick --label quick-restore-$(shell date -u +%Y%m%dT%H%M%SZ)
|
||||
|
||||
FAILOVER_LABEL ?= baseline
|
||||
|
||||
# уровень 4: отказ реплик под нагрузкой на стенде mtusi-bench (HAProxy, две
|
||||
# реплики с лимитами рабочего стенда): 100 записей с ключом и 100 чтений в
|
||||
# секунду, каждая реплика в режимах stop, kill и pause с возвратом,
|
||||
# посекундная шкала, время обнаружения и восстановления, сверка записей,
|
||||
# CPU и память по компонентам и окнам (сэмплер); ~6 мин; результат —
|
||||
# evidence/failover/$(FAILOVER_LABEL)/
|
||||
.PHONY: bench_failover
|
||||
bench_failover:
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile failover --label $(FAILOVER_LABEL)
|
||||
|
||||
# то же короче, режимы stop и kill (самопроверка), с CPU и памятью по
|
||||
# компонентам и окнам (сэмплер), ~2 мин; в git не идёт
|
||||
.PHONY: bench_failover_quick
|
||||
bench_failover_quick:
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile failover_quick --label quick-failover-$(shell date -u +%Y%m%dT%H%M%SZ)
|
||||
|
||||
ROLLOUT_LABEL ?= baseline
|
||||
|
||||
# уровень 4: поочерёдная замена реплик под нагрузкой на стенде mtusi-bench
|
||||
# (HAProxy, две реплики с лимитами рабочего стенда): реплики стартуют на
|
||||
# образе прежнего commit (Profile.rollout_from), посреди 100 записей с
|
||||
# ключом и 100 чтений в секунду scripts/rolling-update.sh меняет их на
|
||||
# образ текущего checkout; посекундная шкала, шаги по репликам, сверка
|
||||
# записей, CPU и память по компонентам и окнам (сэмплер); ~3 мин;
|
||||
# результат — evidence/rollout/$(ROLLOUT_LABEL)/
|
||||
.PHONY: bench_rollout
|
||||
bench_rollout:
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile rollout --label $(ROLLOUT_LABEL)
|
||||
|
||||
# то же с короткими окнами (самопроверка), с CPU и памятью по компонентам и
|
||||
# окнам (сэмплер), ~2 мин; в git не идёт
|
||||
.PHONY: bench_rollout_quick
|
||||
bench_rollout_quick:
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile rollout_quick --label quick-rollout-$(shell date -u +%Y%m%dT%H%M%SZ)
|
||||
|
||||
UPLOADS_LABEL ?= baseline
|
||||
# выключатель телеметрии профилей загрузок и очереди (лаба 6, design change
|
||||
# track1-telemetry-cost, решение 13): on — Collector, Prometheus, Loki и Tempo
|
||||
# рабочего стенда и SDK реплик, worker и relay; по умолчанию off — методика
|
||||
# прежняя. Режим — в паспорте и сводке, продолжение RESUME=1 — в том же режиме
|
||||
TELEMETRY ?= off
|
||||
|
||||
# уровень 4 лабы 4: память реплики при одновременных загрузках на стенде
|
||||
# mtusi-bench (HAProxy, одна реплика 1 CPU / 512 МБ без swap, S3 рабочего
|
||||
# стенда): варианты «до» (Profile.uploads_before), «без лимита» и «с
|
||||
# лимитом» × тела 1 и 10 MiB × 1/10/20/40 клиентов × 3 повтора, на каждый
|
||||
# прогон — новые S3 и реплика; пик памяти окна, OOM, ответы по кодам,
|
||||
# загрузок/с; ~50 мин; результат — evidence/uploads/$(UPLOADS_LABEL)/.
|
||||
# TELEMETRY=on|off — выключатель телеметрии стенда
|
||||
.PHONY: bench_uploads
|
||||
bench_uploads:
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile uploads --label $(UPLOADS_LABEL) --telemetry $(TELEMETRY)
|
||||
|
||||
# то же коротко (самопроверка): «без лимита» и «с лимитом», 10 MiB, 1/10/40
|
||||
# клиентов, один повтор, ~5 мин; в git не идёт
|
||||
.PHONY: bench_uploads_quick
|
||||
bench_uploads_quick:
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile uploads_quick --label quick-uploads-$(shell date -u +%Y%m%dT%H%M%SZ) --telemetry $(TELEMETRY)
|
||||
|
||||
# Очередь под перегрузкой (лаба 5, трек 1; design change track1-queue-overload):
|
||||
# стенд mtusi-bench с S3, брокером, relay, worker и уборщиком, настройки
|
||||
# конкуренции и prefetch × классы изображений × 3 повтора и блоки предела, приёма,
|
||||
# второго worker и рестартов, на каждую ячейку — свежий стенд; ~2 ч 10 мин;
|
||||
# результат — evidence/queue/$(QUEUE_LABEL)/. RESUME=1 — продолжить прерванную метку
|
||||
# на том же commit; TELEMETRY=on|off — выключатель телеметрии стенда
|
||||
QUEUE_LABEL ?= baseline
|
||||
.PHONY: bench_queue
|
||||
bench_queue:
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile queue --label $(QUEUE_LABEL) $(if $(RESUME),--resume) --telemetry $(TELEMETRY)
|
||||
|
||||
# то же коротко (самопроверка, защита): две настройки, предел с пределом 40 и без
|
||||
# него, рестарт worker, второй worker, окна короче, ~11 мин; в git не идёт
|
||||
.PHONY: bench_queue_quick
|
||||
bench_queue_quick:
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile queue_quick --label quick-queue-$(shell date -u +%Y%m%dT%H%M%SZ) --telemetry $(TELEMETRY)
|
||||
|
||||
# Цена наблюдаемости (лаба 6, трек 1; design change track1-telemetry-cost):
|
||||
# стенд mtusi-bench профиля очереди и, в вариантах с телеметрией, Collector,
|
||||
# Prometheus, Loki и Tempo рабочего стенда; варианты off, full, full-aa, head,
|
||||
# tail, metrics, balanced × 3 повтора кругами, свежий стенд на прогон, одинаковая
|
||||
# открытая нагрузка и редкие события; ~1 ч 50 мин; результат —
|
||||
# evidence/telemetry-cost/$(TELEMETRY_LABEL)/. RESUME=1 — продолжить прерванную
|
||||
# метку на том же commit; VARIANTS=a,b — отладка (переопределение в паспорте)
|
||||
TELEMETRY_LABEL ?= baseline
|
||||
.PHONY: bench_telemetry
|
||||
bench_telemetry:
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile telemetry --label $(TELEMETRY_LABEL) $(if $(RESUME),--resume) $(if $(VARIANTS),--variants $(VARIANTS))
|
||||
|
||||
# то же коротко (калибровка, защита «для 5»): все варианты, кроме копии A/A, по
|
||||
# одному разу, окна 10 + 30 + 15 с, ~20 мин; VARIANTS=off,full,tail — ~10 мин;
|
||||
# в git не идёт
|
||||
.PHONY: bench_telemetry_quick
|
||||
bench_telemetry_quick:
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile telemetry_quick --label quick-telemetry-$(shell date -u +%Y%m%dT%H%M%SZ) $(if $(VARIANTS),--variants $(VARIANTS))
|
||||
|
||||
RECONCILE_LABEL ?= baseline
|
||||
|
||||
# трек 2 «5» лабы 4: стоимость сверки bucket и БД на стенде mtusi-bench
|
||||
# (HAProxy, две реплики, PostgreSQL, Valkey и S3 с лимитами рабочего
|
||||
# стенда, разовые проходы уборщика 0,25 CPU / 256 МБ, в управляемом опыте
|
||||
# 1 CPU): наполнение мимо API, этапы 1 000 × 1 MiB и 10k → 30k → 100k ×
|
||||
# 4 KiB, стратегии batch и head, глубокая сверка, фоновая нагрузка с
|
||||
# пределом скорости и без, отказ по пределу на образе до change
|
||||
# (Profile.reconcile_before) и checkout, 3 повтора; ~50 мин; результат —
|
||||
# evidence/reconcile/$(RECONCILE_LABEL)/ (design change track2-reconcile-cost)
|
||||
.PHONY: bench_reconcile
|
||||
bench_reconcile:
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile reconcile --label $(RECONCILE_LABEL)
|
||||
|
||||
# то же коротко (самопроверка): 2 000 × 4 KiB, по одному проходу каждого
|
||||
# вида, окна под нагрузкой по 5 с, отказ по пределу с 300 кандидатами,
|
||||
# ~4 мин (3,7 мин на шумном хосте, 2026-10-23); в git не идёт
|
||||
.PHONY: bench_reconcile_quick
|
||||
bench_reconcile_quick:
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile reconcile_quick --label quick-reconcile-$(shell date -u +%Y%m%dT%H%M%SZ)
|
||||
|
||||
SCALING_LABEL ?= scaling-$(SERIES)
|
||||
|
||||
# уровень 5, трек 1 «Цена масштабирования»: серия на стенде mtusi-bench —
|
||||
# SERIES=a (бюджет 4 CPU: 1 × 4, 2 × 2, 4 × 1, ~50 мин), b (1…6 реплик по
|
||||
# 1 CPU, ~100 мин), pool (4 реплики при max_connections 100 и 50, ~35 мин),
|
||||
# ab (1 × 1 и 6 × 1 для «до/после» и A/A, ~35 мин), db (1, 2, 4 реплики при
|
||||
# узком лимите CPU PostgreSQL и контроль 4 × 1 при 2 CPU, ~50 мин), db4
|
||||
# (из серии db только 4 × 1 при 0,5 и 2 CPU, ~25 мин), db_quick
|
||||
# (самопроверка серии db, ~5 мин, метка quick-*); каждая ячейка — свежий
|
||||
# стенд, открытая модель, поиск R* по SLO; результат —
|
||||
# evidence/bench/$(SCALING_LABEL)/. RESUME=1 — продолжить прерванную метку
|
||||
# на том же commit
|
||||
.PHONY: bench_scaling
|
||||
bench_scaling:
|
||||
@if [ -z "$(SERIES)" ]; then \
|
||||
echo "SERIES is required: make bench_scaling SERIES=a|b|pool|ab|db|db4|quick|db_quick [SCALING_LABEL=...] [RESUME=1]"; \
|
||||
exit 2; \
|
||||
fi
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile scaling_$(SERIES) --label $(SCALING_LABEL) $(if $(RESUME),--resume)
|
||||
|
||||
# самопроверка серий: две ячейки (1 × 1 и 2 × 1 при max_connections 50),
|
||||
# короткие окна, ~5 мин; в git не идёт
|
||||
.PHONY: bench_scaling_quick
|
||||
bench_scaling_quick:
|
||||
$(KEEP_AWAKE) uv run python bench/run.py --profile scaling_quick --label quick-scaling-$(shell date -u +%Y%m%dT%H%M%SZ)
|
||||
|
||||
PLOTS ?= scaling
|
||||
|
||||
# графики и сводка серий трека 1 из меток LABELS (через пробел):
|
||||
# R* от числа реплик, p95 от интенсивности, CPU по компонентам, точка
|
||||
# насыщения; результат — evidence/plots/$(PLOTS)/, пересоздаётся
|
||||
.PHONY: bench_plots
|
||||
bench_plots:
|
||||
uv run python bench/plots.py --labels "$(LABELS)" --out "$(PLOTS)"
|
||||
|
||||
# дельта двух меток по ячейкам матрицы или, у серий трека 1, по общим
|
||||
# конфигурациям: BEFORE и AFTER обязательны, AA — метка того же кода, что
|
||||
# BEFORE, для уровня шума; CHANGE — change, к которому относится сравнение
|
||||
# серий (шапка таблицы, по умолчанию scaling-bench);
|
||||
# результат — evidence/compare/$(BEFORE)__$(AFTER).md
|
||||
.PHONY: bench_compare
|
||||
bench_compare:
|
||||
uv run python bench/compare.py --before "$(BEFORE)" --after "$(AFTER)" --aa "$(AA)" $(if $(CHANGE),--change "$(CHANGE)")
|
||||
|
||||
# «до» и «после» подряд в одной сессии, два прогона bench: bench для
|
||||
# BEFORE, commit доказательств, git revert commit REAPPLY (возврат
|
||||
# откаченного изменения), затем bench для AFTER. С SERIES=<серия> вместо
|
||||
# полной матрицы — серия трека 1 (make bench_scaling). Сам делает два
|
||||
# коммита; рабочее дерево должно быть чистым
|
||||
.PHONY: bench_ab
|
||||
bench_ab:
|
||||
$(KEEP_AWAKE) uv run python bench/ab.py --before "$(BEFORE)" --after "$(AFTER)" --reapply "$(REAPPLY)" $(if $(SERIES),--series "$(SERIES)")
|
||||
|
||||
|
||||
# -------------------------
|
||||
# Observability
|
||||
# -------------------------
|
||||
|
||||
PROMETHEUS_DIR = infra/otel/prometheus
|
||||
|
||||
# правила Prometheus без стенда и без сети (design change slo-alerts, решение
|
||||
# 11): файлы infra/otel/prometheus/ — tar в одноразовый контейнер
|
||||
# закреплённого образа Prometheus (образ — из docker-compose.yml), там promtool
|
||||
# check config, check rules и test rules; затем у каждого оповещения есть
|
||||
# runbook_url, и каждый названный runbook — файл в git. Через stdin, а не bind
|
||||
# mount: так же работает в CI (job не видит своих файлов на хосте Docker)
|
||||
.PHONY: alerts_test
|
||||
alerts_test:
|
||||
@image=$$(sed -n 's/^ *image: *\(prom\/prometheus:[^ ]*\).*$$/\1/p' docker-compose.yml | head -n 1); \
|
||||
if [ -z "$$image" ]; then echo "prometheus image is not found in docker-compose.yml"; exit 2; fi; \
|
||||
echo "promtool from $$image"; \
|
||||
tar -C $(PROMETHEUS_DIR) -cf - prometheus.yml rules.yml rules.test.yml | \
|
||||
docker run --rm -i --network none --entrypoint sh "$$image" -c \
|
||||
'set -e; cd /etc/prometheus; tar -xf -; promtool check config prometheus.yml; promtool check rules rules.yml; promtool test rules rules.test.yml'
|
||||
@alerts=$$(grep -c '^ *- alert:' $(PROMETHEUS_DIR)/rules.yml); \
|
||||
urls=$$(grep -c '^ *runbook_url:' $(PROMETHEUS_DIR)/rules.yml); \
|
||||
if [ "$$alerts" -ne "$$urls" ]; then echo "alerts: $$alerts, runbook_url: $$urls"; exit 1; fi; \
|
||||
missing=0; \
|
||||
for path in $$(sed -n 's/^ *runbook_url: *//p' $(PROMETHEUS_DIR)/rules.yml); do \
|
||||
if [ -f "$$path" ]; then echo "runbook $$path: ok"; else echo "runbook $$path: MISSING"; missing=1; fi; \
|
||||
done; \
|
||||
if [ "$$missing" -ne 0 ]; then exit 1; fi; \
|
||||
echo "alerts: $$alerts, each with an existing runbook"
|
||||
|
||||
|
||||
# -------------------------
|
||||
# Common targets
|
||||
# -------------------------
|
||||
|
||||
# собственные black-box тесты против запущенного сервера (BASE_URL).
|
||||
# EXPECT_REPLICAS — сколько реплик за BASE_URL: по умолчанию API_REPLICAS
|
||||
# (стенд с LB); против одного процесса — EXPECT_REPLICAS=1, и тесты
|
||||
# реплик пропускаются с причиной
|
||||
.PHONY: student_test
|
||||
student_test:
|
||||
BASE_URL=$(BASE_URL) EXPECT_REPLICAS=$(EXPECT_REPLICAS) uv run pytest
|
||||
|
||||
# быстрые тесты сервисов на фейках: без PostgreSQL, Valkey, S3, брокера, docker
|
||||
# и сети (design change unit-of-work, решение 13). Каталог вне student-tests:
|
||||
# правило black-box там прежнее
|
||||
.PHONY: service_test
|
||||
service_test:
|
||||
uv run pytest -c service-tests/pytest.ini service-tests/unit
|
||||
|
||||
# настоящая единица работы, тот же набор условий repo на SQL и общий срок запроса
|
||||
# на временной базе test_uow_<db> в PostgreSQL стенда; база создаётся и мигрирует
|
||||
# в начале, удаляется при любом исходе, рабочая база не затрагивается
|
||||
.PHONY: service_test_db
|
||||
service_test_db: start_db
|
||||
uv run pytest -c service-tests/pytest.ini service-tests/db
|
||||
|
||||
# образ на временной базе test_<POSTGRES_DB>: сборка, миграции, отдельный
|
||||
# контейнер api на 127.0.0.1:TEST_APP_PORT, make test и make student_test,
|
||||
# затем уборка при любом исходе. KEEP_TEST_DB=1 оставляет базу и объекты
|
||||
# S3 для разбора. Valkey и S3 общие с рабочим стендом: ключи кэша и
|
||||
# объектов разделены именем базы, префикс test_<db>/ удаляется при уборке.
|
||||
# $(PYTHON), а не uv run: uv повторно шлёт SIGINT, и Ctrl+C обрывал уборку
|
||||
.PHONY: test_isolated
|
||||
test_isolated: env_setup start_db start_cache start_s3 start_broker
|
||||
$(PYTHON) student-tests/run_isolated.py $(if $(KEEP_TEST_DB),--keep-db,)
|
||||
|
||||
# проверки отказов (pytest -m fault) на отдельном стенде: свой проект
|
||||
# compose <рабочий>-failures со своими Postgres и Valkey, обычный и
|
||||
# «тесный» API, hook student-tests/fault_hook.py; стенд и его volume
|
||||
# удаляются при любом исходе, рабочий стенд не затрагивается.
|
||||
# FAULT_ARGS — дополнительные аргументы pytest, например -k "Valkey"
|
||||
.PHONY: failure_checks
|
||||
failure_checks: env_setup
|
||||
$(PYTHON) student-tests/run_failures.py $(FAULT_ARGS)
|
||||
|
||||
.PHONY: lint
|
||||
lint:
|
||||
@ruff format .
|
||||
@echo "code formatted"
|
||||
@ruff check --fix .
|
||||
@echo "code checked and fixed if needed"
|
||||
@ruff format .
|
||||
@echo "code formatted"
|
||||
@ruff check --fix .
|
||||
@echo "code checked and fixed if needed"
|
||||
|
||||
+611
@@ -0,0 +1,611 @@
|
||||
# Вопросы и решения лабы 6
|
||||
|
||||
Решения, принятые без пользователя, и вопросы, которые не блокируют работу.
|
||||
Раздел на каждый change: `## <change>`, внутри «Решения» и «Вопросы».
|
||||
Вопросы преподавателю собраны в локальном `TEACHER_QUESTIONS.md` (не в git, по решению пользователя 2026-11-15; в
|
||||
`REPORT.md` их нет). План изменений лабы (`PLAN.md`)
|
||||
удалён после последнего шага, последняя версия — `git show db3340d:PLAN.md`; ссылки на
|
||||
него ниже — на эту версию.
|
||||
|
||||
## Ответы пользователя перед прогоном (2026-11-11)
|
||||
|
||||
- Оценка — 5, трек 1 «Цена наблюдаемости».
|
||||
- Хранилища — Prometheus (метрики), Loki (логи), Tempo (трассы), отдельными
|
||||
сервисами; интерфейс — Grafana.
|
||||
- Уровень 4 — два change: `job-trace-propagation`, затем `slo-alerts`.
|
||||
- Без пользователя можно (как в лабе 5): коммиты на ветках `feat/<change>`,
|
||||
ff-merge в `solution/bvt2301-safronov`, архивация, установка зависимостей и
|
||||
образов, запуск стенда и замеров, в конце `git push` ветки решения в свой
|
||||
fork. PR не открывать. Разрешения — `.claude/settings.local.json`.
|
||||
- Длинные замеры исключений (`make bench_uploads`, `make bench_queue`) — в
|
||||
последнем шаге, на коде лабы 6 с телеметрией.
|
||||
- Ответ на вопрос 5 `## otel-telemetry` (2026-11-11): эти замеры — с
|
||||
**включённой** телеметрией (SDK в реплике, worker и relay, Collector и
|
||||
хранилища на стенде `mtusi-bench`), как на рабочем стенде. Мерит по-прежнему
|
||||
внешний прибор (k6, сэмплер cgroup), телеметрия — часть измеряемой системы.
|
||||
Выключатель в `bench/` делает `track1-telemetry-cost`: он годится и для
|
||||
профилей `uploads` и `queue`. Вариант «до» `bench_uploads` (образ
|
||||
`9cc6c0c` без SDK) — смешанное сравнение, назвать в сводке; сумму лимитов
|
||||
`bench_queue` с телеметрией проверить до прогона.
|
||||
|
||||
## Ответы пользователя после последнего шага (2026-11-15)
|
||||
|
||||
- `## otel-telemetry`, вопрос 8: `driver.py stand-from-scratch` может сам удалять volumes своего одноразового проекта
|
||||
`mtusi-lab6-scratch*` («можно»). Переснято на `28b1704` — `evidence/stand/from-scratch.md`, код 0, 2 прогона; закрывает и
|
||||
вопрос 7 там же.
|
||||
- `## track1-telemetry-cost`:
|
||||
- вопрос 8 — метку `baseline2` не переснимать;
|
||||
- вопрос 1 — рабочий стенд на `balanced` не переводить, остаётся со всеми трассами;
|
||||
- вопрос 2 — быстрый профиль не менять: на защите ничего не запускается;
|
||||
- вопрос 3 — предупреждение о сумме лимитов CPU 12,25 у `make bench_queue TELEMETRY=on` вместо отказа — подтверждено;
|
||||
- вопрос 6 — B1 с регистрацией справочно оставить как есть.
|
||||
- `## Последний шаг`:
|
||||
- вопрос 1 — метку `baseline4` не переснимать;
|
||||
- вопрос 2 — Actions в fork пользователь включил; прогон CI для `b651e0a` — `success` (подтвердил пользователь),
|
||||
`evidence/tests/ci-application.md`.
|
||||
|
||||
## Перенос из лабы 5
|
||||
|
||||
Источник: `mtusi2026lab5-safronov`, ветка `solution/bvt2301-safronov`,
|
||||
commit `046ec9e`. Перенос — 2026-11-11.
|
||||
|
||||
### Решения
|
||||
|
||||
- Перенесены отслеживаемые файлы по AGENTS.md, «Переход в следующую лабу»,
|
||||
`git archive 046ec9e`: `src/`, `student-tests/`, `service-tests/`,
|
||||
`migrations/`, `alembic.ini`, `Dockerfile`, `docker-compose.yml`,
|
||||
`infra/valkey/`, `infra/haproxy/`, `infra/s3/`, `infra/rabbitmq/`,
|
||||
`infra/rollback/` (на него ссылаются `balancer.md` и откат реплик; в списке
|
||||
переноса его не было — список дополнен), свои `scripts/restart.sh`,
|
||||
`scripts/stop-one.sh`, `scripts/rolling-update.sh`, `pyproject.toml`,
|
||||
`uv.lock`, `.python-version`, `config_example.toml`, `AGENTS.md`,
|
||||
`CLAUDE.md`, `.claude/`, `openspec/`, `.graphifyignore`, `bench/`,
|
||||
`KNOWN_ISSUES.md`, `.github/workflows/application.yml`, `.github/ci/`.
|
||||
- Не перенесены: `README.md`, `COURSE.md`, `tests/`, `contracts/`, `lab.json`,
|
||||
`REPORT.md`, `evidence/`, `graphify-out/`, `QUESTIONS.md` (этот файл —
|
||||
новый), `.env`, `config.toml`, `.venv`.
|
||||
- `Makefile`, `.gitignore`, `.dockerignore` skeleton лаб 5 и 6 совпадают
|
||||
побайтно, поэтому взяты целиком из лабы 5 (skeleton + свои секции).
|
||||
- `.env.example` — свой файл лабы 5 без правок. Новые имена skeleton
|
||||
(`OTEL_SERVICE_NAME`, `OTEL_EXPORTER_OTLP_ENDPOINT`,
|
||||
`OTEL_EXPORTER_OTLP_PROTOCOL`, `OTEL_RESOURCE_ATTRIBUTES`) сопоставляет
|
||||
первый change лабы (`PLAN.md`), как `BROKER_URL_FILE` и др. в лабе 5.
|
||||
- Контракт API лабы 6 не изменился: `contracts/openapi.json` отличается только
|
||||
`info` (заголовок, версия 1.6.0), `contracts/README.md` и `tests/` совпадают
|
||||
с лабой 5. Новое — `contracts/observability.md`, три роли в
|
||||
`contracts/infrastructure.json` (`otel_collector`, `telemetry_storage` с
|
||||
persistent volume, `grafana` с provisioning в git), `infra/otel/README.md`.
|
||||
`tests/client.py` для лабы 6 ведёт себя как для лабы 5 (загрузка — 202).
|
||||
- Имя проекта compose и образ — `mtusi-lab6`, `mtusi-messenger:lab6`
|
||||
(`docker-compose.yml`, спеки `container-run` и `container-image`, правила
|
||||
`docker.md` и `balancer.md`, драйвер и `SKILL.md`, комментарии override CI
|
||||
и стенда отказов), префикс проектов CI — `mtusi-lab6-safronov-ci-`. Иначе
|
||||
стенд лабы 6 подключился бы к volumes лабы 5.
|
||||
- `.claude/settings.local.json` (не в git) — только запреты: удаление
|
||||
volumes лаб 5 и 6, `make wipe_data`, `down -v`, force push. Разрешения
|
||||
прогона лабы 5 (commit, merge, push) не перенесены: для лабы 6 их даёт
|
||||
пользователь перед прогоном (`PLAN.md`, «Что решает пользователь»).
|
||||
- Commit «до» профилей `rollout`, `uploads`, `reconcile` стенда `bench/`
|
||||
(`Profile.rollout_from`, `uploads_before`, `reconcile_before`) указывали на
|
||||
commit лабы 5 (`7f38948`, `04f8592`), которых в истории лабы 6 нет: профили
|
||||
отказали бы с кодом 2 до стенда. Они переведены на commit переноса `9cc6c0c`
|
||||
отдельным коммитом, как `cc33a03` в лабе 5. Там же код успеха варианта «до»
|
||||
профиля `uploads` — 202 вместо 201 (`uploads_success_codes`): «до» теперь код
|
||||
лабы 5, его загрузка отвечает 202; с 201 вариант насчитал бы ноль успешных.
|
||||
- Проверено на рабочем дереве после переноса: `make check` — PASS; `ruff
|
||||
check` и `ruff format --check` — чисто (545 файлов); `make service_test` —
|
||||
215 passed; `make run_docker` на новом проекте `mtusi-lab6` — см. дефект
|
||||
ниже, после повторного `docker compose up -d --wait` все сервисы `healthy`
|
||||
/ `running`; `make test` — PASS («lab6 public API scenario»); `make
|
||||
student_test` — 223 passed, 1 failed: `test_exclusion_evidence_exists`
|
||||
(ожидаемо, evidence не переносится). Нет 10 файлов:
|
||||
`evidence/attachments/failover.md`, `evidence/attachments/storage.md`,
|
||||
`evidence/auth/passwords-and-tokens.md`, `evidence/broker/isolated.md`,
|
||||
`evidence/broker/stand.md`, `evidence/cache/hits.md`,
|
||||
`evidence/idempotency/replay-after-restart.md`,
|
||||
`evidence/queue/baseline4/summary.md`,
|
||||
`evidence/replicas/test-persistence.md`,
|
||||
`evidence/uploads/baseline/summary.md`. Сверка становится зелёной, когда
|
||||
они сняты заново на стенде лабы 6 (`PLAN.md`, шаг 0 и последний шаг).
|
||||
- Найден дефект первого старта RabbitMQ на пустом volume (`eacces` на
|
||||
`.erlang.cookie` из-за healthcheck от root): `make run_docker` из чистого
|
||||
clone падает на «dependency failed to start». Записан в `KNOWN_ISSUES.md`
|
||||
с предложением правки, не исправлен: правка входит в первый change
|
||||
(`PLAN.md`).
|
||||
|
||||
### Вопросы
|
||||
|
||||
Пока нет: решения пользователя — раздел «Ответы пользователя перед прогоном».
|
||||
|
||||
## otel-telemetry
|
||||
|
||||
Change `openspec/changes/archive/2026-11-11-otel-telemetry/` (propose и архив 2026-11-11). Номера —
|
||||
решения design.
|
||||
|
||||
### Решения
|
||||
|
||||
- Развилки `PLAN.md` (раздел «1. `otel-telemetry`»): Collector — contrib 0.164.0, ради `tail_sampling` трека 1 (1); логи —
|
||||
из SDK, процессором structlog в обеих цепочках, а не `filelog` по журналам Docker (2); метрики — `prometheus` exporter
|
||||
Collector и scrape Prometheus, а не OTLP-приёмник Prometheus и не remote write (3); инструментирование — вручную в
|
||||
единственных точках вызова, библиотек автоинструментирования нет: `instrumentation-sqlalchemy` 0.66b2 требует
|
||||
`sqlalchemy<2.1`, а в lock 2.1.1 (4); relay и уборщик — без SDK до change 2 (5); `scripts/restart.sh` сервисы телеметрии
|
||||
не трогает, история проверяется `telemetry-check` (6); начальные лимиты телеметрии — 2,5 CPU и 2048 МиБ, итог — по
|
||||
замеру (7).
|
||||
- Версии — последние патчи линий, вышедшие хотя бы за две недели до прогона: Prometheus v3.15.1, Loki 3.7.9, Tempo 3.1.1;
|
||||
Grafana 13.3.1 — патч всех линий от 10.11 (1).
|
||||
- Настройки — секция `[telemetry]`, по умолчанию выключено; стенд включает её окружением `api` и `worker`. Имена skeleton
|
||||
`OTEL_*` не настройки: SDK собирается из явных значений, переменные `OTEL_*` удаляются из окружения процесса с `warning`
|
||||
(8).
|
||||
- `service.version` — версия контракта `1.6.0` (заодно `FastAPI(version=…)` вместо устаревшего 1.5.0), а не commit сборки
|
||||
(9).
|
||||
- API не продолжает входящий `traceparent` клиента: публичная точка входа (10).
|
||||
- Класс статуса HTTP — первая цифра `http.response.status_code` в запросах; отдельной метки нет (10).
|
||||
- Исход доставки worker (`ready`, `failed`, `retry`, `skipped`, `requeued`, `dropped`, `error`) возвращает сервис, метрику
|
||||
и span пишет точка входа; меняется тип результата `handle` и быстрые тесты сервиса (11).
|
||||
- Текст исключений в span не пишется — только класс ошибки; traceback — в журнале (10, 12).
|
||||
- Закрытие SDK — со своим сроком в отдельном потоке: пробы — до 6 с на `shutdown()` при замороженном Collector (13).
|
||||
- Grafana — без состояния (tmpfs), без загрузки плагинов, лишние встроенные источники выключены (проба: 368 → 251 МиБ) (16).
|
||||
- Хранилища и Grafana — в отдельной сети `telemetry`, наружу — только Grafana на `127.0.0.1` (17).
|
||||
- Collector, Loki и Tempo без healthcheck Docker: в образах нет оболочки и HTTP-клиента; живость — `up` в Prometheus (18).
|
||||
- Брокер: healthcheck от пользователя брокера (`gosu rabbitmq`) — закрывает дефект первого старта (19).
|
||||
- Консоль, `make test_isolated`, стенд отказов и `bench/` — без телеметрии (20).
|
||||
- Проверка «стенд с нуля» — команда драйвера со своим проектом compose, которая сама удаляет свои volumes:
|
||||
`make wipe_data` и `down -v` агенту запрещены (21).
|
||||
- Apply (2026-11-11), подробности — design, «Уточнения apply»:
|
||||
- `BREW` не доходит до приложения (парсер uvicorn, 400 текстом): `_OTHER` проверен на `PROPFIND`, дефект — в
|
||||
`KNOWN_ISSUES.md` (п. 2);
|
||||
- атрибуты сверх решения 12: `stored` у `SET` Valkey, `messenger.s3.result`, `error.type` = код у 5xx без исключения,
|
||||
атрибуты процесса обработки (п. 3);
|
||||
- закрытие SDK — по потоку на провайдер (п. 4); подтверждение доставки — внутри места конкуренции (п. 5);
|
||||
- Grafana: выключены 15 встроенных источников, кроме prometheus, loki, tempo; сверх решения — получение ключей
|
||||
плагинов, внешние снимки, ссылки обратной связи, gravatar (п. 6);
|
||||
- `level=error` Loki «empty ring» на старте и Tempo «no jobs found» в простое — шум, не отказ (п. 7);
|
||||
- `stand-from-scratch` останавливает рабочий стенд на время проверки (`make stop` / `docker compose start`) (п. 10);
|
||||
- лимиты решения 7 подтверждены замером, не менялись (п. 11).
|
||||
- Правки по verify (2026-11-11, design, «Уточнения apply», п. 13–18):
|
||||
- дренаж API 9 с с включённой телеметрией — ошибка настроек с именем `app.graceful_shutdown_seconds` (8 + 1 с SDK ≤ 9
|
||||
с), без телеметрии 9 с допустимы; у worker закрытие SDK — внутри прежнего окна 0,5 с (п. 13);
|
||||
- экспортёры OTLP — своя `requests.Session` с `trust_env=False`: прокси окружения не действуют (п. 14);
|
||||
- сценарий «Необычный метод и неизвестный путь» — на `PROPFIND` и `GET`, `BREW` — ограничение (п. 15);
|
||||
- `telemetry-check`: ссылки лог ↔ трасса источников Grafana, нет рядов health, `service.instance.id` worker (п. 16);
|
||||
- `stand-from-scratch --project` — только `mtusi-lab6-scratch[-…]`, иначе код 2 до docker (п. 17).
|
||||
|
||||
### Вопросы
|
||||
|
||||
Не блокируют работу; ответ меняет только указанное место.
|
||||
|
||||
1. Преподавателю: класс статуса HTTP («method, route template, status class») — допустимо ли выводить его из кода статуса в
|
||||
запросах (`http_response_status_code=~"5.."`) без отдельной метки? Иначе — атрибут `http.response.status_class` в
|
||||
middleware и в запросах dashboard.
|
||||
2. Преподавателю: restart hook перезапускает API и хранилища бизнес-данных, но не хранилища телеметрии; сохранность истории
|
||||
телеметрии показана отдельно (`evidence/telemetry/check.md`). Достаточно ли так? Иначе — строка в `scripts/restart.sh`.
|
||||
3. Преподавателю: `service.version` — версия контракта, а не ревизия сборки. Иначе — аргумент сборки и четыре пути сборки
|
||||
(design, решение 9).
|
||||
4. Преподавателю: ответы, которые генерирует HAProxy (502, 503, 504), в метрики API не попадают, метрик HAProxy на уровне 3
|
||||
нет. Для SLO уровня 4 это решает change `slo-alerts`.
|
||||
**Решается в change `slo-alerts` (design, решение 2):** метрики HAProxy через Collector, SLI доступности — по ответам LB
|
||||
клиентам; вопрос преподавателю о такой трактовке — `## slo-alerts`, вопрос 2.
|
||||
5. **Отвечено 2026-11-11: с включённой телеметрией** («Ответы пользователя перед прогоном»). Пользователю: метки последнего шага (`make bench_uploads`, `make bench_queue`) по методике `bench/` снимаются с
|
||||
выключенным SDK: «код лабы 6 с телеметрией» — код есть, телеметрия выключена. Если нужны метки с включённой телеметрией —
|
||||
это профиль трека 1 (change `track1-telemetry-cost`) и другая методика.
|
||||
6. Преподавателю (apply): сценарий `observability` «Необычный метод и неизвестный путь» назван методом `BREW`, а его
|
||||
uvicorn отклоняет до приложения (400 не в формате контракта, `KNOWN_ISSUES.md`). Достаточно ли `_OTHER` на методе,
|
||||
который доходит до приложения (`PROPFIND`)? Иначе — `http="h11"` у uvicorn или правило HAProxy (отдельный change).
|
||||
7. Пользователю (apply): перед замерами для отчёта переснять `telemetry-check`, `telemetry-outage`,
|
||||
`stand-from-scratch` и бюджет на закоммиченном коде — evidence сняты на незакоммиченном дереве поверх `9b35c25`.
|
||||
Сделано частично: `telemetry-check` и `telemetry-outage` пересняты на `68f1e97`; замер бюджета на нём поднял лимиты
|
||||
Tempo и Grafana (design, «Уточнения apply», п. 19); `budget.md` переснят на `4178b3d`. `stand-from-scratch` не
|
||||
переснят: запуск команды агентом 2026-11-11 отклонил классификатор режима auto (вопрос 8), `evidence/stand/
|
||||
from-scratch.md` — прежний, с рабочего дерева поверх `9b35c25`. Нужен запуск пользователем (`make stop`, `python3
|
||||
.claude/skills/run-mtusi-messenger/driver.py stand-from-scratch --runs 2`, `docker compose start`) или разрешение.
|
||||
8. Пользователю (verify W4): `driver.py stand-from-scratch` сам удаляет volumes своего проекта (`docker compose -p
|
||||
mtusi-lab6-scratch… down -v` в начале, после каждого прогона и при Ctrl+C), а deny-правила `.claude/settings.local.json`
|
||||
запрещают агенту `down -v`. Подтвердите, что так можно для одноразового проекта `mtusi-lab6-scratch*` (как у `make
|
||||
failure_checks` со своим `<рабочий>-failures`). Имя проекта команда теперь принимает только по шаблону
|
||||
`^mtusi-lab6-scratch(-[a-z0-9]+)?$`, иначе код 2 до вызовов docker. Настройки разрешений не менялись. Иначе —
|
||||
убирать проект scratch руками пользователя, а команда только печатает команду уборки.
|
||||
|
||||
### Предложения на потом
|
||||
|
||||
Найдено verify, решено не исправлять в этом change.
|
||||
|
||||
- S2: evidence для сценария «Restart hook не трогает телеметрию» — по коду выполняется (`scripts/restart.sh` сервисы
|
||||
телеметрии не называет), но вывода нет. Предложение: в `telemetry-check` или отдельной пробе — `StartedAt` сервисов
|
||||
телеметрии до и после `make test-persistence ACTION_SCRIPT=scripts/restart.sh` (задача 11.5 его уже сверяет на глаз).
|
||||
- S4: relay и уборщик SDK не запускают, но загружают его модули через `SqlAlchemyUnitOfWork` (`src/infra/db/uow.py` →
|
||||
`src/infra/telemetry`): 139 модулей, RSS уборщика ~100 МиБ при ~90 МиБ в `docker.md`. Предложение для change 2: ленивый
|
||||
импорт SDK в `src/infra/telemetry` (до `start`) или замер `memory.peak` relay и уборщика и правка `docker.md`.
|
||||
Решено в change `job-trace-propagation` (design, решение 7): ленивый импорт.
|
||||
|
||||
## job-trace-propagation
|
||||
|
||||
Change `openspec/changes/archive/2026-11-11-job-trace-propagation/` (propose и архив 2026-11-11). Номера — решения design.
|
||||
|
||||
### Решения
|
||||
|
||||
- Развилки `PLAN.md` (раздел «2. `job-trace-propagation`»):
|
||||
- parent или link — consumer span дочерний к контексту сообщения и с link на него (2): обработка по одному сообщению без
|
||||
объемлющего span, semantic conventions messaging это допускают и требуют link; одна трасса на загрузку и цельная выборка
|
||||
цепочки при head sampling трека 1. Span producer — на каждую публикацию, в клиенте брокера, дочерний к контексту загрузки,
|
||||
сохранённому в задании (3, 4);
|
||||
- источник очереди — relay: снимок по PostgreSQL раз в 5 с одним запросом по частичным индексам (проба — 0,31 мс), стадии
|
||||
`scheduled`, `outbox`, `published`, `processing`, возраст старейшего незавершённого от устойчивого приёма (9); не
|
||||
приёмник Collector (пароль PostgreSQL у Collector) и не метрики брокера (нет outbox и возраста);
|
||||
- смесь версий при `make rolling_update` — строки и сообщения без контекста: span producer нет, consumer span — корень, как
|
||||
на уровне 3; ни одна комбинация версий не даёт ошибки (6);
|
||||
- `docker.sock` у Collector отвергнут (доступ к API Docker — root на ВМ): CPU и память — из cgroup v2 изнутри контейнеров
|
||||
API, worker и relay (12).
|
||||
- Carrier — заголовки AMQP `traceparent` и `tracestate`, тело сообщения по `contracts/jobs.schema.json` не меняется (1):
|
||||
неверное значение в теле сделало бы сообщение «не по схеме» (`dropped`), а заголовок просто игнорируется;
|
||||
`contracts/attachment-states.md` native headers допускает, отображение полей — в `REPORT.md`.
|
||||
- Контекст в задании — колонки `attachment_jobs.traceparent`, `tracestate` (`text NULL`, CHECK `NOT VALID`), пишет загрузка
|
||||
через зависимость API; сервис телеметрию не импортирует (4).
|
||||
- Sampler — `ParentBased(ALWAYS_ON)`: при 100 % то же, флаг выборки контекста задания соблюдается; baggage не переносится (5).
|
||||
- SDK в relay (`messenger-relay`); у уборщика и команды replay SDK нет; модули SDK грузятся только при запуске телеметрии —
|
||||
закрывает S4 change `otel-telemetry` (проба: −322 модуля и −10 МиБ RSS) (7).
|
||||
- `handle()` worker возвращает DTO итога доставки (исход, попытка, причина, код ошибки, время до готовности); время до
|
||||
готовности — от записи задания до фиксации `ready`, задания после replay не учитываются (8).
|
||||
- Пул — `db.client.connection.*` semantic conventions; ожидающие и отказы по сроку считает пул `CountingQueuePool` (публичный
|
||||
`Pool.connect()`), фабрика engine о телеметрии не знает (10).
|
||||
- Насыщение worker — занятые места, ёмкость, ожидающие места доставки и среднее за окно по сумме длительностей (11).
|
||||
- Без `messaging.message.id` и без span Create и Settle: `id` задания в span — против решения 12 change `otel-telemetry`,
|
||||
подтверждение — внутри consumer span (13, Non-Goals).
|
||||
- Новых параметров `[telemetry]` нет: интервал и срок свежести снимка очереди, границы времени до готовности — константы.
|
||||
- Dashboard уровня 4 — тот же `messenger-overview.json` (без нового bind mount и `configs` CI) (14); проверка — одна команда
|
||||
драйвера `trace-chain` (16).
|
||||
- Apply (design, «Уточнения apply»): redis-py 8.1 сам грузит модули метрик SDK — тест ленивого импорта сравнивает с `import
|
||||
redis.asyncio` (п. 1); запись о недоступных метриках контейнера — только stdout (п. 3); раскладка модулей пакета (п. 4);
|
||||
поля итога у `skipped` и `requeued` (п. 5); снимок после полного пакета (п. 6); Tempo собирает трассу повтора и replay — решение
|
||||
2 прежнее (п. 7); `trace-chain` складывает счётчики двух процессов worker и запускает их `docker start` (п. 8); relay в
|
||||
`telemetry-outage` (п. 9); память уборщика (п. 10); логгер пула на WARNING (п. 11); бюджет relay без изменения лимита (п. 12);
|
||||
evidence раздела 12 на `72cfa9a`: «ревизия до и после» через откат реплик на `ff0073e` и `downgrade -1` (п. 13), Grafana
|
||||
сверх правила 1,5 × пика (п. 14, вопрос 6), предусловие `trace-chain` на нетихом стенде (п. 15), возврат сигналов relay
|
||||
после `docker start` в `telemetry-outage` (п. 16).
|
||||
|
||||
### Вопросы
|
||||
|
||||
Не блокируют работу; ответ меняет только указанное место.
|
||||
|
||||
1. Преподавателю: «End-to-end time to ready — от durable acceptance до публикации ready» измеряется от записи задания (та же
|
||||
транзакция, что `queued`, до ответа 202) до фиксации `ready`, а задания после replay не учитываются: их приём — действие
|
||||
оператора. Достаточно ли так? Иначе — время replay из аудита `attachment_job_replays` (worker, решение 8).
|
||||
2. Преподавателю: «process/container CPU/RAM» — только у процессов с SDK (реплики API, worker вместе с процессами обработки,
|
||||
relay), из их cgroup; PostgreSQL, S3, брокер, LB и уборщик не представлены, потому что сокет Docker у Collector — root на
|
||||
ВМ. Достаточно ли? Иначе — `docker_stats` или cAdvisor с названной ценой (решение 12).
|
||||
3. Преподавателю: «Queue depth» — логическая очередь заданий по стадиям из PostgreSQL (outbox, отложенные повторы, в брокере,
|
||||
в обработке), а не счётчик очереди RabbitMQ: очередь брокера — стадия `published`. Достаточно ли? Иначе — плагин
|
||||
`rabbitmq_prometheus` и доступ к брокеру из сети телеметрии (решение 9).
|
||||
4. Пользователю (apply): сценарий `observability` «Модули SDK без телеметрии не загружаются» буквально не выполним, пока
|
||||
установлен SDK: redis-py 8.1 при импорте сам грузит `opentelemetry.sdk.metrics` (35 модулей). Экспортёра, провайдеров
|
||||
трасс и логов, protobuf и `requests` нет; экономия ленивого импорта — ~6,5 МиБ и ~200 модулей. Принять как есть (тест
|
||||
сравнивает с `import redis.asyncio`) или уточнить сценарий в archive («кроме модулей, которые загружают сторонние
|
||||
библиотеки»)? Ответ меняет только формулировку сценария и докстринг теста (design, «Уточнения apply», п. 1).
|
||||
**Закрыт на verify (W1):** сценарий и требование переформулированы по фактической проверке — нет провайдеров и модулей
|
||||
SDK трасс и журнала, экспортёра, protobuf и `requests`, модулей SDK метрик не больше, чем у `import redis.asyncio`
|
||||
(design, «Уточнения apply», п. 17); тест прежний.
|
||||
5. Пользователю (apply): `memory.peak` уборщика на рабочем стенде — 176 МиБ при лимите 256 (плановая сверка при старте);
|
||||
правило «лимит ≥ 1,5 × пика» для него не выполнено (264). Поднять лимит до 288 МиБ (сумма стенда +32 МиБ, до ВМ остаётся
|
||||
222 МиБ) или оставить: пик — сверка, а не этот change? Ответ — правка `docker-compose.yml`, `docker.md` и `REPORT.md`
|
||||
(design, «Уточнения apply», п. 10). Замер задачи 12.4 на `72cfa9a` (свежая cgroup, плановая сверка при старте, затем
|
||||
`make test` + `make load` + `make student_test` + `trace-chain`) — пик 107,7 МиБ, правило выполнено (162 ≤ 256): 176 МиБ
|
||||
был у прежнего контейнера, пик зависит от прохода сверки (`evidence/telemetry/budget.md`, раздел change).
|
||||
6. Пользователю (apply, задача 12.4): `memory.peak` Grafana — 343,2 МиБ при лимите 512 (1,5 × пик = 515 > 512), в замерах
|
||||
`otel-telemetry` — 248–294. Пик набран сразу после рестарта Grafana в `telemetry-outage` и включает файловый кэш (`anon`
|
||||
188, `file` 95 МиБ; `docker stats` — до 261). По правилу `telemetry.md` (`memory.peak`) лимит не выполнен на 3 МиБ;
|
||||
лимит Grafana — не предмет change, код и compose не менялись. Поднять до 576 МиБ (сумма стенда +64 МиБ, до ВМ остаётся
|
||||
190 МиБ), мерить без кэша (`anon` + `kernel`) или оставить? Ответ — правка `docker-compose.yml`, `docker.md`,
|
||||
`REPORT.md` и `budget.md` (решает verify).
|
||||
**Закрыт на verify (W5):** мерить без кэша — `memory.peak` включает файловый кэш, который ядро освобождает до OOM;
|
||||
неосвобождаемая часть `anon` + `kernel` + `shmem` ≈ 197 МиБ, 1,5 × ≈ 296 ≤ 512, лимит не меняется. Правило «что считать
|
||||
пиком» — `telemetry.md` и `docker.md`, вывод `budget.md` и `REPORT.md` исправлены (design, «Уточнения apply», п. 21).
|
||||
|
||||
### Решения apply по verify
|
||||
|
||||
- W2–W4, S2–S4 исправлены (design, «Уточнения apply», п. 18–20, 22–24; `tasks.md`, раздел 13). Без пользователя решено:
|
||||
`telemetry-outage` проверяет возврат сигналов в первом окне каждого вида и останавливает процессы во втором окне того же
|
||||
вида (команда ~3,5 мин); непредвиденная ошибка снимка очереди relay повторяется не чаще интервала снимка (5 с), а не на
|
||||
каждом проходе; панель пула — две оси с разными единицами, а не две панели (раскладка строки «Saturation» прежняя);
|
||||
`trace-chain` на нетихом стенде — код 2, как «нет стенда».
|
||||
|
||||
### Предложения на потом
|
||||
|
||||
- S1 (verify, для change `slo-alerts`): `increase()` недосчитывает после рестарта worker — новый процесс начинает
|
||||
counter с нуля под тем же `instance`, и если он насчитал больше прежнего, Prometheus сброса не видит (`trace-chain`
|
||||
складывает «тихие» значения двух процессов, «Уточнения apply», п. 8). Для правил SLO и alert это занижение ошибок и
|
||||
готовых заданий. Варианты: created timestamps Prometheus 3 (`created-timestamp-zero-ingestion`: Collector-экспортёр
|
||||
должен отдавать `_created`, проверить) или окна правил длиннее типичного времени жизни процесса с оговоркой в runbook;
|
||||
либо `service.instance.id` с суффиксом запуска процесса (меняет число рядов — цена в кардинальности).
|
||||
Решается в change `slo-alerts` (design, решение 6): экспортёр Collector отдаёт время начала ряда только в protobuf —
|
||||
scrape `PrometheusProto` и `created-timestamp-zero-ingestion`, срок рядов экспортёра 1 мин; быстрый перезапуск того же
|
||||
процесса (быстрее ~75 с) остаётся ограничением.
|
||||
|
||||
## slo-alerts
|
||||
|
||||
Change `openspec/changes/archive/2026-11-14-slo-alerts/` (propose 2026-11-11, заархивирован 2026-11-14). Номера — решения
|
||||
design.
|
||||
|
||||
### Решения
|
||||
|
||||
- Пользователь (2026-11-11, на propose, через основную сессию): бюджет ВМ — не ограничение при выборе; новые сервисы
|
||||
(Alertmanager и любые другие) брать, если они дают пользу, и не отвергать вариант из-за суммы лимитов. Сумма лимитов
|
||||
по-прежнему считается и записывается (`docker.md`, `REPORT.md`), даже если она больше ВМ.
|
||||
- Пользователь (2026-11-11): ресурсы ВМ Docker Desktop можно увеличить; если сумма лимитов стенда превышает ВМ (12 CPU /
|
||||
7934 МиБ) или запаса не хватает, решение не урезается, а отчёт называет отдельной строкой, сколько CPU и памяти нужно ВМ и
|
||||
почему (вопрос 1).
|
||||
- Развилки `PLAN.md` (раздел «3. `slo-alerts`»):
|
||||
- правила Prometheus (файл в git, `promtool test rules`), а не правила Grafana (3);
|
||||
- Alertmanager не ставится — по функции, а не по бюджету: доставки нет, состояние и история firing / resolved — в
|
||||
Prometheus (`ALERTS`) и Grafana, подавление зависимых оповещений нужно в одном месте и выражено в условии (3).
|
||||
- SLI доступности — на публичном frontend LB, вместе с ответами самого LB (502, 503, 504); источник — встроенный экспортёр
|
||||
HAProxy, его забирает Collector (приёмник `prometheus`), сеть хранилищ прежняя (2). Закрывает вопрос 4 `## otel-telemetry`.
|
||||
- SLO: доступность 99,5 %, задержка «лёгких» ручек не дольше 0,25 с — 99 %, время до `ready` не дольше 30 с — 99 %; окно —
|
||||
скользящие 7 суток (срок хранения Prometheus); правила записи — приращения событий за 5 мин (1).
|
||||
- Оповещения — семь, пороговые, окна 2 мин, `for` от 30 с до 2 мин; runbook — файл `infra/otel/runbooks/<имя>.md`,
|
||||
`runbook_url` — путь в репозитории (4, 5).
|
||||
- S1 `## job-trace-propagation`: время начала рядов экспортёра Collector по protobuf и `created-timestamp-zero-ingestion`
|
||||
Prometheus, срок рядов экспортёра 1 мин (6); проба — `resets` 1 и `increase` 25,5 при 25 настоящих против 0 и 15,6.
|
||||
- Collector: очереди экспорта Loki 16 МиБ и Tempo 8 МиБ по байтам, два отправителя, повторы до 30 с, без блокировки приёма
|
||||
(7).
|
||||
- SDK: очереди и сроки прежние; внутренние метрики SDK (`otel.sdk.*`) включает код на время конструирования, а не поле
|
||||
`[telemetry]` и не внешняя `OTEL_*` (8).
|
||||
- Учёт потерь — сумма счётчиков по процессу, а не `increase()`: первая потеря нового ряда учитывается (9).
|
||||
- Без histogram длительности запросов PostgreSQL: для инцидента 2 хватает span БД, пула и CPU реплик (Non-Goals, как
|
||||
JTP-10).
|
||||
- Проверки — `make alerts_test` (и в CI), команды драйвера `alerts-check` и `backend-outage`; медленная БД — блокировка
|
||||
таблицы сообщений в отдельной сессии PostgreSQL, а не лимит CPU контейнера (11).
|
||||
- Пользователь (2026-11-11, во время apply): ВМ Docker Desktop перезапущена с памятью 12 ГБ — `docker info`: 12 CPU,
|
||||
MemTotal 11 902 МиБ. Это ответ на вопрос 1: строки бюджета в `docker.md` и `REPORT.md` — по новой ВМ.
|
||||
|
||||
### Решения apply
|
||||
|
||||
Без пользователя; подробности и отклонения — design, «Уточнения apply».
|
||||
|
||||
- Тест внутренних метрик экспортёра OTLP — через `Exporters(spans=None, logs=None)` и подставную `requests.Session.send`;
|
||||
`otlp_exporters()` разделён на три функции (п. 1).
|
||||
- Глобальные протоколы scrape — список Prometheus 3.15.1 по умолчанию, снятый с `/api/v1/status/config` (п. 4).
|
||||
- Нагрузка драйвера — 6 потоков записи и 1 чтения: иначе блокировка таблицы сообщений не даёт 10 % медленных «лёгких»
|
||||
запросов (п. 7).
|
||||
- `telemetry-check` проверяет ещё метрики LB (сценарии «Метрики балансировщика без доступа к сети хранилищ» и
|
||||
`load-balancing` «Метрики балансировщика»), а обход панелей всех команд подменяет `$__range` на `1h` (пп. 5, 6).
|
||||
- Span PostgreSQL с ошибкой при остановленной БД — наблюдение, не проверка: отказ на выдаче соединения span запроса не
|
||||
создаёт (п. 9).
|
||||
- Сверка SLI за час «по исходным счётчикам» — сумма `increase(…[5m])` исходных селекторов в тех же окнах, что у правил;
|
||||
`increase` за час одним окном — наблюдение: непересекающиеся окна теряют приращение на границах, а при остановленном
|
||||
Prometheus окна нет (п. 12). Пауза блокировки 0,2 с вместо 0,5, нагрузка — чтение раз в 1 с, 3 потока входа, 20
|
||||
хороших загрузок перед шагами (п. 7, 12).
|
||||
- «Ожидающих соединения пула нет» проверяется как «пул не занят целиком и отказов по сроку нет»: счёт `pending` включает
|
||||
проверку при выдаче и открытие соединения (п. 14).
|
||||
|
||||
Вопрос verify: устраивает ли такая трактовка двух сценариев спека («SLO считается» — те же окна; «Медленный handler» —
|
||||
место в пуле, а не мгновенный `pending`)? Иначе — правка спека или новый счётчик «ждут места» отдельно от открытия.
|
||||
**Ответ verify (2026-11-14):** трактовка устраивает, новых счётчиков не нужно — исправлен текст двух сценариев дельты
|
||||
`observability` под проверку; у доступности и задержки `alerts-check` сверяет ещё и с `increase` одним окном часа
|
||||
(design, «Уточнения apply», п. 18).
|
||||
- Evidence раздела 11 — на commit `15ea156` без правок кода; `rules-test.md` от 2026-11-11 оставлен (повторный прогон —
|
||||
тот же вывод); пик Collector в долгом отказе хранилища — по `docker stats` и метрикам Collector, а не по
|
||||
`memory.peak`: шаг отказа Collector в той же команде начинает новую cgroup (design, «Уточнения apply», п. 16).
|
||||
|
||||
### Решения apply по verify
|
||||
|
||||
Без пользователя (verify 2026-11-14, tasks, раздел 12); подробности — design, «Уточнения apply», пп. 17–22.
|
||||
|
||||
- Ноль ряда потерь процесса SDK — по ряду ёмкости очереди span (`… or sum by (job, instance)
|
||||
(otel_sdk_processor_span_queue_capacity) * 0`), как предложил verify; у Collector отдельной части не нужно: его ряды
|
||||
`otelcol_receiver_refused_*` есть с нуля со старта (п. 17).
|
||||
- Описание с текущим значением там, где `$value` пустое по смыслу (`absent()`, `up == 0`), — возраст последнего снимка
|
||||
очереди и число недоступных целей шаблоном `query` (п. 21).
|
||||
- Проверка «Без потерь» в `telemetry-check` ждёт тихого стенда до 330 с (окно `rate()` панели 5 мин), а не падает сразу:
|
||||
иначе прогон сразу после `backend-outage` видел бы его потери (п. 22).
|
||||
- Срок медленной БД — 4 мин в спеке и драйвере (п. 20).
|
||||
- Гонка `relay_pass_records` в `telemetry-check` (пересъёмка на `ef60b47`, правка разрешена основной сессией): ожидание
|
||||
Loki — пока все записи прохода relay из stdout не придут, со сроком 60 с; по сроку — прежний отказ и недостающие
|
||||
записи; проверка не ослаблена (п. 23).
|
||||
|
||||
### Вопросы
|
||||
|
||||
Не блокируют работу; ответ меняет только указанное место.
|
||||
|
||||
1. Пользователю: ресурсы ВМ Docker Desktop. Сейчас у ВМ 12 CPU (все ядра хоста) и 7934 МиБ из 18 ГиБ хоста; лимиты стенда —
|
||||
постоянные 11,5 CPU / 7296 МиБ, с одноразовыми 12,5 CPU / 7680 МиБ (до замера этого change: новых сервисов нет, лимит
|
||||
Collector может вырасти по замеру), а контейнеры `make test_isolated` рядом (API, worker и relay теста) добавляют
|
||||
2,25 CPU / 1792 МиБ. CPU больше не дать: лимиты — доли времени, сумма больше 12 значит конкуренцию, а не отказ. Памяти,
|
||||
чтобы лимиты стенда с одноразовыми и `make test_isolated` помещались вместе с накладными ВМ (~0,5–1 ГиБ), нужно не меньше
|
||||
~11 ГиБ; рекомендация — 12 ГиБ. Точные числа — после замера apply (`docker.md`, `REPORT.md`). Увеличить память ВМ?
|
||||
Ответ меняет только строку ВМ в `REPORT.md` и `docker.md`. **Ответ (2026-11-11):** пользователь увеличил память ВМ до
|
||||
12 ГБ (MemTotal 11 902 МиБ); с одноразовыми и `make test_isolated` — 9472 МиБ лимитов, запас ~2,4 ГиБ.
|
||||
2. Преподавателю: SLI доступности и оповещение о доле ошибок считаются по ответам клиентам на LB (включая сгенерированные LB
|
||||
502, 503, 504 и health через LB), а «доля ошибок» контракта (5xx API / бизнес-запросы без health) осталась отдельной
|
||||
панелью. Допустимо? Иначе — SLI по метрикам API с отдельным счётом ответов LB в числителе (правила записи и панель).
|
||||
|
||||
## track1-telemetry-cost
|
||||
|
||||
Change `openspec/changes/archive/2026-11-15-track1-telemetry-cost/` (propose 2026-11-14, заархивирован 2026-11-15). Номера
|
||||
— решения design.
|
||||
|
||||
### Решения
|
||||
|
||||
- Решения пользователя из промпта propose (не пересматриваются): трек 1; Prometheus, Loki, Tempo и Grafana; Collector contrib;
|
||||
включение телеметрии на стенде `mtusi-bench` строится здесь и нужно `make bench_uploads` и `make bench_queue` последнего шага —
|
||||
оба с включённой телеметрией; прежние профили по умолчанию — как сейчас; бюджет ВМ не ограничение; замеры — apply после коммитов
|
||||
кода и гипотез, рабочий стенд перед `bench/` — `make stop`.
|
||||
- Варианты (2): `off`, `full` (рабочий стенд), `full-aa` (A/A — копия в той же метке, а не вторая метка: без дрейфа хоста между
|
||||
метками), `head` (доля 0,1), `tail` — **типовой** tail sampling (ошибки, трассы ≥ 0,25 с, 10 % остальных, ожидание 30 с по
|
||||
умолчанию), `metrics` (интервал 30 с, грубые границы, отбор лишних рядов), `balanced` (5); 3 повтора кругами, свежий стенд на
|
||||
прогон (1).
|
||||
- Выбор в голове — поле `[telemetry] trace_sample_ratio` (`ParentBased(TraceIdRatioBased)`, при 1 — прежний
|
||||
`ParentBased(ALWAYS_ON)`), не `OTEL_TRACES_SAMPLER` (OT-8); журнал не выбирается: записи невыбранных запросов уходят в Loki с
|
||||
`trace_id` и флагами `02` (проба) — мера H5, не дефект (3).
|
||||
- Счёт начатых span по решению выборки (`otel.sdk.span.started`) включается на рабочем стенде тоже: отброшенное в голове
|
||||
отличается от потерь, правило потерь не меняется; `otel.sdk.span.live` не отдаётся (3).
|
||||
- Наборы границ histogram `default` / `coarse` — поле `metric_buckets`, оба с границами SLO 0,25 с и 30 с; интервал отправки
|
||||
метрик — не больше 30 с (половина срока рядов экспортёра Collector) (4).
|
||||
- «Лишние инструменты» варианта агрегации — собственные ряды хранилищ: 80 % рядов Prometheus рабочего стенда (проба TSDB), их не
|
||||
читает ни панель, ни правило, ни драйвер; инструментов приложения без читателя нет (2, 7).
|
||||
- Сбалансированная конфигурация (5) — tail sampling под эту систему: правило исхода задания (у `failed` нет статуса ошибки span),
|
||||
медленный server span ≥ 0,25 с или consumer span ≥ 5 с через OTTL вместо длительности трассы (она больше 0,25 с у каждой
|
||||
асинхронной цепочки загрузки), 10 % остальных, ожидание 10 с, кэш решений только сохранённых трасс; плюс отбор лишних рядов.
|
||||
Рабочий стенд остаётся со 100 % трасс: проверки уровней 3–4 ищут свой запрос; конфигурация — проверенная рекомендация в
|
||||
`bench/otel/`.
|
||||
- Слои Collector — второй `--config` (проба: карты сливаются, списки заменяются), проверка `validate` и сравнением
|
||||
`print-config --format=json`; конфигурация Prometheus с отбором — копия рабочей с размеченными блоками и построчной сверкой (6, 7).
|
||||
- Редкие события (8): 500 API — одна строка вложения без объекта `\copy` (как профиль сверки); неудачное задание — класс `bad` (`s`
|
||||
с точностью 12 бит в SOF, как `jpeg_precision_12` тестов); редкий медленный маршрут — регистрация (вход требовал бы пароля стенда
|
||||
за пределами `prepare.js`); медленные запросы быстрого маршрута — блокировка `messages` `IN SHARE MODE` 0,6 с трижды в окне
|
||||
отказов. Заморозка S3 отвергнута: недетерминированный счёт worker и всплеск хвоста.
|
||||
- Новые исключения границы чёрного ящика — только профиль цены телеметрии: строка вложения, блокировка таблицы, счёт незавершённых
|
||||
заданий, чтение Prometheus, Loki, Tempo и метрик Collector из контейнера `mtusi-bench-lookup` (образ стенда, stdlib), размер
|
||||
volume только на чтение (9).
|
||||
- Grafana на стенде `bench/` не запускается: не в пути данных (1).
|
||||
- Рост хранилищ на диске — журнал предзаписи: в Tempo 3.1.1 нет `/flush`, Loki режет чанки через 30 мин (9).
|
||||
- Выключатель `TELEMETRY=on` у `uploads` и `queue` — поле профиля, а не отладочное переопределение (`RESUME` сверяет режим);
|
||||
сумма лимитов CPU больше ВМ с телеметрией — предупреждение в паспорте, а не код 2 (очередь — 12,25 CPU при 12) (13).
|
||||
- Результаты — `evidence/telemetry-cost/<метка>/` (12); правило «если `balanced` не прошёл критерии» — заранее, по параметру на
|
||||
нарушение, новая метка целиком (12).
|
||||
|
||||
### Решения apply
|
||||
|
||||
Подробно — design, «Уточнения apply» (номера в скобках); всё, кроме интенсивностей (16), — до коммита гипотез, пороги не
|
||||
менялись.
|
||||
|
||||
- Регистрация на стенде — ~85 мс, а не 0,3–1 с (Argon2id параметров кода): редкий **быстрый** маршрут. Правила выбора трасс
|
||||
решают по span, поэтому полнота в B1, H3 и H5 (`tail`, `balanced`) требуется у 500, записей, **медленных по серверу**
|
||||
(`duration_ms` записи доступа ≥ 0,25 с; из медленных по клиенту 20 из 25 — медленные и по серверу) и цепочек `bad`; у
|
||||
регистраций — доля справочно (что теряет выбор после завершения трассы). Правила «редкий маршрут — всегда» в `balanced` нет:
|
||||
подгонка под внесённое событие. Дельты спеков `load-benchmark` (B1) и `observability` (сценарий) поправлены (1).
|
||||
- Запись о старте — `telemetry.startup_fields` у трёх процессов; `Tracer` собирает `sdk.build` в окне внутренних метрик (2, 3).
|
||||
- Стенд профиля — компоненты и лимиты профиля очереди без её `queue.compose.yml`; разогрев — `queue_warm` (4, 5).
|
||||
- `bad`: Pillow его не открывает и для размеров — размеры из SOF (6).
|
||||
- Лимиты и паспорт — по режиму телеметрии (`limits_by_mode`, `stand`, `stand_telemetry`) (7).
|
||||
- Счёт в метрике — значение в конце прогона; у регистраций в нём ещё пользователи `prepare.js` (8).
|
||||
- Выборка — пачки по 40 id, повтор на обрыв соединения и 5xx (Tempo под пулом запросов закрывал соединение) (9).
|
||||
- `plots.py` самопроверки не имеет — в 9.1 проверяются шесть модулей (11).
|
||||
- Метка `baseline` на `509afca` не снята (20 из 21), каталог удалён, новая — `baseline2` (16): разогрев «24 из 12» — файл
|
||||
консоли k6 от убитого процесса (k6 дописывает; правка — удаление до старта, уборка `.work` в начале запуска,
|
||||
`evidence/**/.work/` в `.gitignore`); DNS в выборке metrics-r3 — Tempo завершился посреди выборки, вероятно OOM под её
|
||||
запросами, не доказано (правка — проверка сервисов телеметрии до и после выборки с журналом погибшего в `raw/`, не больше
|
||||
3 запросов к Tempo разом, пики памяти после выборки). Интенсивности лёгких классов +15 % (`full` на тихом хосте — 28–29,5 %
|
||||
при границе 30 %) — после коммита гипотез, но до первой метки, решение основной сессии; пороги не менялись.
|
||||
- **Решение пользователя (2026-11-15):** выгрузку хоста в swap во время метки профиля цены телеметрии (`swapouts_delta`,
|
||||
пометки `host_swap`, предупреждение «rerun») игнорировать: свободной памяти на хосте достаточно, память ВМ Docker вряд ли
|
||||
уходит в swap. Это не повод переснимать метку (`baseline2` и далее): значения остаются в паспорте и `runs.csv`, в
|
||||
`REPORT.md` — одна фраза с этим решением. Остальные пометки (`saturated`, `storage_down`, `oom`, `dropped` и др.) — как в
|
||||
`bench.md`.
|
||||
|
||||
### Решения основной сессии
|
||||
|
||||
Без пользователя; подробности — design, «Уточнения apply», пп. 16–17, правки verify — `tasks.md`, раздел 13.
|
||||
|
||||
- Интенсивности лёгких классов +15 % (`read` 126,5, `write` 23, `me` 34,5, `card` 34,5) — **после коммита гипотез**, до первой
|
||||
метки: на тихом хосте `full` занимал реплику на 28,1–29,5 % при нижней границе калибровки 30 %. Правило design («Risks»:
|
||||
интенсивности — только до коммита гипотез) нарушено сознательно; пороги H1–H8 и B1–B5 относительные и не менялись, меток до
|
||||
правки нет (п. 16).
|
||||
- Метка `baseline2` принята с пометкой `saturated` у full-r3 (28,4 % CPU реплики при границе 30 %), без пересъёмки (verify W1).
|
||||
Основание — указание пользователя 2026-10-31 (`AGENTS.md`): предупреждения о хосте, которые явно не влияют на результат замера,
|
||||
прогон не останавливают. Решение о swap от 2026-11-15 эту пометку не покрывает. Пометка — недогрузка из-за сдвига хоста внутри
|
||||
третьего круга (с balanced-r3 CPU на запрос у всех вариантов с телеметрией ниже на ~9 %), а не насыщение; медианы устойчивы
|
||||
(`full` — 31,3 %). Цена решения: разброс повторов шире (у `full` 2,473–3,228 мс на запрос), и разница вариантов с SDK уходит
|
||||
в шум (п. 17).
|
||||
|
||||
### Вопросы
|
||||
|
||||
Не блокируют работу; ответ меняет только указанное место.
|
||||
|
||||
1. Пользователю: переводить ли рабочий стенд на сбалансированную конфигурацию после метки? Меняет `infra/otel/` и делает проверки
|
||||
`telemetry-check`, `trace-chain`, `alerts-check` вероятностными (свой запрос сохраняется с вероятностью 10 %). По умолчанию —
|
||||
нет: рекомендация с условиями в `REPORT.md` (design, решение 5).
|
||||
2. Пользователю: быстрый профиль — ~20 мин (шесть вариантов на свежем стенде), дольше прочих быстрых; для шага защиты «для 5» —
|
||||
`make bench_telemetry_quick VARIANTS=off,full,tail` (~10 мин, отладочное переопределение). Устраивает? Иначе — меньше вариантов
|
||||
в быстром профиле (тогда часть путей кода проверяет только полный).
|
||||
3. Пользователю: `make bench_queue TELEMETRY=on` — сумма лимитов CPU 12,25 при 12 у ВМ (два worker в блоках `w2-*` и сервисы
|
||||
телеметрии): по решению о бюджете — предупреждение, а не отказ. Подтвердите. Иначе — отказ и меньший лимит одного из сервисов.
|
||||
4. Преподавателю: достаточно ли трёх настроек (выбор в голове 10 %, типовой tail sampling, агрегация метрик) и проверенной
|
||||
сбалансированной конфигурации на одной нагрузке ниже насыщения? Иначе — вторая интенсивность (ещё одна метка ~1 ч 50 мин).
|
||||
5. Преподавателю: «известное число» редких ошибок и медленных запросов внесено строкой вложения без объекта (500), недекодируемым
|
||||
JPEG (`failed`), регистрацией (Argon2id) и короткой блокировкой таблицы сообщений — допустимы ли такие управляемые воздействия?
|
||||
6. Пользователю (apply): регистрация оказалась быстрой (~85 мс), и `balanced` по своим правилам её не сохраняет полностью —
|
||||
критерий B1 переформулирован до гипотез («медленные по серверу» записи, регистрация справочно). Устраивает? Иначе — либо
|
||||
правило «редкий маршрут POST /api/v1/users — всегда» в `balanced` (ценой подгонки под событие), либо другой медленный редкий
|
||||
маршрут (его в API нет без искусственной задержки).
|
||||
7. Пользователю (apply): хост во время пробных прогонов выгружал память в swap (swap занят 10,7 из 11 ГиБ, ВМ 11,6 из 18 ГиБ ОЗУ;
|
||||
`host_swap` у каждого пробного прогона). Быстрые метки калибровки это не портит (они не результат), но метку `baseline`
|
||||
(~1 ч 50 мин) стоит снимать на освобождённом хосте (закрыть лишние приложения, остановить посторонние `domains-*`), иначе
|
||||
пометки `host_swap` и пересъёмка (`bench.md`, «Результаты»).
|
||||
8. Пользователю (verify W1): переснять ли метку профиля цены телеметрии из-за пометки `saturated` у full-r3 (~1 ч 25 мин, новая
|
||||
метка, `baseline2` остаётся записью)? По умолчанию — нет: метка принята с пометкой («Решения основной сессии»). Ответ «да»
|
||||
меняет числа раздела «Результаты» в `REPORT.md` и шапку раздела.
|
||||
|
||||
### Предложения на потом
|
||||
|
||||
- S1 (verify): учёт потерь Tempo после distributor — счётчики отказов приёма и записи Tempo (`tempo_discarded_spans_total`,
|
||||
`tempo_live_store_*failed*`) в `TOTALS` выборки (`bench/telemetry_lookup.py`) и в условие H6; для недостающих трасс выборка хранит, кроме `trace_id`, ещё
|
||||
`duration_ms` записи доступа и `trace_id` журнала — тогда случай «74 из 75» у `tail` (design, «Уточнения apply», п. 17) можно
|
||||
разобрать по сохранённым данным.
|
||||
- S4 (verify): в тест `OTEL_*` (`service-tests/unit/test_telemetry.py`) добавить `OTEL_TRACES_SAMPLER` и
|
||||
`OTEL_TRACES_SAMPLER_ARG` — удаляются с `warning` и не меняют сэмплер; проверка рядов SLI при `metric_buckets = coarse` —
|
||||
правила записи и `rules.test.yml` на рядах с границами `coarse` (`le="0.25"`, `le="30.0"` есть, остальных границ нет).
|
||||
|
||||
## Последний шаг
|
||||
|
||||
Без отдельного change (`PLAN.md`, «Последний шаг», решение 5). Ветка `feat/lab6-final` от `solution/bvt2301-safronov`
|
||||
(`b3a5ab8`). Агент без пользователя; коммиты и push — основная сессия.
|
||||
|
||||
### Решения
|
||||
|
||||
- **Метка очереди — `baseline4`** (`make bench_queue TELEMETRY=on QUEUE_LABEL=baseline4`): исключения `queue-overload`
|
||||
в `student-tests/spec_coverage.py` ссылаются на `evidence/queue/baseline4/summary.md`. В репозитории лабы 6 этого
|
||||
каталога не было, поэтому метка с тем же именем — новая, снята на стенде лабы 6; текст исключений и тест не менялись.
|
||||
Метка `baseline4` лабы 5 осталась в её репозитории, с этой не сравнивается (в лабе 6 телеметрия включена).
|
||||
- **Метка загрузок — `baseline`** (`make bench_uploads TELEMETRY=on`), имя называет исключение `attachments`.
|
||||
- **Обе метки — подряд одной командой** (`make bench_uploads …; make bench_queue …`), хост: питание от сети, свободной
|
||||
памяти 59 %, контейнеры `domains-*` остановлены на время замеров и запущены после, рабочий стенд — `make stop`.
|
||||
`swapouts_delta` 0 и `slept_seconds` 0 у обеих, у загрузок `host_warnings` пусты, у очереди — одно предупреждение о
|
||||
сумме лимитов CPU (12,25 при 12 у ВМ), его разрешает решение о бюджете (вопрос 3 `## track1-telemetry-cost`).
|
||||
- **`dirty: true` у метки очереди — принято, без пересъёмки.** Код обеих меток — `b3a5ab8`. Метка загрузок снята на
|
||||
чистом дереве (`dirty: false`). Метку очереди команда начала сразу после неё, и в рабочем дереве было две вещи: каталог
|
||||
`evidence/uploads/baseline/` (результат предыдущей метки, не закоммичен) и правка `REPORT.md` агентом во время
|
||||
замера (новые разделы «Архитектура и решения», «Ограничения», «Источники»). Ни то, ни другое `bench/` и образ не
|
||||
читают (образ копирует только `src/`, `migrations/`, `alembic.ini` и lock, `evidence` и `*.md` — в `.dockerignore`);
|
||||
других изменений нет —
|
||||
`git status --porcelain` после метки: ` M REPORT.md`, `?? evidence/queue/`, `?? evidence/uploads/`. Числа
|
||||
воспроизводятся из `b3a5ab8` (правило `bench.md`, «Измеренное состояние — commit»). Пересъёмка — ещё ~2 ч 20 мин
|
||||
хоста без изменения кода; нарушение порядка («чистое дерево») — ошибка агента, названа здесь и в `REPORT.md`.
|
||||
- **Вердикты меток — как есть, гипотезы не пересматривались** (они записаны в лабах 4 и 5):
|
||||
- загрузки: H1 и H4 — да; H2 — нет (вариант «до» — `9cc6c0c`, где места загрузки уже есть, как и в лабе 5); H3 — нет
|
||||
(1 MiB: «с лимитом» 89–90 % «без лимита» при пороге 90 %, на 10 MiB — 112–117 %; в лабе 5 — 85–89 %). Сценарий
|
||||
`load-benchmark` «Буферы соединений ограничены» (вне сверки покрытия) — нет: 1,05 MiB на клиента при пороге 1 MiB
|
||||
(LB 0,57 + `sock` 0,49); у метки лабы 5 этой строки ещё не было. Оба сценария `attachments` исключений выполнены:
|
||||
«без лимита» — 1,21 тела на загрузку (порог 1,5), «с лимитом» — 182,6 / 189,4 / 193,6 МиБ при 10 / 20 / 40 клиентах,
|
||||
OOM 0, 5xx 0;
|
||||
- очередь: H3, H5–H9 подтверждены (девять сценариев исключений `queue-overload` опираются на H6–H9 и блоки);
|
||||
H1 и H2 — нет, обе только на `lp` (4, 4): ядро завершало процесс worker (`oom_kill` 55 и 97, 2 и 11 перезапусков
|
||||
в r2 и r3), CPU worker в окне `over` у r3 — 0,795 при пороге 0,85, `memory.peak` r1 — 870 МиБ при условии ≥ 95 %
|
||||
лимита во всех повторах, отношение длительностей 0,869 при пороге 1,5. В лабе 5 на той же ячейке условие тоже было
|
||||
неустойчивым (`baseline3` — H2 «нет»); с телеметрией перезапусков больше (13 против 5 у `baseline4` лабы 5), у
|
||||
lp-c4p4-r3 — пометка `failed` (задания `retry_exhausted`). Рекомендация правила прежняя — (2, 2).
|
||||
- **Доказательства исключений и полные проверки — на `db3340d`** при дереве без правок кода (менялись только документы и
|
||||
`evidence/`), рабочий стенд `make run_docker` с включённой телеметрией. Порядок вынужденный: `make test_isolated` до появления
|
||||
файлов исключений красный ровно одним `test_exclusion_evidence_exists`, поэтому прогонов три — два в последовательности
|
||||
`evidence/broker/isolated.md` и третий зелёный (`evidence/tests/test-isolated.md`). Повтор после `--force-recreate api` выполнил
|
||||
разовый скрипт на stdlib вне репозитория (как в лабе 5): шаги перечислены в шапке файла.
|
||||
- **`make test-failover` `kill` — `failed_attempts` 1** при PASS: запись была в полёте на убитой реплике, проверка повторила её
|
||||
с тем же ключом, дубля нет (в лабе 5 — 0). Не дефект: LB не повторяет отправленный `POST` (`balancer.md`).
|
||||
- **Проверка из чистого clone — клон `db3340d`**, проект `mtusi-lab6-clonecheck` рядом с рабочим стендом на своих портах;
|
||||
`make student_test` в нём — 1 failed (`test_exclusion_evidence_exists`): файлы исключений этого шага ещё не закоммичены.
|
||||
Уборка — `docker compose down` и `docker volume rm` шести volumes клона по имени: `down -v` запрещён настройками, а
|
||||
volumes рабочего стенда это имя не задевает. `driver.py stand-from-scratch` переснят на `28b1704` после ответа пользователя
|
||||
2026-11-15 (вопрос 8 `## otel-telemetry`, «Ответы пользователя после последнего шага»).
|
||||
- **`PLAN.md` удалён** по его правилу (итоги — `REPORT.md`), последняя версия — `git show db3340d:PLAN.md` (файл не менялся с
|
||||
`db3340d`); ссылка — в `AGENTS.md`, этом файле и шапке `REPORT.md`.
|
||||
- **Хост в перерыве.** Агент продолжил после сброса лимита основной сессии; контейнеры `domains-*` к этому моменту уже
|
||||
запустила команда замера (последний шаг цепочки).
|
||||
|
||||
### Вопросы
|
||||
|
||||
1. Пользователю: переснять ли метку `evidence/queue/baseline4/` на чистом дереве (`dirty: true`, разбор — «Решения»)?
|
||||
По умолчанию — нет: код тот же `b3a5ab8`, а изменённые файлы (`REPORT.md`, незакоммиченный каталог метки загрузок)
|
||||
образ и `bench/` не читают. Ответ «да» — ~2 ч 20 мин хоста. Каталог удаляется и снимается заново под тем же именем:
|
||||
его называют исключения `queue-overload`. Затем переносятся числа в `REPORT.md`.
|
||||
2. Пользователю: прогон CI `Application` для `6c6e6d5` агент не видел: API Gitea требует токен, страница Actions
|
||||
приватного fork без входа отвечает 404, расширение Claude in Chrome не подключено. Посмотрите прогон в Actions fork. Если он
|
||||
зелёный, впишите номер, статус и длительности шагов в `evidence/tests/ci-application.md` (или дайте агенту доступ к
|
||||
странице). Если упал — пришлите шаг и журнал для разбора.
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
# Миграции alembic, правила — .claude/rules/migrations.md.
|
||||
# URL подключения migrations/env.py берёт из настроек приложения (секция
|
||||
# [database]), поэтому sqlalchemy.url здесь нет. Секций logging тоже нет:
|
||||
# журнал идёт через src/infra/logger.py в JSON, как у сервиса.
|
||||
|
||||
[alembic]
|
||||
script_location = %(here)s/migrations
|
||||
# имя ревизии: YYYY_MM_DD_HHMM-<rev>_<slug>.py
|
||||
file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
|
||||
truncate_slug_length = 40
|
||||
# импорт src из корня репозитория и из /app в образе
|
||||
prepend_sys_path = .
|
||||
path_separator = os
|
||||
+125
@@ -0,0 +1,125 @@
|
||||
"""Два прогона подряд: «до» и «после» одного изменения, в одной сессии.
|
||||
|
||||
Запуск — `make bench_ab BEFORE=<метка> AFTER=<метка> REAPPLY=<commit>
|
||||
[SERIES=<серия>]`; с `SERIES` вместо полной матрицы снимается серия трека 1
|
||||
(`make bench_scaling`).
|
||||
В рабочем дереве должен лежать код «до», а изменение — быть
|
||||
закоммиченным и откаченным отдельным commit; `REAPPLY` — commit отката.
|
||||
Скрипт снимает стенд «до», коммитит его результаты, возвращает изменение
|
||||
(`git revert` commit отката) и снимает «после». Между прогонами на хосте
|
||||
нет другой работы. Только stdlib. Методика — design change
|
||||
`perf-bottleneck-fix`, решения 7 и 9; без разложения внутри процесса —
|
||||
design change `bench-postgres`, решение 8.
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import re
|
||||
import subprocess
|
||||
import sys
|
||||
import time
|
||||
from pathlib import Path
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[1]
|
||||
|
||||
|
||||
def git(*args: str) -> subprocess.CompletedProcess[str]:
|
||||
return subprocess.run(
|
||||
["git", "-C", str(ROOT), *args],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
check=False,
|
||||
)
|
||||
|
||||
|
||||
def problems(args: argparse.Namespace) -> list[str]:
|
||||
"""Что мешает начать; пустой список — можно запускать."""
|
||||
found = []
|
||||
for name in (args.before, args.after):
|
||||
if not re.fullmatch(r"[A-Za-z0-9._-]+", name or ""):
|
||||
found.append(f"bad label {name!r}: use [A-Za-z0-9._-]")
|
||||
continue
|
||||
path = ROOT / "evidence" / "bench" / name
|
||||
if path.exists():
|
||||
found.append(f"{path.relative_to(ROOT)} already exists")
|
||||
if args.before == args.after:
|
||||
found.append("BEFORE and AFTER must be different labels")
|
||||
if git("status", "--porcelain").stdout.strip():
|
||||
# иначе стенд запишет в паспорт dirty: true
|
||||
found.append("working tree is not clean: commit or remove changes")
|
||||
if git("cat-file", "-e", f"{args.reapply}^{{commit}}").returncode != 0:
|
||||
found.append(f"commit {args.reapply!r} not found")
|
||||
elif git("merge-base", "--is-ancestor", args.reapply, "HEAD").returncode:
|
||||
found.append(f"commit {args.reapply} is not in the current branch")
|
||||
return found
|
||||
|
||||
|
||||
def run_step(args: argparse.Namespace, label: str) -> list[str]:
|
||||
"""Прогон стенда: полная матрица или серия трека 1 (`--series`,
|
||||
решение 11 design change `scaling-bench`)."""
|
||||
if args.series:
|
||||
return [
|
||||
"make",
|
||||
"bench_scaling",
|
||||
f"SERIES={args.series}",
|
||||
f"SCALING_LABEL={label}",
|
||||
]
|
||||
return ["make", "bench", f"BENCH_LABEL={label}"]
|
||||
|
||||
|
||||
def steps(args: argparse.Namespace) -> list[list[str]]:
|
||||
return [
|
||||
run_step(args, args.before),
|
||||
["git", "add", f"evidence/bench/{args.before}"],
|
||||
["git", "commit", "-m", f"docs: add {args.before} bench evidence"],
|
||||
["git", "revert", "--no-edit", args.reapply],
|
||||
run_step(args, args.after),
|
||||
]
|
||||
|
||||
|
||||
def main(argv: list[str]) -> int:
|
||||
parser = argparse.ArgumentParser(description=__doc__.splitlines()[0])
|
||||
parser.add_argument("--before", default="")
|
||||
parser.add_argument("--after", default="")
|
||||
parser.add_argument("--reapply", default="")
|
||||
parser.add_argument("--dry-run", action="store_true")
|
||||
# серия трека 1 вместо полной матрицы: a, b, pool, ab, quick
|
||||
parser.add_argument("--series", default="")
|
||||
args = parser.parse_args(argv)
|
||||
if not (args.before and args.after and args.reapply):
|
||||
print(
|
||||
"usage: make bench_ab BEFORE=<label> AFTER=<label> "
|
||||
"REAPPLY=<revert commit>",
|
||||
flush=True,
|
||||
)
|
||||
return 2
|
||||
found = problems(args)
|
||||
if found:
|
||||
print("bench_ab refused:\n " + "\n ".join(found), flush=True)
|
||||
return 2
|
||||
plan = steps(args)
|
||||
if args.dry_run:
|
||||
print("\n".join(" ".join(step) for step in plan), flush=True)
|
||||
return 0
|
||||
started = time.monotonic()
|
||||
for number, step in enumerate(plan, 1):
|
||||
print(f"\n=== [{number}/{len(plan)}] {' '.join(step)}", flush=True)
|
||||
code = subprocess.run(step, cwd=ROOT, check=False).returncode
|
||||
if code != 0:
|
||||
print(
|
||||
f"\nbench_ab stopped: step {number} exited with {code}; "
|
||||
"later steps were not run",
|
||||
flush=True,
|
||||
)
|
||||
return 1
|
||||
minutes = (time.monotonic() - started) / 60
|
||||
head = git("rev-parse", "--short", "HEAD").stdout.strip()
|
||||
print(
|
||||
f"\nbench_ab done in {minutes:.0f} min: labels {args.before} and "
|
||||
f"{args.after}, HEAD {head}",
|
||||
flush=True,
|
||||
)
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main(sys.argv[1:]))
|
||||
@@ -0,0 +1,239 @@
|
||||
# Override стенда make bench (bench/run.py): тот же docker-compose.yml под
|
||||
# проектом mtusi-bench, со своими volume, сетью и лимитами. Пины, healthcheck
|
||||
# хранилищ, valkey.conf, haproxy.cfg и миграции — из основного файла.
|
||||
# Подстановки — из bench/bench.env, а не из .env рабочего стенда; пароли и
|
||||
# BENCH_* передаёт run.py (поля Profile), без них стенд не поднимается.
|
||||
# Решения 1, 2, 5 design change bench-postgres и 6 design change
|
||||
# graceful-failover; что не меняется между метками — .claude/rules/bench.md.
|
||||
# Стенд — HAProxy перед BENCH_API_REPLICAS репликами api, как рабочий; k6
|
||||
# ходит через LB по имени сервиса haproxy. Лимиты — в форме
|
||||
# deploy.resources.limits, как в основном файле: compose не принимает
|
||||
# cpus/mem_limit рядом с deploy-лимитами.
|
||||
services:
|
||||
postgres:
|
||||
container_name: mtusi-bench-postgres
|
||||
# упавший контейнер не поднимается сам: прогон помечается stand_down
|
||||
restart: "no"
|
||||
# auto_explain загружен, но выключен (log_min_duration = -1): run.py
|
||||
# включает его только на этапе плана, между прогонами. max_connections
|
||||
# — конфигурация серии трека 1 (граница пула), у прочих профилей 100,
|
||||
# как у образа (решение 1 design change scaling-bench)
|
||||
command:
|
||||
- postgres
|
||||
- -c
|
||||
- shared_preload_libraries=auto_explain
|
||||
- -c
|
||||
- max_connections=${BENCH_DB_MAX_CONNECTIONS:?run make bench}
|
||||
ports: !reset []
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: ${BENCH_DB_CPUS:?run make bench}
|
||||
memory: ${BENCH_DB_MEMORY:?run make bench}
|
||||
memswap_limit: ${BENCH_DB_MEMORY:?run make bench}
|
||||
|
||||
valkey:
|
||||
container_name: mtusi-bench-valkey
|
||||
restart: "no"
|
||||
ports: !reset []
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: ${BENCH_CACHE_CPUS:?run make bench}
|
||||
memory: ${BENCH_CACHE_MEMORY:?run make bench}
|
||||
memswap_limit: ${BENCH_CACHE_MEMORY:?run make bench}
|
||||
|
||||
# S3 (лаба 4) запускает только профиль uploads (design change
|
||||
# upload-memory, решение 10): образ, аргументы сервера и лимиты рабочего
|
||||
# стенда, swap = память; bucket и пользователей создаёт тот же
|
||||
# s3-bootstrap. Профили лаб 2–3 его не запускают: старт стенда
|
||||
# перечисляет сервисы, а реплики API поднимает с --no-deps (design change
|
||||
# s3-storage, решение 9). Без порта хоста, без перезапуска, под своим
|
||||
# именем
|
||||
s3:
|
||||
container_name: mtusi-bench-s3
|
||||
restart: "no"
|
||||
ports: !reset []
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: ${BENCH_S3_CPUS:?run make bench}
|
||||
memory: ${BENCH_S3_MEMORY:?run make bench}
|
||||
memswap_limit: ${BENCH_S3_MEMORY:?run make bench}
|
||||
|
||||
# уборщик незавершённых загрузок (design change upload-consistency,
|
||||
# решение 9) описан, как s3; сервис не запускается: старт стенда
|
||||
# перечисляет сервисы, реплики — с --no-deps. Профиль сверки (change
|
||||
# track2-reconcile-cost, решения 1 и 3) запускает его разовыми проходами
|
||||
# `docker compose run --name mtusi-bench-reconcile-<n> cleaner reconcile`.
|
||||
# Образ стенда, без config.toml рабочего стенда, без перезапуска и без
|
||||
# плановой сверки bucket и БД; лимиты BENCH_CLEANER_* без swap — рабочего
|
||||
# стенда, в управляемом опыте — CPU варианта
|
||||
cleaner:
|
||||
container_name: mtusi-bench-cleaner
|
||||
image: mtusi-messenger:bench
|
||||
restart: "no"
|
||||
volumes: !reset []
|
||||
environment:
|
||||
RECONCILER__INTERVAL_SECONDS: "0"
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: ${BENCH_CLEANER_CPUS:?run make bench}
|
||||
memory: ${BENCH_CLEANER_MEMORY:?run make bench}
|
||||
memswap_limit: ${BENCH_CLEANER_MEMORY:?run make bench}
|
||||
|
||||
# брокер описан и не запускается ни одним профилем (design change
|
||||
# pipeline-reliability, решение 16): реплика к нему не обращается, задания
|
||||
# ждут в PostgreSQL. Образ, rabbitmq.conf и лимиты рабочего стенда, swap =
|
||||
# память; без порта хоста, без перезапуска, под своим именем
|
||||
rabbitmq:
|
||||
container_name: mtusi-bench-rabbitmq
|
||||
restart: "no"
|
||||
ports: !reset []
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: ${BENCH_BROKER_CPUS:?run make bench}
|
||||
memory: ${BENCH_BROKER_MEMORY:?run make bench}
|
||||
memswap_limit: ${BENCH_BROKER_MEMORY:?run make bench}
|
||||
|
||||
# relay и worker описаны и не запускаются ни одним профилем: стенд меряет
|
||||
# реплику, а не обработку. Образ стенда, без config.toml рабочего стенда;
|
||||
# лимиты BENCH_RELAY_* и BENCH_WORKER_* compose требует при разборе
|
||||
relay:
|
||||
container_name: mtusi-bench-relay
|
||||
image: mtusi-messenger:bench
|
||||
restart: "no"
|
||||
volumes: !reset []
|
||||
environment:
|
||||
# телеметрия выключена, как у api и worker (design change
|
||||
# job-trace-propagation, решение 7)
|
||||
TELEMETRY__ENABLED: "false"
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: ${BENCH_RELAY_CPUS:?run make bench}
|
||||
memory: ${BENCH_RELAY_MEMORY:?run make bench}
|
||||
memswap_limit: ${BENCH_RELAY_MEMORY:?run make bench}
|
||||
|
||||
worker:
|
||||
container_name: mtusi-bench-worker
|
||||
image: mtusi-messenger:bench
|
||||
restart: "no"
|
||||
volumes: !reset []
|
||||
environment:
|
||||
# телеметрия выключена: методика и бюджеты стенда прежние (design change
|
||||
# otel-telemetry, решение 20); сервисы телеметрии стенд не запускает
|
||||
TELEMETRY__ENABLED: "false"
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: ${BENCH_WORKER_CPUS:?run make bench}
|
||||
memory: ${BENCH_WORKER_MEMORY:?run make bench}
|
||||
memswap_limit: ${BENCH_WORKER_MEMORY:?run make bench}
|
||||
|
||||
migrate:
|
||||
image: mtusi-messenger:bench
|
||||
# без config.toml рабочего стенда: настройки — окружение и дефолты
|
||||
volumes: !reset []
|
||||
|
||||
api:
|
||||
# реплики без постоянного имени (оно мешало бы масштабированию):
|
||||
# оркестратор находит их через docker compose ps, k6 ходит через LB
|
||||
image: mtusi-messenger:bench
|
||||
restart: "no"
|
||||
volumes: !reset []
|
||||
# healthcheck образа — лишний CPU внутри лимита API; готовность реплик
|
||||
# проверяет HAProxy (раз в секунду /health/ready)
|
||||
healthcheck:
|
||||
disable: true
|
||||
environment:
|
||||
# размер 500k с наполнением идёт ~25 мин; на медленном хосте срок
|
||||
# 3600 с по умолчанию мог бы истечь посреди прогона и дать 401
|
||||
AUTH__SESSION_TTL_SECONDS: ${BENCH_SESSION_TTL_SECONDS:?run make bench}
|
||||
# телеметрия выключена, как у worker (design change otel-telemetry,
|
||||
# решение 20): вариант трека 1 с телеметрией включает её явно
|
||||
TELEMETRY__ENABLED: "false"
|
||||
deploy:
|
||||
replicas: ${BENCH_API_REPLICAS:?run make bench}
|
||||
resources:
|
||||
limits:
|
||||
# на каждую реплику
|
||||
cpus: ${BENCH_APP_CPUS:?run make bench}
|
||||
memory: ${BENCH_APP_MEMORY:?run make bench}
|
||||
memswap_limit: ${BENCH_APP_MEMORY:?run make bench}
|
||||
|
||||
haproxy:
|
||||
# один экземпляр: имя нужно оркестратору (статистика, журнал)
|
||||
container_name: mtusi-bench-haproxy
|
||||
restart: "no"
|
||||
# порт рабочего стенда не занимает: k6 в сети стенда
|
||||
ports: !reset []
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: ${BENCH_LB_CPUS:?run make bench}
|
||||
memory: ${BENCH_LB_MEMORY:?run make bench}
|
||||
memswap_limit: ${BENCH_LB_MEMORY:?run make bench}
|
||||
|
||||
# сервисы телеметрии (design change track1-telemetry-cost, решения 1 и 13):
|
||||
# образы, конфигурации infra/otel/ и лимиты рабочего стенда (BENCH_* — поля
|
||||
# Profile, сверка с основным файлом до стенда), без swap, без перезапуска и
|
||||
# без портов. Запускают их только варианты профиля цены телеметрии и
|
||||
# выключатель TELEMETRY=on профилей загрузок и очереди: старт стенда
|
||||
# перечисляет сервисы. Grafana описана основным файлом и не запускается —
|
||||
# её порт сброшен, чтобы разбор стенда не занимал порт рабочего
|
||||
otel-collector:
|
||||
container_name: mtusi-bench-otel-collector
|
||||
restart: "no"
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: ${BENCH_COLLECTOR_CPUS:?run make bench}
|
||||
memory: ${BENCH_COLLECTOR_MEMORY:?run make bench}
|
||||
memswap_limit: ${BENCH_COLLECTOR_MEMORY:?run make bench}
|
||||
|
||||
prometheus:
|
||||
container_name: mtusi-bench-prometheus
|
||||
restart: "no"
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: ${BENCH_PROMETHEUS_CPUS:?run make bench}
|
||||
memory: ${BENCH_PROMETHEUS_MEMORY:?run make bench}
|
||||
memswap_limit: ${BENCH_PROMETHEUS_MEMORY:?run make bench}
|
||||
|
||||
loki:
|
||||
container_name: mtusi-bench-loki
|
||||
restart: "no"
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: ${BENCH_LOKI_CPUS:?run make bench}
|
||||
memory: ${BENCH_LOKI_MEMORY:?run make bench}
|
||||
memswap_limit: ${BENCH_LOKI_MEMORY:?run make bench}
|
||||
|
||||
tempo:
|
||||
container_name: mtusi-bench-tempo
|
||||
restart: "no"
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: ${BENCH_TEMPO_CPUS:?run make bench}
|
||||
memory: ${BENCH_TEMPO_MEMORY:?run make bench}
|
||||
memswap_limit: ${BENCH_TEMPO_MEMORY:?run make bench}
|
||||
|
||||
grafana:
|
||||
container_name: mtusi-bench-grafana
|
||||
restart: "no"
|
||||
ports: !reset []
|
||||
|
||||
networks:
|
||||
default:
|
||||
# k6 подключается к сети стенда по имени (docker run --network)
|
||||
name: mtusi-bench
|
||||
telemetry:
|
||||
# хранилища телеметрии; контейнер выборки (telemetry_lookup.py)
|
||||
# подключается к ней по имени
|
||||
name: mtusi-bench-telemetry
|
||||
@@ -0,0 +1,21 @@
|
||||
# Подстановки compose для стенда make bench вместо .env рабочего стенда
|
||||
# (docker compose --env-file bench/bench.env). Только несекретные имена и
|
||||
# порты внутри сети стенда: пароли генерирует bench/run.py на каждый
|
||||
# прогон, лимиты и срок сессии приходят из Profile (BENCH_*).
|
||||
POSTGRES_USER=bench
|
||||
POSTGRES_DB=bench
|
||||
POSTGRES_HOST=postgres
|
||||
POSTGRES_PORT=5432
|
||||
VALKEY_HOST=valkey
|
||||
VALKEY_PORT=6379
|
||||
# S3 запускает только профиль uploads (лаба 4), профили лаб 2–3 — нет;
|
||||
# секреты S3 генерирует run.py
|
||||
S3_HOST=s3
|
||||
S3_PORT=8333
|
||||
S3__BUCKET=bench
|
||||
# брокер, relay и worker описаны и не запускаются (лаба 5); compose требует эти
|
||||
# значения при разборе, пароль брокера генерирует run.py
|
||||
RABBITMQ_HOST=rabbitmq
|
||||
RABBITMQ_PORT=5672
|
||||
RABBITMQ_DEFAULT_USER=bench
|
||||
APP__PORT=8080
|
||||
@@ -0,0 +1,792 @@
|
||||
"""Сравнение двух меток стенда: дельта по ячейкам матрицы.
|
||||
|
||||
Запуск — `make bench_compare BEFORE=<метка> AFTER=<метка> [AA=<метка>]`.
|
||||
Читает `runs.csv` и `meta.json` из `evidence/bench/<метка>/`, пишет
|
||||
`evidence/compare/<до>__<после>.md`. Только stdlib, docker и приложение
|
||||
не нужны. Метки с разной методикой не сравниваются (с лабы 2 методика
|
||||
включает и хранилища: design change `bench-postgres`, решение 8). Правило
|
||||
«эффект или шум» — design change `perf-bottleneck-fix`, решение 7.
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import csv
|
||||
import json
|
||||
import re
|
||||
import statistics
|
||||
import sys
|
||||
from dataclasses import dataclass
|
||||
from pathlib import Path
|
||||
from typing import Any
|
||||
|
||||
import scaling
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[1]
|
||||
BENCH_DIR = ROOT / "evidence" / "bench"
|
||||
OUT_DIR = ROOT / "evidence" / "compare"
|
||||
SCENARIOS = ("read", "write")
|
||||
# ячейка матрицы: сценарий, размер истории, число клиентов
|
||||
type CellKey = tuple[str, int, int]
|
||||
|
||||
|
||||
class CompareError(Exception):
|
||||
"""Метки нельзя сравнить: сообщение для человека."""
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class Label:
|
||||
name: str
|
||||
meta: dict[str, Any]
|
||||
runs: list[dict[str, str]]
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class Stat:
|
||||
"""Повторы одной ячейки: RPS, CPU на запрос, медианы задержек."""
|
||||
|
||||
rps: list[float]
|
||||
cpu_us: float
|
||||
p50: float
|
||||
p95: float
|
||||
p99: float
|
||||
|
||||
@property
|
||||
def median(self) -> float:
|
||||
return statistics.median(self.rps)
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class Row:
|
||||
key: CellKey
|
||||
before: Stat
|
||||
after: Stat
|
||||
|
||||
@property
|
||||
def delta(self) -> float:
|
||||
"""Изменение медианы RPS, %."""
|
||||
return (self.after.median / self.before.median - 1) * 100
|
||||
|
||||
@property
|
||||
def overlap(self) -> bool:
|
||||
"""Пересекаются ли разбросы min–max повторов двух меток."""
|
||||
return min(self.before.rps) <= max(self.after.rps) and min(
|
||||
self.after.rps,
|
||||
) <= max(self.before.rps)
|
||||
|
||||
|
||||
def human(n: int) -> str:
|
||||
if n >= 1_000_000 and n % 1_000_000 == 0:
|
||||
return f"{n // 1_000_000}M"
|
||||
if n >= 1000 and n % 1000 == 0:
|
||||
return f"{n // 1000}k"
|
||||
return str(n)
|
||||
|
||||
|
||||
def load(name: str) -> Label:
|
||||
if not re.fullmatch(r"[A-Za-z0-9._-]+", name):
|
||||
raise CompareError(f"bad label {name!r}: use [A-Za-z0-9._-]")
|
||||
directory = BENCH_DIR / name
|
||||
for file in ("meta.json", "runs.csv"):
|
||||
if not (directory / file).is_file():
|
||||
raise CompareError(
|
||||
f"{(directory / file).relative_to(ROOT)} not found",
|
||||
)
|
||||
meta = json.loads((directory / "meta.json").read_text(encoding="utf-8"))
|
||||
with (directory / "runs.csv").open(encoding="utf-8", newline="") as file:
|
||||
runs = list(csv.DictReader(file))
|
||||
return Label(name=name, meta=meta, runs=runs)
|
||||
|
||||
|
||||
def flatten(prefix: str, value: Any, into: dict[str, Any]) -> None:
|
||||
"""Вложенные словари паспорта → плоские ключи `a.b.c`."""
|
||||
if isinstance(value, dict):
|
||||
for key, inner in value.items():
|
||||
flatten(f"{prefix}.{key}", inner, into)
|
||||
else:
|
||||
into[prefix] = value
|
||||
|
||||
|
||||
def is_series(label: Label) -> bool:
|
||||
"""Метка серии трека 1 (design change `scaling-bench`, решение 11)."""
|
||||
return bool(label.meta.get("profile", {}).get("series"))
|
||||
|
||||
|
||||
def methodology(
|
||||
label: Label,
|
||||
configs: set[str] | None = None,
|
||||
) -> dict[str, Any]:
|
||||
"""Параметры, которые у сравнимых меток обязаны совпадать.
|
||||
|
||||
Профиль, лимиты всех контейнеров стенда, образ генератора, образы и
|
||||
настройки PostgreSQL и Valkey, окружение приложения (решение 8 design
|
||||
change `bench-postgres`). У Valkey настройки — `maxmemory*` из
|
||||
`valkey.conf`: правку конфигурации образ не покажет. У серий трека 1
|
||||
имя, серия и состав конфигураций к методике не относятся, лимиты — по
|
||||
общим конфигурациям `configs` (решение 11 design change
|
||||
`scaling-bench`).
|
||||
"""
|
||||
meta = label.meta
|
||||
stand = meta.get("stand", {})
|
||||
flat: dict[str, Any] = {}
|
||||
profile = dict(meta.get("profile", {}))
|
||||
limits = meta.get("limits", {})
|
||||
if configs is not None:
|
||||
for key in ("name", "series", "configs"):
|
||||
profile.pop(key, None)
|
||||
limits = {key: limits[key] for key in configs if key in limits}
|
||||
flatten("profile", profile, flat)
|
||||
flatten("limits", limits, flat)
|
||||
for name, value in (
|
||||
("generator.image", meta.get("generator", {}).get("image")),
|
||||
("stand.postgres.image", stand.get("postgres", {}).get("image")),
|
||||
("stand.valkey.image", stand.get("valkey", {}).get("image")),
|
||||
):
|
||||
if value is not None:
|
||||
flat[name] = value
|
||||
flatten(
|
||||
"stand.postgres.settings",
|
||||
stand.get("postgres", {}).get("settings", {}),
|
||||
flat,
|
||||
)
|
||||
for key, value in stand.get("valkey", {}).items():
|
||||
if key.startswith("maxmemory"):
|
||||
flat[f"stand.valkey.{key}"] = value
|
||||
flatten("stand.app_env", stand.get("app_env", {}), flat)
|
||||
return flat
|
||||
|
||||
|
||||
def check_methodology(
|
||||
first: Label,
|
||||
second: Label,
|
||||
configs: set[str] | None = None,
|
||||
) -> list[str]:
|
||||
"""Отказ при различии; возвращает параметры, записанные в одной метке.
|
||||
|
||||
`configs` — общие конфигурации серий трека 1; None — матрица."""
|
||||
if is_series(first) != is_series(second):
|
||||
series = first if is_series(first) else second
|
||||
raise CompareError(
|
||||
"different methodology: track 1 series "
|
||||
f"{series.name} and matrix "
|
||||
f"{(second if series is first else first).name}",
|
||||
)
|
||||
a, b = methodology(first, configs), methodology(second, configs)
|
||||
# с change graceful-failover в пути запроса стоит HAProxy, и паспорт
|
||||
# пишет число реплик; метка без него снята мимо LB — другая методика
|
||||
# (решение 6 design change graceful-failover), а не «параметр
|
||||
# записан только в одной метке»
|
||||
without_lb = [
|
||||
label.name
|
||||
for label, flat in ((first, a), (second, b))
|
||||
if configs is None and "limits.api_replicas" not in flat
|
||||
]
|
||||
if len(without_lb) == 1:
|
||||
raise CompareError(
|
||||
f"label {without_lb[0]} was measured without the load balancer "
|
||||
"(before change graceful-failover): different methodology",
|
||||
)
|
||||
differs = [
|
||||
f"{key}: {first.name} = {a[key]!r}, {second.name} = {b[key]!r}"
|
||||
for key in sorted(a.keys() & b.keys())
|
||||
if a[key] != b[key]
|
||||
]
|
||||
if differs:
|
||||
raise CompareError(
|
||||
f"labels {first.name} and {second.name} were measured with "
|
||||
"different methodology:\n " + "\n ".join(differs),
|
||||
)
|
||||
return [
|
||||
f"`{key}` записан только в `{(first if key in a else second).name}`: "
|
||||
"совпадение не проверено"
|
||||
for key in sorted(a.keys() ^ b.keys())
|
||||
]
|
||||
|
||||
|
||||
def notes(label: Label) -> list[str]:
|
||||
"""Что мешает считать метку чистым замером."""
|
||||
meta = label.meta
|
||||
found = []
|
||||
if meta.get("status") != "complete":
|
||||
found.append(f"статус {meta.get('status')}: {meta.get('reason')}")
|
||||
if meta.get("git", {}).get("dirty"):
|
||||
found.append("незакоммиченные изменения (`dirty: true`)")
|
||||
if meta.get("overrides"):
|
||||
found.append(f"отладочные переопределения {meta['overrides']}")
|
||||
found += [f"хост: {text}" for text in meta.get("host_warnings", [])]
|
||||
if meta.get("other_containers"):
|
||||
found.append(
|
||||
"посторонние контейнеры: " + ", ".join(meta["other_containers"]),
|
||||
)
|
||||
flagged = [
|
||||
run["run"]
|
||||
for run in label.runs
|
||||
if run.get("flags")
|
||||
or run.get("requests_failed", "0") not in ("0", "")
|
||||
or run.get("check_failed", "0") not in ("0", "")
|
||||
]
|
||||
if flagged:
|
||||
found.append("прогоны с пометками или ошибками: " + ", ".join(flagged))
|
||||
return [f"`{label.name}`: {text}" for text in found]
|
||||
|
||||
|
||||
def cells(label: Label) -> dict[CellKey, Stat]:
|
||||
grouped: dict[CellKey, list[dict[str, str]]] = {}
|
||||
for run in label.runs:
|
||||
if not run["rps"] or float(run["rps"]) <= 0:
|
||||
continue
|
||||
key = (run["scenario"], int(run["size"]), int(run["concurrency"]))
|
||||
grouped.setdefault(key, []).append(run)
|
||||
|
||||
def median(rows: list[dict[str, str]], column: str) -> float:
|
||||
return statistics.median(float(row[column]) for row in rows)
|
||||
|
||||
return {
|
||||
key: Stat(
|
||||
rps=[float(row["rps"]) for row in rows],
|
||||
cpu_us=statistics.median(
|
||||
float(row["app_cpu_cores"]) / float(row["rps"]) * 1e6
|
||||
for row in rows
|
||||
),
|
||||
p50=median(rows, "p50_ms"),
|
||||
p95=median(rows, "p95_ms"),
|
||||
p99=median(rows, "p99_ms"),
|
||||
)
|
||||
for key, rows in grouped.items()
|
||||
}
|
||||
|
||||
|
||||
def compare(before: Label, after: Label) -> tuple[list[Row], list[str]]:
|
||||
"""Строки по общим ячейкам и замечания о ячейках одной метки."""
|
||||
first, second = cells(before), cells(after)
|
||||
rows = [
|
||||
Row(key=key, before=first[key], after=second[key])
|
||||
for key in first
|
||||
if key in second
|
||||
]
|
||||
lonely = [
|
||||
f"ячейка {key[0]} {human(key[1])} × {key[2]} есть только в "
|
||||
f"`{(before if key in first else after).name}`"
|
||||
for key in sorted(first.keys() ^ second.keys())
|
||||
]
|
||||
repeats = [
|
||||
f"ячейка {row.key[0]} {human(row.key[1])} × {row.key[2]}: повторов "
|
||||
f"{len(row.before.rps)} и {len(row.after.rps)}"
|
||||
for row in rows
|
||||
if len(row.before.rps) != len(row.after.rps)
|
||||
]
|
||||
return rows, lonely + repeats
|
||||
|
||||
|
||||
def noise_floor(rows: list[Row]) -> dict[str, Row]:
|
||||
"""Ячейка с наибольшим изменением медианы RPS в каждом сценарии."""
|
||||
floor: dict[str, Row] = {}
|
||||
for row in rows:
|
||||
worst = floor.get(row.key[0])
|
||||
if worst is None or abs(row.delta) > abs(worst.delta):
|
||||
floor[row.key[0]] = row
|
||||
return floor
|
||||
|
||||
|
||||
def passport_rows(labels: list[Label]) -> list[str]:
|
||||
def field(title: str, value: Any) -> str:
|
||||
return (
|
||||
f"| {title} | " + " | ".join(value(x.meta) for x in labels) + " |"
|
||||
)
|
||||
|
||||
def host(meta: dict[str, Any]) -> str:
|
||||
# занятый swap — не помеха; помеха — выгрузка за прогон (решение 12
|
||||
# design change scaling-bench)
|
||||
state = meta.get("host_state", {})
|
||||
start = state.get("start", {})
|
||||
before = start.get("swapouts")
|
||||
after = state.get("end", {}).get("swapouts")
|
||||
swapped = (
|
||||
f"выгрузок в swap за прогон {after - before}"
|
||||
if before is not None and after is not None
|
||||
else f"swap {start.get('swap_used_mib')} МиБ"
|
||||
)
|
||||
return f"{swapped}, {start.get('power')}"
|
||||
|
||||
def versions(meta: dict[str, Any]) -> str:
|
||||
found = meta.get("app_image", {}).get("versions", {})
|
||||
return ", ".join(f"{name} {ver}" for name, ver in found.items())
|
||||
|
||||
def machine(meta: dict[str, Any]) -> str:
|
||||
found, docker = meta.get("host", {}), meta.get("docker", {})
|
||||
cores = (
|
||||
f" ({found['performance_cores']} P + "
|
||||
f"{found['efficiency_cores']} E)"
|
||||
if found.get("performance_cores") is not None
|
||||
else ""
|
||||
)
|
||||
return (
|
||||
f"{found.get('machine')}{cores}, ВМ {docker.get('vm_cpus')} vCPU "
|
||||
f"/ {docker.get('vm_memory_gib')} GiB, Docker "
|
||||
f"{docker.get('server')}"
|
||||
)
|
||||
|
||||
return [
|
||||
"| | " + " | ".join(f"`{x.name}`" for x in labels) + " |",
|
||||
"|---|" + "---|" * len(labels),
|
||||
field("Commit", lambda m: f"`{m.get('git', {}).get('commit')}`"),
|
||||
field("Начало прогона", lambda m: str(m.get("started_at"))),
|
||||
field("Статус", lambda m: str(m.get("status"))),
|
||||
field("Версии в образе", versions),
|
||||
field("Машина", machine),
|
||||
field("Хост в начале", host),
|
||||
]
|
||||
|
||||
|
||||
def scenario_table(
|
||||
rows: list[Row],
|
||||
floor: dict[str, Row] | None,
|
||||
) -> list[str]:
|
||||
lines = [
|
||||
"| Размер | Клиенты | RPS до | RPS после | Δ RPS | Вывод | "
|
||||
"CPU на запрос, мкс | Δ CPU, мкс | p50, мс | p95, мс | p99, мс |",
|
||||
"|---|---|---|---|---|---|---|---|---|---|---|",
|
||||
]
|
||||
for row in rows:
|
||||
before, after = row.before, row.after
|
||||
if floor is None:
|
||||
verdict = (
|
||||
"разбросы пересекаются"
|
||||
if row.overlap
|
||||
else "разбросы не пересекаются"
|
||||
)
|
||||
elif not row.overlap and abs(row.delta) > abs(floor[row.key[0]].delta):
|
||||
verdict = "эффект"
|
||||
else:
|
||||
verdict = "в пределах шума"
|
||||
lines.append(
|
||||
f"| {human(row.key[1])} | {row.key[2]} | "
|
||||
f"{before.median:.0f} ({min(before.rps):.0f}–"
|
||||
f"{max(before.rps):.0f}) | "
|
||||
f"{after.median:.0f} ({min(after.rps):.0f}–"
|
||||
f"{max(after.rps):.0f}) | "
|
||||
f"{row.delta:+.1f}% | {verdict} | "
|
||||
f"{before.cpu_us:.0f} → {after.cpu_us:.0f} | "
|
||||
f"{after.cpu_us - before.cpu_us:+.0f} | "
|
||||
f"{before.p50:.2f} → {after.p50:.2f} | "
|
||||
f"{before.p95:.2f} → {after.p95:.2f} | "
|
||||
f"{before.p99:.2f} → {after.p99:.2f} |",
|
||||
)
|
||||
deltas = [row.delta for row in rows]
|
||||
lines += [
|
||||
"",
|
||||
f"Δ RPS по ячейкам: от {min(deltas):+.1f}% до {max(deltas):+.1f}%, "
|
||||
f"медиана {statistics.median(deltas):+.1f}%.",
|
||||
]
|
||||
return lines
|
||||
|
||||
|
||||
def memory_table(before: Label, after: Label) -> list[str]:
|
||||
def sizes(label: Label) -> dict[int, dict[str, Any]]:
|
||||
return {item["size"]: item for item in label.meta.get("sizes", [])}
|
||||
|
||||
first, second = sizes(before), sizes(after)
|
||||
lines = [
|
||||
"| Размер | Байт RSS на сообщение до | после | "
|
||||
"RSS после наполнения до, МиБ | после | "
|
||||
"Байт в БД на сообщение до | после |",
|
||||
"|---|---|---|---|---|---|---|",
|
||||
]
|
||||
for size in sorted(first.keys() & second.keys()):
|
||||
a, b = first[size], second[size]
|
||||
lines.append(
|
||||
f"| {human(size)} | {a.get('bytes_per_message')} | "
|
||||
f"{b.get('bytes_per_message')} | {a.get('rss_after_mib')} | "
|
||||
f"{b.get('rss_after_mib')} | {a.get('db_bytes_per_message')} | "
|
||||
f"{b.get('db_bytes_per_message')} |",
|
||||
)
|
||||
return lines
|
||||
|
||||
|
||||
def render(
|
||||
before: Label,
|
||||
after: Label,
|
||||
aa: Label | None,
|
||||
command: str,
|
||||
) -> str:
|
||||
unverified = check_methodology(before, after)
|
||||
rows, remarks = compare(before, after)
|
||||
if not rows:
|
||||
raise CompareError("labels have no common matrix cells")
|
||||
labels = [before, after]
|
||||
floor = None
|
||||
if aa is not None:
|
||||
unverified += check_methodology(aa, before)
|
||||
aa_rows, aa_remarks = compare(aa, before)
|
||||
floor = noise_floor(aa_rows)
|
||||
missing = [s for s in {row.key[0] for row in rows} if s not in floor]
|
||||
if missing:
|
||||
raise CompareError(
|
||||
f"label {aa.name} has no cells for {', '.join(missing)}",
|
||||
)
|
||||
remarks += aa_remarks
|
||||
labels.append(aa)
|
||||
remarks = (
|
||||
unverified + [text for x in labels for text in notes(x)] + remarks
|
||||
)
|
||||
lines = [
|
||||
f"# Сравнение меток: `{before.name}` → `{after.name}`",
|
||||
"",
|
||||
f"- Команда: `{command}`",
|
||||
"- «До» и «после» — медиана повторов ячейки, в скобках min–max. "
|
||||
"Δ RPS — отношение медиан минус единица.",
|
||||
"- CPU на запрос — `app_cpu_cores / rps`, медиана по повторам; "
|
||||
"задержки — медианы по повторам, «до → после».",
|
||||
]
|
||||
if aa is None:
|
||||
lines.append(
|
||||
"- Уровень шума не задан (`AA`): вывод говорит только, "
|
||||
"пересекаются ли разбросы повторов.",
|
||||
)
|
||||
else:
|
||||
lines += [
|
||||
f"- Уровень шума — наибольшее по ячейкам сценария изменение "
|
||||
f"медианы RPS между `{aa.name}` и `{before.name}`. Он имеет "
|
||||
"смысл, только если код приложения в этих метках одинаков; "
|
||||
"это проверяется по git, команда этого не видит.",
|
||||
"- «Эффект» — разбросы повторов не пересекаются и изменение "
|
||||
"медианы больше уровня шума сценария; иначе «в пределах шума».",
|
||||
]
|
||||
lines += [
|
||||
"",
|
||||
"## Метки",
|
||||
"",
|
||||
*passport_rows(labels),
|
||||
"",
|
||||
"## Замечания",
|
||||
"",
|
||||
]
|
||||
lines += [f"- {text}" for text in dict.fromkeys(remarks)] or ["Нет."]
|
||||
if floor is not None and aa is not None:
|
||||
lines += [
|
||||
"",
|
||||
"## Уровень шума",
|
||||
"",
|
||||
f"| Сценарий | Наибольшее изменение RPS, `{aa.name}` → "
|
||||
f"`{before.name}` | Ячейка |",
|
||||
"|---|---|---|",
|
||||
]
|
||||
lines += [
|
||||
f"| {scenario} | {abs(floor[scenario].delta):.1f}% | "
|
||||
f"{human(floor[scenario].key[1])} × {floor[scenario].key[2]} |"
|
||||
for scenario in SCENARIOS
|
||||
if scenario in floor
|
||||
]
|
||||
for scenario in SCENARIOS:
|
||||
selected = [row for row in rows if row.key[0] == scenario]
|
||||
if selected:
|
||||
lines += [
|
||||
"",
|
||||
f"## Сценарий `{scenario}`",
|
||||
"",
|
||||
*scenario_table(selected, floor),
|
||||
]
|
||||
lines += ["", "## Память", "", *memory_table(before, after)]
|
||||
return "\n".join(lines) + "\n"
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class SeriesRow:
|
||||
"""Общая конфигурация двух меток серий: R* повторов и числа сводки."""
|
||||
|
||||
config: str
|
||||
before: dict[str, Any]
|
||||
after: dict[str, Any]
|
||||
|
||||
@property
|
||||
def delta(self) -> float:
|
||||
return (self.after["r_star"] / self.before["r_star"] - 1) * 100
|
||||
|
||||
@property
|
||||
def overlap(self) -> bool:
|
||||
a, b = self.before["r_stars"], self.after["r_stars"]
|
||||
return min(a) <= max(b) and min(b) <= max(a)
|
||||
|
||||
|
||||
def series_stats(label: Label) -> dict[str, dict[str, Any]]:
|
||||
"""Сводка конфигураций серии (`scaling.config_stats`) с R* полных
|
||||
ячеек; ячейки с браком генератора в сравнение не входят."""
|
||||
directory = BENCH_DIR / label.name
|
||||
searches = scaling.read_csv(directory / "searches.csv")
|
||||
return {
|
||||
c["config"]: c
|
||||
for c in scaling.config_stats(label.meta, label.runs, searches)
|
||||
}
|
||||
|
||||
|
||||
def series_notes(label: Label, stats: dict[str, dict[str, Any]]) -> list[str]:
|
||||
"""Что мешает считать метку серии чистым замером: прочее — как у
|
||||
матрицы, но нарушения SLO на ступенях поиска — норма, а не пометка."""
|
||||
meta = label.meta
|
||||
found = []
|
||||
if meta.get("status") != "complete":
|
||||
found.append(f"статус {meta.get('status')}: {meta.get('reason')}")
|
||||
if meta.get("git", {}).get("dirty"):
|
||||
found.append("незакоммиченные изменения (`dirty: true`)")
|
||||
if meta.get("overrides"):
|
||||
found.append(f"отладочные переопределения {meta['overrides']}")
|
||||
found += [f"хост: {text}" for text in meta.get("host_warnings", [])]
|
||||
bound = [cell for c in stats.values() for cell in c["generator_bound"]]
|
||||
if bound:
|
||||
found.append(
|
||||
"брак генератора, ячейки не сравниваются: " + ", ".join(bound),
|
||||
)
|
||||
marked = sorted(
|
||||
{
|
||||
run["cell"]
|
||||
for run in label.runs
|
||||
if {"oom", "app_down", "stand_down", "host_swap"}
|
||||
& set((run.get("flags") or "").split())
|
||||
},
|
||||
)
|
||||
if marked:
|
||||
found.append(
|
||||
"ячейки с отказом стенда или выгрузкой: " + ", ".join(marked),
|
||||
)
|
||||
return [f"`{label.name}`: {text}" for text in found]
|
||||
|
||||
|
||||
def series_noise(aa: Label, before: Label) -> tuple[float, str]:
|
||||
"""Шум A/A серий: наибольшее по общим конфигурациям |Δ медианы R*|."""
|
||||
first, second = series_stats(aa), series_stats(before)
|
||||
common = [
|
||||
SeriesRow(config=key, before=first[key], after=second[key])
|
||||
for key in first
|
||||
if key in second
|
||||
and first[key]["r_stars"]
|
||||
and second[key]["r_stars"]
|
||||
and first[key]["r_star"]
|
||||
]
|
||||
if not common:
|
||||
raise CompareError(
|
||||
f"labels {aa.name} and {before.name} have no common configs",
|
||||
)
|
||||
worst = max(common, key=lambda row: abs(row.delta))
|
||||
return abs(worst.delta), worst.config
|
||||
|
||||
|
||||
def render_series(
|
||||
before: Label,
|
||||
after: Label,
|
||||
aa: Label | None,
|
||||
command: str,
|
||||
change: str = "scaling-bench",
|
||||
) -> str:
|
||||
"""Сравнение меток серий трека 1 по общим конфигурациям (решение 11
|
||||
design change `scaling-bench`); раздел PostgreSQL на R* и первой
|
||||
нарушившей ступени — решение 7 change `scaling-improvement`."""
|
||||
first, second = series_stats(before), series_stats(after)
|
||||
common = [key for key in first if key in second]
|
||||
if not common:
|
||||
raise CompareError("labels have no common track 1 configs")
|
||||
unverified = check_methodology(before, after, set(common))
|
||||
labels = [before, after]
|
||||
floor = None
|
||||
if aa is not None:
|
||||
aa_stats = series_stats(aa)
|
||||
unverified += check_methodology(
|
||||
aa,
|
||||
before,
|
||||
{key for key in aa_stats if key in first},
|
||||
)
|
||||
floor = series_noise(aa, before)
|
||||
labels.append(aa)
|
||||
remarks = list(unverified)
|
||||
remarks += series_notes(before, first) + series_notes(after, second)
|
||||
if aa is not None:
|
||||
remarks += series_notes(aa, series_stats(aa))
|
||||
remarks += [
|
||||
f"конфигурация {key} есть только в `{label.name}`: не сравнивается"
|
||||
for key, label in [
|
||||
*((k, before) for k in first if k not in second),
|
||||
*((k, after) for k in second if k not in first),
|
||||
]
|
||||
]
|
||||
rows = [
|
||||
SeriesRow(config=key, before=first[key], after=second[key])
|
||||
for key in common
|
||||
if first[key]["r_stars"]
|
||||
and second[key]["r_stars"]
|
||||
and first[key]["r_star"]
|
||||
]
|
||||
lines = [
|
||||
f"# Сравнение серий: `{before.name}` → `{after.name}`",
|
||||
"",
|
||||
f"- Команда: `{command}`",
|
||||
f"- Спек: `load-benchmark` (сравнение меток), change `{change}`; "
|
||||
"даты, commit и хост — таблица «Метки»",
|
||||
"- Метки серий трека 1 сравниваются по общим конфигурациям. R* — "
|
||||
"медиана повторов, в скобках min–max; Δ R* — отношение медиан "
|
||||
"минус единица. Ячейки с браком генератора не входят.",
|
||||
"- Задержки — медианы по повторам на фиксированных уровнях, «до → "
|
||||
"после»; CPU на запрос — CPU реплик на успешный запрос на втором "
|
||||
"фиксированном уровне; CPU PostgreSQL — на ступени R*.",
|
||||
]
|
||||
if floor is None:
|
||||
lines.append(
|
||||
"- Уровень шума не задан (`AA`): вывод говорит только, "
|
||||
"пересекаются ли разбросы повторов.",
|
||||
)
|
||||
else:
|
||||
lines += [
|
||||
f"- Уровень шума — наибольшее по общим конфигурациям изменение "
|
||||
f"медианы R* между `{aa.name if aa else ''}` и `{before.name}`: "
|
||||
f"{floor[0]:.1f}% ({floor[1]}). Он имеет смысл, только если код "
|
||||
"приложения в этих метках одинаков; это проверяется по git.",
|
||||
"- «Эффект» — разбросы повторов не пересекаются и изменение "
|
||||
"медианы больше уровня шума; иначе «в пределах шума».",
|
||||
]
|
||||
lines += [
|
||||
"",
|
||||
"## Метки",
|
||||
"",
|
||||
*passport_rows(labels),
|
||||
"",
|
||||
"## Замечания",
|
||||
"",
|
||||
]
|
||||
lines += [f"- {text}" for text in dict.fromkeys(remarks)] or ["Нет."]
|
||||
fixed = before.meta["profile"].get("fixed_rps") or []
|
||||
second_level = (
|
||||
fixed[1] if len(fixed) > 1 else (fixed[0] if fixed else None)
|
||||
)
|
||||
lines += [
|
||||
"",
|
||||
"## R* по общим конфигурациям",
|
||||
"",
|
||||
"| Конфигурация | R* до | R* после | Δ R* | Вывод | "
|
||||
+ " | ".join(f"p95 / p99 на {lvl}, мс" for lvl in fixed)
|
||||
+ f" | CPU на запрос на {second_level}, мкс | CPU PostgreSQL на R*, "
|
||||
"ядер |",
|
||||
"|---|---|---|---|---|" + "---|" * len(fixed) + "---|---|",
|
||||
]
|
||||
for row in rows:
|
||||
a, b = row.before, row.after
|
||||
if floor is None:
|
||||
verdict = (
|
||||
"разбросы пересекаются"
|
||||
if row.overlap
|
||||
else "разбросы не пересекаются"
|
||||
)
|
||||
elif not row.overlap and abs(row.delta) > floor[0]:
|
||||
verdict = "эффект"
|
||||
else:
|
||||
verdict = "в пределах шума"
|
||||
latency = []
|
||||
for lvl in fixed:
|
||||
fa, fb = a["fixed"].get(lvl) or {}, b["fixed"].get(lvl) or {}
|
||||
latency.append(
|
||||
f"{scaling.fmt(fa.get('p95'), 1)} → "
|
||||
f"{scaling.fmt(fb.get('p95'), 1)} / "
|
||||
f"{scaling.fmt(fa.get('p99'), 1)} → "
|
||||
f"{scaling.fmt(fb.get('p99'), 1)}",
|
||||
)
|
||||
us_a = (a["fixed"].get(second_level) or {}).get("app_us")
|
||||
us_b = (b["fixed"].get(second_level) or {}).get("app_us")
|
||||
lines.append(
|
||||
f"| {row.config} | {scaling.spread(a['r_stars'])} | "
|
||||
f"{scaling.spread(b['r_stars'])} | {row.delta:+.1f}% | "
|
||||
f"{verdict} | "
|
||||
+ " | ".join(latency)
|
||||
+ f" | {scaling.fmt(us_a, 0)} → {scaling.fmt(us_b, 0)} | "
|
||||
f"{scaling.fmt(a['db_cpu_r'], 2)} → {scaling.fmt(b['db_cpu_r'], 2)} |",
|
||||
)
|
||||
if rows:
|
||||
deltas = [row.delta for row in rows]
|
||||
lines += [
|
||||
"",
|
||||
f"Δ R* по конфигурациям: от {min(deltas):+.1f}% до "
|
||||
f"{max(deltas):+.1f}%.",
|
||||
]
|
||||
lines += pg_section(first, second, common)
|
||||
return "\n".join(lines) + "\n"
|
||||
|
||||
|
||||
def pg_section(
|
||||
first: dict[str, dict[str, Any]],
|
||||
second: dict[str, dict[str, Any]],
|
||||
common: list[str],
|
||||
) -> list[str]:
|
||||
"""PostgreSQL на ступени R* и первой нарушившей выше неё: медианы по
|
||||
повторам, «до → после»."""
|
||||
|
||||
def pair(a: Any, b: Any) -> str:
|
||||
return f"{scaling.fmt(a)} → {scaling.fmt(b)}"
|
||||
|
||||
lines = [
|
||||
"",
|
||||
"## PostgreSQL на R* и первой нарушившей ступени",
|
||||
"",
|
||||
"Медианы по завершённым ячейкам, «до → после». Уровень R* — медиана "
|
||||
"R*; первая нарушившая — ближайшая ступень выше R* ячейки, "
|
||||
"нарушившая SLO. CPU PostgreSQL — на успешный запрос; новые сессии "
|
||||
"— прирост `pg_stat_database.sessions` за окно; соединения — "
|
||||
"наибольшее число соединений с PostgreSQL в окне. Нет значения — "
|
||||
"«—».",
|
||||
"",
|
||||
"| Конфигурация | Ступень | Уровень, запросов/с | CPU PostgreSQL "
|
||||
"на запрос, мкс | Новых сессий за окно | Соединений PostgreSQL |",
|
||||
"|---|---|---|---|---|---|",
|
||||
]
|
||||
for key in common:
|
||||
a, b = first[key], second[key]
|
||||
lines += [
|
||||
f"| {key} | R* | {pair(a['r_star'], b['r_star'])} | "
|
||||
f"{pair(a['db_us_r'], b['db_us_r'])} | "
|
||||
f"{pair(a['sessions_r'], b['sessions_r'])} | "
|
||||
f"{pair(a['conn_r'], b['conn_r'])} |",
|
||||
f"| {key} | первая нарушившая | "
|
||||
f"{pair(a['level_f'], b['level_f'])} | "
|
||||
f"{pair(a['db_us_f'], b['db_us_f'])} | "
|
||||
f"{pair(a['sessions_f'], b['sessions_f'])} | "
|
||||
f"{pair(a['conn_f'], b['conn_f'])} |",
|
||||
]
|
||||
return lines
|
||||
|
||||
|
||||
def main(argv: list[str]) -> int:
|
||||
parser = argparse.ArgumentParser(description=__doc__.splitlines()[0])
|
||||
parser.add_argument("--before", default="")
|
||||
parser.add_argument("--after", default="")
|
||||
parser.add_argument("--aa", default="")
|
||||
# change, к которому относится сравнение серий (строка шапки)
|
||||
parser.add_argument("--change", default="scaling-bench")
|
||||
args = parser.parse_args(argv)
|
||||
if not args.before or not args.after:
|
||||
print(
|
||||
"both labels are required: "
|
||||
"make bench_compare BEFORE=<label> AFTER=<label> [AA=<label>]",
|
||||
flush=True,
|
||||
)
|
||||
return 2
|
||||
command = f"make bench_compare BEFORE={args.before} AFTER={args.after}"
|
||||
if args.aa:
|
||||
command += f" AA={args.aa}"
|
||||
if args.change != parser.get_default("change"):
|
||||
command += f" CHANGE={args.change}"
|
||||
try:
|
||||
before, after = load(args.before), load(args.after)
|
||||
aa = load(args.aa) if args.aa else None
|
||||
if any(is_series(x) for x in (before, after, aa) if x is not None):
|
||||
for other in (after, aa):
|
||||
if other is not None:
|
||||
check_methodology(before, other, set())
|
||||
text = render_series(before, after, aa, command, args.change)
|
||||
else:
|
||||
text = render(before, after, aa, command)
|
||||
except CompareError as exc:
|
||||
print(f"compare failed: {exc}", flush=True)
|
||||
return 1
|
||||
out = OUT_DIR / f"{args.before}__{args.after}.md"
|
||||
out.parent.mkdir(parents=True, exist_ok=True)
|
||||
out.write_text(text, encoding="utf-8")
|
||||
print(text, flush=True)
|
||||
print(f"saved to {out.relative_to(ROOT)}", flush=True)
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main(sys.argv[1:]))
|
||||
@@ -0,0 +1,606 @@
|
||||
"""Профиль отказа реплик: разбор и расчёт без docker.
|
||||
|
||||
Оркестрирует фазы `run.py` (профили `failover`, `failover_quick`), здесь —
|
||||
чистые функции на stdlib: строки k6 о каждом запросе, статистика и
|
||||
журнал HAProxy, события Docker, посекундная шкала, величины фазы и
|
||||
`summary.md`. Определения величин — решение 5 design change
|
||||
`graceful-failover`. Все отметки времени — часы ВМ Docker: `Date.now()` в
|
||||
k6, отметки `docker logs -t` и `TimeNano` событий Docker.
|
||||
"""
|
||||
|
||||
import csv
|
||||
import io
|
||||
import math
|
||||
import re
|
||||
from dataclasses import dataclass
|
||||
from datetime import UTC, datetime
|
||||
from typing import Any
|
||||
|
||||
import resources as res
|
||||
|
||||
# худшее время обнаружения по проверкам LB, с (infra/haproxy/haproxy.cfg:
|
||||
# inter 1s, fastinter 500ms, fall 2, timeout check 2500ms, timeout connect
|
||||
# 500ms): адрес пропал — inter + 0,5 + fastinter + 0,5; зависшая —
|
||||
# inter + timeout check + fastinter + timeout check
|
||||
BOUNDS = {"stop": 2.5, "kill": 2.5, "pause": 6.5}
|
||||
# действие и возврат фазы — события Docker
|
||||
ACTIONS = {"stop": "kill", "kill": "kill", "pause": "pause"}
|
||||
RESTORES = {"stop": "start", "kill": "start", "pause": "unpause"}
|
||||
|
||||
PHASE_FIELDS = [
|
||||
"phase",
|
||||
"mode",
|
||||
"replica",
|
||||
"instance",
|
||||
"slot",
|
||||
"action_at",
|
||||
"signal",
|
||||
"lb_out_s",
|
||||
"lb_out_state",
|
||||
"lb_out_reason",
|
||||
"bound_s",
|
||||
"first_write_ok_s",
|
||||
"first_read_ok_s",
|
||||
"last_error_s",
|
||||
"requests",
|
||||
"errors_before",
|
||||
"errors_down",
|
||||
"codes_down",
|
||||
"errors_after",
|
||||
"codes_after",
|
||||
"min_success",
|
||||
"recovery_s",
|
||||
"ok_rps_before",
|
||||
"ok_rps_down_min",
|
||||
"p95_before_ms",
|
||||
"p95_down_max_ms",
|
||||
"restore_at",
|
||||
"lb_up_s",
|
||||
"slot_back",
|
||||
"instance_back_s",
|
||||
"writes",
|
||||
"writes_failed",
|
||||
"retried_ok",
|
||||
"write_chat_messages",
|
||||
"distinct_texts",
|
||||
"pg_idle_tx_terminated",
|
||||
"dropped_iterations",
|
||||
"flags",
|
||||
]
|
||||
TIMELINE_FIELDS = [
|
||||
"phase",
|
||||
"mode",
|
||||
"replica",
|
||||
"second",
|
||||
"writes_ok",
|
||||
"writes_failed",
|
||||
"reads_ok",
|
||||
"reads_failed",
|
||||
"codes",
|
||||
"success",
|
||||
"p50_ms",
|
||||
"p95_ms",
|
||||
"instances",
|
||||
]
|
||||
|
||||
# без привязки к началу и концу строки: две строки, склеенные без перевода
|
||||
# строки, всё равно разбираются; число строк run.py сверяет с итогом k6
|
||||
LINE_RE = re.compile(
|
||||
r"fo,(?P<kind>[wr]),(?P<n>\d+),(?P<start>\d{13}),(?P<dur>-?\d+),"
|
||||
r"(?P<status>-?\d+),(?P<instance>[A-Za-z0-9._-]*),(?P<ok>[01])",
|
||||
)
|
||||
|
||||
|
||||
def unparsed(text: str) -> list[str]:
|
||||
"""Строки с `fo,`, которые разбор не взял: в сообщение об отказе."""
|
||||
return [
|
||||
line
|
||||
for line in text.splitlines()
|
||||
if "fo," in line and not LINE_RE.search(line)
|
||||
]
|
||||
|
||||
|
||||
LB_RE = re.compile(
|
||||
r"^(?P<stamp>\S+) .*?Server api/(?P<slot>api-\d+) (?P<rest>.*)$",
|
||||
)
|
||||
IDLE_TX = "terminating connection due to idle-in-transaction timeout"
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class Request:
|
||||
"""Один запрос фазы: строка `fo,…` вывода k6."""
|
||||
|
||||
kind: str
|
||||
n: int
|
||||
start: float
|
||||
duration_ms: int
|
||||
status: int
|
||||
instance: str
|
||||
ok: bool
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class LbEvent:
|
||||
"""Смена состояния слота в журнале HAProxy."""
|
||||
|
||||
time: float
|
||||
slot: str
|
||||
state: str
|
||||
reason: str
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class DockerEvent:
|
||||
time: float
|
||||
action: str
|
||||
signal: str
|
||||
|
||||
|
||||
def parse_requests(text: str) -> list[Request]:
|
||||
return [
|
||||
Request(
|
||||
kind=match["kind"],
|
||||
n=int(match["n"]),
|
||||
start=int(match["start"]) / 1000,
|
||||
duration_ms=max(0, int(match["dur"])),
|
||||
status=int(match["status"]),
|
||||
instance=match["instance"],
|
||||
ok=match["ok"] == "1",
|
||||
)
|
||||
for match in LINE_RE.finditer(text)
|
||||
]
|
||||
|
||||
|
||||
def parse_stamp(stamp: str) -> float:
|
||||
"""Отметка `docker logs -t` (RFC 3339, наносекунды) → секунды эпохи."""
|
||||
head, _, frac = stamp.rstrip("Z").partition(".")
|
||||
seconds = datetime.fromisoformat(head).replace(tzinfo=UTC).timestamp()
|
||||
return seconds + (float(f"0.{frac}") if frac else 0.0)
|
||||
|
||||
|
||||
def iso(seconds: float) -> str:
|
||||
return datetime.fromtimestamp(seconds, UTC).isoformat(
|
||||
timespec="milliseconds",
|
||||
)
|
||||
|
||||
|
||||
def parse_lb_stats(text: str) -> list[dict[str, str]]:
|
||||
"""CSV статистики HAProxy → занятые слоты backend `api`."""
|
||||
lines = [
|
||||
line for line in text.splitlines() if line.startswith(("# ", "api,"))
|
||||
]
|
||||
if not lines:
|
||||
return []
|
||||
reader = csv.DictReader(io.StringIO("\n".join(lines).removeprefix("# ")))
|
||||
return [
|
||||
{
|
||||
"slot": row["svname"],
|
||||
"addr": row.get("addr") or "",
|
||||
"status": row["status"],
|
||||
"check_status": row.get("check_status") or "",
|
||||
}
|
||||
for row in reader
|
||||
if row["pxname"] == "api"
|
||||
and row["svname"] not in ("BACKEND", "FRONTEND")
|
||||
and row.get("addr")
|
||||
]
|
||||
|
||||
|
||||
def parse_lb_log(text: str) -> list[LbEvent]:
|
||||
"""Строки смены состояния слотов из журнала LB (`docker logs -t`).
|
||||
|
||||
HAProxy пишет каждое событие дважды (в журнал и предупреждением):
|
||||
повтор с тем же слотом и состоянием в пределах миллисекунды
|
||||
отбрасывается.
|
||||
"""
|
||||
events: list[LbEvent] = []
|
||||
for line in text.splitlines():
|
||||
match = LB_RE.match(line)
|
||||
if not match:
|
||||
continue
|
||||
rest = match["rest"]
|
||||
if "maintenance" in rest:
|
||||
state = "MAINT"
|
||||
elif rest.startswith("is DOWN,") or rest == "is DOWN.":
|
||||
state = "DOWN"
|
||||
elif rest.startswith("is UP"):
|
||||
state = "UP"
|
||||
else:
|
||||
continue
|
||||
reason = re.search(r"reason: ([^,]+)", rest)
|
||||
info = re.search(r"maintenance \(([^)]*)\)", rest)
|
||||
event = LbEvent(
|
||||
time=parse_stamp(match["stamp"]),
|
||||
slot=match["slot"],
|
||||
state=state,
|
||||
reason=(
|
||||
reason.group(1)
|
||||
if reason
|
||||
else (info.group(1).strip() if info else "")
|
||||
),
|
||||
)
|
||||
if any(
|
||||
e.slot == event.slot
|
||||
and e.state == event.state
|
||||
and abs(e.time - event.time) < 0.001
|
||||
for e in events
|
||||
):
|
||||
continue
|
||||
events.append(event)
|
||||
return sorted(events, key=lambda e: e.time)
|
||||
|
||||
|
||||
def lb_lines(text: str) -> str:
|
||||
"""Строки журнала LB о состоянии слотов — для `raw/<фаза>-lb.log`."""
|
||||
return "\n".join(
|
||||
line
|
||||
for line in text.splitlines()
|
||||
if "Server api/" in line and "[WARNING]" not in line
|
||||
)
|
||||
|
||||
|
||||
def parse_events(text: str) -> list[DockerEvent]:
|
||||
events = []
|
||||
for line in text.splitlines():
|
||||
parts = line.split()
|
||||
if len(parts) < 2 or not parts[0].isdigit():
|
||||
continue
|
||||
signal = parts[2] if len(parts) > 2 and parts[2].isdigit() else ""
|
||||
events.append(DockerEvent(int(parts[0]) / 1e9, parts[1], signal))
|
||||
return sorted(events, key=lambda e: e.time)
|
||||
|
||||
|
||||
def count_idle_terminations(text: str) -> int:
|
||||
"""Сколько соединений PostgreSQL прервал по простою в транзакции."""
|
||||
return text.count(IDLE_TX)
|
||||
|
||||
|
||||
def percentile(values: list[int], share: float) -> int | None:
|
||||
"""Ближайший ранг: p95 из 100 значений — 95-е по возрастанию."""
|
||||
if not values:
|
||||
return None
|
||||
ordered = sorted(values)
|
||||
return ordered[max(0, math.ceil(share * len(ordered)) - 1)]
|
||||
|
||||
|
||||
def code(request: Request) -> str:
|
||||
"""Код ошибки: статус, 0 — ошибка соединения или таймаут клиента,
|
||||
`200-short` — чтение без полной страницы."""
|
||||
if request.status == 200 and not request.ok:
|
||||
return "200-short"
|
||||
return str(request.status)
|
||||
|
||||
|
||||
def codes(requests: list[Request]) -> str:
|
||||
counts: dict[str, int] = {}
|
||||
for request in requests:
|
||||
if not request.ok:
|
||||
counts[code(request)] = counts.get(code(request), 0) + 1
|
||||
return " ".join(f"{key}:{value}" for key, value in sorted(counts.items()))
|
||||
|
||||
|
||||
def build_timeline(
|
||||
requests: list[Request],
|
||||
t0: float,
|
||||
*,
|
||||
phase: str,
|
||||
mode: str,
|
||||
replica: int,
|
||||
) -> list[dict[str, Any]]:
|
||||
"""Посекундная шкала от действия: секунда запроса — по отправке."""
|
||||
buckets: dict[int, list[Request]] = {}
|
||||
for request in requests:
|
||||
buckets.setdefault(math.floor(request.start - t0), []).append(request)
|
||||
rows = []
|
||||
for second in range(min(buckets, default=0), max(buckets, default=-1) + 1):
|
||||
group = buckets.get(second, [])
|
||||
ok = [r for r in group if r.ok]
|
||||
instances: dict[str, int] = {}
|
||||
for request in ok:
|
||||
instances[request.instance] = (
|
||||
instances.get(request.instance, 0) + 1
|
||||
)
|
||||
durations = [r.duration_ms for r in ok]
|
||||
rows.append(
|
||||
{
|
||||
"phase": phase,
|
||||
"mode": mode,
|
||||
"replica": replica,
|
||||
"second": second,
|
||||
"writes_ok": sum(1 for r in ok if r.kind == "w"),
|
||||
"writes_failed": sum(
|
||||
1 for r in group if r.kind == "w" and not r.ok
|
||||
),
|
||||
"reads_ok": sum(1 for r in ok if r.kind == "r"),
|
||||
"reads_failed": sum(
|
||||
1 for r in group if r.kind == "r" and not r.ok
|
||||
),
|
||||
"codes": codes(group),
|
||||
"success": round(len(ok) / len(group), 4) if group else None,
|
||||
"p50_ms": percentile(durations, 0.5),
|
||||
"p95_ms": percentile(durations, 0.95),
|
||||
"instances": " ".join(
|
||||
f"{key}:{value}"
|
||||
for key, value in sorted(instances.items())
|
||||
),
|
||||
},
|
||||
)
|
||||
return rows
|
||||
|
||||
|
||||
def first_after(
|
||||
events: list[LbEvent],
|
||||
slot: str | None,
|
||||
states: tuple[str, ...],
|
||||
since: float,
|
||||
) -> LbEvent | None:
|
||||
return next(
|
||||
(
|
||||
e
|
||||
for e in events
|
||||
if e.slot == slot and e.state in states and e.time >= since
|
||||
),
|
||||
None,
|
||||
)
|
||||
|
||||
|
||||
def rounded(value: float | None, digits: int = 2) -> float | None:
|
||||
return None if value is None else round(value, digits)
|
||||
|
||||
|
||||
def analyze(
|
||||
requests: list[Request],
|
||||
timeline: list[dict[str, Any]],
|
||||
lb_events: list[LbEvent],
|
||||
*,
|
||||
mode: str,
|
||||
instance: str,
|
||||
t0: float,
|
||||
restore: float,
|
||||
slot: str | None,
|
||||
slot_back: str | None,
|
||||
threshold: float,
|
||||
) -> dict[str, Any]:
|
||||
"""Величины фазы (решение 5): секунды от действия и от возврата.
|
||||
|
||||
До действия — запросы, завершённые до него. Запрос в полёте в момент
|
||||
действия (на замороженной или убитой реплике) относится к окну
|
||||
отказа, хотя в шкале он — в секунде отправки.
|
||||
"""
|
||||
|
||||
def ended(request: Request) -> float:
|
||||
return request.start + request.duration_ms / 1000
|
||||
|
||||
before = [r for r in requests if ended(r) < t0]
|
||||
down = [r for r in requests if ended(r) >= t0 and r.start < restore]
|
||||
after = [r for r in requests if r.start >= restore]
|
||||
window = math.ceil(restore - t0)
|
||||
down_rows = [row for row in timeline if 0 <= row["second"] < window]
|
||||
before_rows = [row for row in timeline if row["second"] < 0][2:]
|
||||
bad = [
|
||||
row["second"]
|
||||
for row in down_rows
|
||||
if row["success"] is not None and row["success"] < threshold
|
||||
]
|
||||
out = first_after(lb_events, slot, ("DOWN", "MAINT"), t0)
|
||||
up = first_after(lb_events, slot_back, ("UP",), restore)
|
||||
back = next(
|
||||
(
|
||||
r
|
||||
for r in sorted(after, key=lambda r: r.start)
|
||||
if r.ok and r.instance == instance
|
||||
),
|
||||
None,
|
||||
)
|
||||
|
||||
def first_ok(kind: str) -> float | None:
|
||||
starts = [
|
||||
r.start for r in down if r.kind == kind and r.ok and r.start >= t0
|
||||
]
|
||||
return rounded(min(starts) - t0) if starts else None
|
||||
|
||||
failed_down = [r for r in down if not r.ok]
|
||||
p95_down = [
|
||||
row["p95_ms"] for row in down_rows if row["p95_ms"] is not None
|
||||
]
|
||||
lb_out_s = rounded(out.time - t0) if out else None
|
||||
flags = []
|
||||
if out is None:
|
||||
flags.append("no_lb_out")
|
||||
elif lb_out_s is not None and lb_out_s > BOUNDS[mode]:
|
||||
flags.append("over_bound")
|
||||
if up is None:
|
||||
flags.append("no_lb_up")
|
||||
if [r for r in before if not r.ok]:
|
||||
flags.append("errors_before")
|
||||
return {
|
||||
"lb_out_s": lb_out_s,
|
||||
"lb_out_state": out.state if out else None,
|
||||
"lb_out_reason": out.reason if out else None,
|
||||
"bound_s": BOUNDS[mode],
|
||||
"first_write_ok_s": first_ok("w"),
|
||||
"first_read_ok_s": first_ok("r"),
|
||||
"last_error_s": (
|
||||
rounded(max(r.start for r in failed_down) - t0)
|
||||
if failed_down
|
||||
else None
|
||||
),
|
||||
"requests": len(requests),
|
||||
"errors_before": sum(1 for r in before if not r.ok),
|
||||
"errors_down": len(failed_down),
|
||||
"codes_down": codes(down),
|
||||
"errors_after": sum(1 for r in after if not r.ok),
|
||||
"codes_after": codes(after),
|
||||
"min_success": min(
|
||||
(
|
||||
row["success"]
|
||||
for row in down_rows
|
||||
if row["success"] is not None
|
||||
),
|
||||
default=None,
|
||||
),
|
||||
"recovery_s": max(bad) + 1 if bad else 0,
|
||||
"ok_rps_before": (
|
||||
round(
|
||||
sum(row["writes_ok"] + row["reads_ok"] for row in before_rows)
|
||||
/ len(before_rows),
|
||||
1,
|
||||
)
|
||||
if before_rows
|
||||
else None
|
||||
),
|
||||
"ok_rps_down_min": min(
|
||||
(row["writes_ok"] + row["reads_ok"] for row in down_rows),
|
||||
default=None,
|
||||
),
|
||||
"p95_before_ms": percentile(
|
||||
[r.duration_ms for r in before if r.ok],
|
||||
0.95,
|
||||
),
|
||||
"p95_down_max_ms": max(p95_down, default=None),
|
||||
"lb_up_s": rounded(up.time - restore) if up else None,
|
||||
"instance_back_s": rounded(back.start - restore) if back else None,
|
||||
"writes": sum(1 for r in requests if r.kind == "w"),
|
||||
"writes_failed": sum(
|
||||
1 for r in requests if r.kind == "w" and not r.ok
|
||||
),
|
||||
"flags": " ".join(flags),
|
||||
}
|
||||
|
||||
|
||||
def fmt(value: Any) -> str:
|
||||
if value is None or value == "":
|
||||
return "—"
|
||||
if isinstance(value, float):
|
||||
return f"{value:g}"
|
||||
return str(value)
|
||||
|
||||
|
||||
def limits_line(profile: dict[str, Any]) -> str:
|
||||
"""Строка лимитов шапки сводки; с сэмплером — и его лимит, и k6 без
|
||||
лимита (design change `profile-resources`, решение 7)."""
|
||||
line = (
|
||||
f"- Лимиты без swap: API {profile['cpus']} CPU / "
|
||||
f"{profile['memory']} на реплику, HAProxy {profile['lb_cpus']} CPU / "
|
||||
f"{profile['lb_memory']}, PostgreSQL {profile['db_cpus']} CPU / "
|
||||
f"{profile['db_memory']}, Valkey {profile['cache_cpus']} CPU / "
|
||||
f"{profile['cache_memory']}"
|
||||
)
|
||||
if profile.get("sample_resources"):
|
||||
line += (
|
||||
f", сэмплер {profile['sampler_cpus']} CPU / "
|
||||
f"{profile['sampler_memory']}, k6 без лимита"
|
||||
)
|
||||
return line
|
||||
|
||||
|
||||
def render_summary(
|
||||
meta: dict[str, Any],
|
||||
phases: list[dict[str, Any]],
|
||||
timeline: list[dict[str, Any]],
|
||||
resources: list[dict[str, Any]] | None = None,
|
||||
) -> str:
|
||||
"""`summary.md` профиля отказа: условия, таблица фаз, шкалы вокруг
|
||||
действия и возврата; с `resources` (строки `resources.csv`) — ещё
|
||||
ресурсы по фазам и окнам."""
|
||||
profile = meta["profile"]
|
||||
lines = [
|
||||
f"# Отказ реплик под нагрузкой: метка `{meta['label']}`",
|
||||
"",
|
||||
f"- Статус: **{meta['status']}**"
|
||||
+ (f" ({meta['reason']})" if meta.get("reason") else ""),
|
||||
f"- Commit: `{meta['git']['commit']}`"
|
||||
+ (" + незакоммиченные изменения" if meta["git"]["dirty"] else ""),
|
||||
f"- Профиль `{profile['name']}`: {profile['replicas']} реплики за "
|
||||
f"HAProxy; {profile['failover_write_rate']} записей с ключом и "
|
||||
f"{profile['failover_read_rate']} чтений страницы истории в "
|
||||
"секунду (k6, постоянная интенсивность); режимы "
|
||||
f"{', '.join(profile['failover_modes'])}; окна фазы: "
|
||||
f"{profile['failover_before_s']} с до действия, "
|
||||
f"{profile['failover_down_s']} с до возврата, "
|
||||
f"{profile['failover_after_s']} с после; порог восстановления "
|
||||
f"{profile['failover_success']:.0%}",
|
||||
limits_line(profile),
|
||||
"- Посторонние контейнеры в VM во время замера: "
|
||||
+ (", ".join(meta.get("other_containers") or []) or "нет"),
|
||||
"",
|
||||
"Время — секунды на часах ВМ Docker. Действие — событие Docker "
|
||||
"(`kill` с сигналом 15 у `docker stop`, 9 у `docker kill`, "
|
||||
"`pause`), исключение и возврат — строки журнала HAProxy, ответы — "
|
||||
"отметки k6 при отправке. Граница — худший случай формулы проверок "
|
||||
"LB для режима. Восстановление — конец последней секунды окна "
|
||||
"отказа с долей успешных ниже порога (0 — таких секунд нет). "
|
||||
"Сверка — после повтора неуспешных записей с тем же ключом: "
|
||||
"сообщений в чате записи и разных текстов столько, сколько "
|
||||
"отправлено разных ключей.",
|
||||
"",
|
||||
"| Фаза | Реплика | Исключение LB, с (граница) | Причина | "
|
||||
"Первая запись / чтение, с | Ошибки в окне отказа | Мин. доля "
|
||||
"успешных | Восстановление, с | Возврат в LB, с | Ошибки после "
|
||||
"возврата | Повтор записей | Сообщений = ключей | PG: прервано "
|
||||
"простоев | Пометки |",
|
||||
"|---|---|---|---|---|---|---|---|---|---|---|---|---|---|",
|
||||
]
|
||||
for row in phases:
|
||||
lines.append(
|
||||
f"| {row['phase']} | {row['instance']} ({row['slot']}) | "
|
||||
f"{fmt(row['lb_out_s'])} ({fmt(row['bound_s'])}) | "
|
||||
f"{fmt(row['lb_out_state'])}: {fmt(row['lb_out_reason'])} | "
|
||||
f"{fmt(row['first_write_ok_s'])} / {fmt(row['first_read_ok_s'])} "
|
||||
f"| {row['errors_down']} {fmt(row['codes_down'])} | "
|
||||
f"{fmt(row['min_success'])} | {row['recovery_s']} | "
|
||||
f"{fmt(row['lb_up_s'])} | {row['errors_after']} | "
|
||||
f"{row['writes_failed']} → {fmt(row['retried_ok'])} | "
|
||||
f"{fmt(row['write_chat_messages'])} = "
|
||||
f"{fmt(row['distinct_texts'])} | "
|
||||
f"{fmt(row['pg_idle_tx_terminated'])} | {fmt(row['flags'])} |",
|
||||
)
|
||||
lines.append("")
|
||||
if resources:
|
||||
order = list(dict.fromkeys(r["phase"] for r in resources))
|
||||
lines += res.render_failover(resources, order)
|
||||
for row in phases:
|
||||
rows = [r for r in timeline if r["phase"] == row["phase"]]
|
||||
reach = max(
|
||||
row["recovery_s"] or 0,
|
||||
math.ceil(row["lb_out_s"] or 0),
|
||||
)
|
||||
down_s = profile["failover_down_s"]
|
||||
shown = [
|
||||
r
|
||||
for r in rows
|
||||
if -2 <= r["second"] <= reach + 2
|
||||
or down_s - 1 <= r["second"] <= down_s + 3
|
||||
]
|
||||
lines += [
|
||||
f"## Фаза {row['phase']}",
|
||||
"",
|
||||
f"Действие {row['action_at']} над `{row['instance']}` (слот "
|
||||
f"{row['slot']}), возврат {row['restore_at']}; ответов "
|
||||
f"{row['requests']}, до действия {fmt(row['ok_rps_before'])} "
|
||||
f"успешных/с, p95 {fmt(row['p95_before_ms'])} мс. Полная шкала "
|
||||
"— `timeline.csv`.",
|
||||
"",
|
||||
"| с от действия | Записи ok / ош | Чтения ok / ош | Коды ошибок "
|
||||
"| Доля успешных | p50 / p95, мс | Ответы реплик |",
|
||||
"|---|---|---|---|---|---|---|",
|
||||
]
|
||||
previous = None
|
||||
for r in shown:
|
||||
if previous is not None and r["second"] != previous + 1:
|
||||
lines.append("| … | | | | | | |")
|
||||
previous = r["second"]
|
||||
lines.append(
|
||||
f"| {r['second']} | {r['writes_ok']} / {r['writes_failed']} | "
|
||||
f"{r['reads_ok']} / {r['reads_failed']} | {fmt(r['codes'])} | "
|
||||
f"{fmt(r['success'])} | {fmt(r['p50_ms'])} / "
|
||||
f"{fmt(r['p95_ms'])} | {fmt(r['instances'])} |",
|
||||
)
|
||||
lines.append("")
|
||||
if resources:
|
||||
lines += res.render_failover_phase(resources, row["phase"])
|
||||
if meta.get("host_warnings"):
|
||||
lines += ["## Предупреждения о хосте", ""]
|
||||
lines += [f"- {w}" for w in meta["host_warnings"]]
|
||||
lines.append("")
|
||||
return "\n".join(lines)
|
||||
@@ -0,0 +1,116 @@
|
||||
"""Загрузчик объектов профиля сверки: прямой PUT в S3 стенда мимо API.
|
||||
|
||||
Работает только в контейнере `mtusi-bench-fill` на образе стенда
|
||||
(`mtusi-messenger:bench`): botocore образа, `src` не импортируется, каталог
|
||||
`bench/` смонтирован только на чтение, номера, ключи и содержимое объектов
|
||||
— генератор набора `bench/reconcile.py` (design change
|
||||
`track2-reconcile-cost`, решение 3). Ключи пользователя API — окружение
|
||||
контейнера (`S3__ACCESS_KEY_ID`, `S3__SECRET_ACCESS_KEY`: `docker run -e
|
||||
<имя>` без значения в argv); в вывод они не попадают.
|
||||
|
||||
Объекты — номера диапазона [--start, --end), у которых по модели набора
|
||||
есть объект; несколько процессов по нескольку потоков, у каждого процесса
|
||||
свой клиент. Вывод — одна строка `fill: <объектов> objects, <PUT/с>
|
||||
put/s, <с> s`; ошибка любого PUT — код 1.
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import os
|
||||
import sys
|
||||
import time
|
||||
from concurrent.futures import ThreadPoolExecutor
|
||||
from multiprocessing import Pool
|
||||
from pathlib import Path
|
||||
from typing import Any
|
||||
|
||||
sys.path.insert(0, str(Path(__file__).resolve().parent))
|
||||
|
||||
import reconcile # noqa: E402
|
||||
|
||||
KEY_ENV = ("S3__ACCESS_KEY_ID", "S3__SECRET_ACCESS_KEY")
|
||||
|
||||
|
||||
def client(endpoint: str, threads: int) -> Any:
|
||||
import botocore.session
|
||||
from botocore.config import Config
|
||||
|
||||
session = botocore.session.get_session()
|
||||
return session.create_client(
|
||||
"s3",
|
||||
endpoint_url=endpoint,
|
||||
region_name="us-east-1",
|
||||
aws_access_key_id=os.environ[KEY_ENV[0]],
|
||||
aws_secret_access_key=os.environ[KEY_ENV[1]],
|
||||
config=Config(
|
||||
s3={"addressing_style": "path"},
|
||||
retries={"total_max_attempts": 3},
|
||||
max_pool_connections=threads,
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
def put_chunk(job: tuple[dict[str, Any], list[int]]) -> int:
|
||||
"""Один процесс: свой клиент, потоки по номерам; число записанных."""
|
||||
args, indices = job
|
||||
s3 = client(args["endpoint"], args["threads"])
|
||||
|
||||
def put(index: int) -> None:
|
||||
attachment_id = reconcile.object_id(args["seed"], index)
|
||||
s3.put_object(
|
||||
Bucket=args["bucket"],
|
||||
Key=reconcile.object_key(args["namespace"], attachment_id),
|
||||
Body=reconcile.content(args["seed"], index, args["size"]),
|
||||
ContentType=reconcile.CONTENT_TYPE,
|
||||
)
|
||||
|
||||
with ThreadPoolExecutor(max_workers=args["threads"]) as pool:
|
||||
for _ in pool.map(put, indices):
|
||||
pass
|
||||
return len(indices)
|
||||
|
||||
|
||||
def main(argv: list[str]) -> int:
|
||||
parser = argparse.ArgumentParser(description=__doc__.splitlines()[0])
|
||||
parser.add_argument("--endpoint", required=True)
|
||||
parser.add_argument("--bucket", required=True)
|
||||
parser.add_argument("--namespace", required=True)
|
||||
parser.add_argument("--seed", type=int, required=True)
|
||||
parser.add_argument("--start", type=int, required=True)
|
||||
parser.add_argument("--end", type=int, required=True)
|
||||
parser.add_argument("--size", type=int, required=True)
|
||||
parser.add_argument("--force", choices=(reconcile.FORCE_OK,))
|
||||
parser.add_argument("--processes", type=int, default=3)
|
||||
parser.add_argument("--threads", type=int, default=24)
|
||||
args = parser.parse_args(argv)
|
||||
if not Path("/.dockerenv").exists():
|
||||
print("fill: run only in the bench container", flush=True)
|
||||
return 2
|
||||
if any(not os.environ.get(name) for name in KEY_ENV):
|
||||
print(f"fill: {' and '.join(KEY_ENV)} are required", flush=True)
|
||||
return 2
|
||||
indices = reconcile.object_indices(args.start, args.end, args.force)
|
||||
parts = [indices[i :: args.processes] for i in range(args.processes)]
|
||||
shared = {
|
||||
key: getattr(args, key)
|
||||
for key in ("endpoint", "bucket", "namespace", "seed", "size")
|
||||
}
|
||||
shared["threads"] = args.threads
|
||||
started = time.monotonic()
|
||||
try:
|
||||
with Pool(args.processes) as pool:
|
||||
done = sum(pool.map(put_chunk, [(shared, p) for p in parts if p]))
|
||||
except Exception as exc:
|
||||
# без текста исключения botocore: в нём может быть адрес и заголовки
|
||||
print(f"fill: put failed ({type(exc).__name__})", flush=True)
|
||||
return 1
|
||||
seconds = time.monotonic() - started
|
||||
print(
|
||||
f"fill: {done} objects, {done / seconds if seconds else 0:.0f} "
|
||||
f"put/s, {seconds:.1f} s",
|
||||
flush=True,
|
||||
)
|
||||
return 0 if done == len(indices) else 1
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main(sys.argv[1:]))
|
||||
@@ -0,0 +1,42 @@
|
||||
// Активность после backup (трек 2, восстановление): новый пользователь
|
||||
// с паролем входит по Basic, создаёт чат с читателем и пишет в него одно
|
||||
// сообщение. После восстановления из backup всего этого в базе быть не
|
||||
// должно, а карточка чата остаётся в кэше. Итог — after.json в рабочем
|
||||
// каталоге (токен только там, оркестратор удаляет его в конце прогона).
|
||||
import http from "k6/http";
|
||||
import { fail } from "k6";
|
||||
|
||||
import { API, WORK_DIR, createChat, messageHeaders, register } from "./lib.js";
|
||||
|
||||
const fixture = JSON.parse(open(`${WORK_DIR}/fixture.json`));
|
||||
|
||||
export const options = {
|
||||
vus: 1,
|
||||
iterations: 1,
|
||||
setupTimeout: "60s",
|
||||
};
|
||||
|
||||
export function setup() {
|
||||
const stamp = Date.now().toString(36);
|
||||
const late = register(`b${stamp}_late`, "Bench after backup");
|
||||
const chatId = createChat(
|
||||
late.token,
|
||||
"bench after backup",
|
||||
[late.id, fixture.readerId],
|
||||
);
|
||||
const res = http.post(
|
||||
`${API}/chats/${chatId}/messages`,
|
||||
JSON.stringify({ text: "written after backup" }),
|
||||
{ headers: messageHeaders(late.token) },
|
||||
);
|
||||
if (res.status !== 201) {
|
||||
fail(`message after backup: ${res.status} ${res.body}`);
|
||||
}
|
||||
return { userId: late.id, token: late.token, chatId };
|
||||
}
|
||||
|
||||
export default function () {}
|
||||
|
||||
export function handleSummary(data) {
|
||||
return { [`${WORK_DIR}/after.json`]: JSON.stringify(data.setup_data) };
|
||||
}
|
||||
@@ -0,0 +1,138 @@
|
||||
// Фоновая нагрузка профиля сверки (design change track2-reconcile-cost,
|
||||
// решение 10): открытая модель, три сценария constant-arrival-rate через
|
||||
// LB — скачивания оригиналов вложений набора (`/work/downloads.json` от
|
||||
// run.py; читатель фикстуры — владелец и участник чата набора), запись
|
||||
// сообщений в чат записи и чтение его первой страницы истории. Каждый
|
||||
// запрос — строка «bg,<d|w|r>,<отправка мс>,<длительность мс>,<статус>» в
|
||||
// файл консоли k6; run.py делит их на окна до, во время и после прохода
|
||||
// сверки и сверяет число строк со счётчиком bg_lines_<сценарий> и с
|
||||
// итерациями сценариев: снизу, а сверху — с запасом на VU. Оркестратор
|
||||
// останавливает прогон сигналом SIGINT, когда блок проходов закончен:
|
||||
// итог (handleSummary) k6 пишет и тогда.
|
||||
import exec from "k6/execution";
|
||||
import http from "k6/http";
|
||||
import { SharedArray } from "k6/data";
|
||||
import { Counter } from "k6/metrics";
|
||||
|
||||
import {
|
||||
API,
|
||||
PAGE_LIMIT,
|
||||
SUMMARY_THRESHOLDS,
|
||||
SUMMARY_TREND_STATS,
|
||||
WORK_DIR,
|
||||
authHeaders,
|
||||
messageHeaders,
|
||||
summaryFiles,
|
||||
syntheticText,
|
||||
} from "./lib.js";
|
||||
|
||||
const fixture = JSON.parse(open(`${WORK_DIR}/fixture.json`));
|
||||
const ids = new SharedArray(
|
||||
"downloads",
|
||||
() => JSON.parse(open(`${WORK_DIR}/downloads.json`)),
|
||||
);
|
||||
const DURATION = __ENV.DURATION || "1h";
|
||||
const PRE_VUS = Number(__ENV.PRE_VUS || 100);
|
||||
const MAX_VUS = Number(__ENV.MAX_VUS || 600);
|
||||
const TIMEOUT = __ENV.TIMEOUT || "15s";
|
||||
const READER = authHeaders(fixture.tokens[fixture.readerId]);
|
||||
// счёт строк bg,… тем же кодом, что их пишет. Итерация, которую остановка
|
||||
// SIGINT прервала уже после строки, в iterations не входит, а её отсчёт
|
||||
// здесь k6 может не принять (контекст итерации уже отменён). run.py
|
||||
// требует строк не меньше счётчика и итераций, а лишних — не больше VU
|
||||
// сценария (design change track2-reconcile-cost, «Уточнения apply», п. 15)
|
||||
const LINES = {
|
||||
d: new Counter("bg_lines_download"),
|
||||
w: new Counter("bg_lines_write"),
|
||||
r: new Counter("bg_lines_read"),
|
||||
};
|
||||
const WRITE_URL = `${API}/chats/${fixture.writeChatId}/messages`;
|
||||
|
||||
function scenario(fn, rate) {
|
||||
return {
|
||||
executor: "constant-arrival-rate",
|
||||
exec: fn,
|
||||
rate,
|
||||
timeUnit: "1s",
|
||||
duration: DURATION,
|
||||
preAllocatedVUs: PRE_VUS,
|
||||
maxVUs: MAX_VUS,
|
||||
gracefulStop: "5s",
|
||||
};
|
||||
}
|
||||
|
||||
export const options = {
|
||||
scenarios: {
|
||||
download: scenario("download", Number(__ENV.DOWNLOAD_RATE)),
|
||||
write: scenario("write", Number(__ENV.WRITE_RATE)),
|
||||
read: scenario("read", Number(__ENV.READ_RATE)),
|
||||
},
|
||||
summaryTrendStats: SUMMARY_TREND_STATS,
|
||||
// пороги всегда выполняются: подметрики итераций по сценариям попадают
|
||||
// в итог, и run.py сверяет с ними число строк о запросах
|
||||
thresholds: {
|
||||
...SUMMARY_THRESHOLDS,
|
||||
"iterations{scenario:download}": ["count>=0"],
|
||||
"iterations{scenario:write}": ["count>=0"],
|
||||
"iterations{scenario:read}": ["count>=0"],
|
||||
},
|
||||
};
|
||||
|
||||
// длительность — по монотонным таймингам k6 (как в failover.js), с точностью
|
||||
// 0,01 мс: p95 чтения истории — единицы миллисекунд, и целые мс огрубляли
|
||||
// бы отношение r; без ответа (status 0) — разность часов
|
||||
function report(kind, start, res) {
|
||||
const t = res.timings;
|
||||
const measured = t.blocked + t.connecting + t.tls_handshaking + t.duration;
|
||||
const duration = Math.max(
|
||||
0,
|
||||
Math.round((res.status === 0 ? Date.now() - start : measured) * 100) / 100,
|
||||
);
|
||||
LINES[kind].add(1);
|
||||
console.log(`bg,${kind},${start},${duration},${res.status}`);
|
||||
}
|
||||
|
||||
export function download() {
|
||||
const n = exec.scenario.iterationInTest;
|
||||
const id = ids[n % ids.length];
|
||||
const start = Date.now();
|
||||
const res = http.get(`${API}/attachments/${id}/content`, {
|
||||
headers: READER,
|
||||
responseType: "none",
|
||||
timeout: TIMEOUT,
|
||||
responseCallback: http.expectedStatuses(200),
|
||||
});
|
||||
report("d", start, res);
|
||||
}
|
||||
|
||||
export function write() {
|
||||
const n = exec.scenario.iterationInTest;
|
||||
const sender = fixture.memberIds[n % fixture.memberIds.length];
|
||||
const start = Date.now();
|
||||
const res = http.post(
|
||||
WRITE_URL,
|
||||
JSON.stringify({ text: syntheticText("bg", n) }),
|
||||
{
|
||||
headers: messageHeaders(fixture.tokens[sender]),
|
||||
responseType: "none",
|
||||
timeout: TIMEOUT,
|
||||
responseCallback: http.expectedStatuses(201),
|
||||
},
|
||||
);
|
||||
report("w", start, res);
|
||||
}
|
||||
|
||||
export function read() {
|
||||
const start = Date.now();
|
||||
const res = http.get(`${WRITE_URL}?limit=${PAGE_LIMIT}`, {
|
||||
headers: READER,
|
||||
responseType: "none",
|
||||
timeout: TIMEOUT,
|
||||
responseCallback: http.expectedStatuses(200),
|
||||
});
|
||||
report("r", start, res);
|
||||
}
|
||||
|
||||
export function handleSummary(data) {
|
||||
return summaryFiles(data);
|
||||
}
|
||||
@@ -0,0 +1,63 @@
|
||||
// Пул курсоров сценария read: проход истории читаемого чата страницами по
|
||||
// WALK_LIMIT и равномерная выборка до POOL_SIZE курсоров. В пул идут
|
||||
// только позиции, после которых есть ещё PAGE_LIMIT сообщений, чтобы
|
||||
// каждая страница read была полной.
|
||||
import http from "k6/http";
|
||||
import { fail } from "k6";
|
||||
|
||||
import { API, PAGE_LIMIT, WORK_DIR, authHeaders } from "./lib.js";
|
||||
|
||||
const fixture = JSON.parse(open(`${WORK_DIR}/fixture.json`));
|
||||
const WALK_LIMIT = Number(__ENV.WALK_LIMIT || 100);
|
||||
const POOL_SIZE = Number(__ENV.POOL_SIZE || 1000);
|
||||
|
||||
export const options = {
|
||||
vus: 1,
|
||||
iterations: 1,
|
||||
setupTimeout: "30m",
|
||||
};
|
||||
|
||||
export function setup() {
|
||||
const url = `${API}/chats/${fixture.readChatId}/messages`;
|
||||
const params = { headers: authHeaders(fixture.tokens[fixture.readerId]) };
|
||||
const positions = [];
|
||||
let cursor = null;
|
||||
let walked = 0;
|
||||
for (;;) {
|
||||
const query = cursor === null
|
||||
? `?limit=${WALK_LIMIT}`
|
||||
: `?limit=${WALK_LIMIT}&cursor=${encodeURIComponent(cursor)}`;
|
||||
const res = http.get(url + query, params);
|
||||
if (res.status !== 200) {
|
||||
fail(`history page after ${walked}: ${res.status} ${res.body}`);
|
||||
}
|
||||
const body = res.json();
|
||||
walked += body.items.length;
|
||||
if (body.next_cursor === null) {
|
||||
break;
|
||||
}
|
||||
positions.push({ after: walked, cursor: body.next_cursor });
|
||||
cursor = body.next_cursor;
|
||||
}
|
||||
const eligible = positions.filter((p) => walked - p.after >= PAGE_LIMIT);
|
||||
const step = Math.max(1, eligible.length / POOL_SIZE);
|
||||
const pool = [];
|
||||
for (let i = 0; i < eligible.length && pool.length < POOL_SIZE; i += step) {
|
||||
pool.push(eligible[Math.floor(i)]);
|
||||
}
|
||||
return {
|
||||
walked,
|
||||
eligible: eligible.length,
|
||||
first_after: pool.length ? pool[0].after : null,
|
||||
last_after: pool.length ? pool[pool.length - 1].after : null,
|
||||
// позиции курсоров пула: сколько сообщений до каждого (для плана)
|
||||
afters: pool.map((p) => p.after),
|
||||
cursors: pool.map((p) => p.cursor),
|
||||
};
|
||||
}
|
||||
|
||||
export default function () {}
|
||||
|
||||
export function handleSummary(data) {
|
||||
return { [`${WORK_DIR}/cursors.json`]: JSON.stringify(data.setup_data) };
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
// Этап плана: страницы истории из plan_pages.json подряд, пока в Postgres
|
||||
// стенда включён auto_explain. Для читаемого чата и первого чата каждого
|
||||
// фонового уровня — первая, средняя и последняя полная страница (у
|
||||
// короткого чата — первая). Порядок запросов = порядок планов в журнале:
|
||||
// оркестратор сопоставляет их по нему.
|
||||
import http from "k6/http";
|
||||
import { check, fail } from "k6";
|
||||
|
||||
import { API, PAGE_LIMIT, WORK_DIR, authHeaders } from "./lib.js";
|
||||
|
||||
const fixture = JSON.parse(open(`${WORK_DIR}/fixture.json`));
|
||||
const pages = JSON.parse(open(`${WORK_DIR}/plan_pages.json`));
|
||||
|
||||
export const options = {
|
||||
vus: 1,
|
||||
iterations: 1,
|
||||
};
|
||||
|
||||
export default function () {
|
||||
const params = { headers: authHeaders(fixture.tokens[fixture.readerId]) };
|
||||
for (const page of pages) {
|
||||
const name = `${page.chat} ${page.page}`;
|
||||
const query = page.cursor === null
|
||||
? `?limit=${PAGE_LIMIT}`
|
||||
: `?limit=${PAGE_LIMIT}&cursor=${encodeURIComponent(page.cursor)}`;
|
||||
const res = http.get(`${API}/chats/${page.chat_id}/messages${query}`, params);
|
||||
const ok = check(res, {
|
||||
[`${name} 200`]: (r) => r.status === 200,
|
||||
[`${name} ${page.items} items`]: (r) =>
|
||||
r.status === 200 && r.json("items.#") === page.items,
|
||||
});
|
||||
if (!ok) {
|
||||
fail(`explain page ${name}: ${res.status}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// итог не нужен: планы оркестратор берёт из журнала Postgres
|
||||
export function handleSummary() {
|
||||
return {};
|
||||
}
|
||||
@@ -0,0 +1,130 @@
|
||||
// Профили отказа и замены реплик: постоянная интенсивность записи с ключом
|
||||
// и чтения страницы истории через LB, пока оркестратор останавливает и
|
||||
// возвращает реплику (решение 7 design change graceful-failover) или
|
||||
// заменяет реплики scripts/rolling-update.sh (решение 8 design change
|
||||
// rolling-update). Каждый запрос —
|
||||
// строка «fo,<w|r>,<n>,<отправка мс>,<длительность мс>,<статус>,
|
||||
// <X-Instance-Id>,<успех>» в вывод k6: из них run.py строит посекундную
|
||||
// шкалу. Время — Date.now() часов ВМ Docker, те же часы, что у журнала LB и
|
||||
// событий Docker.
|
||||
import exec from "k6/execution";
|
||||
import http from "k6/http";
|
||||
import { SharedArray } from "k6/data";
|
||||
|
||||
import {
|
||||
API,
|
||||
PAGE_LIMIT,
|
||||
SUMMARY_THRESHOLDS,
|
||||
SUMMARY_TREND_STATS,
|
||||
WORK_DIR,
|
||||
authHeaders,
|
||||
messageHeaders,
|
||||
mulberry32,
|
||||
summaryFiles,
|
||||
syntheticText,
|
||||
} from "./lib.js";
|
||||
|
||||
const fixture = JSON.parse(open(`${WORK_DIR}/fixture.json`));
|
||||
const cursors = new SharedArray(
|
||||
"cursors",
|
||||
() => JSON.parse(open(`${WORK_DIR}/cursors.json`)).cursors,
|
||||
);
|
||||
// ключ записи — <RUN>.<PHASE>.<n>: повтор (retry.js) строит тот же
|
||||
const RUN = __ENV.RUN;
|
||||
const PHASE = Number(__ENV.PHASE);
|
||||
const SEED = Number(__ENV.SEED || 0);
|
||||
// VU сценария: заранее созданные и предел (Profile.failover_pre_vus,
|
||||
// failover_max_vus). Создание VU на ходу пропускает итерации
|
||||
const PRE_VUS = Number(__ENV.PRE_VUS || 600);
|
||||
const MAX_VUS = Number(__ENV.MAX_VUS || 1500);
|
||||
// больше timeout server LB (10 с): клиент видит ответ LB, а не свой таймаут
|
||||
const TIMEOUT = __ENV.TIMEOUT || "15s";
|
||||
const WRITE_URL = `${API}/chats/${fixture.writeChatId}/messages`;
|
||||
const READ_URL = `${API}/chats/${fixture.readChatId}/messages`;
|
||||
const READ_HEADERS = authHeaders(fixture.tokens[fixture.readerId]);
|
||||
|
||||
function scenario(fn, rate) {
|
||||
return {
|
||||
executor: "constant-arrival-rate",
|
||||
exec: fn,
|
||||
rate,
|
||||
timeUnit: "1s",
|
||||
duration: __ENV.DURATION,
|
||||
// зависшая реплика держит запрос до timeout server: VU с запасом
|
||||
preAllocatedVUs: PRE_VUS,
|
||||
maxVUs: MAX_VUS,
|
||||
gracefulStop: "20s",
|
||||
};
|
||||
}
|
||||
|
||||
export const options = {
|
||||
scenarios: {
|
||||
write: scenario("write", Number(__ENV.WRITE_RATE)),
|
||||
read: scenario("read", Number(__ENV.READ_RATE)),
|
||||
},
|
||||
summaryTrendStats: SUMMARY_TREND_STATS,
|
||||
// пороги всегда выполняются: подметрики итераций по сценариям попадают
|
||||
// в итог, и run.py сверяет с ними число строк о запросах
|
||||
thresholds: {
|
||||
...SUMMARY_THRESHOLDS,
|
||||
"iterations{scenario:write}": ["count>=0"],
|
||||
"iterations{scenario:read}": ["count>=0"],
|
||||
},
|
||||
};
|
||||
|
||||
// длительность — по монотонным таймингам k6, а не разность Date.now():
|
||||
// часы ВМ подводятся, и при шаге назад разность выходила отрицательной.
|
||||
// Ответа нет (status 0) — тайминги пусты, тогда разность часов
|
||||
function report(kind, n, start, res, ok) {
|
||||
const instance = res.headers["X-Instance-Id"] || "-";
|
||||
const t = res.timings;
|
||||
const measured = t.blocked + t.connecting + t.tls_handshaking + t.duration;
|
||||
const duration = Math.max(
|
||||
0,
|
||||
Math.round(res.status === 0 ? Date.now() - start : measured),
|
||||
);
|
||||
console.log(
|
||||
`fo,${kind},${n},${start},${duration},${res.status},${instance},${ok ? 1 : 0}`,
|
||||
);
|
||||
}
|
||||
|
||||
export function write() {
|
||||
const n = exec.scenario.iterationInTest;
|
||||
const sender = fixture.memberIds[n % fixture.memberIds.length];
|
||||
const start = Date.now();
|
||||
const res = http.post(
|
||||
WRITE_URL,
|
||||
JSON.stringify({ text: syntheticText(`f${PHASE}`, n) }),
|
||||
{
|
||||
headers: messageHeaders(fixture.tokens[sender], `${RUN}.${PHASE}.${n}`),
|
||||
responseType: "none",
|
||||
timeout: TIMEOUT,
|
||||
responseCallback: http.expectedStatuses(201),
|
||||
},
|
||||
);
|
||||
report("w", n, start, res, res.status === 201);
|
||||
}
|
||||
|
||||
let random = null;
|
||||
|
||||
export function read() {
|
||||
if (random === null) {
|
||||
random = mulberry32(SEED + exec.vu.idInTest);
|
||||
}
|
||||
const n = exec.scenario.iterationInTest;
|
||||
const cursor = encodeURIComponent(
|
||||
cursors[Math.floor(random() * cursors.length)],
|
||||
);
|
||||
const start = Date.now();
|
||||
const res = http.get(`${READ_URL}?limit=${PAGE_LIMIT}&cursor=${cursor}`, {
|
||||
headers: READ_HEADERS,
|
||||
timeout: TIMEOUT,
|
||||
responseCallback: http.expectedStatuses(200),
|
||||
});
|
||||
const full = res.status === 200 && res.json("items.#") === PAGE_LIMIT;
|
||||
report("r", n, start, res, full);
|
||||
}
|
||||
|
||||
export function handleSummary(data) {
|
||||
return summaryFiles(data);
|
||||
}
|
||||
+122
@@ -0,0 +1,122 @@
|
||||
// Общие хелперы сценариев стенда: адрес, идентификация, текст, генератор
|
||||
// случайных чисел, запись итога. Не Node.js: только встроенные модули k6.
|
||||
import encoding from "k6/encoding";
|
||||
import http from "k6/http";
|
||||
import { check, fail } from "k6";
|
||||
|
||||
// через балансировщик стенда: имя сервиса haproxy — алиас в сети
|
||||
// mtusi-bench, за ним Profile.replicas реплик (решение 6 design change
|
||||
// graceful-failover)
|
||||
export const BASE_URL = __ENV.BASE_URL || "http://haproxy:8080";
|
||||
export const API = `${BASE_URL}/api/v1`;
|
||||
// каталог метки (сырые итоги) и рабочий каталог (фикстура, курсоры)
|
||||
export const OUT_DIR = __ENV.OUT_DIR || "/out";
|
||||
export const WORK_DIR = __ENV.WORK_DIR || "/work";
|
||||
|
||||
export const TEXT_LENGTH = Number(__ENV.TEXT_LENGTH || 64);
|
||||
export const PAGE_LIMIT = Number(__ENV.PAGE_LIMIT || 50);
|
||||
|
||||
// перцентили в итоге; подметрика expected_response:true — только успехи
|
||||
export const SUMMARY_TREND_STATS = [
|
||||
"avg", "min", "med", "p(50)", "p(95)", "p(99)", "max",
|
||||
];
|
||||
export const SUCCESS_DURATION = "http_req_duration{expected_response:true}";
|
||||
// порог всегда выполняется: он нужен, чтобы подметрика попала в итог
|
||||
export const SUMMARY_THRESHOLDS = { [SUCCESS_DURATION]: ["max>=0"] };
|
||||
|
||||
// идентификация, как Actor.headers() в student-tests: Bearer-токен сессии
|
||||
export function authHeaders(token) {
|
||||
return {
|
||||
Authorization: `Bearer ${token}`,
|
||||
"Content-Type": "application/json",
|
||||
};
|
||||
}
|
||||
|
||||
// заголовки отправки сообщения: с лабы 3 обязателен Idempotency-Key. Новый
|
||||
// ключ на каждую отправку (UUID v4 WebCrypto — допустимый алфавит
|
||||
// контракта); стенд отправку не повторяет. Профиль отказа задаёт ключ сам:
|
||||
// повтор неподтверждённой записи строит тот же ключ по номеру
|
||||
export function messageHeaders(token, key = crypto.randomUUID()) {
|
||||
return {
|
||||
...authHeaders(token),
|
||||
"Idempotency-Key": key,
|
||||
};
|
||||
}
|
||||
|
||||
// синтетический пароль из двух UUID v4 WebCrypto (73 символа, контракт —
|
||||
// 12–128): только в памяти prepare.js, в фикстуру и результаты не попадает
|
||||
function syntheticPassword() {
|
||||
return `${crypto.randomUUID()}-${crypto.randomUUID()}`;
|
||||
}
|
||||
|
||||
// синтетический текст ровно TEXT_LENGTH ASCII-символов
|
||||
export function syntheticText(tag, n) {
|
||||
const prefix = `${tag}-${n}-`;
|
||||
return prefix + "x".repeat(Math.max(0, TEXT_LENGTH - prefix.length));
|
||||
}
|
||||
|
||||
// mulberry32: воспроизводимая последовательность из 32-битного зерна
|
||||
export function mulberry32(seed) {
|
||||
let a = seed >>> 0;
|
||||
return function () {
|
||||
a = (a + 0x6d2b79f5) >>> 0;
|
||||
let t = a;
|
||||
t = Math.imul(t ^ (t >>> 15), t | 1);
|
||||
t ^= t + Math.imul(t ^ (t >>> 7), t | 61);
|
||||
return ((t ^ (t >>> 14)) >>> 0) / 4294967296;
|
||||
};
|
||||
}
|
||||
|
||||
// регистрация с паролем и вход по Basic: { id, token } пользователя
|
||||
export function register(username, displayName) {
|
||||
const password = syntheticPassword();
|
||||
const res = http.post(
|
||||
`${API}/users`,
|
||||
JSON.stringify({ username, display_name: displayName, password }),
|
||||
{ headers: { "Content-Type": "application/json" } },
|
||||
);
|
||||
if (!check(res, { "register 201": (r) => r.status === 201 })) {
|
||||
fail(`register ${username}: ${res.status} ${res.body}`);
|
||||
}
|
||||
const basic = encoding.b64encode(`${username}:${password}`);
|
||||
const login = http.post(`${API}/auth/sessions`, null, {
|
||||
headers: { Authorization: `Basic ${basic}` },
|
||||
});
|
||||
if (!check(login, { "login 201": (r) => r.status === 201 })) {
|
||||
fail(`login ${username}: ${login.status} ${login.body}`);
|
||||
}
|
||||
return { id: res.json("id"), token: login.json("token") };
|
||||
}
|
||||
|
||||
export function createChat(ownerToken, title, memberIds) {
|
||||
const res = http.post(
|
||||
`${API}/chats`,
|
||||
JSON.stringify({ title, member_ids: memberIds }),
|
||||
{ headers: authHeaders(ownerToken) },
|
||||
);
|
||||
if (!check(res, { "chat 201": (r) => r.status === 201 })) {
|
||||
fail(`create chat ${title}: ${res.status} ${res.body}`);
|
||||
}
|
||||
return res.json("id");
|
||||
}
|
||||
|
||||
export function sendMessage(chatId, senderToken, text, key = undefined) {
|
||||
const res = http.post(
|
||||
`${API}/chats/${chatId}/messages`,
|
||||
JSON.stringify({ text }),
|
||||
{
|
||||
headers: messageHeaders(senderToken, key),
|
||||
responseCallback: http.expectedStatuses(201),
|
||||
},
|
||||
);
|
||||
check(res, { "message 201": (r) => r.status === 201 });
|
||||
return res;
|
||||
}
|
||||
|
||||
// итог прогона: в файл NAME.json каталога метки; без NAME — в рабочий
|
||||
// каталог (прогрев), чтобы оркестратор посчитал подтверждённые записи
|
||||
export function summaryFiles(data) {
|
||||
const name = __ENV.NAME;
|
||||
const path = name ? `${OUT_DIR}/raw/${name}.json` : `${WORK_DIR}/last.json`;
|
||||
return { [path]: JSON.stringify(data) };
|
||||
}
|
||||
@@ -0,0 +1,217 @@
|
||||
// Ступень серии трека 1 (решения 2–3 design change scaling-bench):
|
||||
// открытая модель, три сценария ramping-arrival-rate с долями смеси —
|
||||
// страница истории читаемого чата, отправка с новым Idempotency-Key в один
|
||||
// из чатов записи, GET /users/me. Ступень — подъём от START до LEVEL за
|
||||
// WARMUP_S (в замер не входит) и окно MEASURE_S с постоянной
|
||||
// интенсивностью. Каждый запрос получает тег window (warm / hold) по
|
||||
// времени отправки от начала сценария; итог содержит подметрики окна.
|
||||
// Время setup (t0) — часы ВМ Docker: по нему run.py режет отсчёты
|
||||
// сэмплера. Вход по Basic — в prepare.js, до ступеней.
|
||||
import exec from "k6/execution";
|
||||
import http from "k6/http";
|
||||
import { check } from "k6";
|
||||
import { SharedArray } from "k6/data";
|
||||
import { Counter } from "k6/metrics";
|
||||
|
||||
import {
|
||||
API,
|
||||
PAGE_LIMIT,
|
||||
SUMMARY_TREND_STATS,
|
||||
WORK_DIR,
|
||||
authHeaders,
|
||||
messageHeaders,
|
||||
mulberry32,
|
||||
summaryFiles,
|
||||
syntheticText,
|
||||
} from "./lib.js";
|
||||
|
||||
const fixture = JSON.parse(open(`${WORK_DIR}/fixture.json`));
|
||||
const cursors = new SharedArray(
|
||||
"cursors",
|
||||
() => JSON.parse(open(`${WORK_DIR}/cursors.json`)).cursors,
|
||||
);
|
||||
const LEVEL = Number(__ENV.LEVEL);
|
||||
const START = Number(__ENV.START || 0);
|
||||
// «read:0.7,write:0.2,me:0.1» — Profile.mix
|
||||
const MIX = (__ENV.MIX || "read:0.7,write:0.2,me:0.1")
|
||||
.split(",")
|
||||
.map((item) => item.split(":"))
|
||||
.map(([name, share]) => [name, Number(share)]);
|
||||
const WARMUP_S = Number(__ENV.WARMUP_S);
|
||||
const MEASURE_S = Number(__ENV.MEASURE_S);
|
||||
const WARMUP_MS = WARMUP_S * 1000;
|
||||
// больше timeout server LB (10 с): клиент видит ответ LB, а не свой таймаут
|
||||
const TIMEOUT_S = Number(__ENV.TIMEOUT || 15);
|
||||
const PRE_VUS_PER_RPS = Number(__ENV.PRE_VUS_PER_RPS || 0.05);
|
||||
const MAX_VUS_PER_RPS = Number(__ENV.MAX_VUS_PER_RPS || 0.2);
|
||||
const SEED = Number(__ENV.SEED || 0);
|
||||
const STEP = Number(__ENV.STEP || 0);
|
||||
// короткие ID реплик: подметрики распределения по X-Instance-Id
|
||||
const INSTANCES = (__ENV.INSTANCES || "").split(",").filter((x) => x);
|
||||
const ABORT_ERRORS = Number(__ENV.ABORT_ERRORS || 0.5);
|
||||
const ABORT_P95_MS = Number(__ENV.ABORT_P95_MS || 2000);
|
||||
// коды неуспешных ответов окна (bench/scaling.py, ERROR_STATUSES)
|
||||
const ERROR_STATUSES = [0, 400, 401, 403, 404, 409, 422, 429, 500, 502, 503, 504];
|
||||
|
||||
const READ_URL = `${API}/chats/${fixture.readChatId}/messages`;
|
||||
const READ_HEADERS = authHeaders(fixture.tokens[fixture.readerId]);
|
||||
const USERS = [fixture.readerId, ...fixture.memberIds];
|
||||
const WRITE_CHATS = fixture.writeChatIds || [fixture.writeChatId];
|
||||
|
||||
const shortPages = new Counter("short_pages");
|
||||
const instanceOk = new Counter("instance_ok");
|
||||
|
||||
function scenario(name, share) {
|
||||
const target = Math.round(LEVEL * share);
|
||||
const start = Math.round(START * share);
|
||||
return {
|
||||
executor: "ramping-arrival-rate",
|
||||
exec: name,
|
||||
startRate: start,
|
||||
timeUnit: "1s",
|
||||
preAllocatedVUs: Math.ceil(target * PRE_VUS_PER_RPS) + 10,
|
||||
maxVUs: Math.ceil(target * MAX_VUS_PER_RPS) + 20,
|
||||
stages: [
|
||||
{ target, duration: `${WARMUP_S}s` },
|
||||
{ target, duration: `${MEASURE_S}s` },
|
||||
],
|
||||
// запрос, начатый в конце окна, успевает дождаться ответа или таймаута
|
||||
gracefulStop: `${TIMEOUT_S + 1}s`,
|
||||
};
|
||||
}
|
||||
|
||||
const HOLD = "window:hold";
|
||||
const thresholds = {
|
||||
// досрочный выход по подметрикам окна (код k6 99): перегрузка не тянется
|
||||
// до конца ступени
|
||||
[`http_req_duration{${HOLD},expected_response:true}`]: [
|
||||
"max>=0",
|
||||
{
|
||||
threshold: `p(95)<${ABORT_P95_MS}`,
|
||||
abortOnFail: true,
|
||||
delayAbortEval: `${WARMUP_S + 5}s`,
|
||||
},
|
||||
],
|
||||
[`http_req_failed{${HOLD}}`]: [
|
||||
"rate>=0",
|
||||
{
|
||||
threshold: `rate<=${ABORT_ERRORS}`,
|
||||
abortOnFail: true,
|
||||
delayAbortEval: `${WARMUP_S + 5}s`,
|
||||
},
|
||||
],
|
||||
[`short_pages{${HOLD}}`]: ["count>=0"],
|
||||
[`checks{${HOLD}}`]: ["rate>=0"],
|
||||
};
|
||||
// остальные пороги всегда выполняются: они нужны, чтобы подметрики попали
|
||||
// в итог
|
||||
for (const [name] of MIX) {
|
||||
thresholds[`http_reqs{${HOLD},scenario:${name}}`] = ["count>=0"];
|
||||
thresholds[`http_req_failed{${HOLD},scenario:${name}}`] = ["rate>=0"];
|
||||
thresholds[
|
||||
`http_req_duration{${HOLD},expected_response:true,scenario:${name}}`
|
||||
] = ["max>=0"];
|
||||
thresholds[`http_reqs{scenario:${name}}`] = ["count>=0"];
|
||||
thresholds[`http_req_failed{scenario:${name}}`] = ["rate>=0"];
|
||||
}
|
||||
for (const id of [...INSTANCES, "-"]) {
|
||||
thresholds[`instance_ok{${HOLD},instance:${id}}`] = ["count>=0"];
|
||||
}
|
||||
for (const status of ERROR_STATUSES) {
|
||||
thresholds[`http_reqs{${HOLD},status:${status}}`] = ["count>=0"];
|
||||
}
|
||||
|
||||
export const options = {
|
||||
scenarios: Object.fromEntries(
|
||||
MIX.map(([name, share]) => [name, scenario(name, share)]),
|
||||
),
|
||||
summaryTrendStats: SUMMARY_TREND_STATS,
|
||||
thresholds,
|
||||
};
|
||||
|
||||
export function setup() {
|
||||
return { t0: Date.now() };
|
||||
}
|
||||
|
||||
// тег окна по времени отправки от начала сценария
|
||||
function windowTag() {
|
||||
return Date.now() - exec.scenario.startTime < WARMUP_MS ? "warm" : "hold";
|
||||
}
|
||||
|
||||
function counted(res, ok, window) {
|
||||
if (ok) {
|
||||
instanceOk.add(1, {
|
||||
window,
|
||||
instance: res.headers["X-Instance-Id"] || "-",
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
let random = null;
|
||||
|
||||
export function read() {
|
||||
if (random === null) {
|
||||
random = mulberry32(SEED + exec.vu.idInTest);
|
||||
}
|
||||
const window = windowTag();
|
||||
const cursor = encodeURIComponent(
|
||||
cursors[Math.floor(random() * cursors.length)],
|
||||
);
|
||||
const res = http.get(`${READ_URL}?limit=${PAGE_LIMIT}&cursor=${cursor}`, {
|
||||
headers: READ_HEADERS,
|
||||
timeout: `${TIMEOUT_S}s`,
|
||||
tags: { window },
|
||||
responseCallback: http.expectedStatuses(200),
|
||||
});
|
||||
const full = res.status === 200 && res.json("items.#") === PAGE_LIMIT;
|
||||
if (res.status === 200 && !full) {
|
||||
// неполная страница при 200: отдельный счётчик, без двойного учёта
|
||||
shortPages.add(1, { window });
|
||||
}
|
||||
check(res, { "read 200 full page": () => full }, { window });
|
||||
counted(res, full, window);
|
||||
}
|
||||
|
||||
export function write() {
|
||||
const n = exec.scenario.iterationInTest;
|
||||
const sender = fixture.memberIds[n % fixture.memberIds.length];
|
||||
const chat = WRITE_CHATS[
|
||||
Math.floor(n / fixture.memberIds.length) % WRITE_CHATS.length
|
||||
];
|
||||
const window = windowTag();
|
||||
const res = http.post(
|
||||
`${API}/chats/${chat}/messages`,
|
||||
JSON.stringify({ text: syntheticText(`s${STEP}`, n) }),
|
||||
{
|
||||
// ключ — новый на каждую отправку (lib.js); стенд не повторяет
|
||||
headers: messageHeaders(fixture.tokens[sender]),
|
||||
responseType: "none",
|
||||
timeout: `${TIMEOUT_S}s`,
|
||||
tags: { window },
|
||||
responseCallback: http.expectedStatuses(201),
|
||||
},
|
||||
);
|
||||
const ok = res.status === 201;
|
||||
check(res, { "write 201": () => ok }, { window });
|
||||
counted(res, ok, window);
|
||||
}
|
||||
|
||||
export function me() {
|
||||
const n = exec.scenario.iterationInTest;
|
||||
const user = USERS[n % USERS.length];
|
||||
const window = windowTag();
|
||||
const res = http.get(`${API}/users/me`, {
|
||||
headers: authHeaders(fixture.tokens[user]),
|
||||
responseType: "none",
|
||||
timeout: `${TIMEOUT_S}s`,
|
||||
tags: { window },
|
||||
responseCallback: http.expectedStatuses(200),
|
||||
});
|
||||
const ok = res.status === 200;
|
||||
check(res, { "me 200": () => ok }, { window });
|
||||
counted(res, ok, window);
|
||||
}
|
||||
|
||||
export function handleSummary(data) {
|
||||
return summaryFiles(data);
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
// Курсоры страниц плана фоновых чатов (трек 2): проход истории каждого чата
|
||||
// из plan_chats.json страницами по WALK_LIMIT, позиция и курсор после каждой
|
||||
// страницы. Идёт до включения auto_explain, поэтому в журнал не попадает;
|
||||
// заодно прогревает страницы этих чатов, как cursors.js — читаемого.
|
||||
import http from "k6/http";
|
||||
import { fail } from "k6";
|
||||
|
||||
import { API, WORK_DIR, authHeaders } from "./lib.js";
|
||||
|
||||
const fixture = JSON.parse(open(`${WORK_DIR}/fixture.json`));
|
||||
const chats = JSON.parse(open(`${WORK_DIR}/plan_chats.json`));
|
||||
const WALK_LIMIT = Number(__ENV.WALK_LIMIT || 100);
|
||||
|
||||
export const options = {
|
||||
vus: 1,
|
||||
iterations: 1,
|
||||
setupTimeout: "10m",
|
||||
};
|
||||
|
||||
export function setup() {
|
||||
const params = { headers: authHeaders(fixture.tokens[fixture.readerId]) };
|
||||
return chats.map((chat) => {
|
||||
const url = `${API}/chats/${chat.id}/messages`;
|
||||
const positions = [];
|
||||
let cursor = null;
|
||||
let walked = 0;
|
||||
for (;;) {
|
||||
const query = cursor === null
|
||||
? `?limit=${WALK_LIMIT}`
|
||||
: `?limit=${WALK_LIMIT}&cursor=${encodeURIComponent(cursor)}`;
|
||||
const res = http.get(url + query, params);
|
||||
if (res.status !== 200) {
|
||||
fail(`chat ${chat.id} after ${walked}: ${res.status} ${res.body}`);
|
||||
}
|
||||
const body = res.json();
|
||||
walked += body.items.length;
|
||||
if (body.next_cursor === null) {
|
||||
break;
|
||||
}
|
||||
positions.push({ after: walked, cursor: body.next_cursor });
|
||||
cursor = body.next_cursor;
|
||||
}
|
||||
return { id: chat.id, walked, positions };
|
||||
});
|
||||
}
|
||||
|
||||
export default function () {}
|
||||
|
||||
export function handleSummary(data) {
|
||||
return { [`${WORK_DIR}/plan_walks.json`]: JSON.stringify(data.setup_data) };
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
// Одна порция наполнения: COUNT сообщений от участников по кругу. Чат
|
||||
// сообщения n берётся из расписания оркестратора (schedule.json: 0 —
|
||||
// читаемый чат, дальше фоновые в порядке фикстуры), так что сообщения всех
|
||||
// чатов идут вперемешку. OFFSET — сколько сообщений уже отправлено.
|
||||
import exec from "k6/execution";
|
||||
import { SharedArray } from "k6/data";
|
||||
|
||||
import {
|
||||
SUMMARY_THRESHOLDS,
|
||||
SUMMARY_TREND_STATS,
|
||||
WORK_DIR,
|
||||
sendMessage,
|
||||
summaryFiles,
|
||||
syntheticText,
|
||||
} from "./lib.js";
|
||||
|
||||
const fixture = JSON.parse(open(`${WORK_DIR}/fixture.json`));
|
||||
const schedule = new SharedArray(
|
||||
"schedule",
|
||||
() => JSON.parse(open(`${WORK_DIR}/schedule.json`)),
|
||||
);
|
||||
const chats = [fixture.readChatId, ...fixture.bgChats.map((c) => c.id)];
|
||||
const OFFSET = Number(__ENV.OFFSET || 0);
|
||||
|
||||
export const options = {
|
||||
scenarios: {
|
||||
prefill: {
|
||||
executor: "shared-iterations",
|
||||
vus: Number(__ENV.VUS || 32),
|
||||
iterations: Number(__ENV.COUNT),
|
||||
maxDuration: "30m",
|
||||
},
|
||||
},
|
||||
discardResponseBodies: true,
|
||||
summaryTrendStats: SUMMARY_TREND_STATS,
|
||||
thresholds: SUMMARY_THRESHOLDS,
|
||||
};
|
||||
|
||||
export default function () {
|
||||
const n = OFFSET + exec.scenario.iterationInTest;
|
||||
const sender = fixture.memberIds[n % fixture.memberIds.length];
|
||||
sendMessage(
|
||||
chats[schedule[n]],
|
||||
fixture.tokens[sender],
|
||||
syntheticText("p", n),
|
||||
);
|
||||
}
|
||||
|
||||
export function handleSummary(data) {
|
||||
return summaryFiles(data);
|
||||
}
|
||||
@@ -0,0 +1,69 @@
|
||||
// Пользователи и чаты стенда: читаемый (сценарий read), чат записи
|
||||
// (сценарий write) и фоновые чаты неравномерных размеров (трек 2). Каждый
|
||||
// пользователь регистрируется с паролем и входит по Basic; в фикстуру идут
|
||||
// id и Bearer-токены, пароли — нет. Итог — fixture.json в рабочем каталоге:
|
||||
// оркестратор удаляет его в конце прогона.
|
||||
import { WORK_DIR, createChat, register } from "./lib.js";
|
||||
|
||||
const MEMBERS = Number(__ENV.MEMBERS || 10);
|
||||
// чатов записи (Profile.write_chats): у прежних профилей один
|
||||
const WRITE_CHATS = Math.max(1, Number(__ENV.WRITE_CHATS || 1));
|
||||
// уровни фоновых чатов: «10x5000,100x400» — число чатов x сообщений в чате
|
||||
const BACKGROUND = (__ENV.BACKGROUND || "")
|
||||
.split(",")
|
||||
.filter((tier) => tier !== "")
|
||||
.map((tier) => tier.split("x").map(Number));
|
||||
|
||||
export const options = {
|
||||
vus: 1,
|
||||
iterations: 1,
|
||||
setupTimeout: "5m",
|
||||
};
|
||||
|
||||
export function setup() {
|
||||
// размер начинается с пустой базы, поэтому имени хватает времени
|
||||
const stamp = Date.now().toString(36);
|
||||
const tokens = {};
|
||||
const reader = register(`b${stamp}_reader`, "Bench reader");
|
||||
tokens[reader.id] = reader.token;
|
||||
const memberIds = [];
|
||||
for (let i = 0; i < MEMBERS; i++) {
|
||||
const member = register(`b${stamp}_m${i}`, `Bench member ${i}`);
|
||||
tokens[member.id] = member.token;
|
||||
memberIds.push(member.id);
|
||||
}
|
||||
const everyone = [reader.id, ...memberIds];
|
||||
// фоновые чаты в порядке уровней: номер чата в расписании наполнения —
|
||||
// 1 + индекс в этом списке (0 — читаемый чат)
|
||||
const bgChats = [];
|
||||
for (const [count, size] of BACKGROUND) {
|
||||
for (let i = 0; i < count; i++) {
|
||||
const title = `bench bg ${size} #${i}`;
|
||||
bgChats.push({ id: createChat(reader.token, title, everyone), size });
|
||||
}
|
||||
}
|
||||
const readChatId = createChat(reader.token, "bench read", everyone);
|
||||
// чаты записи со всеми пользователями: серии трека 1 делят вставки на
|
||||
// WRITE_CHATS правых краёв индекса истории (решение 2 design change
|
||||
// scaling-bench); прежние сценарии пишут в первый — writeChatId
|
||||
const writeChatIds = [];
|
||||
for (let i = 0; i < WRITE_CHATS; i++) {
|
||||
const title = i === 0 ? "bench write" : `bench write #${i}`;
|
||||
writeChatIds.push(createChat(reader.token, title, everyone));
|
||||
}
|
||||
return {
|
||||
readerId: reader.id,
|
||||
memberIds,
|
||||
tokens,
|
||||
readChatId,
|
||||
writeChatId: writeChatIds[0],
|
||||
writeChatIds,
|
||||
bgChats,
|
||||
};
|
||||
}
|
||||
|
||||
export default function () {}
|
||||
|
||||
export function handleSummary(data) {
|
||||
return { [`${WORK_DIR}/fixture.json`]: JSON.stringify(data.setup_data) };
|
||||
}
|
||||
@@ -0,0 +1,113 @@
|
||||
// Профиль очереди (design change track1-queue-overload, решение 6): открытая
|
||||
// модель загрузок через LB. Окна — сценарии constant-arrival-rate, timeUnit 10 с
|
||||
// для дробной интенсивности; VU заранее и без прибавления: тело — open на VU,
|
||||
// создание на ходу с телом 10 MiB теряет итерации. Ответ не повторяется: 429 —
|
||||
// отказ, недосланные итерации — dropped_iterations. Строка на загрузку
|
||||
// «q,<окно>,<отправка мс>,<длительность мс>,<статус>,<Retry-After>,<X-Instance-Id>,
|
||||
// <id>» — в файл консоли (--console-output); setup() пишет «q-t0,<мс>». WINDOWS —
|
||||
// «имя:интенсивность:секунды:VU», окна идут подряд; WARM=N — N загрузок подряд.
|
||||
import exec from "k6/execution";
|
||||
import http from "k6/http";
|
||||
|
||||
import {
|
||||
API,
|
||||
SUMMARY_THRESHOLDS,
|
||||
SUMMARY_TREND_STATS,
|
||||
WORK_DIR,
|
||||
summaryFiles,
|
||||
} from "./lib.js";
|
||||
|
||||
const fixture = JSON.parse(open(`${WORK_DIR}/fixture.json`));
|
||||
const BODY = open(`${WORK_DIR}/${__ENV.BODY}`, "b");
|
||||
const MEDIA = __ENV.MEDIA;
|
||||
const WARM = Number(__ENV.WARM || 0);
|
||||
const WINDOWS = (__ENV.WINDOWS || "")
|
||||
.split(",")
|
||||
.filter((item) => item !== "")
|
||||
.map((item) => {
|
||||
const [name, rate, seconds, vus] = item.split(":");
|
||||
return {
|
||||
name,
|
||||
rate: Number(rate),
|
||||
seconds: Number(seconds),
|
||||
vus: Number(vus),
|
||||
};
|
||||
});
|
||||
// больше timeout server LB пути загрузки (30 с): клиент видит ответ LB
|
||||
const TIMEOUT = "60s";
|
||||
const URL = `${API}/chats/${fixture.readChatId}/attachments?filename=bench`;
|
||||
const HEADERS = {
|
||||
Authorization: `Bearer ${fixture.tokens[fixture.readerId]}`,
|
||||
"Content-Type": MEDIA,
|
||||
};
|
||||
|
||||
function scenarios() {
|
||||
if (WARM) {
|
||||
return {
|
||||
warm: { executor: "shared-iterations", vus: 1, iterations: WARM },
|
||||
};
|
||||
}
|
||||
const out = {};
|
||||
let start = 0;
|
||||
for (const item of WINDOWS) {
|
||||
out[item.name] = {
|
||||
executor: "constant-arrival-rate",
|
||||
rate: Math.round(item.rate * 10),
|
||||
timeUnit: "10s",
|
||||
startTime: `${start}s`,
|
||||
duration: `${item.seconds}s`,
|
||||
preAllocatedVUs: item.vus,
|
||||
maxVUs: item.vus,
|
||||
gracefulStop: "45s",
|
||||
};
|
||||
start += item.seconds;
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
export const options = {
|
||||
scenarios: scenarios(),
|
||||
summaryTrendStats: SUMMARY_TREND_STATS,
|
||||
// порог всегда выполняется: итерации попадают в итог, run.py сверяет с ними
|
||||
// число строк
|
||||
thresholds: {
|
||||
...SUMMARY_THRESHOLDS,
|
||||
iterations: ["count>=0"],
|
||||
dropped_iterations: ["count>=0"],
|
||||
},
|
||||
};
|
||||
|
||||
export function setup() {
|
||||
const t0 = Date.now();
|
||||
console.log(`q-t0,${t0}`);
|
||||
return t0;
|
||||
}
|
||||
|
||||
export default function () {
|
||||
const start = Date.now();
|
||||
const res = http.post(URL, BODY, {
|
||||
headers: HEADERS,
|
||||
timeout: TIMEOUT,
|
||||
responseCallback: http.expectedStatuses(202, 429),
|
||||
});
|
||||
const t = res.timings;
|
||||
const measured = t.blocked + t.connecting + t.tls_handshaking + t.duration;
|
||||
const duration = Math.max(
|
||||
0,
|
||||
Math.round(res.status === 0 ? Date.now() - start : measured),
|
||||
);
|
||||
let id = "-";
|
||||
if (res.status === 202) {
|
||||
id = res.json("id");
|
||||
}
|
||||
const retry = res.headers["Retry-After"] || "-";
|
||||
const instance = res.headers["X-Instance-Id"] || "-";
|
||||
console.log(
|
||||
`q,${exec.scenario.name},${start},${duration},${res.status},${retry},` +
|
||||
`${instance},${id}`,
|
||||
);
|
||||
}
|
||||
|
||||
export function handleSummary(data) {
|
||||
return summaryFiles(data);
|
||||
}
|
||||
@@ -0,0 +1,81 @@
|
||||
// Обход принятых вложений профиля очереди (design change track1-queue-overload,
|
||||
// решение 9): истина о готовности — метаданные GET /attachments/{id}, опрос в
|
||||
// замере не нужен: updated_at у ready не меняется после фиксации. Строка на
|
||||
// вложение «qs,<id>,<http>,<status>,<error_code>,<variants>,<updated_at>»; у
|
||||
// выборки (первые SAMPLE ids, порядок задал оркестратор от зерна) — оригинал и
|
||||
// варианты с SHA-256 из метаданных: «qv,<id>,<имя>,<1|0>».
|
||||
import { sha256 } from "k6/crypto";
|
||||
import exec from "k6/execution";
|
||||
import http from "k6/http";
|
||||
import { SharedArray } from "k6/data";
|
||||
|
||||
import { API, WORK_DIR, authHeaders, summaryFiles } from "./lib.js";
|
||||
|
||||
const fixture = JSON.parse(open(`${WORK_DIR}/fixture.json`));
|
||||
const ids = new SharedArray("ids", () =>
|
||||
JSON.parse(open(`${WORK_DIR}/${__ENV.IDS}`)),
|
||||
);
|
||||
const SAMPLE = Number(__ENV.SAMPLE || 10);
|
||||
const READER = authHeaders(fixture.tokens[fixture.readerId]);
|
||||
const VARIANTS = ["thumbnail", "crop", "optimized"];
|
||||
|
||||
export const options = {
|
||||
scenarios: {
|
||||
sweep: {
|
||||
executor: "shared-iterations",
|
||||
vus: 4,
|
||||
iterations: Math.max(1, ids.length),
|
||||
maxDuration: "10m",
|
||||
},
|
||||
},
|
||||
thresholds: { iterations: ["count>=0"] },
|
||||
};
|
||||
|
||||
function checkBytes(id, name, expected) {
|
||||
const query = name === "original" ? "" : `?variant=${name}`;
|
||||
const res = http.get(`${API}/attachments/${id}/content${query}`, {
|
||||
headers: READER,
|
||||
responseType: "binary",
|
||||
timeout: "60s",
|
||||
});
|
||||
let good = 0;
|
||||
if (res.status === 200) {
|
||||
good = sha256(res.body, "hex") === expected ? 1 : 0;
|
||||
}
|
||||
console.log(`qv,${id},${name},${good}`);
|
||||
}
|
||||
|
||||
export default function () {
|
||||
const index = exec.scenario.iterationInTest;
|
||||
if (index >= ids.length) {
|
||||
return;
|
||||
}
|
||||
const id = ids[index];
|
||||
const res = http.get(`${API}/attachments/${id}`, {
|
||||
headers: READER,
|
||||
timeout: "30s",
|
||||
responseCallback: http.expectedStatuses(200, 404),
|
||||
});
|
||||
if (res.status !== 200) {
|
||||
console.log(`qs,${id},${res.status},-,-,0,-`);
|
||||
return;
|
||||
}
|
||||
const meta = res.json();
|
||||
const variants = meta.variants || [];
|
||||
console.log(
|
||||
`qs,${id},200,${meta.status},${meta.error_code || "-"},` +
|
||||
`${variants.length},${meta.updated_at}`,
|
||||
);
|
||||
if (index < SAMPLE && meta.status === "ready") {
|
||||
checkBytes(id, "original", meta.sha256);
|
||||
for (const item of variants) {
|
||||
if (VARIANTS.includes(item.name)) {
|
||||
checkBytes(id, item.name, item.sha256);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function handleSummary(data) {
|
||||
return summaryFiles(data);
|
||||
}
|
||||
@@ -0,0 +1,69 @@
|
||||
// Сценарий read: страница истории читаемого чата с курсором, случайно
|
||||
// выбранным из пула. У каждого VU свой генератор с зерном SEED + номер VU:
|
||||
// последовательность одинакова в разных метках и различна у клиентов.
|
||||
import exec from "k6/execution";
|
||||
import http from "k6/http";
|
||||
import { check } from "k6";
|
||||
import { SharedArray } from "k6/data";
|
||||
|
||||
import {
|
||||
API,
|
||||
PAGE_LIMIT,
|
||||
SUMMARY_THRESHOLDS,
|
||||
SUMMARY_TREND_STATS,
|
||||
WORK_DIR,
|
||||
authHeaders,
|
||||
mulberry32,
|
||||
summaryFiles,
|
||||
} from "./lib.js";
|
||||
|
||||
const fixture = JSON.parse(open(`${WORK_DIR}/fixture.json`));
|
||||
const cursors = new SharedArray(
|
||||
"cursors",
|
||||
() => JSON.parse(open(`${WORK_DIR}/cursors.json`)).cursors,
|
||||
);
|
||||
const SEED = Number(__ENV.SEED || 0);
|
||||
// отладка стенда: напечатать первые TRACE выборов каждого VU
|
||||
const TRACE = Number(__ENV.TRACE || 0);
|
||||
const URL = `${API}/chats/${fixture.readChatId}/messages`;
|
||||
const PARAMS = {
|
||||
headers: authHeaders(fixture.tokens[fixture.readerId]),
|
||||
responseCallback: http.expectedStatuses(200),
|
||||
};
|
||||
|
||||
export const options = {
|
||||
scenarios: {
|
||||
read: {
|
||||
executor: "constant-vus",
|
||||
vus: Number(__ENV.VUS),
|
||||
duration: __ENV.DURATION,
|
||||
gracefulStop: "5s",
|
||||
},
|
||||
},
|
||||
summaryTrendStats: SUMMARY_TREND_STATS,
|
||||
thresholds: SUMMARY_THRESHOLDS,
|
||||
};
|
||||
|
||||
let random = null;
|
||||
let picks = 0;
|
||||
|
||||
export default function () {
|
||||
if (random === null) {
|
||||
random = mulberry32(SEED + exec.vu.idInTest);
|
||||
}
|
||||
const index = Math.floor(random() * cursors.length);
|
||||
if (picks < TRACE) {
|
||||
console.log(`trace vu=${exec.vu.idInTest} pick=${picks} index=${index}`);
|
||||
}
|
||||
picks += 1;
|
||||
const cursor = encodeURIComponent(cursors[index]);
|
||||
const res = http.get(`${URL}?limit=${PAGE_LIMIT}&cursor=${cursor}`, PARAMS);
|
||||
check(res, {
|
||||
"status 200": (r) => r.status === 200,
|
||||
"full page": (r) => r.status === 200 && r.json("items.#") === PAGE_LIMIT,
|
||||
});
|
||||
}
|
||||
|
||||
export function handleSummary(data) {
|
||||
return summaryFiles(data);
|
||||
}
|
||||
@@ -0,0 +1,87 @@
|
||||
// Проверки восстановления через HTTP (трек 2), фаза — PHASE:
|
||||
// - source: исходная база до восстановления;
|
||||
// - stale: API на восстановленной базе, кэш ещё не очищен;
|
||||
// - restored: после FLUSHALL.
|
||||
// Во всех фазах — страницы этапа плана (plan_pages.json) и /users/me
|
||||
// читателя; в stale и restored — ещё чат и пользователь «после backup».
|
||||
// Ответы не проверяются здесь: статусы и элементы страниц пишутся в
|
||||
// check-<фаза>.json, сверяет оркестратор. Токенов в итоге нет.
|
||||
import http from "k6/http";
|
||||
|
||||
import {
|
||||
API,
|
||||
PAGE_LIMIT,
|
||||
WORK_DIR,
|
||||
authHeaders,
|
||||
messageHeaders,
|
||||
} from "./lib.js";
|
||||
|
||||
const PHASE = __ENV.PHASE;
|
||||
const fixture = JSON.parse(open(`${WORK_DIR}/fixture.json`));
|
||||
const pages = JSON.parse(open(`${WORK_DIR}/plan_pages.json`));
|
||||
// after.json появляется только после активности «после backup»
|
||||
const after = PHASE === "source"
|
||||
? null
|
||||
: JSON.parse(open(`${WORK_DIR}/after.json`));
|
||||
|
||||
export const options = {
|
||||
vus: 1,
|
||||
iterations: 1,
|
||||
setupTimeout: "5m",
|
||||
};
|
||||
|
||||
function status(res) {
|
||||
return res.status;
|
||||
}
|
||||
|
||||
export function setup() {
|
||||
const reader = { headers: authHeaders(fixture.tokens[fixture.readerId]) };
|
||||
const result = {
|
||||
phase: PHASE,
|
||||
reader_me: status(http.get(`${API}/users/me`, reader)),
|
||||
pages: pages.map((page) => {
|
||||
const query = page.cursor === null
|
||||
? `?limit=${PAGE_LIMIT}`
|
||||
: `?limit=${PAGE_LIMIT}&cursor=${encodeURIComponent(page.cursor)}`;
|
||||
const res = http.get(
|
||||
`${API}/chats/${page.chat_id}/messages${query}`,
|
||||
reader,
|
||||
);
|
||||
return {
|
||||
chat: page.chat,
|
||||
page: page.page,
|
||||
status: res.status,
|
||||
items: res.status === 200 ? res.json("items") : null,
|
||||
};
|
||||
}),
|
||||
};
|
||||
if (after !== null) {
|
||||
const late = { headers: authHeaders(after.token) };
|
||||
result.late_me = status(http.get(`${API}/users/me`, late));
|
||||
result.after_chat_get = status(
|
||||
http.get(`${API}/chats/${after.chatId}`, reader),
|
||||
);
|
||||
}
|
||||
if (PHASE === "stale") {
|
||||
// запись в чат, которого нет в восстановленной базе, а карточка — в
|
||||
// кэше; с ключом, иначе 400 пришёл бы раньше проверки членства
|
||||
result.after_chat_post = status(
|
||||
http.post(
|
||||
`${API}/chats/${after.chatId}/messages`,
|
||||
JSON.stringify({ text: "written to a stale chat" }),
|
||||
{
|
||||
headers: messageHeaders(fixture.tokens[fixture.readerId]),
|
||||
},
|
||||
),
|
||||
);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
export default function () {}
|
||||
|
||||
export function handleSummary(data) {
|
||||
return {
|
||||
[`${WORK_DIR}/check-${PHASE}.json`]: JSON.stringify(data.setup_data),
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,55 @@
|
||||
// Повтор неподтверждённых записей фазы отказа с тем же ключом и тем же
|
||||
// телом до 201 (решение 7 design change graceful-failover). Номера — в
|
||||
// retry.json рабочего каталога; итог — retry-result.json: сколько
|
||||
// получили 201 и какие нет. Ключ и текст строятся так же, как в
|
||||
// failover.js, поэтому повтор после неопределённого исхода (kill, 504)
|
||||
// возвращает сохранённое сообщение или пишет его впервые — без дубля.
|
||||
import { sleep } from "k6";
|
||||
|
||||
import { WORK_DIR, sendMessage, syntheticText } from "./lib.js";
|
||||
|
||||
const fixture = JSON.parse(open(`${WORK_DIR}/fixture.json`));
|
||||
const items = JSON.parse(open(`${WORK_DIR}/retry.json`)).items;
|
||||
const RUN = __ENV.RUN;
|
||||
const PHASE = Number(__ENV.PHASE);
|
||||
const ATTEMPTS = 5;
|
||||
|
||||
export const options = {
|
||||
vus: 1,
|
||||
iterations: 1,
|
||||
setupTimeout: "5m",
|
||||
};
|
||||
|
||||
export function setup() {
|
||||
let ok = 0;
|
||||
const failed = [];
|
||||
for (const n of items) {
|
||||
const sender = fixture.memberIds[n % fixture.memberIds.length];
|
||||
let status = 0;
|
||||
for (let attempt = 1; attempt <= ATTEMPTS; attempt++) {
|
||||
const res = sendMessage(
|
||||
fixture.writeChatId,
|
||||
fixture.tokens[sender],
|
||||
syntheticText(`f${PHASE}`, n),
|
||||
`${RUN}.${PHASE}.${n}`,
|
||||
);
|
||||
status = res.status;
|
||||
if (status === 201) {
|
||||
break;
|
||||
}
|
||||
sleep(1);
|
||||
}
|
||||
if (status === 201) {
|
||||
ok += 1;
|
||||
} else {
|
||||
failed.push({ n, status });
|
||||
}
|
||||
}
|
||||
return { ok, failed };
|
||||
}
|
||||
|
||||
export default function () {}
|
||||
|
||||
export function handleSummary(data) {
|
||||
return { [`${WORK_DIR}/retry-result.json`]: JSON.stringify(data.setup_data) };
|
||||
}
|
||||
@@ -0,0 +1,48 @@
|
||||
// Проверка после блока read: читаемый чат не изменился. Дочитывает
|
||||
// историю от последнего курсора пула до конца и считает сообщения. Новое
|
||||
// сообщение встало бы в конец, поэтому хвоста достаточно.
|
||||
import http from "k6/http";
|
||||
import { fail } from "k6";
|
||||
|
||||
import { API, WORK_DIR, authHeaders } from "./lib.js";
|
||||
|
||||
const fixture = JSON.parse(open(`${WORK_DIR}/fixture.json`));
|
||||
const pool = JSON.parse(open(`${WORK_DIR}/cursors.json`));
|
||||
const WALK_LIMIT = Number(__ENV.WALK_LIMIT || 100);
|
||||
|
||||
export const options = {
|
||||
vus: 1,
|
||||
iterations: 1,
|
||||
setupTimeout: "30m",
|
||||
};
|
||||
|
||||
export function setup() {
|
||||
const url = `${API}/chats/${fixture.readChatId}/messages`;
|
||||
const params = { headers: authHeaders(fixture.tokens[fixture.readerId]) };
|
||||
// пустой пул (история короче страницы обхода) — читаем с начала
|
||||
const hasPool = pool.cursors.length > 0;
|
||||
let cursor = hasPool ? pool.cursors[pool.cursors.length - 1] : null;
|
||||
let tail = 0;
|
||||
for (;;) {
|
||||
const query = cursor === null
|
||||
? `?limit=${WALK_LIMIT}`
|
||||
: `?limit=${WALK_LIMIT}&cursor=${encodeURIComponent(cursor)}`;
|
||||
const res = http.get(url + query, params);
|
||||
if (res.status !== 200) {
|
||||
fail(`history tail after ${tail}: ${res.status} ${res.body}`);
|
||||
}
|
||||
const body = res.json();
|
||||
tail += body.items.length;
|
||||
if (body.next_cursor === null) {
|
||||
break;
|
||||
}
|
||||
cursor = body.next_cursor;
|
||||
}
|
||||
return { from_after: hasPool ? pool.last_after : 0, tail };
|
||||
}
|
||||
|
||||
export default function () {}
|
||||
|
||||
export function handleSummary(data) {
|
||||
return { [`${WORK_DIR}/tail.json`]: JSON.stringify(data.setup_data) };
|
||||
}
|
||||
@@ -0,0 +1,229 @@
|
||||
// Профиль цены телеметрии (design change track1-telemetry-cost, решение 8):
|
||||
// одинаковая открытая нагрузка ниже насыщения через LB во всех вариантах.
|
||||
// Классы — сценарии constant-arrival-rate с одним startTime на всю длину
|
||||
// прогона (разогрев + чистое окно + окно отказов), timeUnit 10 с для дробной
|
||||
// интенсивности; деление на окна — по времени отправки от t0 (setup пишет
|
||||
// «t-t0,<мс>», часы ВМ). VU заранее и без прибавления, ответ не повторяется:
|
||||
// недосланные итерации — dropped_iterations. Строка на запрос в файл консоли:
|
||||
// «t,<класс>,<отправка мс>,<длительность мс>,<статус>,<X-Request-Id>,
|
||||
// <X-Instance-Id>,<id вложения|->». Входы оркестратора: fixture.json
|
||||
// (prepare.js), downloads.json (готовые вложения разогрева), broken.json (id
|
||||
// вложения без объекта), тела s.jpg и bad.jpg (make_images.py).
|
||||
// RATES — «класс:в секунду,…» (Profile.telemetry_rates)
|
||||
// DURATION — секунды всех окон
|
||||
// NAME — имя итога в raw/
|
||||
// Регистрация: пароль — crypto.randomUUID() только в памяти итерации, в строки,
|
||||
// итог и файлы не попадает; токен ответа не читается.
|
||||
import exec from "k6/execution";
|
||||
import http from "k6/http";
|
||||
import { SharedArray } from "k6/data";
|
||||
|
||||
import {
|
||||
API,
|
||||
PAGE_LIMIT,
|
||||
SUMMARY_THRESHOLDS,
|
||||
SUMMARY_TREND_STATS,
|
||||
WORK_DIR,
|
||||
authHeaders,
|
||||
messageHeaders,
|
||||
summaryFiles,
|
||||
syntheticText,
|
||||
} from "./lib.js";
|
||||
|
||||
const fixture = JSON.parse(open(`${WORK_DIR}/fixture.json`));
|
||||
const downloads = new SharedArray(
|
||||
"downloads",
|
||||
() => JSON.parse(open(`${WORK_DIR}/downloads.json`)),
|
||||
);
|
||||
const BROKEN = JSON.parse(open(`${WORK_DIR}/broken.json`));
|
||||
const GOOD_BODY = open(`${WORK_DIR}/s.jpg`, "b");
|
||||
const BAD_BODY = open(`${WORK_DIR}/bad.jpg`, "b");
|
||||
const DURATION = Number(__ENV.DURATION);
|
||||
const RATES = Object.fromEntries(
|
||||
(__ENV.RATES || "")
|
||||
.split(",")
|
||||
.filter((item) => item !== "")
|
||||
.map((item) => {
|
||||
const [name, rate] = item.split(":");
|
||||
return [name, Number(rate)];
|
||||
}),
|
||||
);
|
||||
// больше timeout server LB (10 с, у загрузки 30 с): клиент видит ответ LB
|
||||
const TIMEOUT = "40s";
|
||||
const READER = authHeaders(fixture.tokens[fixture.readerId]);
|
||||
const WRITE_URL = `${API}/chats/${fixture.writeChatId}/messages`;
|
||||
const UPLOAD_URL = `${API}/chats/${fixture.readChatId}/attachments`;
|
||||
|
||||
// VU заранее: интенсивность × запас на медленные ответы (запись под
|
||||
// блокировкой до 0,6 с, регистрация с Argon2id до 1 с) + постоянная часть
|
||||
function vus(rate) {
|
||||
return Math.max(4, Math.ceil(rate * 2) + 4);
|
||||
}
|
||||
|
||||
function scenarios() {
|
||||
const out = {};
|
||||
for (const [name, rate] of Object.entries(RATES)) {
|
||||
if (!(rate > 0)) {
|
||||
continue;
|
||||
}
|
||||
out[name] = {
|
||||
executor: "constant-arrival-rate",
|
||||
exec: name,
|
||||
rate: Math.max(1, Math.round(rate * 10)),
|
||||
timeUnit: "10s",
|
||||
startTime: "0s",
|
||||
duration: `${DURATION}s`,
|
||||
preAllocatedVUs: vus(rate),
|
||||
maxVUs: vus(rate),
|
||||
gracefulStop: "45s",
|
||||
};
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
const iterationThresholds = Object.fromEntries(
|
||||
Object.keys(RATES).map((name) => [
|
||||
`iterations{scenario:${name}}`,
|
||||
["count>=0"],
|
||||
]),
|
||||
);
|
||||
|
||||
export const options = {
|
||||
scenarios: scenarios(),
|
||||
summaryTrendStats: SUMMARY_TREND_STATS,
|
||||
// пороги всегда выполняются: итерации по сценариям и недосланные попадают
|
||||
// в итог, run.py сверяет с ними число строк
|
||||
thresholds: {
|
||||
...SUMMARY_THRESHOLDS,
|
||||
...iterationThresholds,
|
||||
iterations: ["count>=0"],
|
||||
dropped_iterations: ["count>=0"],
|
||||
},
|
||||
};
|
||||
|
||||
export function setup() {
|
||||
const t0 = Date.now();
|
||||
console.log(`t-t0,${t0}`);
|
||||
return { t0 };
|
||||
}
|
||||
|
||||
// длительность — монотонные тайминги k6 с точностью 0,01 мс, без ответа —
|
||||
// разность часов
|
||||
function report(kind, start, res, id = "-") {
|
||||
const t = res.timings;
|
||||
const measured = t.blocked + t.connecting + t.tls_handshaking + t.duration;
|
||||
const duration = Math.max(
|
||||
0,
|
||||
Math.round((res.status === 0 ? Date.now() - start : measured) * 100) / 100,
|
||||
);
|
||||
const requestId = res.headers["X-Request-Id"] || "-";
|
||||
const instance = res.headers["X-Instance-Id"] || "-";
|
||||
console.log(
|
||||
`t,${kind},${start},${duration},${res.status},${requestId},${instance},` +
|
||||
`${id}`,
|
||||
);
|
||||
}
|
||||
|
||||
function get(kind, url, expected) {
|
||||
const start = Date.now();
|
||||
const res = http.get(url, {
|
||||
headers: READER,
|
||||
responseType: "none",
|
||||
timeout: TIMEOUT,
|
||||
responseCallback: http.expectedStatuses(expected),
|
||||
});
|
||||
report(kind, start, res);
|
||||
}
|
||||
|
||||
export function read() {
|
||||
get("read", `${WRITE_URL}?limit=${PAGE_LIMIT}`, 200);
|
||||
}
|
||||
|
||||
export function me() {
|
||||
get("me", `${API}/users/me`, 200);
|
||||
}
|
||||
|
||||
export function card() {
|
||||
get("card", `${API}/chats/${fixture.writeChatId}`, 200);
|
||||
}
|
||||
|
||||
export function download() {
|
||||
const id = downloads[exec.scenario.iterationInTest % downloads.length];
|
||||
get("download", `${API}/attachments/${id}/content`, 200);
|
||||
}
|
||||
|
||||
// вложение без объекта: 500 AttachmentContentMissing — ожидаемый ответ класса
|
||||
export function broken() {
|
||||
get("broken", `${API}/attachments/${BROKEN}/content`, 500);
|
||||
}
|
||||
|
||||
export function write() {
|
||||
const n = exec.scenario.iterationInTest;
|
||||
const sender = fixture.memberIds[n % fixture.memberIds.length];
|
||||
const start = Date.now();
|
||||
const res = http.post(
|
||||
WRITE_URL,
|
||||
JSON.stringify({ text: syntheticText("tc", n) }),
|
||||
{
|
||||
headers: messageHeaders(fixture.tokens[sender]),
|
||||
responseType: "none",
|
||||
timeout: TIMEOUT,
|
||||
responseCallback: http.expectedStatuses(201),
|
||||
},
|
||||
);
|
||||
report("write", start, res);
|
||||
}
|
||||
|
||||
function postUpload(kind, body) {
|
||||
const start = Date.now();
|
||||
const res = http.post(`${UPLOAD_URL}?filename=bench`, body, {
|
||||
headers: {
|
||||
Authorization: `Bearer ${fixture.tokens[fixture.readerId]}`,
|
||||
"Content-Type": "image/jpeg",
|
||||
},
|
||||
timeout: TIMEOUT,
|
||||
responseCallback: http.expectedStatuses(202),
|
||||
});
|
||||
let id = "-";
|
||||
if (res.status === 202) {
|
||||
id = res.json("id");
|
||||
}
|
||||
report(kind, start, res, id);
|
||||
}
|
||||
|
||||
// имя сценария — имя класса и экспортируемой функции (exec)
|
||||
export function upload() {
|
||||
postUpload("upload", GOOD_BODY);
|
||||
}
|
||||
|
||||
export function upload_bad() {
|
||||
postUpload("upload_bad", BAD_BODY);
|
||||
}
|
||||
|
||||
// регистрация — редкий медленный маршрут (Argon2id): имя из UUID без
|
||||
// дефисов (шаблон контракта ^[a-z0-9_]{3,32}$), пароль сразу выбрасывается
|
||||
export function register() {
|
||||
const name = `t${crypto.randomUUID().split("-").join("").slice(0, 30)}`;
|
||||
const start = Date.now();
|
||||
const res = http.post(
|
||||
`${API}/users`,
|
||||
JSON.stringify({
|
||||
username: name,
|
||||
display_name: "Bench telemetry",
|
||||
password: crypto.randomUUID(),
|
||||
}),
|
||||
{
|
||||
headers: { "Content-Type": "application/json" },
|
||||
responseType: "none",
|
||||
timeout: TIMEOUT,
|
||||
responseCallback: http.expectedStatuses(201),
|
||||
},
|
||||
);
|
||||
report("register", start, res);
|
||||
}
|
||||
|
||||
export function handleSummary(data) {
|
||||
// t0 — в строке t-t0, итог без данных setup
|
||||
delete data.setup_data;
|
||||
return summaryFiles(data);
|
||||
}
|
||||
@@ -0,0 +1,106 @@
|
||||
// Профиль загрузок (design change upload-memory, решение 10): CLIENTS VU
|
||||
// загружают одно и то же тело PNG без пауз (constant-vus) через LB, пока
|
||||
// оркестратор меряет память реплики. На 429 VU ждёт Retry-After, на прочие
|
||||
// ошибки — секунду. Каждая загрузка — строка «up,<vu>,<итерация>,
|
||||
// <отправка мс>,<длительность мс>,<статус>,<X-Instance-Id>» в файл консоли
|
||||
// k6 (--console-output); setup() пишет «up-t0,<мс>» — начало нагрузки на
|
||||
// часах ВМ: окно замера — [t0 + RAMP_S, t0 + RAMP_S + WINDOW_S). WARMUP=1 —
|
||||
// одна разогревающая загрузка, она должна получить код успеха. Успех — 202, у
|
||||
// варианта с образом commit до перехода на 202 — 201 (design change
|
||||
// async-attachments, решение 16); чей код чей, считает bench/uploads.py.
|
||||
import exec from "k6/execution";
|
||||
import http from "k6/http";
|
||||
import { fail, sleep } from "k6";
|
||||
|
||||
import {
|
||||
API,
|
||||
SUMMARY_THRESHOLDS,
|
||||
SUMMARY_TREND_STATS,
|
||||
WORK_DIR,
|
||||
summaryFiles,
|
||||
} from "./lib.js";
|
||||
|
||||
const fixture = JSON.parse(open(`${WORK_DIR}/fixture.json`));
|
||||
// тело — файл рабочего каталога, его строит оркестратор (bench/uploads.py)
|
||||
const BODY = open(`${WORK_DIR}/${__ENV.BODY}`, "b");
|
||||
const CLIENTS = Number(__ENV.CLIENTS || 1);
|
||||
const RAMP_S = Number(__ENV.RAMP_S || 3);
|
||||
const WINDOW_S = Number(__ENV.WINDOW_S || 20);
|
||||
const WARMUP = __ENV.WARMUP === "1";
|
||||
const SUCCESS = [201, 202];
|
||||
// больше timeout server LB пути загрузки (30 с): клиент видит ответ LB
|
||||
const TIMEOUT = "60s";
|
||||
const URL = `${API}/chats/${fixture.readChatId}/attachments?filename=bench.png`;
|
||||
// идентификация — Bearer, как authHeaders() в lib.js, но тело — PNG, а не
|
||||
// JSON
|
||||
const HEADERS = {
|
||||
Authorization: `Bearer ${fixture.tokens[fixture.readerId]}`,
|
||||
"Content-Type": "image/png",
|
||||
};
|
||||
|
||||
export const options = {
|
||||
scenarios: {
|
||||
upload: WARMUP
|
||||
? { executor: "per-vu-iterations", vus: 1, iterations: 1 }
|
||||
: {
|
||||
executor: "constant-vus",
|
||||
vus: CLIENTS,
|
||||
duration: `${RAMP_S + WINDOW_S}s`,
|
||||
// начатая загрузка доходит до ответа: больше срока LB (30 с) и
|
||||
// паузы после ответа — строк столько же, сколько итераций
|
||||
gracefulStop: "45s",
|
||||
},
|
||||
},
|
||||
summaryTrendStats: SUMMARY_TREND_STATS,
|
||||
thresholds: {
|
||||
...SUMMARY_THRESHOLDS,
|
||||
"iterations{scenario:upload}": ["count>=0"],
|
||||
},
|
||||
};
|
||||
|
||||
export function setup() {
|
||||
const t0 = Date.now();
|
||||
console.log(`up-t0,${t0}`);
|
||||
return t0;
|
||||
}
|
||||
|
||||
// длительность — по монотонным таймингам k6; без ответа (status 0) —
|
||||
// разность часов
|
||||
function report(start, res) {
|
||||
const instance = res.headers["X-Instance-Id"] || "-";
|
||||
const t = res.timings;
|
||||
const measured = t.blocked + t.connecting + t.tls_handshaking + t.duration;
|
||||
const duration = Math.max(
|
||||
0,
|
||||
Math.round(res.status === 0 ? Date.now() - start : measured),
|
||||
);
|
||||
console.log(
|
||||
`up,${exec.vu.idInTest},${exec.vu.iterationInScenario},${start},` +
|
||||
`${duration},${res.status},${instance}`,
|
||||
);
|
||||
}
|
||||
|
||||
export default function () {
|
||||
const start = Date.now();
|
||||
const res = http.post(URL, BODY, {
|
||||
headers: HEADERS,
|
||||
responseType: "none",
|
||||
timeout: TIMEOUT,
|
||||
responseCallback: http.expectedStatuses(...SUCCESS),
|
||||
});
|
||||
report(start, res);
|
||||
const success = SUCCESS.includes(res.status);
|
||||
if (WARMUP && !success) {
|
||||
fail(`warmup upload: ${res.status}`);
|
||||
}
|
||||
if (res.status === 429) {
|
||||
const retry = Number(res.headers["Retry-After"]);
|
||||
sleep(retry > 0 ? retry : 1);
|
||||
} else if (!success) {
|
||||
sleep(1);
|
||||
}
|
||||
}
|
||||
|
||||
export function handleSummary(data) {
|
||||
return summaryFiles(data);
|
||||
}
|
||||
@@ -0,0 +1,43 @@
|
||||
// Сценарий write: ровно COUNT сообщений в чат записи от участников по
|
||||
// кругу, VUS клиентов одновременно. Читаемый чат не меняется.
|
||||
import exec from "k6/execution";
|
||||
|
||||
import {
|
||||
SUMMARY_THRESHOLDS,
|
||||
SUMMARY_TREND_STATS,
|
||||
WORK_DIR,
|
||||
sendMessage,
|
||||
summaryFiles,
|
||||
syntheticText,
|
||||
} from "./lib.js";
|
||||
|
||||
const fixture = JSON.parse(open(`${WORK_DIR}/fixture.json`));
|
||||
const OFFSET = Number(__ENV.OFFSET || 0);
|
||||
|
||||
export const options = {
|
||||
scenarios: {
|
||||
write: {
|
||||
executor: "shared-iterations",
|
||||
vus: Number(__ENV.VUS),
|
||||
iterations: Number(__ENV.COUNT),
|
||||
maxDuration: "10m",
|
||||
},
|
||||
},
|
||||
discardResponseBodies: true,
|
||||
summaryTrendStats: SUMMARY_TREND_STATS,
|
||||
thresholds: SUMMARY_THRESHOLDS,
|
||||
};
|
||||
|
||||
export default function () {
|
||||
const n = OFFSET + exec.scenario.iterationInTest;
|
||||
const sender = fixture.memberIds[n % fixture.memberIds.length];
|
||||
sendMessage(
|
||||
fixture.writeChatId,
|
||||
fixture.tokens[sender],
|
||||
syntheticText("w", n),
|
||||
);
|
||||
}
|
||||
|
||||
export function handleSummary(data) {
|
||||
return summaryFiles(data);
|
||||
}
|
||||
@@ -0,0 +1,188 @@
|
||||
"""Файлы классов профиля очереди (design change `track1-queue-overload`,
|
||||
решение 5): `s`, `m`, `lj`, `lp`, детерминированно от зерна; класс `bad` —
|
||||
профиль цены телеметрии (design change `track1-telemetry-cost`, решение 8).
|
||||
|
||||
Только в контейнере `mtusi-bench-images` на образе стенда: Pillow образа и та же
|
||||
его версия, что у процесса обработки; `src` не импортируется. На stdout — JSON с
|
||||
размерами, пикселями и SHA-256; файл больше лимита контракта — код 1.
|
||||
|
||||
python make_images.py <зерно> <каталог>
|
||||
"""
|
||||
|
||||
import hashlib
|
||||
import io
|
||||
import json
|
||||
import random
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
from PIL import Image, ImageChops, UnidentifiedImageError
|
||||
from uploads import png_noise
|
||||
|
||||
MAX_BYTES = 10_485_760
|
||||
MAX_PIXELS = 40_000_000
|
||||
LARGE = (8000, 5000)
|
||||
SMALL = (1600, 1200)
|
||||
NOISE_HEIGHT = 3409
|
||||
CELLS_LOW = 64
|
||||
CELLS_HIGH = 512
|
||||
FINE_DIVISOR = 6
|
||||
TILE = 512
|
||||
AMPLITUDE = 24
|
||||
POSTERIZE_MASK = 0xF0
|
||||
# точность в SOF, которую Pillow не декодирует
|
||||
PRECISION_12 = 12
|
||||
|
||||
|
||||
def noise_l(width: int, height: int, seed: int) -> Image.Image:
|
||||
data = random.Random(seed).randbytes(width * height)
|
||||
return Image.frombytes("L", (width, height), data)
|
||||
|
||||
|
||||
def clouds(
|
||||
width: int,
|
||||
height: int,
|
||||
seed: int,
|
||||
cells: int = CELLS_LOW,
|
||||
) -> Image.Image:
|
||||
"""Гладкое поле из шума низкого разрешения: низкие частоты фото."""
|
||||
return noise_l(cells, max(2, cells * height // width), seed).resize(
|
||||
(width, height),
|
||||
Image.Resampling.BICUBIC,
|
||||
)
|
||||
|
||||
|
||||
def detail_tile(
|
||||
width: int,
|
||||
height: int,
|
||||
seed: int,
|
||||
amplitude: int,
|
||||
) -> Image.Image:
|
||||
"""Плитка шума амплитуды `amplitude`, повторённая на всё поле."""
|
||||
tile = noise_l(TILE, TILE, seed).point(lambda v: v * amplitude // 255)
|
||||
field = Image.new("L", (width, height))
|
||||
for y in range(0, height, TILE):
|
||||
for x in range(0, width, TILE):
|
||||
field.paste(tile, (x, y))
|
||||
return field
|
||||
|
||||
|
||||
def bands(
|
||||
width: int,
|
||||
height: int,
|
||||
seed: int,
|
||||
amplitude: int,
|
||||
) -> list[Image.Image]:
|
||||
out = []
|
||||
for number in range(3):
|
||||
band = ImageChops.add(
|
||||
clouds(width, height, seed + number),
|
||||
clouds(
|
||||
width,
|
||||
height,
|
||||
seed + 10 + number,
|
||||
cells=CELLS_HIGH,
|
||||
).point(lambda v: v // FINE_DIVISOR),
|
||||
)
|
||||
if amplitude:
|
||||
band = ImageChops.add(
|
||||
band,
|
||||
detail_tile(width, height, seed + 20 + number, amplitude),
|
||||
)
|
||||
out.append(band)
|
||||
return out
|
||||
|
||||
|
||||
def jpeg(image: Image.Image, quality: int) -> bytes:
|
||||
out = io.BytesIO()
|
||||
image.save(out, format="JPEG", quality=quality, subsampling="4:2:0")
|
||||
return out.getvalue()
|
||||
|
||||
|
||||
def build_s(seed: int) -> bytes:
|
||||
return jpeg(Image.merge("RGB", bands(*SMALL, seed, AMPLITUDE)), 85)
|
||||
|
||||
|
||||
def build_lj(seed: int) -> bytes:
|
||||
return jpeg(Image.merge("RGB", bands(*LARGE, seed + 200, AMPLITUDE)), 88)
|
||||
|
||||
|
||||
def build_lp(seed: int) -> bytes:
|
||||
colour = [
|
||||
band.point(lambda v: v & POSTERIZE_MASK)
|
||||
for band in bands(*LARGE, seed + 200, 0)
|
||||
]
|
||||
alpha = clouds(*LARGE, seed + 300).point(
|
||||
lambda v: (128 + v // 2) & POSTERIZE_MASK,
|
||||
)
|
||||
out = io.BytesIO()
|
||||
Image.merge("RGBA", (*colour, alpha)).save(
|
||||
out,
|
||||
format="PNG",
|
||||
compress_level=6,
|
||||
)
|
||||
return out.getvalue()
|
||||
|
||||
|
||||
def build_m(seed: int) -> bytes:
|
||||
return png_noise(NOISE_HEIGHT, seed + NOISE_HEIGHT)
|
||||
|
||||
|
||||
def build_bad(seed: int) -> bytes:
|
||||
"""Класс `bad` профиля цены телеметрии (design change
|
||||
`track1-telemetry-cost`, решение 8): байты `s` с 12 битами точности в
|
||||
SOF — структура верна (202), Pillow не декодирует (`failed`,
|
||||
`invalid_image`), как `images.jpeg_precision_12()` тестов."""
|
||||
data = bytearray(build_s(seed))
|
||||
sof = data.index(b"\xff\xc0")
|
||||
data[sof + 4] = PRECISION_12
|
||||
return bytes(data)
|
||||
|
||||
|
||||
def image_size(data: bytes) -> tuple[int, int]:
|
||||
"""Ширина и высота: Pillow, а у `bad`, который Pillow не открывает, —
|
||||
поля SOF (высота и ширина после точности)."""
|
||||
try:
|
||||
with Image.open(io.BytesIO(data)) as image:
|
||||
return image.size
|
||||
except UnidentifiedImageError:
|
||||
sof = data.index(b"\xff\xc0")
|
||||
height = int.from_bytes(data[sof + 5 : sof + 7], "big")
|
||||
width = int.from_bytes(data[sof + 7 : sof + 9], "big")
|
||||
return width, height
|
||||
|
||||
|
||||
BUILDERS = {
|
||||
"s": (build_s, "s.jpg", "image/jpeg"),
|
||||
"m": (build_m, "m.png", "image/png"),
|
||||
"lj": (build_lj, "lj.jpg", "image/jpeg"),
|
||||
"lp": (build_lp, "lp.png", "image/png"),
|
||||
"bad": (build_bad, "bad.jpg", "image/jpeg"),
|
||||
}
|
||||
|
||||
|
||||
def main() -> int:
|
||||
seed, directory = int(sys.argv[1]), Path(sys.argv[2])
|
||||
report = {}
|
||||
code = 0
|
||||
for name, (build, filename, media) in BUILDERS.items():
|
||||
data = build(seed)
|
||||
width, height = image_size(data)
|
||||
(directory / filename).write_bytes(data)
|
||||
report[name] = {
|
||||
"file": filename,
|
||||
"media_type": media,
|
||||
"bytes": len(data),
|
||||
"width": width,
|
||||
"height": height,
|
||||
"sha256": hashlib.sha256(data).hexdigest(),
|
||||
}
|
||||
if len(data) > MAX_BYTES or width * height > MAX_PIXELS:
|
||||
print(f"{name}: over the contract limit", file=sys.stderr)
|
||||
code = 1
|
||||
print(json.dumps(report))
|
||||
return code
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
@@ -0,0 +1,85 @@
|
||||
# bench-lean: begin
|
||||
# Конфигурация Prometheus вариантов `metrics` и `balanced` профиля цены
|
||||
# телеметрии (design change track1-telemetry-cost, решение 7): копия
|
||||
# infra/otel/prometheus/prometheus.yml плюс размеченные блоки отбора рядов у
|
||||
# целей loki, tempo и prometheus. Prometheus конфигурации не сливает, поэтому
|
||||
# копия; вне строк `bench-lean` файл обязан совпадать с рабочим построчно —
|
||||
# это проверяют run.py до стенда и `telemetry_cost.py --selftest`. Остаются
|
||||
# ряды приёма, отказов и объёма хранения (их же читает профиль) и `up`
|
||||
# (синтетический, отбор его не касается); ряды приложения и Collector — все.
|
||||
# Рабочий стенд забирает все ряды (решение 5).
|
||||
# bench-lean: end
|
||||
# Prometheus v3.15.1 — хранилище метрик (design change otel-telemetry,
|
||||
# решения 3 и 15). Метрики приложения — scrape экспортёра prometheus
|
||||
# Collector (honor_labels: job = service.name, instance = service.instance.id
|
||||
# из OTLP; там же метрики LB с job = haproxy), плюс собственные метрики
|
||||
# Collector, Loki, Tempo и самого Prometheus: по ним видно, жив ли конвейер.
|
||||
# Срок и предел объёма хранения, путь данных и время начала рядов — флаги
|
||||
# команды в docker-compose.yml. Приёмников remote write и OTLP, admin API и
|
||||
# lifecycle нет; порт не публикуется. Правила записи и оповещения — rules.yml
|
||||
# (design change slo-alerts, решения 1, 3, 4, 9); блока alerting нет:
|
||||
# доставки наружу нет, состояние firing / resolved — API правил, ряды ALERTS и
|
||||
# Grafana.
|
||||
global:
|
||||
scrape_interval: 15s
|
||||
scrape_timeout: 10s
|
||||
evaluation_interval: 15s
|
||||
# явно прежний текстовый список Prometheus 3 по умолчанию: флаг
|
||||
# created-timestamp-zero-ingestion иначе переводит на protobuf все цели, а
|
||||
# время начала нужно только экспортёру Collector (решение 6)
|
||||
scrape_protocols:
|
||||
- OpenMetricsText1.0.0
|
||||
- OpenMetricsText0.0.1
|
||||
- PrometheusText1.0.0
|
||||
- PrometheusText0.0.4
|
||||
|
||||
rule_files:
|
||||
- /etc/prometheus/rules.yml
|
||||
|
||||
scrape_configs:
|
||||
# метрики API, worker и relay, пришедшие в Collector по OTLP, и метрики LB
|
||||
# с приёмника prometheus/haproxy. Protobuf первым: время начала
|
||||
# cumulative-ряда экспортёр Collector отдаёт только в нём, и Prometheus
|
||||
# пишет ноль в момент старта нового процесса (решение 6)
|
||||
- job_name: otel-collector-exporter
|
||||
honor_labels: true
|
||||
scrape_protocols:
|
||||
- PrometheusProto
|
||||
- OpenMetricsText1.0.0
|
||||
- PrometheusText0.0.4
|
||||
static_configs:
|
||||
- targets: ["otel-collector:8889"]
|
||||
- job_name: otel-collector
|
||||
static_configs:
|
||||
- targets: ["otel-collector:8888"]
|
||||
- job_name: loki
|
||||
static_configs:
|
||||
- targets: ["loki:3100"]
|
||||
# bench-lean: begin
|
||||
# приём (байты, строки, структурированные метаданные), объём чанков,
|
||||
# отказы записи и отброшенное
|
||||
metric_relabel_configs:
|
||||
- source_labels: [__name__]
|
||||
action: keep
|
||||
regex: loki_distributor_(bytes|lines|structured_metadata_bytes)_received_total|loki_ingester_chunk_stored_bytes_total|loki_ingester_(chunks_flush_failures|wal_disk_full_failures)_total|loki_discarded_.*
|
||||
# bench-lean: end
|
||||
- job_name: tempo
|
||||
static_configs:
|
||||
- targets: ["tempo:3200"]
|
||||
# bench-lean: begin
|
||||
# приём (байты, span), приём live-store, его отказы и отброшенные span
|
||||
metric_relabel_configs:
|
||||
- source_labels: [__name__]
|
||||
action: keep
|
||||
regex: tempo_distributor_(bytes|spans)_received_total|tempo_live_store_bytes_received_total|tempo_live_store_.*failed.*|tempo_discarded_spans_total
|
||||
# bench-lean: end
|
||||
- job_name: prometheus
|
||||
static_configs:
|
||||
- targets: ["127.0.0.1:9090"]
|
||||
# bench-lean: begin
|
||||
# ряды и отсчёты головы, отказы правил, компакций и журнала предзаписи
|
||||
metric_relabel_configs:
|
||||
- source_labels: [__name__]
|
||||
action: keep
|
||||
regex: prometheus_tsdb_head_(series|samples_appended_total)|prometheus_rule_evaluation_failures_total|prometheus_tsdb_(compactions_failed|wal_corruptions)_total
|
||||
# bench-lean: end
|
||||
@@ -0,0 +1,59 @@
|
||||
# Слой Collector варианта `balanced` профиля цены телеметрии — предложенная
|
||||
# сбалансированная конфигурация (design change track1-telemetry-cost,
|
||||
# решение 5; спек observability, «Сбалансированная конфигурация телеметрии»).
|
||||
# SDK отправляет все трассы, решение — после завершения трассы, по правилам
|
||||
# этой системы; журнал и метрики не выбираются. Вместе с ним —
|
||||
# bench/otel/prometheus-lean.yml. Рабочий стенд остаётся со всеми трассами.
|
||||
#
|
||||
# Запуск — вторым `--config` после infra/otel/collector.yaml; слой меняет
|
||||
# только процессор выбора трасс и список процессоров pipeline трасс
|
||||
# (проверка run.py до стенда, решение 6). Если метка не подтвердит B1–B3,
|
||||
# правило правки — design, решение 12: один параметр на нарушение.
|
||||
processors:
|
||||
tail_sampling:
|
||||
# цепочка загрузки ниже насыщения — до ~3 с (relay раз в 0,25 с,
|
||||
# обработка 0,3–1 с, пакет SDK 1 с): запас втрое; память Collector
|
||||
# пропорциональна сроку
|
||||
decision_wait: 10s
|
||||
# ~250 трасс/с × 10 с = 2500: восьмикратный запас без роста карт
|
||||
num_traces: 20000
|
||||
expected_new_traces_per_sec: 300
|
||||
# поздние span сохранённой трассы (повтор, replay) остаются с ней;
|
||||
# поздние span несохранённой — заново через правила: ошибка worker после
|
||||
# решения по API сохраняется хотя бы частичной трассой
|
||||
decision_cache:
|
||||
sampled_cache_size: 100000
|
||||
non_sampled_cache_size: 0
|
||||
policies:
|
||||
# 5xx API, исключения, отказ хранилища в span
|
||||
- name: errors
|
||||
type: status_code
|
||||
status_code:
|
||||
status_codes: [ERROR]
|
||||
# неуспешный исход задания: у `failed` нет статуса ошибки span (исход, а
|
||||
# не исключение, otel-telemetry OT-11)
|
||||
- name: job-outcome
|
||||
type: string_attribute
|
||||
string_attribute:
|
||||
key: messenger.job.outcome
|
||||
values: [failed, retry, error, requeued, dropped]
|
||||
# порог SLO на запрос, а не на трассу: длительность трассы загрузки
|
||||
# больше 0,25 с у каждой загрузки; 5 с — больше пути обработки без
|
||||
# повторов (0,3–1 с)
|
||||
- name: slow-spans
|
||||
type: ottl_condition
|
||||
ottl_condition:
|
||||
error_mode: ignore
|
||||
span:
|
||||
- kind == SPAN_KIND_SERVER and end_time_unix_nano - start_time_unix_nano >= 250000000
|
||||
- kind == SPAN_KIND_CONSUMER and end_time_unix_nano - start_time_unix_nano >= 5000000000
|
||||
# остальные трассы — как вариант `head`
|
||||
- name: rest
|
||||
type: probabilistic
|
||||
probabilistic:
|
||||
sampling_percentage: 10
|
||||
|
||||
service:
|
||||
pipelines:
|
||||
traces:
|
||||
processors: [memory_limiter, tail_sampling, batch]
|
||||
@@ -0,0 +1,33 @@
|
||||
# Слой Collector варианта `tail` профиля цены телеметрии (design change
|
||||
# track1-telemetry-cost, решения 2 и 6): типовой tail sampling, каким его
|
||||
# включают по документации, — трассы со span в статусе ошибки, трассы не
|
||||
# короче 0,25 с (граница SLO задержки, slo-alerts SA-1) и 10 % остальных.
|
||||
# Остальное по умолчанию: decision_wait 30 с, num_traces 50 000, кэшей решений
|
||||
# нет. Только для стенда bench/: рабочий стенд — со всеми трассами (решение 5).
|
||||
#
|
||||
# Запуск — вторым `--config` после infra/otel/collector.yaml: карты сливаются,
|
||||
# списки заменяются. Слой меняет только процессор выбора трасс и список
|
||||
# процессоров pipeline трасс; это проверяет run.py до стенда (validate и
|
||||
# сравнение print-config со слоем и без него, решение 6).
|
||||
processors:
|
||||
tail_sampling:
|
||||
policies:
|
||||
- name: errors
|
||||
type: status_code
|
||||
status_code:
|
||||
status_codes: [ERROR]
|
||||
# длительность трассы целиком: у асинхронной цепочки загрузки
|
||||
# (API → relay → worker) она больше 0,25 с всегда
|
||||
- name: slow-traces
|
||||
type: latency
|
||||
latency:
|
||||
threshold_ms: 250
|
||||
- name: rest
|
||||
type: probabilistic
|
||||
probabilistic:
|
||||
sampling_percentage: 10
|
||||
|
||||
service:
|
||||
pipelines:
|
||||
traces:
|
||||
processors: [memory_limiter, tail_sampling, batch]
|
||||
+2666
File diff suppressed because it is too large
Load Diff
+1341
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,21 @@
|
||||
# Override профиля очереди (третий -f, только этот профиль; design change
|
||||
# track1-queue-overload, решение 10). Плагин метрик брокера и интервал
|
||||
# статистики в секунду: порт 15692 — только сеть стенда, порты брокера сброшены
|
||||
# в bench.compose.yml. Worker перезапускается, как на рабочем стенде: ядро может
|
||||
# завершить его процесс 1, когда конкуренция не помещается в лимит памяти, и без
|
||||
# перезапуска ячейка простояла бы до срока окна с ложными stuck. Пути — от
|
||||
# каталога первого файла compose (корень репозитория)
|
||||
services:
|
||||
rabbitmq:
|
||||
volumes:
|
||||
- type: bind
|
||||
source: ./bench/rabbitmq/enabled_plugins
|
||||
target: /etc/rabbitmq/enabled_plugins
|
||||
read_only: true
|
||||
- type: bind
|
||||
source: ./bench/rabbitmq/91-bench.conf
|
||||
target: /etc/rabbitmq/conf.d/91-bench.conf
|
||||
read_only: true
|
||||
|
||||
worker:
|
||||
restart: unless-stopped
|
||||
@@ -0,0 +1,2 @@
|
||||
# Профиль очереди: значения метрик свежие за секунду (проба: 4,7 мс CPU на опрос)
|
||||
collect_statistics_interval = 1000
|
||||
@@ -0,0 +1 @@
|
||||
[rabbitmq_prometheus].
|
||||
+2295
File diff suppressed because it is too large
Load Diff
+1246
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,676 @@
|
||||
"""Профиль поочерёдной замены реплик: разбор и расчёт без docker.
|
||||
|
||||
Оркестрирует прогон `run.py` (профили `rollout`, `rollout_quick`), здесь —
|
||||
чистые функции на stdlib: строки `scripts/rolling-update.sh`, события
|
||||
Docker проекта, журнал HAProxy, посекундная шкала с ответами старых и
|
||||
новых реплик, шаги по каждой заменённой реплике и `summary.md`. Строки
|
||||
k6 о запросах, отметки времени и перцентили — из `failover.py`. Все
|
||||
отметки — часы ВМ Docker. Решение 8 design change `rolling-update`.
|
||||
"""
|
||||
|
||||
import math
|
||||
import re
|
||||
from dataclasses import dataclass
|
||||
from typing import Any
|
||||
|
||||
import failover
|
||||
import resources as res
|
||||
|
||||
ROLLOUT_FIELDS = [
|
||||
"label",
|
||||
"from_commit",
|
||||
"replicas",
|
||||
"revision_before",
|
||||
"revision_after",
|
||||
"build_s",
|
||||
"migrate_s",
|
||||
"rollout_s",
|
||||
"script_exit",
|
||||
"requests",
|
||||
"errors_before",
|
||||
"codes_before",
|
||||
"errors_during",
|
||||
"codes_during",
|
||||
"errors_after",
|
||||
"codes_after",
|
||||
"min_success",
|
||||
"seconds_below",
|
||||
"ok_rps_before",
|
||||
"ok_rps_during_min",
|
||||
"p95_before_ms",
|
||||
"p95_during_max_ms",
|
||||
"first_new_s",
|
||||
"last_old_s",
|
||||
"old_after_drain",
|
||||
"writes",
|
||||
"writes_failed",
|
||||
"retried_ok",
|
||||
"write_chat_messages",
|
||||
"distinct_texts",
|
||||
"dropped_iterations",
|
||||
"flags",
|
||||
]
|
||||
REPLICA_FIELDS = [
|
||||
"step",
|
||||
"new_instance",
|
||||
"new_slot",
|
||||
"old_instance",
|
||||
"old_slot",
|
||||
"new_created_s",
|
||||
"new_up_s",
|
||||
"ready_s",
|
||||
"drain_s",
|
||||
"drain_timeout",
|
||||
"stop_s",
|
||||
"old_removed_s",
|
||||
"slot_ready_s",
|
||||
"replace_s",
|
||||
"errors",
|
||||
"after_drain",
|
||||
]
|
||||
TIMELINE_FIELDS = [
|
||||
"second",
|
||||
"writes_ok",
|
||||
"writes_failed",
|
||||
"reads_ok",
|
||||
"reads_failed",
|
||||
"codes",
|
||||
"success",
|
||||
"p50_ms",
|
||||
"p95_ms",
|
||||
"old_ok",
|
||||
"new_ok",
|
||||
"instances",
|
||||
]
|
||||
|
||||
SCRIPT_TAG = "rolling-update:"
|
||||
NEW_UP_RE = re.compile(
|
||||
r"replica (?P<n>\d+)/\d+: new (?P<id>[0-9a-f]{12}) addr (?P<addr>\S+) "
|
||||
r"slot (?P<slot>api-\d+) UP",
|
||||
)
|
||||
DRAIN_RE = re.compile(
|
||||
r"replica (?P<n>\d+)/\d+: drain old (?P<id>[0-9a-f]{12}) addr "
|
||||
r"(?P<addr>\S+) slot (?P<slot>api-\d+)",
|
||||
)
|
||||
DRAIN_TIMEOUT_RE = re.compile(r"replica (?P<n>\d+)/\d+: drain timeout")
|
||||
# запас на отметку отправки k6 против момента drain в журнале LB, с
|
||||
DRAIN_MARGIN_S = 0.2
|
||||
BUILD_RE = re.compile(r"build done in (\d+)s")
|
||||
MIGRATE_RE = re.compile(r"migrate done in (\d+)s")
|
||||
# состояния слота в журнале HAProxy: ручные (drain, maint, возврат из
|
||||
# maint) и по проверкам и DNS
|
||||
LB_STATES = (
|
||||
("enters drain state", "DRAIN"),
|
||||
("is going DOWN for maintenance (No IP", "DNS_MAINT"),
|
||||
("is going DOWN for maintenance", "MAINT"),
|
||||
("leaving forced maintenance", "READY"),
|
||||
("is UP", "UP"),
|
||||
("is DOWN", "DOWN"),
|
||||
)
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class ContainerEvent:
|
||||
"""Событие Docker контейнера проекта: время, действие, полный ID."""
|
||||
|
||||
time: float
|
||||
action: str
|
||||
id: str
|
||||
name: str
|
||||
signal: str
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class SlotEvent:
|
||||
time: float
|
||||
slot: str
|
||||
state: str
|
||||
|
||||
|
||||
def script_lines(text: str) -> str:
|
||||
"""Строки самого скрипта, без вывода сборки и миграции."""
|
||||
return "\n".join(line for line in text.splitlines() if SCRIPT_TAG in line)
|
||||
|
||||
|
||||
def script_error(text: str) -> str:
|
||||
"""Последняя строка ошибки скрипта — в сообщение об отказе."""
|
||||
errors = [
|
||||
line
|
||||
for line in text.splitlines()
|
||||
if SCRIPT_TAG in line and "error:" in line
|
||||
]
|
||||
return errors[-1].split(SCRIPT_TAG, 1)[1].strip() if errors else ""
|
||||
|
||||
|
||||
def parse_steps(text: str) -> list[dict[str, Any]]:
|
||||
"""Шаги замены из строк скрипта: новая и старая реплика, их слоты."""
|
||||
steps: dict[int, dict[str, Any]] = {}
|
||||
for line in text.splitlines():
|
||||
if match := NEW_UP_RE.search(line):
|
||||
step = steps.setdefault(int(match["n"]), {})
|
||||
step.update(
|
||||
new_id=match["id"],
|
||||
new_addr=match["addr"],
|
||||
new_slot=match["slot"],
|
||||
)
|
||||
elif match := DRAIN_RE.search(line):
|
||||
step = steps.setdefault(int(match["n"]), {})
|
||||
step.update(
|
||||
old_id=match["id"],
|
||||
old_addr=match["addr"],
|
||||
old_slot=match["slot"],
|
||||
)
|
||||
elif match := DRAIN_TIMEOUT_RE.search(line):
|
||||
steps.setdefault(int(match["n"]), {})["drain_timeout"] = True
|
||||
return [{"step": n, **steps[n]} for n in sorted(steps)]
|
||||
|
||||
|
||||
def seconds(pattern: re.Pattern[str], text: str) -> int | None:
|
||||
match = pattern.search(text)
|
||||
return int(match.group(1)) if match else None
|
||||
|
||||
|
||||
def parse_container_events(text: str) -> list[ContainerEvent]:
|
||||
"""`docker events` в формате `время|действие|ID|имя|сигнал`.
|
||||
|
||||
Действие exec содержит команду, поэтому поля берутся с краёв.
|
||||
"""
|
||||
events = []
|
||||
for line in text.splitlines():
|
||||
parts = line.split("|")
|
||||
if len(parts) < 5 or not parts[0].isdigit():
|
||||
continue
|
||||
events.append(
|
||||
ContainerEvent(
|
||||
time=int(parts[0]) / 1e9,
|
||||
action="|".join(parts[1:-3]),
|
||||
id=parts[-3],
|
||||
name=parts[-2],
|
||||
signal=parts[-1],
|
||||
),
|
||||
)
|
||||
return sorted(events, key=lambda e: e.time)
|
||||
|
||||
|
||||
def parse_slot_events(text: str) -> list[SlotEvent]:
|
||||
"""Смена состояния слотов из журнала LB (`docker logs -t`); повтор
|
||||
одной строки предупреждением в пределах миллисекунды отбрасывается."""
|
||||
events: list[SlotEvent] = []
|
||||
for line in text.splitlines():
|
||||
match = failover.LB_RE.match(line)
|
||||
if not match:
|
||||
continue
|
||||
state = next(
|
||||
(name for marker, name in LB_STATES if marker in match["rest"]),
|
||||
None,
|
||||
)
|
||||
if state is None:
|
||||
continue
|
||||
event = SlotEvent(
|
||||
failover.parse_stamp(match["stamp"]),
|
||||
match["slot"],
|
||||
state,
|
||||
)
|
||||
if any(
|
||||
e.slot == event.slot
|
||||
and e.state == event.state
|
||||
and abs(e.time - event.time) < 0.001
|
||||
for e in events
|
||||
):
|
||||
continue
|
||||
events.append(event)
|
||||
return sorted(events, key=lambda e: e.time)
|
||||
|
||||
|
||||
def container_event(
|
||||
events: list[ContainerEvent],
|
||||
short_id: str | None,
|
||||
action: str,
|
||||
since: float = 0.0,
|
||||
) -> ContainerEvent | None:
|
||||
if not short_id:
|
||||
return None
|
||||
return next(
|
||||
(
|
||||
e
|
||||
for e in events
|
||||
if e.id.startswith(short_id)
|
||||
and e.action == action
|
||||
and e.time >= since
|
||||
),
|
||||
None,
|
||||
)
|
||||
|
||||
|
||||
def slot_event(
|
||||
events: list[SlotEvent],
|
||||
slot: str | None,
|
||||
state: str,
|
||||
since: float | None,
|
||||
) -> SlotEvent | None:
|
||||
if slot is None or since is None:
|
||||
return None
|
||||
return next(
|
||||
(
|
||||
e
|
||||
for e in events
|
||||
if e.slot == slot and e.state == state and e.time >= since
|
||||
),
|
||||
None,
|
||||
)
|
||||
|
||||
|
||||
def start_time(events: list[ContainerEvent]) -> float | None:
|
||||
"""Начало изменения стенда: создание контейнера миграции, без него —
|
||||
первой новой реплики (миграции пропущены)."""
|
||||
# контейнер сервиса migrate (scripts/rolling-update.sh пересоздаёт его
|
||||
# на новом образе) или одноразовый migrate-run
|
||||
migrate = next(
|
||||
(e for e in events if e.action == "create" and "-migrate-" in e.name),
|
||||
None,
|
||||
)
|
||||
if migrate is not None:
|
||||
return migrate.time
|
||||
create = next((e for e in events if e.action == "create"), None)
|
||||
return create.time if create else None
|
||||
|
||||
|
||||
def script_start(
|
||||
events: list[ContainerEvent],
|
||||
since: float,
|
||||
ignore: frozenset[str] | set[str] = frozenset(),
|
||||
) -> float | None:
|
||||
"""Начало подготовки замены (решение 4 design change
|
||||
`profile-resources`): первое `exec_start` в контейнер проекта не
|
||||
раньше `since` (первого запроса) — первое обращение скрипта к LB.
|
||||
Оркестратор во время нагрузки `docker exec` не делает, k6 — вне
|
||||
проекта; `exec_start` проверок здоровья (`ignore` — их действия)
|
||||
отбрасываются (найдено в apply: они тоже приходят каждые 5 с)."""
|
||||
return next(
|
||||
(
|
||||
e.time
|
||||
for e in events
|
||||
if e.action.startswith("exec_start")
|
||||
and e.action not in ignore
|
||||
and e.time >= since
|
||||
),
|
||||
None,
|
||||
)
|
||||
|
||||
|
||||
def diff(later: Any, earlier: Any) -> float | None:
|
||||
if later is None or earlier is None:
|
||||
return None
|
||||
return round(later.time - earlier.time, 2)
|
||||
|
||||
|
||||
def since_t0(event: Any, t0: float) -> float | None:
|
||||
return None if event is None else round(event.time - t0, 2)
|
||||
|
||||
|
||||
def replica_rows(
|
||||
steps: list[dict[str, Any]],
|
||||
containers: list[ContainerEvent],
|
||||
slots: list[SlotEvent],
|
||||
requests: list[failover.Request],
|
||||
t0: float,
|
||||
) -> list[dict[str, Any]]:
|
||||
"""Шаги каждой замены: от создания новой до возврата слота старой."""
|
||||
rows = []
|
||||
for step in steps:
|
||||
created = container_event(containers, step.get("new_id"), "create")
|
||||
started = container_event(containers, step.get("new_id"), "start")
|
||||
up = slot_event(
|
||||
slots,
|
||||
step.get("new_slot"),
|
||||
"UP",
|
||||
started.time if started else None,
|
||||
)
|
||||
drain = slot_event(
|
||||
slots,
|
||||
step.get("old_slot"),
|
||||
"DRAIN",
|
||||
up.time if up else None,
|
||||
)
|
||||
maint = slot_event(
|
||||
slots,
|
||||
step.get("old_slot"),
|
||||
"MAINT",
|
||||
drain.time if drain else None,
|
||||
)
|
||||
kill = container_event(
|
||||
containers,
|
||||
step.get("old_id"),
|
||||
"kill",
|
||||
maint.time if maint else 0.0,
|
||||
)
|
||||
die = container_event(
|
||||
containers,
|
||||
step.get("old_id"),
|
||||
"die",
|
||||
kill.time if kill else 0.0,
|
||||
)
|
||||
destroy = container_event(containers, step.get("old_id"), "destroy")
|
||||
ready = slot_event(
|
||||
slots,
|
||||
step.get("old_slot"),
|
||||
"READY",
|
||||
destroy.time if destroy else None,
|
||||
)
|
||||
window = [
|
||||
r
|
||||
for r in requests
|
||||
if created is not None
|
||||
and destroy is not None
|
||||
and created.time <= r.start < destroy.time
|
||||
]
|
||||
# ответы старой реплики, отправленные после её вывода из LB: запрос
|
||||
# мог уйти до команды drain на доли миллисекунды раньше отметки k6,
|
||||
# поэтому запас DRAIN_MARGIN_S
|
||||
after_drain = [
|
||||
r
|
||||
for r in requests
|
||||
if drain is not None
|
||||
and r.instance == step.get("old_id")
|
||||
and r.start > drain.time + DRAIN_MARGIN_S
|
||||
]
|
||||
rows.append(
|
||||
{
|
||||
"step": step["step"],
|
||||
"new_instance": step.get("new_id"),
|
||||
"new_slot": step.get("new_slot"),
|
||||
"old_instance": step.get("old_id"),
|
||||
"old_slot": step.get("old_slot"),
|
||||
"new_created_s": since_t0(created, t0),
|
||||
"new_up_s": since_t0(up, t0),
|
||||
"ready_s": diff(up, started),
|
||||
"drain_s": diff(maint, drain),
|
||||
"drain_timeout": bool(step.get("drain_timeout")),
|
||||
"stop_s": diff(die, kill),
|
||||
"old_removed_s": since_t0(destroy, t0),
|
||||
"slot_ready_s": since_t0(ready, t0),
|
||||
"replace_s": diff(destroy, created),
|
||||
"errors": sum(1 for r in window if not r.ok),
|
||||
"after_drain": len(after_drain),
|
||||
},
|
||||
)
|
||||
return rows
|
||||
|
||||
|
||||
def build_timeline(
|
||||
requests: list[failover.Request],
|
||||
t0: float,
|
||||
old: set[str],
|
||||
new: set[str],
|
||||
) -> list[dict[str, Any]]:
|
||||
"""Посекундная шкала от начала замены; секунда — по отправке.
|
||||
|
||||
`old` и `new` — `X-Instance-Id` (12 символов) реплик до и после.
|
||||
"""
|
||||
buckets: dict[int, list[failover.Request]] = {}
|
||||
for request in requests:
|
||||
buckets.setdefault(math.floor(request.start - t0), []).append(request)
|
||||
rows = []
|
||||
for second in range(min(buckets, default=0), max(buckets, default=-1) + 1):
|
||||
group = buckets.get(second, [])
|
||||
ok = [r for r in group if r.ok]
|
||||
instances: dict[str, int] = {}
|
||||
for request in ok:
|
||||
instances[request.instance] = (
|
||||
instances.get(request.instance, 0) + 1
|
||||
)
|
||||
durations = [r.duration_ms for r in ok]
|
||||
rows.append(
|
||||
{
|
||||
"second": second,
|
||||
"writes_ok": sum(1 for r in ok if r.kind == "w"),
|
||||
"writes_failed": sum(
|
||||
1 for r in group if r.kind == "w" and not r.ok
|
||||
),
|
||||
"reads_ok": sum(1 for r in ok if r.kind == "r"),
|
||||
"reads_failed": sum(
|
||||
1 for r in group if r.kind == "r" and not r.ok
|
||||
),
|
||||
"codes": failover.codes(group),
|
||||
"success": round(len(ok) / len(group), 4) if group else None,
|
||||
"p50_ms": failover.percentile(durations, 0.5),
|
||||
"p95_ms": failover.percentile(durations, 0.95),
|
||||
"old_ok": sum(1 for r in ok if r.instance in old),
|
||||
"new_ok": sum(1 for r in ok if r.instance in new),
|
||||
"instances": " ".join(
|
||||
f"{key}:{value}"
|
||||
for key, value in sorted(instances.items())
|
||||
),
|
||||
},
|
||||
)
|
||||
return rows
|
||||
|
||||
|
||||
def analyze(
|
||||
requests: list[failover.Request],
|
||||
timeline: list[dict[str, Any]],
|
||||
replicas: list[dict[str, Any]],
|
||||
*,
|
||||
t0: float,
|
||||
end: float,
|
||||
old: set[str],
|
||||
new: set[str],
|
||||
threshold: float,
|
||||
) -> dict[str, Any]:
|
||||
"""Величины прогона: окна до, во время и после замены (решение 8)."""
|
||||
|
||||
def ended(request: failover.Request) -> float:
|
||||
return request.start + request.duration_ms / 1000
|
||||
|
||||
before = [r for r in requests if ended(r) < t0]
|
||||
during = [r for r in requests if ended(r) >= t0 and r.start < end]
|
||||
after = [r for r in requests if r.start >= end]
|
||||
window = math.ceil(end - t0)
|
||||
during_rows = [row for row in timeline if 0 <= row["second"] < window]
|
||||
before_rows = [row for row in timeline if row["second"] < 0][2:]
|
||||
# после вывода из LB старая реплика запросов получать не должна
|
||||
old_after_drain = sum(r["after_drain"] for r in replicas)
|
||||
new_ok = [r.start for r in requests if r.ok and r.instance in new]
|
||||
old_ok = [r.start for r in requests if r.ok and r.instance in old]
|
||||
p95_during = [
|
||||
row["p95_ms"] for row in during_rows if row["p95_ms"] is not None
|
||||
]
|
||||
flags = []
|
||||
if any(not r.ok for r in requests):
|
||||
flags.append("errors")
|
||||
if old_after_drain:
|
||||
flags.append("old_after_drain")
|
||||
return {
|
||||
"rollout_s": round(end - t0, 2),
|
||||
"requests": len(requests),
|
||||
"errors_before": sum(1 for r in before if not r.ok),
|
||||
"codes_before": failover.codes(before),
|
||||
"errors_during": sum(1 for r in during if not r.ok),
|
||||
"codes_during": failover.codes(during),
|
||||
"errors_after": sum(1 for r in after if not r.ok),
|
||||
"codes_after": failover.codes(after),
|
||||
"min_success": min(
|
||||
(
|
||||
row["success"]
|
||||
for row in during_rows
|
||||
if row["success"] is not None
|
||||
),
|
||||
default=None,
|
||||
),
|
||||
"seconds_below": sum(
|
||||
1
|
||||
for row in during_rows
|
||||
if row["success"] is not None and row["success"] < threshold
|
||||
),
|
||||
"ok_rps_before": (
|
||||
round(
|
||||
sum(row["writes_ok"] + row["reads_ok"] for row in before_rows)
|
||||
/ len(before_rows),
|
||||
1,
|
||||
)
|
||||
if before_rows
|
||||
else None
|
||||
),
|
||||
"ok_rps_during_min": min(
|
||||
(row["writes_ok"] + row["reads_ok"] for row in during_rows),
|
||||
default=None,
|
||||
),
|
||||
"p95_before_ms": failover.percentile(
|
||||
[r.duration_ms for r in before if r.ok],
|
||||
0.95,
|
||||
),
|
||||
"p95_during_max_ms": max(p95_during, default=None),
|
||||
"first_new_s": round(min(new_ok) - t0, 2) if new_ok else None,
|
||||
"last_old_s": round(max(old_ok) - t0, 2) if old_ok else None,
|
||||
"old_after_drain": old_after_drain,
|
||||
"writes": sum(1 for r in requests if r.kind == "w"),
|
||||
"writes_failed": sum(
|
||||
1 for r in requests if r.kind == "w" and not r.ok
|
||||
),
|
||||
"flags": " ".join(flags),
|
||||
}
|
||||
|
||||
|
||||
fmt = failover.fmt
|
||||
|
||||
|
||||
def render_summary(
|
||||
meta: dict[str, Any],
|
||||
row: dict[str, Any] | None,
|
||||
replicas: list[dict[str, Any]],
|
||||
timeline: list[dict[str, Any]],
|
||||
resources: list[dict[str, Any]] | None = None,
|
||||
) -> str:
|
||||
"""`summary.md` профиля замены: условия, итог, шаги по репликам,
|
||||
контейнеры до и после, шкала вокруг замены; с `resources` (строки
|
||||
`resources.csv`) — ещё ресурсы по окнам замены."""
|
||||
profile = meta["profile"]
|
||||
info = meta.get("rollout", {})
|
||||
lines = [
|
||||
f"# Поочерёдная замена реплик под нагрузкой: метка `{meta['label']}`",
|
||||
"",
|
||||
f"- Статус: **{meta['status']}**"
|
||||
+ (f" ({meta['reason']})" if meta.get("reason") else ""),
|
||||
f"- Commit: `{meta['git']['commit']}`"
|
||||
+ (" + незакоммиченные изменения" if meta["git"]["dirty"] else ""),
|
||||
f"- Профиль `{profile['name']}`: {profile['replicas']} реплики за "
|
||||
f"HAProxy; замена с образа commit `{info.get('from_commit')}` на "
|
||||
"образ текущего checkout (`scripts/rolling-update.sh`); "
|
||||
f"{profile['failover_write_rate']} записей с ключом и "
|
||||
f"{profile['failover_read_rate']} чтений страницы истории в "
|
||||
"секунду (k6, постоянная интенсивность); окна: "
|
||||
f"{profile['rollout_before_s']} с до запуска скрипта, бюджет "
|
||||
f"замены {profile['rollout_budget_s']} с, ещё "
|
||||
f"{profile['rollout_after_s']} с; порог доли успешных "
|
||||
f"{profile['failover_success']:.0%}",
|
||||
failover.limits_line(profile),
|
||||
"- Посторонние контейнеры в VM во время замера: "
|
||||
+ (", ".join(meta.get("other_containers") or []) or "нет"),
|
||||
"",
|
||||
"Время — секунды на часах ВМ Docker от начала замены (создание "
|
||||
"контейнера миграции). Шаги — события Docker (создание и старт "
|
||||
"новой реплики, SIGTERM, выход и удаление старой) и журнал HAProxy "
|
||||
"(`UP` новой, `drain` и `maint` старой, возврат слота в `ready`). "
|
||||
"Ответы — отметки k6 при отправке; «старые» и «новые» — по "
|
||||
"`X-Instance-Id` контейнеров до и после замены. Окно замены — от "
|
||||
"начала до удаления последней старой реплики. Сверка — после "
|
||||
"повтора неуспешных записей с тем же ключом: сообщений в чате "
|
||||
"записи и разных текстов столько, сколько отправлено ключей.",
|
||||
"",
|
||||
]
|
||||
if row:
|
||||
lines += [
|
||||
"| Замена, с | Сборка / миграция, с | Ревизия до → после | "
|
||||
"Ошибки до / во время / после | Мин. доля успешных | Секунд ниже "
|
||||
"порога | Успешных в секунду: до / мин. во время | p95: до / "
|
||||
"макс. во время, мс | Первый ответ новой / последний старой, с | "
|
||||
"Ответов старых после дренажа | Повтор записей | "
|
||||
"Сообщений = ключей | Пометки |",
|
||||
"|---|---|---|---|---|---|---|---|---|---|---|---|---|",
|
||||
f"| {fmt(row['rollout_s'])} | {fmt(row['build_s'])} / "
|
||||
f"{fmt(row['migrate_s'])} | `{fmt(row['revision_before'])}` → "
|
||||
f"`{fmt(row['revision_after'])}` | {row['errors_before']} / "
|
||||
f"{row['errors_during']}"
|
||||
+ (f" ({row['codes_during']})" if row["codes_during"] else "")
|
||||
+ f" / {row['errors_after']} | {fmt(row['min_success'])} | "
|
||||
f"{row['seconds_below']} | {fmt(row['ok_rps_before'])} / "
|
||||
f"{fmt(row['ok_rps_during_min'])} | {fmt(row['p95_before_ms'])} / "
|
||||
f"{fmt(row['p95_during_max_ms'])} | {fmt(row['first_new_s'])} / "
|
||||
f"{fmt(row['last_old_s'])} | {row['old_after_drain']} | "
|
||||
f"{row['writes_failed']} → {fmt(row['retried_ok'])} | "
|
||||
f"{fmt(row['write_chat_messages'])} = "
|
||||
f"{fmt(row['distinct_texts'])} | {fmt(row['flags'])} |",
|
||||
"",
|
||||
]
|
||||
if replicas:
|
||||
lines += [
|
||||
"## Шаги по репликам",
|
||||
"",
|
||||
"| Шаг | Новая (слот) | Старая (слот) | Новая создана, с | Новая "
|
||||
"`UP`, с | Старт → `UP`, с | Дренаж, с | Остановка, с | Старая "
|
||||
"удалена, с | Слот `ready`, с | Замена целиком, с | Ошибок за "
|
||||
"шаг | Ответов старой после дренажа |",
|
||||
"|---|---|---|---|---|---|---|---|---|---|---|---|---|",
|
||||
]
|
||||
for r in replicas:
|
||||
drain = fmt(r["drain_s"]) + (
|
||||
" (срок)" if r["drain_timeout"] else ""
|
||||
)
|
||||
lines.append(
|
||||
f"| {r['step']} | `{fmt(r['new_instance'])}` "
|
||||
f"({fmt(r['new_slot'])}) | `{fmt(r['old_instance'])}` "
|
||||
f"({fmt(r['old_slot'])}) | {fmt(r['new_created_s'])} | "
|
||||
f"{fmt(r['new_up_s'])} | {fmt(r['ready_s'])} | {drain} | "
|
||||
f"{fmt(r['stop_s'])} | {fmt(r['old_removed_s'])} | "
|
||||
f"{fmt(r['slot_ready_s'])} | {fmt(r['replace_s'])} | "
|
||||
f"{r['errors']} | {r['after_drain']} |",
|
||||
)
|
||||
lines.append("")
|
||||
if resources:
|
||||
lines += res.render_rollout(resources)
|
||||
for title, key in (
|
||||
("до", "containers_before"),
|
||||
("после", "containers_after"),
|
||||
):
|
||||
items = info.get(key) or []
|
||||
if not items:
|
||||
continue
|
||||
lines += [
|
||||
f"## Контейнеры `api` {title} замены",
|
||||
"",
|
||||
"| Контейнер | `X-Instance-Id` | Образ (тег) | Конфигурация образа |",
|
||||
"|---|---|---|---|",
|
||||
]
|
||||
lines += [
|
||||
f"| {c['name']} | `{c['instance']}` | `{c['tag']}` | "
|
||||
f"`{c['image'][:19]}…` |"
|
||||
for c in items
|
||||
]
|
||||
lines.append("")
|
||||
if timeline:
|
||||
end = math.ceil(row["rollout_s"]) if row else 0
|
||||
shown = [r for r in timeline if -3 <= r["second"] <= end + 3]
|
||||
lines += [
|
||||
"## Шкала вокруг замены",
|
||||
"",
|
||||
"Полная шкала — `timeline.csv`.",
|
||||
"",
|
||||
"| с от начала | Записи ok / ош | Чтения ok / ош | Коды ошибок | "
|
||||
"Доля успешных | p50 / p95, мс | Старые / новые ok | Ответы "
|
||||
"реплик |",
|
||||
"|---|---|---|---|---|---|---|---|",
|
||||
]
|
||||
for r in shown:
|
||||
lines.append(
|
||||
f"| {r['second']} | {r['writes_ok']} / {r['writes_failed']} | "
|
||||
f"{r['reads_ok']} / {r['reads_failed']} | {fmt(r['codes'])} | "
|
||||
f"{fmt(r['success'])} | {fmt(r['p50_ms'])} / "
|
||||
f"{fmt(r['p95_ms'])} | {r['old_ok']} / {r['new_ok']} | "
|
||||
f"{fmt(r['instances'])} |",
|
||||
)
|
||||
lines.append("")
|
||||
if meta.get("host_warnings"):
|
||||
lines += ["## Предупреждения о хосте", ""]
|
||||
lines += [f"- {w}" for w in meta["host_warnings"]]
|
||||
lines.append("")
|
||||
return "\n".join(lines)
|
||||
+10045
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,319 @@
|
||||
#!/usr/bin/env bash
|
||||
# Сэмплер стенда (решение 7 design change scaling-bench, решение 1 design
|
||||
# change profile-resources). Работает только внутри контейнера
|
||||
# mtusi-bench-sampler (образ PostgreSQL стенда, --cgroupns host), не на
|
||||
# хосте: его запускает bench/run.py (Stand.start_sampler). Раз в интервал
|
||||
# пишет в /work/samples.log строки с отметкой часов ВМ в наносекундах
|
||||
# (одна отметка на весь тик):
|
||||
# cg <нс> <роль> <id12> <usage_usec> <nr_periods> <nr_throttled>
|
||||
# <throttled_usec> <memory.current> <cpu.pressure some total>
|
||||
# cg <нс> <роль> <id12> missing — нет каталога cgroup
|
||||
# vm <нс> <занято jiffies> <всего jiffies> <PSI CPU some total, мкс>
|
||||
# lb <нс> # <заголовок CSV статистики HAProxy> / lb <нс> api,<строка>
|
||||
# lb <нс> missing — статистика недоступна
|
||||
# Режимы — по второму аргументу:
|
||||
# list (серии трека 1): <интервал, с> <роль>=<полный id контейнера>…
|
||||
# Сеть mtusi-bench. Строки cg заданных контейнеров, vm и lb; в фоне
|
||||
# psql с \watch пишет /work/pg-samples.log (одно соединение на всю
|
||||
# ячейку): act, db, wal, io — разбор в bench/scaling.py
|
||||
# (parse_samples).
|
||||
# scan (профили failover и rollout): <интервал, с> scan
|
||||
# Контейнер без сети. На каждом тике — обход /sys/fs/cgroup/docker/*/
|
||||
# (только каталоги с именем из 64 hex — контейнеры), строка
|
||||
# `cg <нс> - <id12> …` на каждый; роли назначает оркестратор. Строки
|
||||
# vm — как в list. Ни psql, ни опроса LB: наблюдатель не обращается к
|
||||
# стенду.
|
||||
# peak (профиль uploads, design change upload-memory, решение 10):
|
||||
# <интервал, с> peak <имя> <роль>=<полный id контейнера>…
|
||||
# Контейнер без сети, --user 0, cgroupfs на запись. perl открывает
|
||||
# memory.peak каждого контейнера на чтение и запись, пишет его прежнее
|
||||
# значение (`start <роль> <байт>`) и сбрасывает пик записью в свой
|
||||
# дескриптор (ядро ≥ 6.12): `reset <роль> ok|failed`. Раз в интервал —
|
||||
# `pk <нс> <роль> <id12> <memory.current> <anon> <sock> <oom_kill>`
|
||||
# (`anon`, `sock` — memory.stat, `oom_kill` — memory.events) или
|
||||
# `pk <нс> <роль> <id12> missing`. Появился /work/<имя>.stop — perl
|
||||
# читает пик через тот же дескриптор (`peak <роль> <байт>|missing`),
|
||||
# строка `end <нс>`, выход 0. Всё — в /work/<имя>.log.
|
||||
# queue (профиль очереди, design change track1-queue-overload, решение 10):
|
||||
# <интервал, с> queue <имя очереди>
|
||||
# Сеть mtusi-bench. Обход cgroup, как scan (`cg`), `vm`, `lb`; ещё `mp <нс>
|
||||
# <id12> <memory.peak> <anon> <oom_kill>` на контейнер и `mq <нс> <ready>
|
||||
# <unacked>` — метрики брокера HTTP/1.0 по /dev/tcp (брокер недоступен —
|
||||
# `mq <нс> missing`). В фоне psql с \watch пишет /work/jobs.log (одно
|
||||
# соединение): jobs|<мс>|outbox|waiting|published|processing|oldest_s|
|
||||
# staging_ready. Разбор — bench/overload.py.
|
||||
# cost (профиль цены телеметрии, design change track1-telemetry-cost,
|
||||
# решение 10): <интервал, с> cost
|
||||
# Контейнер без сети, как scan: строки `cg` всех контейнеров ВМ, `vm` и
|
||||
# `mp` каждого контейнера (memory.peak, anon, oom_kill), как у queue. Ни
|
||||
# psql, ни опроса LB и брокера. Разбор — bench/telemetry_cost.py.
|
||||
set -u
|
||||
|
||||
interval=$1
|
||||
shift
|
||||
mode=list
|
||||
if [[ ${1:-} == scan ]]; then
|
||||
mode=scan
|
||||
shift
|
||||
elif [[ ${1:-} == cost ]]; then
|
||||
mode=cost
|
||||
shift
|
||||
elif [[ ${1:-} == queue ]]; then
|
||||
mode=queue
|
||||
queue_name=$2
|
||||
shift 2
|
||||
elif [[ ${1:-} == peak ]]; then
|
||||
mode=peak
|
||||
name=$2
|
||||
shift 2
|
||||
fi
|
||||
roles=()
|
||||
ids=()
|
||||
for arg in "$@"; do
|
||||
roles+=("${arg%%=*}")
|
||||
ids+=("${arg#*=}")
|
||||
done
|
||||
|
||||
if [[ $mode == list ]]; then
|
||||
export PGPASSWORD="$POSTGRES_PASSWORD"
|
||||
psql "host=postgres user=$POSTGRES_USER dbname=$POSTGRES_DB \
|
||||
application_name=bench-sampler" -XAtq -F '|' >/work/pg-samples.log 2>&1 <<SQL &
|
||||
WITH t AS (
|
||||
SELECT (extract(epoch FROM clock_timestamp()) * 1000)::bigint AS ts
|
||||
)
|
||||
SELECT 'act', (SELECT ts FROM t), coalesce(host(client_addr), '-'),
|
||||
coalesce(state, '-'), coalesce(wait_event_type, 'CPU'),
|
||||
coalesce(wait_event, '-'), count(*)
|
||||
FROM pg_stat_activity
|
||||
WHERE backend_type = 'client backend' AND pid <> pg_backend_pid()
|
||||
GROUP BY 3, 4, 5, 6
|
||||
UNION ALL
|
||||
SELECT 'db', (SELECT ts FROM t), xact_commit::text, xact_rollback::text,
|
||||
sessions::text, sessions_fatal::text, numbackends::bigint
|
||||
FROM pg_stat_database WHERE datname = current_database()
|
||||
UNION ALL
|
||||
SELECT 'wal', (SELECT ts FROM t), wal_records::text, wal_fpi::text,
|
||||
wal_bytes::text, NULL, NULL
|
||||
FROM pg_stat_wal
|
||||
UNION ALL
|
||||
SELECT 'io', (SELECT ts FROM t), coalesce(sum(writes), 0)::text,
|
||||
coalesce(sum(fsyncs), 0)::text, NULL, NULL, NULL
|
||||
FROM pg_stat_io WHERE object = 'wal'
|
||||
\watch $interval
|
||||
SQL
|
||||
fi
|
||||
|
||||
if [[ $mode == queue ]]; then
|
||||
export PGPASSWORD="$POSTGRES_PASSWORD"
|
||||
psql "host=postgres user=$POSTGRES_USER dbname=$POSTGRES_DB \
|
||||
application_name=bench-sampler" -XAtq -F '|' >/work/jobs.log 2>&1 <<SQL &
|
||||
SELECT 'jobs', (extract(epoch FROM clock_timestamp()) * 1000)::bigint,
|
||||
count(*) FILTER (WHERE state = 'queued' AND published_at IS NULL
|
||||
AND coalesce(next_attempt_at, created_at) <= clock_timestamp()),
|
||||
count(*) FILTER (WHERE state = 'queued' AND published_at IS NULL
|
||||
AND coalesce(next_attempt_at, created_at) > clock_timestamp()),
|
||||
count(*) FILTER (WHERE state = 'queued' AND published_at IS NOT NULL),
|
||||
count(*) FILTER (WHERE state = 'processing'),
|
||||
coalesce(round(extract(epoch FROM clock_timestamp() - min(created_at))::numeric, 1), 0),
|
||||
(SELECT count(*) FROM attachments
|
||||
WHERE status = 'ready' AND staging_key IS NOT NULL)
|
||||
FROM attachment_jobs WHERE state IN ('queued', 'processing')
|
||||
\watch $interval
|
||||
SQL
|
||||
fi
|
||||
|
||||
if [[ $mode == peak ]]; then
|
||||
log=/work/$name.log
|
||||
stop=/work/$name.stop
|
||||
: >"$log"
|
||||
exec 4>>"$log"
|
||||
# пик через свой дескриптор: сброс и чтение — в одном процессе perl, bash
|
||||
# позиционировать дескриптор не умеет
|
||||
perl -e '
|
||||
use strict;
|
||||
my ($stop, @targets) = @ARGV;
|
||||
$| = 1;
|
||||
my %fh;
|
||||
for my $t (@targets) {
|
||||
my ($role, $id) = split /=/, $t, 2;
|
||||
my $path = "/sys/fs/cgroup/docker/$id/memory.peak";
|
||||
my $h;
|
||||
if (!open($h, "+<", $path)) {
|
||||
print "start $role missing\nreset $role failed open\n";
|
||||
next;
|
||||
}
|
||||
my $old = "";
|
||||
sysread($h, $old, 64);
|
||||
chomp $old;
|
||||
print "start $role ", ($old =~ /^\d+$/ ? $old : "missing"), "\n";
|
||||
sysseek($h, 0, 0);
|
||||
if (defined syswrite($h, "reset")) {
|
||||
print "reset $role ok\n";
|
||||
$fh{$role} = $h;
|
||||
} else {
|
||||
print "reset $role failed $!\n";
|
||||
}
|
||||
}
|
||||
select(undef, undef, undef, 0.05) until -e $stop;
|
||||
for my $role (sort keys %fh) {
|
||||
my $h = $fh{$role};
|
||||
my $value = "";
|
||||
if (sysseek($h, 0, 0) && sysread($h, $value, 64)) {
|
||||
chomp $value;
|
||||
}
|
||||
print "peak $role ", ($value =~ /^\d+$/ ? $value : "missing"), "\n";
|
||||
}
|
||||
' "$stop" "$@" >&4 &
|
||||
perl_pid=$!
|
||||
|
||||
pk_line() {
|
||||
local role=$1 id=$2 dir=/sys/fs/cgroup/docker/$2
|
||||
local key val mem= anon= sock= oom=
|
||||
{
|
||||
read -r mem <"$dir/memory.current"
|
||||
while read -r key val; do
|
||||
case $key in
|
||||
anon) anon=$val ;;
|
||||
sock) sock=$val ;;
|
||||
esac
|
||||
done <"$dir/memory.stat"
|
||||
while read -r key val; do
|
||||
[[ $key == oom_kill ]] && oom=$val
|
||||
done <"$dir/memory.events"
|
||||
} 2>/dev/null
|
||||
if [[ -z $mem || -z $anon || -z $sock || -z $oom ]]; then
|
||||
printf 'pk %s %s %s missing\n' "$ns" "$role" "${id:0:12}" >&4
|
||||
return
|
||||
fi
|
||||
printf 'pk %s %s %s %s %s %s %s\n' "$ns" "$role" "${id:0:12}" \
|
||||
"$mem" "$anon" "$sock" "$oom" >&4
|
||||
}
|
||||
|
||||
while [[ ! -e $stop ]]; do
|
||||
ns=${EPOCHREALTIME/./}000
|
||||
for i in "${!ids[@]}"; do
|
||||
pk_line "${roles[$i]}" "${ids[$i]}"
|
||||
done
|
||||
sleep "$interval"
|
||||
done
|
||||
wait "$perl_pid"
|
||||
printf 'end %s\n' "${EPOCHREALTIME/./}000" >&4
|
||||
exit 0
|
||||
fi
|
||||
|
||||
exec 4>>/work/samples.log
|
||||
|
||||
cg_line() {
|
||||
local role=$1 id=$2 dir=/sys/fs/cgroup/docker/$2
|
||||
local key val usage= periods=0 throttled=0 thr_usec=0 mem= psi=0 rest=
|
||||
if [[ ! -r $dir/cpu.stat ]]; then
|
||||
printf 'cg %s %s %s missing\n' "$ns" "$role" "${id:0:12}" >&4
|
||||
return
|
||||
fi
|
||||
# каталог может пропасть между проверкой и чтением (контейнер
|
||||
# остановлен посреди тика): тогда тоже missing, а не строка нулей
|
||||
{
|
||||
while read -r key val; do
|
||||
case $key in
|
||||
usage_usec) usage=$val ;;
|
||||
nr_periods) periods=$val ;;
|
||||
nr_throttled) throttled=$val ;;
|
||||
throttled_usec) thr_usec=$val ;;
|
||||
esac
|
||||
done <"$dir/cpu.stat"
|
||||
read -r mem <"$dir/memory.current"
|
||||
read -r _ _ _ _ rest <"$dir/cpu.pressure"
|
||||
} 2>/dev/null
|
||||
if [[ -z $usage || -z $mem ]]; then
|
||||
printf 'cg %s %s %s missing\n' "$ns" "$role" "${id:0:12}" >&4
|
||||
return
|
||||
fi
|
||||
psi=${rest#total=}
|
||||
printf 'cg %s %s %s %s %s %s %s %s %s\n' "$ns" "$role" "${id:0:12}" \
|
||||
"$usage" "$periods" "$throttled" "$thr_usec" "$mem" "$psi" >&4
|
||||
}
|
||||
|
||||
vm_line() {
|
||||
local _cpu user nice system idle iowait irq softirq steal rest total
|
||||
read -r _cpu user nice system idle iowait irq softirq steal rest </proc/stat
|
||||
total=$((user + nice + system + idle + iowait + irq + softirq + steal))
|
||||
read -r _ _ _ _ rest </proc/pressure/cpu
|
||||
printf 'vm %s %s %s %s\n' "$ns" "$((total - idle - iowait))" "$total" \
|
||||
"${rest#total=}" >&4
|
||||
}
|
||||
|
||||
lb_lines() {
|
||||
local line
|
||||
if ! exec 3<>/dev/tcp/haproxy/8404 2>/dev/null; then
|
||||
printf 'lb %s missing\n' "$ns" >&4
|
||||
return
|
||||
fi
|
||||
printf 'GET /stats;csv HTTP/1.0\r\n\r\n' >&3
|
||||
while IFS= read -r line; do
|
||||
line=${line%$'\r'}
|
||||
case $line in
|
||||
"# "* | api,*) printf 'lb %s %s\n' "$ns" "$line" >&4 ;;
|
||||
esac
|
||||
done <&3
|
||||
exec 3<&-
|
||||
}
|
||||
|
||||
mp_line() {
|
||||
local id=$1 dir=/sys/fs/cgroup/docker/$1
|
||||
local key val peak= anon= oom=
|
||||
{
|
||||
read -r peak <"$dir/memory.peak"
|
||||
while read -r key val; do
|
||||
[[ $key == anon ]] && { anon=$val; break; }
|
||||
done <"$dir/memory.stat"
|
||||
while read -r key val; do
|
||||
[[ $key == oom_kill ]] && oom=$val
|
||||
done <"$dir/memory.events"
|
||||
} 2>/dev/null
|
||||
[[ -n $peak && -n $anon && -n $oom ]] &&
|
||||
printf 'mp %s %s %s %s %s\n' "$ns" "${id:0:12}" "$peak" "$anon" "$oom" >&4
|
||||
}
|
||||
|
||||
mq_line() {
|
||||
local line ready= unacked=
|
||||
if ! exec 3<>/dev/tcp/rabbitmq/15692 2>/dev/null; then
|
||||
printf 'mq %s missing\n' "$ns" >&4
|
||||
return
|
||||
fi
|
||||
printf 'GET /metrics/detailed?vhost=%%2F&family=queue_coarse_metrics HTTP/1.0\r\nHost: x\r\n\r\n' >&3
|
||||
while IFS= read -r line; do
|
||||
line=${line%$'\r'}
|
||||
case $line in
|
||||
rabbitmq_detailed_queue_messages_ready\{*"$queue_name"*) ready=${line##* } ;;
|
||||
rabbitmq_detailed_queue_messages_unacked\{*"$queue_name"*) unacked=${line##* } ;;
|
||||
esac
|
||||
done <&3
|
||||
exec 3<&-
|
||||
# очередь ещё не объявлена — нули, а брокер отвечает
|
||||
printf 'mq %s %s %s\n' "$ns" "${ready:-0}" "${unacked:-0}" >&4
|
||||
}
|
||||
|
||||
hex64='^[0-9a-f]{64}$'
|
||||
|
||||
while :; do
|
||||
# EPOCHREALTIME bash 5 — часы ВМ без запуска date
|
||||
ns=${EPOCHREALTIME/./}000
|
||||
if [[ $mode == scan || $mode == queue || $mode == cost ]]; then
|
||||
for dir in /sys/fs/cgroup/docker/*/; do
|
||||
dir=${dir%/}
|
||||
id=${dir##*/}
|
||||
if [[ $id =~ $hex64 ]]; then
|
||||
cg_line - "$id"
|
||||
[[ $mode == queue || $mode == cost ]] && mp_line "$id"
|
||||
fi
|
||||
done
|
||||
else
|
||||
for i in "${!ids[@]}"; do
|
||||
cg_line "${roles[$i]}" "${ids[$i]}"
|
||||
done
|
||||
fi
|
||||
vm_line
|
||||
[[ $mode == list || $mode == queue ]] && lb_lines
|
||||
[[ $mode == queue ]] && mq_line
|
||||
sleep "$interval"
|
||||
done
|
||||
+1776
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,23 @@
|
||||
# Override включённой телеметрии стенда bench/ (design change
|
||||
# track1-telemetry-cost, решения 1 и 13): второй -f после bench.compose.yml —
|
||||
# у вариантов профиля цены телеметрии с телеметрией и у профилей загрузок и
|
||||
# очереди с TELEMETRY=on. SDK реплик, worker и relay включён и отправляет в
|
||||
# Collector стенда; доля выбора трасс, набор границ и интервал — значения по
|
||||
# умолчанию (рабочий стенд), вариант профиля задаёт их своим override
|
||||
# (.work/variant.compose.yml). Без этого файла телеметрия стенда выключена
|
||||
# (TELEMETRY__ENABLED: "false" в bench.compose.yml)
|
||||
services:
|
||||
api:
|
||||
environment:
|
||||
TELEMETRY__ENABLED: "true"
|
||||
TELEMETRY__OTLP_ENDPOINT: http://otel-collector:4318
|
||||
|
||||
worker:
|
||||
environment:
|
||||
TELEMETRY__ENABLED: "true"
|
||||
TELEMETRY__OTLP_ENDPOINT: http://otel-collector:4318
|
||||
|
||||
relay:
|
||||
environment:
|
||||
TELEMETRY__ENABLED: "true"
|
||||
TELEMETRY__OTLP_ENDPOINT: http://otel-collector:4318
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,640 @@
|
||||
"""Выборка из хранилищ телеметрии профиля цены телеметрии.
|
||||
|
||||
Design change `track1-telemetry-cost`, решение 9. Только в контейнере
|
||||
`mtusi-bench-lookup` на образе стенда, в сети хранилищ `mtusi-bench-telemetry`;
|
||||
только stdlib (`urllib`), `src` не импортирует, `bench/` — на чтение. Запросы
|
||||
— HTTP API Tempo, Loki, Prometheus и метрики Collector, пулом из восьми
|
||||
потоков; к Tempo — не больше трёх запросов одновременно.
|
||||
|
||||
python telemetry_lookup.py wait-ready [--timeout 90]
|
||||
python telemetry_lookup.py collect <события.json> <итог.json>
|
||||
|
||||
`wait-ready` — `/-/ready` Prometheus, `/ready` Loki и Tempo, `:8888/metrics`
|
||||
Collector; код 0 — все готовы, 1 — срок вышел. `collect` — по событиям прогона
|
||||
(id запросов редких классов, выборка нормальных, окна) ищет трассы по
|
||||
`span.messenger.request_id` (и цельные цепочки загрузок), записи журнала по
|
||||
`request_id` и их переход к трассе, счётчики Prometheus (приём, потери,
|
||||
события), ряды по `job`, `status/tsdb`, признаки слоёв Collector и
|
||||
Prometheus, квантили из buckets против журнала. Результат поиска, равный
|
||||
пределу числа результатов, — отказ «lookup truncated» (код 1): неполный счёт
|
||||
не выдаётся за полный.
|
||||
"""
|
||||
|
||||
import contextlib
|
||||
import json
|
||||
import math
|
||||
import sys
|
||||
import threading
|
||||
import time
|
||||
import urllib.error
|
||||
import urllib.parse
|
||||
import urllib.request
|
||||
from concurrent.futures import ThreadPoolExecutor
|
||||
from typing import Any
|
||||
|
||||
PROMETHEUS = "http://prometheus:9090"
|
||||
LOKI = "http://loki:3100"
|
||||
TEMPO = "http://tempo:3200"
|
||||
COLLECTOR = "http://otel-collector:8888"
|
||||
READY = (
|
||||
f"{PROMETHEUS}/-/ready",
|
||||
f"{LOKI}/ready",
|
||||
f"{TEMPO}/ready",
|
||||
f"{COLLECTOR}/metrics",
|
||||
)
|
||||
THREADS = 8
|
||||
# переходы журнал → трасса: потоков на класс (классы идут параллельно)
|
||||
LINK_THREADS = 2
|
||||
# одновременных запросов к Tempo (поиски классов и переходы журнал → трасса):
|
||||
# под восемью поисками и загрузками трасс сразу Tempo с лимитом рабочего
|
||||
# стенда (640m без swap) завершился посреди выборки metrics-r3 метки baseline
|
||||
# (design, «Уточнения apply», п. 16); выборка идёт после окон замера
|
||||
TEMPO_REQUESTS = 3
|
||||
TEMPO_GATE = threading.BoundedSemaphore(TEMPO_REQUESTS)
|
||||
TIMEOUT_S = 60
|
||||
ATTEMPTS = 4
|
||||
RETRY_PAUSE_S = 1.0
|
||||
# счётчики по краям окна: шаг — интервал scrape, взгляд назад — был ли ряд
|
||||
# до окна
|
||||
STEP_S = 15
|
||||
LOOKBACK_S = 60
|
||||
# id в одном поиске Tempo и Loki: регулярное выражение в query string
|
||||
BATCH = 40
|
||||
# предел результатов — не меньше 4 × ожидаемого (решение 9)
|
||||
LIMIT_FACTOR = 4
|
||||
API_SERVICE = "messenger-api"
|
||||
REQUEST_ATTR = "span.messenger.request_id"
|
||||
# у загрузки цепочка — server span API, span producer relay, consumer span
|
||||
# worker с итогом задания
|
||||
CHAIN_OUTCOME = {"upload": "ready", "upload_bad": "failed"}
|
||||
# имена Collector — без суффикса _total у собственных метрик (rule
|
||||
# telemetry.md); на всякий случай оба варианта
|
||||
TOTALS = {
|
||||
"sdk_span_started_sampled": (
|
||||
'sum(otel_sdk_span_started_total{otel_span_sampling_result='
|
||||
'"RECORD_AND_SAMPLE"})'
|
||||
),
|
||||
"sdk_span_started_dropped": (
|
||||
'sum(otel_sdk_span_started_total{otel_span_sampling_result="DROP"})'
|
||||
),
|
||||
"sdk_span_processed_ok": (
|
||||
'sum(otel_sdk_processor_span_processed_total{error_type=""})'
|
||||
),
|
||||
"sdk_span_processed_lost": (
|
||||
'sum(otel_sdk_processor_span_processed_total{error_type!=""})'
|
||||
),
|
||||
"sdk_span_exported_ok": (
|
||||
'sum(otel_sdk_exporter_span_exported_total{error_type=""})'
|
||||
),
|
||||
"sdk_span_export_failed": (
|
||||
'sum(otel_sdk_exporter_span_exported_total{error_type!=""})'
|
||||
),
|
||||
"sdk_log_processed_ok": (
|
||||
'sum(otel_sdk_processor_log_processed_total{error_type=""})'
|
||||
),
|
||||
"sdk_log_processed_lost": (
|
||||
'sum(otel_sdk_processor_log_processed_total{error_type!=""})'
|
||||
),
|
||||
"sdk_log_exported_ok": (
|
||||
'sum(otel_sdk_exporter_log_exported_total{error_type=""})'
|
||||
),
|
||||
"sdk_log_export_failed": (
|
||||
'sum(otel_sdk_exporter_log_exported_total{error_type!=""})'
|
||||
),
|
||||
"col_accepted_spans": "otelcol_receiver_accepted_spans",
|
||||
"col_refused_spans": "otelcol_receiver_refused_spans",
|
||||
"col_failed_spans": "otelcol_receiver_failed_spans",
|
||||
"col_accepted_logs": "otelcol_receiver_accepted_log_records",
|
||||
"col_refused_logs": "otelcol_receiver_refused_log_records",
|
||||
"col_failed_logs": "otelcol_receiver_failed_log_records",
|
||||
"col_accepted_points": "otelcol_receiver_accepted_metric_points",
|
||||
"col_refused_points": "otelcol_receiver_refused_metric_points",
|
||||
"col_sent_spans": "otelcol_exporter_sent_spans",
|
||||
"col_send_failed_spans": "otelcol_exporter_send_failed_spans",
|
||||
"col_enqueue_failed_spans": "otelcol_exporter_enqueue_failed_spans",
|
||||
"col_sent_logs": "otelcol_exporter_sent_log_records",
|
||||
"col_send_failed_logs": "otelcol_exporter_send_failed_log_records",
|
||||
"col_enqueue_failed_logs": "otelcol_exporter_enqueue_failed_log_records",
|
||||
"col_sent_points": "otelcol_exporter_sent_metric_points",
|
||||
"tail_sampled": (
|
||||
"otelcol_processor_tail_sampling_global_count_traces_sampled"
|
||||
'{sampled="true"}'
|
||||
),
|
||||
"tail_not_sampled": (
|
||||
"otelcol_processor_tail_sampling_global_count_traces_sampled"
|
||||
'{sampled="false"}'
|
||||
),
|
||||
"tail_dropped_too_early": (
|
||||
"otelcol_processor_tail_sampling_sampling_trace_dropped_too_early"
|
||||
),
|
||||
"tail_new_traces": (
|
||||
"otelcol_processor_tail_sampling_new_trace_id_received"
|
||||
),
|
||||
"tail_policy_errors": (
|
||||
"otelcol_processor_tail_sampling_sampling_policy_evaluation_error"
|
||||
),
|
||||
"tempo_spans": "sum(tempo_distributor_spans_received_total)",
|
||||
"tempo_bytes": "sum(tempo_distributor_bytes_received_total)",
|
||||
"loki_lines": "sum(loki_distributor_lines_received_total)",
|
||||
"loki_bytes": "sum(loki_distributor_bytes_received_total)",
|
||||
"loki_sm_bytes": (
|
||||
"sum(loki_distributor_structured_metadata_bytes_received_total)"
|
||||
),
|
||||
"prom_series": "max(prometheus_tsdb_head_series)",
|
||||
"prom_samples": "sum(prometheus_tsdb_head_samples_appended_total)",
|
||||
}
|
||||
# счётчики, приращение которых нужно за чистое окно (приём, решение 9)
|
||||
CLEAN = (
|
||||
"col_accepted_spans",
|
||||
"col_accepted_logs",
|
||||
"col_accepted_points",
|
||||
"tempo_spans",
|
||||
"tempo_bytes",
|
||||
"loki_lines",
|
||||
"loki_bytes",
|
||||
"loki_sm_bytes",
|
||||
"prom_samples",
|
||||
"prom_series",
|
||||
)
|
||||
GAUGES = frozenset({"prom_series"})
|
||||
CONTENT_ROUTE = "/api/v1/attachments/{attachment_id}/content"
|
||||
MESSAGES_ROUTE = "/api/v1/chats/{chat_id}/messages"
|
||||
HTTP_COUNT = "http_server_request_duration_seconds_count"
|
||||
HTTP_BUCKET = "http_server_request_duration_seconds_bucket"
|
||||
RARE_METRICS = {
|
||||
"broken": (
|
||||
f'sum({HTTP_COUNT}{{http_route="{CONTENT_ROUTE}",'
|
||||
'http_response_status_code="500"})'
|
||||
),
|
||||
"register": (
|
||||
f'sum({HTTP_COUNT}{{http_route="/api/v1/users",'
|
||||
'http_request_method="POST",http_response_status_code="201"})'
|
||||
),
|
||||
"write_slow": (
|
||||
f'sum({HTTP_COUNT}{{http_route="{MESSAGES_ROUTE}",'
|
||||
'http_request_method="POST"}) - '
|
||||
f'sum({HTTP_BUCKET}{{http_route="{MESSAGES_ROUTE}",'
|
||||
'http_request_method="POST",le="0.25"})'
|
||||
),
|
||||
"upload_bad": (
|
||||
'sum(messenger_job_duration_seconds_count{messenger_job_outcome='
|
||||
'"failed"})'
|
||||
),
|
||||
"upload": "sum(messenger_job_time_to_ready_seconds_count)",
|
||||
}
|
||||
QUANTILES = (0.95, 0.99)
|
||||
|
||||
|
||||
class TruncatedError(Exception):
|
||||
"""Поиск упёрся в предел числа результатов."""
|
||||
|
||||
|
||||
def collector_name(expr: str) -> str:
|
||||
"""Имя Collector с и без `_total`: `sum({__name__=~"имя(_total)?", …})`."""
|
||||
if expr.startswith(("sum(", "max(")):
|
||||
return expr
|
||||
name, _, labels = expr.partition("{")
|
||||
labels = labels.rstrip("}")
|
||||
matcher = f'__name__=~"{name}(_total)?"'
|
||||
if labels:
|
||||
matcher += f",{labels}"
|
||||
return f"sum({{{matcher}}})"
|
||||
|
||||
|
||||
def fetch(url: str) -> bytes:
|
||||
"""GET с повтором на обрыв соединения и 5xx: хранилище с 0,5 CPU под
|
||||
пулом запросов изредка закрывает соединение без ответа. 4xx — сразу.
|
||||
Запрос к Tempo ждёт места `TEMPO_GATE`; пауза повтора места не держит."""
|
||||
for attempt in range(1, ATTEMPTS + 1):
|
||||
gate = (
|
||||
TEMPO_GATE if url.startswith(TEMPO) else contextlib.nullcontext()
|
||||
)
|
||||
try:
|
||||
with (
|
||||
gate,
|
||||
urllib.request.urlopen(url, timeout=TIMEOUT_S) as response,
|
||||
):
|
||||
return response.read()
|
||||
except urllib.error.HTTPError as exc:
|
||||
if exc.code < 500 or attempt == ATTEMPTS:
|
||||
raise
|
||||
except (OSError, urllib.error.URLError):
|
||||
if attempt == ATTEMPTS:
|
||||
raise
|
||||
time.sleep(RETRY_PAUSE_S * attempt)
|
||||
raise AssertionError("unreachable")
|
||||
|
||||
|
||||
def get(url: str, params: dict[str, Any] | None = None) -> Any:
|
||||
if params:
|
||||
url = f"{url}?{urllib.parse.urlencode(params)}"
|
||||
body = fetch(url)
|
||||
return json.loads(body) if body[:1] in (b"{", b"[") else body
|
||||
|
||||
|
||||
def exists(url: str) -> bool:
|
||||
try:
|
||||
fetch(url)
|
||||
except urllib.error.HTTPError as exc:
|
||||
if exc.code == 404:
|
||||
return False
|
||||
raise
|
||||
return True
|
||||
|
||||
|
||||
def wait_ready(timeout: float) -> int:
|
||||
deadline = time.monotonic() + timeout
|
||||
pending = list(READY)
|
||||
while time.monotonic() < deadline:
|
||||
left = []
|
||||
for url in pending:
|
||||
try:
|
||||
with urllib.request.urlopen(url, timeout=3) as response:
|
||||
response.read()
|
||||
if response.status != 200:
|
||||
left.append(url)
|
||||
except (OSError, urllib.error.URLError):
|
||||
left.append(url)
|
||||
pending = left
|
||||
if not pending:
|
||||
print("telemetry storages ready", flush=True)
|
||||
return 0
|
||||
time.sleep(1)
|
||||
print(f"not ready in {timeout:.0f}s: {pending}", flush=True)
|
||||
return 1
|
||||
|
||||
|
||||
def batches(items: list[str]) -> list[list[str]]:
|
||||
return [items[i : i + BATCH] for i in range(0, len(items), BATCH)]
|
||||
|
||||
|
||||
def tempo_search(query: str, window: dict[str, float], expected: int) -> Any:
|
||||
limit = max(20, LIMIT_FACTOR * expected)
|
||||
data = get(
|
||||
f"{TEMPO}/api/search",
|
||||
{
|
||||
"q": query,
|
||||
"start": int(window["start"]),
|
||||
"end": int(window["end"]) + 1,
|
||||
"limit": limit,
|
||||
"spss": 10,
|
||||
},
|
||||
)
|
||||
traces = data.get("traces") or []
|
||||
if len(traces) >= limit:
|
||||
raise TruncatedError(
|
||||
f"lookup truncated: tempo {len(traces)} = {limit}",
|
||||
)
|
||||
return traces
|
||||
|
||||
|
||||
def request_ids_in(traces: list[dict[str, Any]]) -> set[str]:
|
||||
found = set()
|
||||
for item in traces:
|
||||
for spanset in item.get("spanSets") or [item.get("spanSet") or {}]:
|
||||
for span in spanset.get("spans") or []:
|
||||
for attr in span.get("attributes") or []:
|
||||
if attr.get("key") == "messenger.request_id":
|
||||
found.add(attr["value"].get("stringValue", ""))
|
||||
return found
|
||||
|
||||
|
||||
def traces_of(
|
||||
ids: list[str],
|
||||
window: dict[str, float],
|
||||
outcome: str | None = None,
|
||||
) -> set[str]:
|
||||
"""Id запросов, у которых в Tempo есть трасса (у `outcome` — цельная
|
||||
цепочка загрузки с consumer span этого итога и span producer)."""
|
||||
found: set[str] = set()
|
||||
for part in batches(ids):
|
||||
pattern = "|".join(part)
|
||||
query = f'{{ {REQUEST_ATTR} =~ "{pattern}" }}'
|
||||
if outcome is not None:
|
||||
query += (
|
||||
" && { kind = consumer && span.messenger.job.outcome = "
|
||||
f'"{outcome}" }} && {{ kind = producer }}'
|
||||
)
|
||||
query += f" | select({REQUEST_ATTR})"
|
||||
found |= request_ids_in(tempo_search(query, window, len(part)))
|
||||
return found & set(ids)
|
||||
|
||||
|
||||
def loki_records(
|
||||
ids: list[str],
|
||||
window: dict[str, float],
|
||||
) -> dict[str, dict[str, str]]:
|
||||
"""Запись доступа API по `request_id`: метки потока (поля записи)."""
|
||||
out: dict[str, dict[str, str]] = {}
|
||||
for part in batches(ids):
|
||||
limit = LIMIT_FACTOR * len(part) + 10
|
||||
query = (
|
||||
f'{{service_name="{API_SERVICE}"}} | middleware="http" | '
|
||||
f'request_id=~"{"|".join(part)}"'
|
||||
)
|
||||
data = get(
|
||||
f"{LOKI}/loki/api/v1/query_range",
|
||||
{
|
||||
"query": query,
|
||||
"start": int(window["start"] * 1e9),
|
||||
"end": int((window["end"] + 1) * 1e9),
|
||||
"limit": limit,
|
||||
"direction": "forward",
|
||||
},
|
||||
)
|
||||
streams = data["data"]["result"]
|
||||
lines = sum(len(stream["values"]) for stream in streams)
|
||||
if lines >= limit:
|
||||
raise TruncatedError(f"lookup truncated: loki {lines} = {limit}")
|
||||
for stream in streams:
|
||||
labels = stream["stream"]
|
||||
out[labels.get("request_id", "")] = labels
|
||||
return {key: value for key, value in out.items() if key in set(ids)}
|
||||
|
||||
|
||||
def trace_exists(trace_id: str) -> bool:
|
||||
"""Трасса есть и в ней есть span: на неизвестный id Tempo может ответить
|
||||
и пустым телом (пробный прогон `head` — 12 «найденных» трасс из 12
|
||||
невыбранных)."""
|
||||
try:
|
||||
body = fetch(f"{TEMPO}/api/v2/traces/{trace_id}")
|
||||
except urllib.error.HTTPError as exc:
|
||||
if exc.code == 404:
|
||||
return False
|
||||
raise
|
||||
if not body.strip():
|
||||
return False
|
||||
data = json.loads(body)
|
||||
trace = data.get("trace", data)
|
||||
return bool(trace.get("resourceSpans") or trace.get("batches"))
|
||||
|
||||
|
||||
def class_result(
|
||||
name: str,
|
||||
ids: list[str],
|
||||
window: dict[str, float],
|
||||
slow_ms: float,
|
||||
) -> dict[str, Any]:
|
||||
traced = traces_of(ids, window)
|
||||
chains = None
|
||||
if name in CHAIN_OUTCOME and ids:
|
||||
chains = len(traces_of(ids, window, CHAIN_OUTCOME[name]))
|
||||
records = loki_records(ids, window) if ids else {}
|
||||
with_trace = {
|
||||
rid: labels["trace_id"]
|
||||
for rid, labels in records.items()
|
||||
if labels.get("trace_id")
|
||||
}
|
||||
sampled = sum(
|
||||
1
|
||||
for labels in records.values()
|
||||
if labels.get("flags", "").isdigit() and int(labels["flags"]) & 1
|
||||
)
|
||||
# свой пул: задачи классов уже заняли потоки общего
|
||||
with ThreadPoolExecutor(LINK_THREADS) as links:
|
||||
linked_by = dict(
|
||||
zip(
|
||||
with_trace,
|
||||
links.map(trace_exists, with_trace.values()),
|
||||
strict=True,
|
||||
),
|
||||
)
|
||||
linked = sum(linked_by.values())
|
||||
# медленные по серверу: длительность записи доступа (та же величина, что
|
||||
# server span) не меньше порога; по ней решает правило выбора трасс
|
||||
server_slow = {
|
||||
rid
|
||||
for rid, labels in records.items()
|
||||
if float(labels.get("duration_ms") or 0) >= slow_ms
|
||||
}
|
||||
return {
|
||||
"ids": len(ids),
|
||||
"traces": len(traced),
|
||||
"server_slow": len(server_slow),
|
||||
"server_slow_traces": len(server_slow & traced),
|
||||
"server_slow_linked": sum(
|
||||
1 for rid in server_slow if linked_by.get(rid)
|
||||
),
|
||||
"chains": chains,
|
||||
"logs": len(records),
|
||||
"logs_with_trace": len(with_trace),
|
||||
"logs_sampled_flag": sampled,
|
||||
"log_to_trace": linked,
|
||||
"missing_traces": sorted(set(ids) - traced)[:5],
|
||||
}
|
||||
|
||||
|
||||
def prom_value(expr: str, at: float) -> float | None:
|
||||
data = get(f"{PROMETHEUS}/api/v1/query", {"query": expr, "time": at})
|
||||
result = data["data"]["result"]
|
||||
if not result:
|
||||
return None
|
||||
value = float(result[0]["value"][1])
|
||||
# histogram_quantile без отсчётов — NaN: в JSON это не число
|
||||
return None if math.isnan(value) else value
|
||||
|
||||
|
||||
def prom_delta(
|
||||
expr: str,
|
||||
start: float,
|
||||
end: float,
|
||||
*,
|
||||
gauge: bool,
|
||||
) -> dict[str, float | None]:
|
||||
"""Разность первого отсчёта не раньше начала окна и последнего не позже
|
||||
конца (шаг 15 с, решение 9); у gauge — последнее значение."""
|
||||
data = get(
|
||||
f"{PROMETHEUS}/api/v1/query_range",
|
||||
{
|
||||
"query": expr,
|
||||
"start": start - LOOKBACK_S,
|
||||
"end": end,
|
||||
"step": STEP_S,
|
||||
},
|
||||
)
|
||||
result = data["data"]["result"]
|
||||
if not result:
|
||||
return {"delta": None, "seconds": None, "last": None}
|
||||
series = [(float(t), float(v)) for t, v in result[0]["values"]]
|
||||
inside = [(t, v) for t, v in series if start <= t <= end]
|
||||
if not inside:
|
||||
return {"delta": None, "seconds": None, "last": None}
|
||||
t1, v1 = inside[-1]
|
||||
if gauge:
|
||||
return {"delta": None, "seconds": t1 - inside[0][0], "last": v1}
|
||||
# ряд счётчика, которого до окна не было (Tempo заводит его на первый
|
||||
# принятый span — у tail через срок решения), начинается с нуля: база —
|
||||
# ноль в начале окна, а не первый отсчёт внутри (иначе приёма «нет»)
|
||||
if any(t < start for t, _ in series) and len(inside) >= 2:
|
||||
t0, v0 = inside[0]
|
||||
else:
|
||||
t0, v0 = start, 0.0
|
||||
if t1 <= t0:
|
||||
return {"delta": None, "seconds": None, "last": v1}
|
||||
return {"delta": v1 - v0, "seconds": t1 - t0, "last": v1}
|
||||
|
||||
|
||||
def quantiles(
|
||||
method: str,
|
||||
route: str,
|
||||
window: dict[str, float],
|
||||
) -> dict[str, float | None]:
|
||||
seconds = max(1, int(window["end"] - window["start"]))
|
||||
out: dict[str, float | None] = {}
|
||||
for q in QUANTILES:
|
||||
key = f"p{int(q * 100)}"
|
||||
out[f"{key}_buckets"] = prom_value(
|
||||
f"histogram_quantile({q}, sum by (le) (increase({HTTP_BUCKET}"
|
||||
f'{{http_route="{route}",http_request_method="{method}"}}'
|
||||
f"[{seconds}s])))",
|
||||
window["end"],
|
||||
)
|
||||
data = get(
|
||||
f"{LOKI}/loki/api/v1/query",
|
||||
{
|
||||
"query": (
|
||||
f"quantile_over_time({q}, "
|
||||
f'{{service_name="{API_SERVICE}"}} | middleware="http" '
|
||||
f'| method="{method}" | path="{route}" '
|
||||
f"| unwrap duration_ms [{seconds}s]) by ()"
|
||||
),
|
||||
"time": int(window["end"] * 1e9),
|
||||
},
|
||||
)
|
||||
result = data["data"]["result"]
|
||||
value = float(result[0]["value"][1]) / 1000 if result else None
|
||||
out[f"{key}_log"] = (
|
||||
None if value is None or math.isnan(value) else value
|
||||
)
|
||||
return out
|
||||
|
||||
|
||||
def loki_counts(window: dict[str, float]) -> dict[str, int]:
|
||||
seconds = max(1, int(window["end"] - window["start"]))
|
||||
data = get(
|
||||
f"{LOKI}/loki/api/v1/query",
|
||||
{
|
||||
"query": (
|
||||
"sum by (method, path) (count_over_time("
|
||||
f'{{service_name="{API_SERVICE}"}} | middleware="http" '
|
||||
f"[{seconds}s]))"
|
||||
),
|
||||
"time": int(window["end"] * 1e9),
|
||||
},
|
||||
)
|
||||
return {
|
||||
f"{item['metric'].get('method', '')} {item['metric'].get('path', '')}": (
|
||||
int(float(item["value"][1]))
|
||||
)
|
||||
for item in data["data"]["result"]
|
||||
}
|
||||
|
||||
|
||||
def collect(events: dict[str, Any]) -> dict[str, Any]:
|
||||
started = time.monotonic()
|
||||
search = events["search"]
|
||||
run = events["run"]
|
||||
clean = events["clean"]
|
||||
out: dict[str, Any] = {"classes": {}}
|
||||
with ThreadPoolExecutor(THREADS) as pool:
|
||||
futures = {
|
||||
name: pool.submit(
|
||||
class_result,
|
||||
name,
|
||||
ids,
|
||||
search,
|
||||
float(events.get("slow_ms", 250)),
|
||||
)
|
||||
for name, ids in events["classes"].items()
|
||||
}
|
||||
sample = events.get("sample_me") or []
|
||||
sample_future = pool.submit(traces_of, sample, search)
|
||||
for name, future in futures.items():
|
||||
out["classes"][name] = future.result()
|
||||
out["sample_me"] = {
|
||||
"ids": len(sample),
|
||||
"traces": len(sample_future.result()),
|
||||
}
|
||||
at = search["end"]
|
||||
names = list(TOTALS)
|
||||
values = pool.map(
|
||||
lambda key: prom_value(collector_name(TOTALS[key]), at),
|
||||
names,
|
||||
)
|
||||
out["totals"] = dict(zip(names, values, strict=True))
|
||||
rare = list(RARE_METRICS)
|
||||
out["rare_metrics"] = dict(
|
||||
zip(
|
||||
rare,
|
||||
pool.map(lambda key: prom_value(RARE_METRICS[key], at), rare),
|
||||
strict=True,
|
||||
),
|
||||
)
|
||||
out["clean"] = dict(
|
||||
zip(
|
||||
CLEAN,
|
||||
pool.map(
|
||||
lambda key: prom_delta(
|
||||
collector_name(TOTALS[key]),
|
||||
clean["start"],
|
||||
clean["end"],
|
||||
gauge=key in GAUGES,
|
||||
),
|
||||
CLEAN,
|
||||
),
|
||||
strict=True,
|
||||
),
|
||||
)
|
||||
out["quantiles"] = {
|
||||
name: quantiles(method, route, clean)
|
||||
for name, (method, route) in events["routes"].items()
|
||||
}
|
||||
out["loki_counts"] = loki_counts(run)
|
||||
jobs = get(
|
||||
f"{PROMETHEUS}/api/v1/query",
|
||||
{"query": 'count by (job) ({__name__=~".+"})', "time": at},
|
||||
)
|
||||
out["series_by_job"] = {
|
||||
item["metric"].get("job", ""): int(float(item["value"][1]))
|
||||
for item in jobs["data"]["result"]
|
||||
}
|
||||
tsdb = get(f"{PROMETHEUS}/api/v1/status/tsdb")["data"]
|
||||
out["tsdb"] = {
|
||||
"num_series": tsdb.get("headStats", {}).get("numSeries"),
|
||||
"top_metrics": tsdb.get("seriesCountByMetricName", [])[:10],
|
||||
}
|
||||
config = get(f"{PROMETHEUS}/api/v1/status/config")["data"]["yaml"]
|
||||
tail = prom_value(
|
||||
'count({__name__=~"otelcol_processor_tail_sampling_.*"})',
|
||||
at,
|
||||
)
|
||||
out["layers"] = {
|
||||
"tail_sampling": bool(tail),
|
||||
"lean_prometheus": "loki_distributor_" in config,
|
||||
}
|
||||
out["seconds"] = round(time.monotonic() - started, 1)
|
||||
return out
|
||||
|
||||
|
||||
def main(argv: list[str]) -> int:
|
||||
if argv[:1] == ["wait-ready"]:
|
||||
timeout = float(argv[2]) if argv[1:2] == ["--timeout"] else 90.0
|
||||
return wait_ready(timeout)
|
||||
if argv[:1] == ["collect"] and len(argv) == 3:
|
||||
with open(argv[1], encoding="utf-8") as file:
|
||||
events = json.load(file)
|
||||
try:
|
||||
result = collect(events)
|
||||
except TruncatedError as exc:
|
||||
print(str(exc), flush=True)
|
||||
return 1
|
||||
with open(argv[2], "w", encoding="utf-8") as file:
|
||||
json.dump(result, file, ensure_ascii=False, indent=1)
|
||||
print(f"lookup done in {result['seconds']}s", flush=True)
|
||||
return 0
|
||||
print(__doc__, flush=True)
|
||||
return 2
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main(sys.argv[1:]))
|
||||
+1167
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,213 @@
|
||||
# Шаблон config.toml: `make env_setup` копирует его, не перезаписывая
|
||||
# существующий файл. Приоритет: окружение > .env > config.toml >
|
||||
# значения по умолчанию. Любой параметр можно задать и через
|
||||
# окружение: SECTION__FIELD, например APP__LOG_LEVEL.
|
||||
|
||||
[app]
|
||||
# Режим (console / docker) задают Makefile, Dockerfile и compose через
|
||||
# APP__RUN_MODE, а порт — APP__PORT в .env; здесь их не указывать.
|
||||
log_level = "INFO"
|
||||
# сколько секунд uvicorn ждёт текущие запросы после SIGTERM
|
||||
graceful_shutdown_seconds = 8
|
||||
# сколько секунд uvicorn держит простаивающее keep-alive соединение;
|
||||
# больше, чем HAProxy держит простаивающее соединение с репликой (timeout
|
||||
# http-keep-alive 10 с, http-reuse never в infra/haproxy/haproxy.cfg):
|
||||
# простаивающее соединение закрывает LB
|
||||
keep_alive_seconds = 60
|
||||
# instance_id (X-Instance-Id) здесь не задавать: config.toml общий у всех
|
||||
# реплик, а значение должно различаться. Без него берётся hostname
|
||||
# процесса (в compose — короткий ID контейнера); в консоли его можно
|
||||
# заменить окружением APP__INSTANCE_ID.
|
||||
|
||||
[database]
|
||||
# Адрес, порт, пользователь, пароль и имя базы приходят из .env (мосты к
|
||||
# POSTGRES_*) и из environment compose; здесь их не указывать.
|
||||
pool_size = 10
|
||||
# 0 — без переполнения: соединения сверх pool_size переоткрывались бы
|
||||
max_overflow = 0
|
||||
# секунды ожидания свободного соединения пула
|
||||
pool_timeout_seconds = 5
|
||||
# секунды на установку соединения
|
||||
connect_timeout_seconds = 3
|
||||
# миллисекунды, серверный statement_timeout; 0 — без ограничения
|
||||
statement_timeout_ms = 5000
|
||||
# секунды на всю работу запроса с БД: зависший сервер, обрыв сети
|
||||
request_timeout_seconds = 6
|
||||
# миллисекунды, серверный idle_in_transaction_session_timeout: транзакцию
|
||||
# замороженной реплики PostgreSQL прерывает и снимает её блокировки.
|
||||
# 0 — без ограничения, иначе больше request_timeout_seconds
|
||||
idle_in_transaction_timeout_ms = 10000
|
||||
|
||||
[auth]
|
||||
# секунды жизни сессии с момента входа (контрактное имя
|
||||
# SESSION_TTL_SECONDS); короткий срок для проверки истечения — окружением
|
||||
# AUTH__SESSION_TTL_SECONDS=2
|
||||
session_ttl_seconds = 3600
|
||||
# сколько хэшей пароля Argon2id считается одновременно: 64 MiB на каждый
|
||||
kdf_concurrency = 4
|
||||
|
||||
[cache]
|
||||
# Адрес, порт и пароль Valkey приходят из .env (мосты к VALKEY_*) и из
|
||||
# environment compose; здесь их не указывать.
|
||||
# секунды на всю команду Valkey (ожидание пула, соединение, ответ);
|
||||
# дольше — запрос идёт в PostgreSQL
|
||||
timeout_seconds = 0.2
|
||||
# секунды, на которые кэш пропускается после отказа Valkey
|
||||
retry_after_seconds = 5
|
||||
# секунды жизни карточки чата в кэше
|
||||
chat_ttl_seconds = 3600
|
||||
# соединений в пуле клиента Valkey
|
||||
max_connections = 10
|
||||
|
||||
[s3]
|
||||
# Адрес, порт, bucket и ключи пользователя API приходят из .env (мосты к
|
||||
# S3_OUT_PORT и S3_API_*, S3__BUCKET) и из environment compose; здесь их
|
||||
# не указывать.
|
||||
# регион подписи SigV4; SeaweedFS берёт его из запроса
|
||||
region = "us-east-1"
|
||||
# секунды на установку соединения с S3
|
||||
connect_timeout_seconds = 1
|
||||
# секунды на весь вызов S3; меньше timeout server HAProxy (10 с)
|
||||
timeout_seconds = 5
|
||||
# соединений в пуле клиента S3 на процесс
|
||||
max_connections = 10
|
||||
|
||||
[idempotency]
|
||||
# секунды, в течение которых повтор POST сообщения с тем же
|
||||
# Idempotency-Key возвращает исходный результат (имя skeleton
|
||||
# IDEMPOTENCY_TTL_SECONDS); контракт требует не меньше 86400 — 24 ч.
|
||||
# Короткий срок для проверки — окружением IDEMPOTENCY__TTL_SECONDS=2
|
||||
ttl_seconds = 86400
|
||||
|
||||
[uploads]
|
||||
# Места загрузок вложений процесса API; разовая подмена — окружением
|
||||
# UPLOADS__*. Память загрузок ограничена числом мест, а не клиентов.
|
||||
# загрузок, которые процесс обрабатывает одновременно
|
||||
max_concurrent = 4
|
||||
# загрузок, которые ждут места; 0 — без ожидания, сразу 429
|
||||
max_waiting = 16
|
||||
# секунды ожидания места, затем 429 rate_limited с Retry-After; вход,
|
||||
# членство и ожидание (2 × 6 + 5 = 17 с) меньше timeout server LB пути
|
||||
# загрузки (30 с). Проверки при старте нет: больше 18 с — 504 от LB
|
||||
# вместо 429
|
||||
wait_timeout_seconds = 5
|
||||
# секунды на всё тело с момента, как загрузка заняла место; иначе 400
|
||||
body_timeout_seconds = 30
|
||||
# незавершённых заданий стенда (queued и processing), при которых загрузка
|
||||
# сразу получает 429 rate_limited с Retry-After: 5; 0 — без предела. Срок
|
||||
# ожидания = предел / потолок worker; при другом числе worker предел другой
|
||||
max_unfinished_jobs = 250
|
||||
|
||||
[cleaner]
|
||||
# Уборщик незавершённых загрузок (сервис compose cleaner); реплики API
|
||||
# секцию не читают. Разовая подмена — окружением CLEANER__*.
|
||||
# секунды между проходами
|
||||
interval_seconds = 60
|
||||
# секунды: строку pending моложе уборщик не трогает (grace period).
|
||||
# Должно быть больше 2 × [database] request_timeout_seconds +
|
||||
# [s3] timeout_seconds (17 с), иначе уборщик не стартует
|
||||
pending_grace_seconds = 900
|
||||
# строк pending или вложений со staging в одной выборке кандидатов
|
||||
batch_size = 100
|
||||
# секунды хранения объекта staging вложения failed и объекта staging без
|
||||
# метаданных; у ready staging убирается следующим проходом
|
||||
staging_retention_seconds = 86400
|
||||
|
||||
[reconciler]
|
||||
# Сверка bucket и БД процессом уборщика: плановая в сервисе cleaner и
|
||||
# разовая — make reconcile. Grace — [cleaner] pending_grace_seconds.
|
||||
# Разовая подмена — окружением RECONCILER__*.
|
||||
# секунды между плановыми сверками; 0 — без плановой сверки
|
||||
interval_seconds = 3600
|
||||
# ключей на страницу списка S3 и строк на запрос к PostgreSQL, 1–1000
|
||||
page_size = 1000
|
||||
# предел изменений за проход: больше — ни одного изменения и код 3;
|
||||
# разовый проход принимает больший аргументом --max-changes
|
||||
max_changes = 100
|
||||
# предел скорости прохода: объектов S3 в секунду (ключи страниц списка,
|
||||
# HEAD, GET, DELETE) в среднем от начала прохода; 0 — без предела;
|
||||
# разовый проход принимает другой аргументом --max-objects-per-second
|
||||
max_objects_per_second = 2000
|
||||
|
||||
[broker]
|
||||
# Адрес, порт, пользователь и пароль RabbitMQ приходят из .env (мосты к
|
||||
# RABBITMQ_*) и из environment compose; здесь их не указывать.
|
||||
# секунды на установку соединения с брокером
|
||||
connect_timeout_seconds = 2
|
||||
# секунды на публикацию пакета заданий relay целиком: соединение, канал,
|
||||
# публикация и подтверждения; меньше срока шага с БД: блокировки строк
|
||||
# держатся не дольше него
|
||||
publish_timeout_seconds = 2
|
||||
|
||||
[worker]
|
||||
# Worker обработки вложений (сервис compose worker); реплики API и relay
|
||||
# секцию не читают. Разовая подмена — окружением WORKER__*.
|
||||
# заданий, которые worker обрабатывает одновременно (лимит памяти
|
||||
# контейнера — на эту конкуренцию)
|
||||
concurrency = 2
|
||||
# неподтверждённых сообщений, которые выдаёт брокер
|
||||
prefetch = 2
|
||||
# попыток у задания с последнего replay, включая первую
|
||||
max_attempts = 5
|
||||
# секунды на одну попытку
|
||||
job_timeout_seconds = 60
|
||||
# секунды запаса аренды сверх срока попытки
|
||||
lease_margin_seconds = 10
|
||||
# секунды, основа паузы перед следующей попыткой: случайно из [d / 2, d],
|
||||
# d = min(предел, основа × 2^(N − 1))
|
||||
retry_base_delay_seconds = 5
|
||||
# секунды, предел паузы; не меньше основы
|
||||
retry_max_delay_seconds = 300
|
||||
# секунды жизни процесса обработки; меньше срока попытки
|
||||
render_timeout_seconds = 40
|
||||
# секунды CPU процесса обработки, целое
|
||||
render_cpu_limit_seconds = 15
|
||||
# МиБ адресного пространства процесса обработки, целое
|
||||
render_memory_limit_mib = 450
|
||||
# секунды, которые worker ждёт начатые задания после SIGTERM, не больше 8
|
||||
graceful_shutdown_seconds = 8
|
||||
# секунды паузы между попытками соединиться с брокером и перед возвратом
|
||||
# сообщения при отказе PostgreSQL
|
||||
reconnect_seconds = 2
|
||||
|
||||
[relay]
|
||||
# Relay публикации заданий (сервис compose relay); реплики API и worker секцию
|
||||
# не читают. Разовая подмена — окружением RELAY__*.
|
||||
# секунды паузы между проходами, когда публиковать нечего
|
||||
poll_interval_seconds = 0.25
|
||||
# заданий за один проход
|
||||
batch_size = 100
|
||||
# предел опубликованных и не взятых заданий; 0 — без предела
|
||||
max_published_backlog = 1000
|
||||
# секунды: отмеченное задание старше может считаться потерянным, если в
|
||||
# очереди нет готовых сообщений
|
||||
republish_after_seconds = 300
|
||||
# секунды паузы после отказа брокера или PostgreSQL
|
||||
failure_pause_seconds = 2
|
||||
|
||||
[telemetry]
|
||||
# Телеметрия API, worker и relay (OpenTelemetry SDK → Collector). Включение и
|
||||
# адрес Collector здесь не задаются: файл монтируется и в консольный запуск, а
|
||||
# телеметрию включает compose у api, worker и relay (TELEMETRY__ENABLED,
|
||||
# TELEMETRY__OTLP_ENDPOINT). Уборщик, миграции и команда replay секцию не
|
||||
# применяют. Переменные OTEL_* настройками не являются.
|
||||
# deployment.environment.name ресурса
|
||||
environment = "lab"
|
||||
# доля корней трасс, выбранных в голове по trace_id: 0…1, 1 — все трассы;
|
||||
# span с родителем (в том числе worker из задания) следует его флагу, журнал и
|
||||
# метрики не выбираются (OTEL_TRACES_SAMPLER_ARG skeleton)
|
||||
trace_sample_ratio = 1.0
|
||||
# набор границ histogram: "default" или "coarse" (меньше границ, те же
|
||||
# границы SLO 0,25 с и 30 с)
|
||||
metric_buckets = "default"
|
||||
# секунды между отправками метрик; не больше 30 — половины срока рядов
|
||||
# экспортёра Collector
|
||||
metric_export_interval_seconds = 15
|
||||
# секунды на одну отправку пакета
|
||||
export_timeout_seconds = 2
|
||||
# span и записей журнала в очереди SDK; сверх — теряются
|
||||
max_queue_size = 2048
|
||||
# span и записей в одной отправке; не больше очереди
|
||||
max_export_batch_size = 512
|
||||
# секунды паузы между пакетами
|
||||
schedule_delay_seconds = 1
|
||||
@@ -0,0 +1,781 @@
|
||||
# Стенд лабы 6: HAProxy — единственная точка входа, за ним API ×
|
||||
# API_REPLICAS; PostgreSQL, Valkey (кэш), S3 (SeaweedFS, байты вложений),
|
||||
# RabbitMQ (задания обработки), одноразовые миграции и bootstrap S3, уборщик
|
||||
# незавершённых загрузок, relay публикации заданий, worker обработки вложений;
|
||||
# с лабы 6 — OTel Collector, Prometheus, Loki, Tempo и Grafana (сеть
|
||||
# telemetry). Правила — .claude/rules/docker.md, balancer.md и telemetry.md. Значения — из .env
|
||||
# (шаблон .env.example); литералы только у адреса публикации 127.0.0.1 и
|
||||
# у режима docker. Имя проекта меняется в каждой лабе: от него зависят
|
||||
# имена volumes, и стенд не должен подключаться к данным прошлой лабы.
|
||||
name: mtusi-lab6
|
||||
|
||||
# окружение по сервисам: секреты получают только те, кому они нужны.
|
||||
# PostgreSQL — api, cleaner, relay, worker и migrate
|
||||
x-db-env: &db-env
|
||||
APP__RUN_MODE: docker
|
||||
DATABASE__HOST: ${POSTGRES_HOST:-postgres}
|
||||
DATABASE__PORT: ${POSTGRES_PORT:-5432}
|
||||
DATABASE__USER: ${POSTGRES_USER:?POSTGRES_USER is not set, run make env_setup}
|
||||
DATABASE__PASSWORD: ${POSTGRES_PASSWORD:?POSTGRES_PASSWORD is empty, run make env_setup}
|
||||
DATABASE__NAME: ${POSTGRES_DB:?POSTGRES_DB is not set, run make env_setup}
|
||||
|
||||
# Valkey — только api
|
||||
x-cache-env: &cache-env
|
||||
CACHE__HOST: ${VALKEY_HOST:-valkey}
|
||||
CACHE__PORT: ${VALKEY_PORT:-6379}
|
||||
CACHE__PASSWORD: ${VALKEY_PASSWORD:?VALKEY_PASSWORD is empty, copy Valkey lines from .env.example}
|
||||
|
||||
# S3 — api, cleaner и worker: адрес в сети и bucket; ключи — у каждого своего
|
||||
# пользователя (не административные). Секреты S3 по сервисам (design
|
||||
# change s3-storage, решение 3; upload-consistency, решение 9):
|
||||
# административная пара — только s3, ключ подписи — s3 и s3-bootstrap,
|
||||
# ключи API — s3-bootstrap и api, ключи уборщика — s3-bootstrap и cleaner,
|
||||
# ключи worker — s3-bootstrap и worker
|
||||
x-s3-env: &s3-env
|
||||
S3__HOST: ${S3_HOST:-s3}
|
||||
S3__PORT: ${S3_PORT:-8333}
|
||||
S3__BUCKET: ${S3__BUCKET:-messenger}
|
||||
|
||||
# ключи пользователя API в S3 — только api
|
||||
x-s3-api-keys-env: &s3-api-keys-env
|
||||
S3__ACCESS_KEY_ID: ${S3_API_ACCESS_KEY:?S3_API_ACCESS_KEY is empty, copy S3 lines from .env.example}
|
||||
S3__SECRET_ACCESS_KEY: ${S3_API_SECRET_KEY:?S3_API_SECRET_KEY is empty, copy S3 lines from .env.example}
|
||||
|
||||
# RabbitMQ — relay и worker: адрес в сети и учётные данные; один пользователь
|
||||
# на оба сервиса, разделение прав — лаба 7 (design change async-attachments,
|
||||
# решение 4). У реплик API брокера нет (design change pipeline-reliability,
|
||||
# решение 1)
|
||||
x-broker-env: &broker-env
|
||||
BROKER__HOST: ${RABBITMQ_HOST:-rabbitmq}
|
||||
BROKER__PORT: ${RABBITMQ_PORT:-5672}
|
||||
BROKER__USER: ${RABBITMQ_DEFAULT_USER:?RABBITMQ_DEFAULT_USER is not set, run make env_setup}
|
||||
BROKER__PASSWORD: ${RABBITMQ_DEFAULT_PASS:?RABBITMQ_DEFAULT_PASS is empty, run make env_setup}
|
||||
|
||||
# телеметрия — api и worker (design change otel-telemetry, решение 8): SDK
|
||||
# включён и шлёт OTLP/HTTP только в Collector по имени сервиса в сети compose.
|
||||
# Адрес не секрет; переменные OTEL_* настройками не являются
|
||||
x-telemetry-env: &telemetry-env
|
||||
TELEMETRY__ENABLED: "true"
|
||||
TELEMETRY__OTLP_ENDPOINT: http://otel-collector:4318
|
||||
|
||||
# образ сервера S3 и bootstrap: тег с версией и digest индекса (amd64 и
|
||||
# arm64)
|
||||
x-s3-image: &s3-image chrislusf/seaweedfs:4.48@sha256:4e61d15fd35994cb1e43e1e553dff106794841fd9a99ade2fc8c8bfce4d7872d
|
||||
|
||||
# config.toml только на чтение, длинной записью: без файла запуск падает,
|
||||
# а не создаёт на хосте каталог config.toml/
|
||||
x-config-toml: &config-toml
|
||||
type: bind
|
||||
source: ./config.toml
|
||||
target: /app/config.toml
|
||||
read_only: true
|
||||
bind:
|
||||
create_host_path: false
|
||||
|
||||
services:
|
||||
postgres:
|
||||
image: postgres:18.6-trixie@sha256:5a5a84b19854a9ffaa54082c166ff4ec27473a361e496e5ea167f298f2da9722
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
POSTGRES_USER: ${POSTGRES_USER:?POSTGRES_USER is not set, run make env_setup}
|
||||
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:?POSTGRES_PASSWORD is empty, run make env_setup}
|
||||
POSTGRES_DB: ${POSTGRES_DB:?POSTGRES_DB is not set, run make env_setup}
|
||||
# порт самого сервера; его же берут pg_isready и psql в контейнере
|
||||
PGPORT: ${POSTGRES_PORT:-5432}
|
||||
ports:
|
||||
# только localhost: к нему подключается приложение в console
|
||||
- "127.0.0.1:${POSTGRES_OUT_PORT:-5433}:${POSTGRES_PORT:-5432}"
|
||||
volumes:
|
||||
# с 18.x данные в /var/lib/postgresql/18/docker, volume образа —
|
||||
# весь /var/lib/postgresql (Config.Volumes)
|
||||
- postgres_data:/var/lib/postgresql
|
||||
networks:
|
||||
default:
|
||||
# любое значение POSTGRES_HOST указывает на этот сервис
|
||||
aliases:
|
||||
- ${POSTGRES_HOST:-postgres}
|
||||
healthcheck:
|
||||
# по TCP, а не через сокет: при инициализации образ поднимает
|
||||
# временный сервер только на сокете, и проверка через сокет
|
||||
# сказала бы «готов» раньше времени. $$ — переменная контейнера
|
||||
test: ["CMD-SHELL", "pg_isready -h 127.0.0.1 -U \"$$POSTGRES_USER\" -d \"$$POSTGRES_DB\""]
|
||||
interval: 5s
|
||||
timeout: 3s
|
||||
retries: 10
|
||||
start_period: 30s
|
||||
start_interval: 1s
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
# соединения реплик: API_REPLICAS × pool_size (переполнения нет,
|
||||
# max_overflow 0) + migrate + cleaner (пул 1) + worker (пул 2) +
|
||||
# relay (пул 1) ≤ max_connections (100): 2 × 10 + 1 + 1 + 2 + 1 = 25,
|
||||
# при поочерёдной замене 3 × 10 + 1 + 1 + 2 + 1 = 35; расчёт — REPORT.md
|
||||
cpus: "2.0"
|
||||
memory: 1G
|
||||
|
||||
# кэш карточек чатов: без volume, persistence выключен в valkey.conf —
|
||||
# после рестарта кэш пуст, данные остаются в PostgreSQL
|
||||
valkey:
|
||||
image: valkey/valkey:9.1.2-trixie@sha256:418652cfb58ef879d4978c33553735d7147016032d5aefaa14c828e611eb9dfd
|
||||
restart: unless-stopped
|
||||
# $$ — переменные контейнера: пароль не попадает в command литералом.
|
||||
# Через docker-entrypoint.sh образа: он запускает сервер не от root
|
||||
command:
|
||||
- sh
|
||||
- -c
|
||||
- exec docker-entrypoint.sh valkey-server /usr/local/etc/valkey/valkey.conf --port "$$VALKEY_PORT" --requirepass "$$VALKEY_PASSWORD"
|
||||
environment:
|
||||
VALKEY_PORT: ${VALKEY_PORT:-6379}
|
||||
VALKEY_PASSWORD: ${VALKEY_PASSWORD:?VALKEY_PASSWORD is empty, copy Valkey lines from .env.example}
|
||||
# пароль для valkey-cli в контейнере (healthcheck), без -a в команде
|
||||
VALKEYCLI_AUTH: ${VALKEY_PASSWORD:?VALKEY_PASSWORD is empty, copy Valkey lines from .env.example}
|
||||
ports:
|
||||
# только localhost: к нему подключается приложение в console
|
||||
- "127.0.0.1:${VALKEY_OUT_PORT:-6380}:${VALKEY_PORT:-6379}"
|
||||
volumes:
|
||||
- type: bind
|
||||
source: ./infra/valkey/valkey.conf
|
||||
target: /usr/local/etc/valkey/valkey.conf
|
||||
read_only: true
|
||||
bind:
|
||||
create_host_path: false
|
||||
networks:
|
||||
default:
|
||||
# любое значение VALKEY_HOST указывает на этот сервис
|
||||
aliases:
|
||||
- ${VALKEY_HOST:-valkey}
|
||||
healthcheck:
|
||||
# PONG только после AUTH: проверяет и запуск, и пароль
|
||||
test: ["CMD-SHELL", 'test "$$(valkey-cli -p "$$VALKEY_PORT" ping)" = PONG']
|
||||
interval: 5s
|
||||
timeout: 3s
|
||||
retries: 10
|
||||
start_period: 10s
|
||||
start_interval: 1s
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
# maxmemory 64mb в valkey.conf плюс накладные
|
||||
cpus: "0.5"
|
||||
memory: 128M
|
||||
|
||||
# S3 — байты вложений (design change s3-storage, решения 1–2): master,
|
||||
# volume, filer и шлюз S3 одним процессом weed server. Служебные серверы
|
||||
# слушают только 127.0.0.1 контейнера, в сеть выходят порт API S3
|
||||
# (S3_PORT) и gRPC шлюза (S3_PORT + 10000), закрытый ключом подписи.
|
||||
# Entrypoint образа сам переходит на пользователя seaweed и добавляет
|
||||
# -dir=/data -volume.max=0 -master.volumeSizeLimitMB=1024
|
||||
s3:
|
||||
image: *s3-image
|
||||
restart: unless-stopped
|
||||
command:
|
||||
- server
|
||||
# master, volume и filer — только loopback контейнера
|
||||
- -ip=127.0.0.1
|
||||
- -ip.bind=127.0.0.1
|
||||
# по умолчанию master шлёт статистику на telemetry.seaweedfs.com
|
||||
- -master.telemetry=false
|
||||
# узел один, выборам ждать некого: перезапуск до healthy ~7 с, а не ~24
|
||||
- -master.electionTimeout=1s
|
||||
# пауза перед остановкой тома нужна кластеру, а не одному узлу
|
||||
- -volume.preStopSeconds=0
|
||||
- -filer
|
||||
- -s3
|
||||
- -s3.ip.bind=0.0.0.0
|
||||
- -s3.port=${S3_PORT:-8333}
|
||||
# REST Catalog и Lance по умолчанию открыты на 8181 и 9101
|
||||
- -s3.port.iceberg=0
|
||||
- -s3.port.lance=0
|
||||
# встроенный IAM API на порту S3 не нужен: bootstrap — weed shell
|
||||
- -s3.iam=false
|
||||
# шлюз держит не больше 64 МБ загрузок одновременно, лишние ждут
|
||||
- -s3.concurrentUploadLimitMB=64
|
||||
environment:
|
||||
# административная пара: учётная запись есть с первого старта, и
|
||||
# анонимного окна нет. Только у сервера: ни API, ни bootstrap её не
|
||||
# получают
|
||||
AWS_ACCESS_KEY_ID: ${S3_ROOT_ACCESS_KEY:?S3_ROOT_ACCESS_KEY is empty, copy S3 lines from .env.example}
|
||||
AWS_SECRET_ACCESS_KEY: ${S3_ROOT_SECRET_KEY:?S3_ROOT_SECRET_KEY is empty, copy S3 lines from .env.example}
|
||||
# без ключа подписи gRPC шлюза принимает учётную запись
|
||||
# администратора от любого контейнера сети
|
||||
WEED_JWT_FILER_SIGNING_KEY: ${S3_JWT_SIGNING_KEY:?S3_JWT_SIGNING_KEY is empty, copy S3 lines from .env.example}
|
||||
# сборщик мусора Go чаще у предела: вместе с лимитом загрузок 20
|
||||
# одновременных PUT по 10 MiB укладываются в 512 МБ
|
||||
GOMEMLIMIT: 400MiB
|
||||
# порт API S3 для healthcheck
|
||||
S3_PORT: ${S3_PORT:-8333}
|
||||
ports:
|
||||
# только localhost и только API S3: к нему подключается приложение в
|
||||
# console; консоль, UI и служебные серверы не публикуются
|
||||
- "127.0.0.1:${S3_OUT_PORT:-8334}:${S3_PORT:-8333}"
|
||||
volumes:
|
||||
# volume образа (Config.Volumes): тома, filer и IAM
|
||||
- s3_data:/data
|
||||
networks:
|
||||
default:
|
||||
# любое значение S3_HOST указывает на этот сервис
|
||||
aliases:
|
||||
- ${S3_HOST:-s3}
|
||||
healthcheck:
|
||||
# master выбран, том зарегистрирован у master (непустой DataNodes в
|
||||
# /dir/status), filer и шлюз S3 отвечают; всё на loopback. Без
|
||||
# проверки тома healthy наступал на ~4 с раньше регистрации, и первая
|
||||
# запись ждала её до ~4,8 с при сроке вызова 5 с. $$ — переменная
|
||||
# контейнера
|
||||
test: ["CMD-SHELL", "wget -q -O /dev/null http://127.0.0.1:9333/cluster/healthz && wget -q -O - http://127.0.0.1:9333/dir/status | grep -qF '\"DataNodes\":[{' && wget -q -O /dev/null http://127.0.0.1:8888/healthz && wget -q -O /dev/null \"http://127.0.0.1:$$S3_PORT/healthz\""]
|
||||
interval: 5s
|
||||
timeout: 3s
|
||||
retries: 10
|
||||
start_period: 30s
|
||||
start_interval: 1s
|
||||
# плавная остановка ~15 с: срок ожидания подписок filer зашит в код.
|
||||
# При 10 с остановка кончалась бы SIGKILL (код 137)
|
||||
stop_grace_period: 20s
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
# память — GOMEMLIMIT и лимит загрузок выше
|
||||
cpus: "1.0"
|
||||
memory: 512M
|
||||
|
||||
# брокер заданий обработки вложений (design change async-attachments,
|
||||
# решение 4). hostname постоянный: имя узла задаёт каталог данных, и
|
||||
# пересозданный контейнер иначе не нашёл бы свои данные в том же volume.
|
||||
# Учётная запись приложения создаётся при первом старте на пустом volume.
|
||||
# Наружу — только AMQP на loopback, для запуска в консоли
|
||||
rabbitmq:
|
||||
image: rabbitmq:4.3.7@sha256:bd88985187aa73cd598fa0d8b31d49b2f814a6d9e58f6d5a89bae588669d946a
|
||||
hostname: rabbitmq
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
RABBITMQ_DEFAULT_USER: ${RABBITMQ_DEFAULT_USER:?RABBITMQ_DEFAULT_USER is not set, run make env_setup}
|
||||
RABBITMQ_DEFAULT_PASS: ${RABBITMQ_DEFAULT_PASS:?RABBITMQ_DEFAULT_PASS is empty, run make env_setup}
|
||||
RABBITMQ_NODE_PORT: ${RABBITMQ_PORT:-5672}
|
||||
ports:
|
||||
- "127.0.0.1:${RABBITMQ_OUT_PORT:-5673}:${RABBITMQ_PORT:-5672}"
|
||||
volumes:
|
||||
# volume образа (Config.Volumes): очереди и сообщения
|
||||
- rabbitmq_data:/var/lib/rabbitmq
|
||||
- type: bind
|
||||
source: ./infra/rabbitmq/rabbitmq.conf
|
||||
target: /etc/rabbitmq/conf.d/90-messenger.conf
|
||||
read_only: true
|
||||
bind:
|
||||
create_host_path: false
|
||||
networks:
|
||||
default:
|
||||
# любое значение RABBITMQ_HOST указывает на этот сервис
|
||||
aliases:
|
||||
- ${RABBITMQ_HOST:-rabbitmq}
|
||||
healthcheck:
|
||||
# от пользователя брокера, exec-формой: CLI от root на пустом volume
|
||||
# создавал .erlang.cookie (0400, root) раньше сервера, и тот падал на
|
||||
# eacces (design change otel-telemetry, решение 19)
|
||||
test: ["CMD", "gosu", "rabbitmq", "rabbitmq-diagnostics", "-q", "check_port_connectivity"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 10
|
||||
start_period: 30s
|
||||
start_interval: 1s
|
||||
# брокер завершается сам за ~2 с; 20 с — запас на большую очередь
|
||||
stop_grace_period: 20s
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
# предел памяти брокера — 400 МиБ в infra/rabbitmq/rabbitmq.conf
|
||||
cpus: "1.0"
|
||||
memory: 512M
|
||||
|
||||
# bootstrap S3 — один раз до реплик, как миграции (решение 4): приватный
|
||||
# bucket, пользователь API с политикой «только объекты своего bucket»,
|
||||
# пользователь уборщика — «чтение и удаление объектов своего bucket»,
|
||||
# проверки приватности вне API. Повтор сводит состояние к .env и ничего
|
||||
# не ломает. В сетевом пространстве s3: master и filer сервера на
|
||||
# 127.0.0.1 доступны ему, а в сети их нет. make s3_check запускает его
|
||||
# же в режиме check
|
||||
s3-bootstrap:
|
||||
image: *s3-image
|
||||
network_mode: service:s3
|
||||
user: seaweed
|
||||
entrypoint: ["sh", "/opt/s3/bootstrap.sh"]
|
||||
command: ["apply"]
|
||||
restart: "no"
|
||||
environment:
|
||||
S3_BUCKET: ${S3__BUCKET:-messenger}
|
||||
S3_PORT: ${S3_PORT:-8333}
|
||||
# ключ подписи: им weed shell подписывает вызовы IAM filer
|
||||
WEED_JWT_FILER_SIGNING_KEY: ${S3_JWT_SIGNING_KEY:?S3_JWT_SIGNING_KEY is empty, copy S3 lines from .env.example}
|
||||
S3_API_ACCESS_KEY: ${S3_API_ACCESS_KEY:?S3_API_ACCESS_KEY is empty, copy S3 lines from .env.example}
|
||||
S3_API_SECRET_KEY: ${S3_API_SECRET_KEY:?S3_API_SECRET_KEY is empty, copy S3 lines from .env.example}
|
||||
S3_CLEANER_ACCESS_KEY: ${S3_CLEANER_ACCESS_KEY:?S3_CLEANER_ACCESS_KEY is empty, run make env_setup}
|
||||
S3_CLEANER_SECRET_KEY: ${S3_CLEANER_SECRET_KEY:?S3_CLEANER_SECRET_KEY is empty, run make env_setup}
|
||||
S3_WORKER_ACCESS_KEY: ${S3_WORKER_ACCESS_KEY:?S3_WORKER_ACCESS_KEY is empty, run make env_setup}
|
||||
S3_WORKER_SECRET_KEY: ${S3_WORKER_SECRET_KEY:?S3_WORKER_SECRET_KEY is empty, run make env_setup}
|
||||
# список объектов уборщику — только по префиксу вложений своей базы
|
||||
# (сверка bucket и БД, design change track2-reconciler, решение 2);
|
||||
# не секрет, уборщик строит префикс сам из имени базы
|
||||
S3_CLEANER_LIST_PREFIX: ${POSTGRES_DB:?POSTGRES_DB is not set, run make env_setup}/attachments/
|
||||
HOME: /tmp
|
||||
volumes:
|
||||
- type: bind
|
||||
source: ./infra/s3/bootstrap.sh
|
||||
target: /opt/s3/bootstrap.sh
|
||||
read_only: true
|
||||
bind:
|
||||
create_host_path: false
|
||||
# файл ключа для curl и политика — только в памяти. /data — volume
|
||||
# образа (Config.Volumes): без tmpfs каждый новый контейнер bootstrap
|
||||
# оставлял бы анонимный volume
|
||||
tmpfs:
|
||||
- /tmp
|
||||
- /data
|
||||
depends_on:
|
||||
s3:
|
||||
condition: service_healthy
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
# пик по пробе — 35 MiB, 0,76 с CPU
|
||||
cpus: "0.5"
|
||||
memory: 128M
|
||||
|
||||
# миграции — один раз до реплик, сами реплики их не запускают
|
||||
migrate:
|
||||
# образ собирает сервис api (make run_docker, make test_isolated)
|
||||
image: mtusi-messenger:lab6
|
||||
pull_policy: never
|
||||
command: ["alembic", "upgrade", "head"]
|
||||
restart: "no"
|
||||
# только PostgreSQL: пароль Valkey миграциям не нужен
|
||||
environment: *db-env
|
||||
volumes:
|
||||
- *config-toml
|
||||
depends_on:
|
||||
postgres:
|
||||
condition: service_healthy
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: "0.5"
|
||||
memory: 256M
|
||||
|
||||
# реплики API: порты не публикуются, фиксированного имени контейнера
|
||||
# нет (мешало бы масштабированию) — запросы идут только через haproxy; X-Instance-Id — hostname, то есть
|
||||
# короткий ID контейнера. Разовая подмена числа — make replicas
|
||||
# API_REPLICAS=N
|
||||
api:
|
||||
build: .
|
||||
image: mtusi-messenger:lab6
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
<<: [*db-env, *cache-env, *s3-env, *s3-api-keys-env, *telemetry-env]
|
||||
APP__PORT: ${APP__PORT:-8080}
|
||||
volumes:
|
||||
- *config-toml
|
||||
depends_on:
|
||||
postgres:
|
||||
condition: service_healthy
|
||||
# без кэша API работает, но в штатном стенде он есть с первого запроса
|
||||
valkey:
|
||||
condition: service_healthy
|
||||
migrate:
|
||||
condition: service_completed_successfully
|
||||
# bucket и пользователь API есть до первого запроса
|
||||
s3-bootstrap:
|
||||
condition: service_completed_successfully
|
||||
# healthcheck — из образа; SIGKILL не раньше, чем через 10 с
|
||||
stop_grace_period: 10s
|
||||
# буфер приёма сокетов реплики — до 512 KiB, а не до 32 MiB ВМ Docker:
|
||||
# ядро копит недочитанное тело (ожидание места загрузки, отказ до тела)
|
||||
# в буфере сокета, и он считается памятью контейнера. Параметр сетевого
|
||||
# пространства контейнера — его получают все контейнеры сервиса, в том
|
||||
# числе bench/, make test_isolated и стенд отказов (design change
|
||||
# upload-memory, решение 6). В консоли (make run_dev) его нет
|
||||
sysctls:
|
||||
net.ipv4.tcp_rmem: "4096 131072 524288"
|
||||
deploy:
|
||||
replicas: ${API_REPLICAS:-2}
|
||||
resources:
|
||||
limits:
|
||||
# один event loop занимает не больше 1 CPU. Argon2id (p=4, до
|
||||
# kdf_concurrency хэшей сразу) взял бы больше: под лимитом вход
|
||||
# медленнее в 4–5 раз, осознанно (REPORT.md, «Ограничения»).
|
||||
# Память: Argon2id 4 × 64 MiB + интерпретатор ≈ 350 МБ
|
||||
cpus: "1.0"
|
||||
memory: 512M
|
||||
|
||||
# уборщик незавершённых загрузок (design change upload-consistency,
|
||||
# решения 2 и 9): строки pending старше grace и их объекты. Один процесс
|
||||
# на образе API со своей командой; реплики его не ждут, сам он ждёт
|
||||
# схему и пользователя S3. Портов нет, HTTP не слушает
|
||||
cleaner:
|
||||
image: mtusi-messenger:lab6
|
||||
pull_policy: never
|
||||
# точка входа, а не command: разовый проход —
|
||||
# docker compose run --rm --no-deps cleaner --once
|
||||
entrypoint: ["python", "-m", "src.cleaner"]
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
<<: [*db-env, *s3-env]
|
||||
# проход последовательный: второе соединение не нужно
|
||||
DATABASE__POOL_SIZE: "1"
|
||||
# пользователь уборщика: чтение и удаление объектов, без записи и
|
||||
# списка; ключей API, пароля Valkey и административных ключей S3 нет
|
||||
S3__ACCESS_KEY_ID: ${S3_CLEANER_ACCESS_KEY:?S3_CLEANER_ACCESS_KEY is empty, run make env_setup}
|
||||
S3__SECRET_ACCESS_KEY: ${S3_CLEANER_SECRET_KEY:?S3_CLEANER_SECRET_KEY is empty, run make env_setup}
|
||||
volumes:
|
||||
- *config-toml
|
||||
depends_on:
|
||||
postgres:
|
||||
condition: service_healthy
|
||||
migrate:
|
||||
condition: service_completed_successfully
|
||||
s3-bootstrap:
|
||||
condition: service_completed_successfully
|
||||
# healthcheck образа — HTTP /health/ready, а уборщик HTTP не слушает.
|
||||
# Живость — журнал: старт, проходы, отказы
|
||||
healthcheck:
|
||||
disable: true
|
||||
# SIGTERM: текущая строка доводится (≤ 6 с), затем выход с кодом 0
|
||||
stop_grace_period: 10s
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: "0.25"
|
||||
memory: 256M
|
||||
|
||||
# relay (design change pipeline-reliability, решения 1 и 2): доводит намерения
|
||||
# из PostgreSQL до брокера, возвращает истёкшие аренды. Один процесс на образе
|
||||
# API; реплики его не ждут: без него загрузка отвечает 202, задания ждут в
|
||||
# PostgreSQL. Разовая команда реестра — make replay (docker compose run --rm
|
||||
# --no-deps relay replay …). Портов нет, HTTP не слушает
|
||||
relay:
|
||||
image: mtusi-messenger:lab6
|
||||
pull_policy: never
|
||||
# точка входа, а не command: аргументы после имени сервиса — подкоманда
|
||||
entrypoint: ["python", "-m", "src.relay"]
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
# только PostgreSQL и брокер: ни ключей S3, ни пароля Valkey; адрес
|
||||
# Collector — не секрет (design change job-trace-propagation, решение 7)
|
||||
<<: [*db-env, *broker-env, *telemetry-env]
|
||||
# проход последовательный: второе соединение не нужно
|
||||
DATABASE__POOL_SIZE: "1"
|
||||
volumes:
|
||||
- *config-toml
|
||||
depends_on:
|
||||
postgres:
|
||||
condition: service_healthy
|
||||
rabbitmq:
|
||||
condition: service_healthy
|
||||
migrate:
|
||||
condition: service_completed_successfully
|
||||
# healthcheck образа — HTTP /health/ready, а relay HTTP не слушает. Живость
|
||||
# — журнал и очередь
|
||||
healthcheck:
|
||||
disable: true
|
||||
# SIGTERM: текущий шаг доводится (≤ 6 с), затем выход с кодом 0
|
||||
stop_grace_period: 10s
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: "0.25"
|
||||
memory: 256M
|
||||
|
||||
# worker обработки вложений (design change async-attachments, решение 6):
|
||||
# отдельный процесс на образе API; декодирование и варианты — в процессе
|
||||
# обработки на задание, ни у реплик, ни в самом worker декодера нет
|
||||
# (pipeline-reliability, решение 7). Портов нет, HTTP не слушает; реплики его
|
||||
# не ждут
|
||||
worker:
|
||||
image: mtusi-messenger:lab6
|
||||
pull_policy: never
|
||||
entrypoint: ["python", "-m", "src.worker"]
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
<<: [*db-env, *s3-env, *broker-env, *telemetry-env]
|
||||
# шаги с БД короткие: соединение на задание
|
||||
DATABASE__POOL_SIZE: "2"
|
||||
# пользователь worker: чтение и запись объектов, без удаления и
|
||||
# списка; ключей API и уборщика, пароля Valkey и административных
|
||||
# ключей S3 нет
|
||||
S3__ACCESS_KEY_ID: ${S3_WORKER_ACCESS_KEY:?S3_WORKER_ACCESS_KEY is empty, run make env_setup}
|
||||
S3__SECRET_ACCESS_KEY: ${S3_WORKER_SECRET_KEY:?S3_WORKER_SECRET_KEY is empty, run make env_setup}
|
||||
volumes:
|
||||
- *config-toml
|
||||
depends_on:
|
||||
postgres:
|
||||
condition: service_healthy
|
||||
rabbitmq:
|
||||
condition: service_healthy
|
||||
migrate:
|
||||
condition: service_completed_successfully
|
||||
s3-bootstrap:
|
||||
condition: service_completed_successfully
|
||||
# healthcheck образа — HTTP /health/ready, а worker HTTP не слушает.
|
||||
# Живость — журнал и очередь
|
||||
healthcheck:
|
||||
disable: true
|
||||
# SIGTERM: начатые задания ждут ≤ [worker] graceful_shutdown_seconds,
|
||||
# закрытие клиентов — в сумме не больше 9,5 с
|
||||
stop_grace_period: 10s
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
# два процесса обработки PNG RGBA на 40 Мпкс: ~360 МиБ VmHWM на
|
||||
# процесс, вместе с worker и телами меньше лимита при конкуренции 2
|
||||
# (расчёт — REPORT.md); лимит адресного пространства процесса — 450 МиБ
|
||||
cpus: "1.0"
|
||||
memory: 1G
|
||||
|
||||
# единственная точка входа: реплики находит через DNS Docker, проверяет
|
||||
# /health/ready; конфиг — infra/haproxy/haproxy.cfg. Секретов не получает
|
||||
haproxy:
|
||||
image: haproxy:3.4.6-trixie@sha256:e273915691a8eab3f105bf3e39fd4c29a4ecf334e33421903b5589d25e14db26
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
# порт реплик и самого LB внутри сети: тот же APP__PORT
|
||||
API_PORT: ${APP__PORT:-8080}
|
||||
ports:
|
||||
# только localhost: стенд учебный; API на хосте доступно только так
|
||||
- "127.0.0.1:${APP_OUT_PORT:-8080}:${APP__PORT:-8080}"
|
||||
volumes:
|
||||
- type: bind
|
||||
source: ./infra/haproxy/haproxy.cfg
|
||||
target: /usr/local/etc/haproxy/haproxy.cfg
|
||||
read_only: true
|
||||
bind:
|
||||
create_host_path: false
|
||||
# make stop гасит LB раньше реплик, make run_docker поднимает после них
|
||||
depends_on:
|
||||
- api
|
||||
healthcheck:
|
||||
# healthy — через LB можно обслужить запрос: /lb/ready отвечает 200,
|
||||
# пока есть хотя бы одна готовая реплика. curl в образе нет, bash есть
|
||||
test: ["CMD", "bash", "-c", "exec 3<>/dev/tcp/127.0.0.1/8404 && printf 'GET /lb/ready HTTP/1.0\\r\\n\\r\\n' >&3 && head -n 1 <&3 | grep -q ' 200 '"]
|
||||
interval: 5s
|
||||
timeout: 3s
|
||||
retries: 3
|
||||
start_period: 10s
|
||||
start_interval: 1s
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
# nbthread 1 в haproxy.cfg
|
||||
cpus: "1.0"
|
||||
memory: 256M
|
||||
|
||||
# --- наблюдаемость (design change otel-telemetry, решения 1, 7, 14–18) ---
|
||||
# Сервисы приложения их не ждут, а они — друг друга: без них приложение
|
||||
# работает, отправку и запросы они повторяют сами. Порты наружу — только
|
||||
# у Grafana. Сервисы на Go получают GOMEMLIMIT (лимит cgroup рантайм не
|
||||
# видит): ~80 % лимита, а у тех, чей пик дошёл до GOMEMLIMIT (Tempo), —
|
||||
# не больше лимита / 1,5
|
||||
|
||||
# OTel Collector contrib: OTLP/HTTP от api и worker (сеть default), метрики
|
||||
# для scrape и экспорт в Loki и Tempo (сеть telemetry). Секретов нет. В
|
||||
# образе нет ни оболочки, ни HTTP-клиента: healthcheck нет, живость — цель
|
||||
# otel-collector в Prometheus
|
||||
otel-collector:
|
||||
image: otel/opentelemetry-collector-contrib:0.164.0@sha256:340c9ca6a36617084c6661bdc4f0fe92b7cda5a805d61673ec8db375fddc522b
|
||||
restart: unless-stopped
|
||||
command: ["--config=/etc/otelcol-contrib/config.yaml"]
|
||||
environment:
|
||||
GOMEMLIMIT: 160MiB
|
||||
volumes:
|
||||
- type: bind
|
||||
source: ./infra/otel/collector.yaml
|
||||
target: /etc/otelcol-contrib/config.yaml
|
||||
read_only: true
|
||||
bind:
|
||||
create_host_path: false
|
||||
networks:
|
||||
- default
|
||||
- telemetry
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
# memory_limiter 200 / 40 МиБ в collector.yaml
|
||||
cpus: "0.5"
|
||||
memory: 256M
|
||||
|
||||
# Prometheus — метрики: scrape Collector и собственных метрик конвейера;
|
||||
# срок и предел объёма хранения — флаги. Без remote write, OTLP, admin API и
|
||||
# lifecycle. Правила записи и оповещения — файл rules.yml (design change
|
||||
# slo-alerts, решения 1, 3, 4); доставки оповещений наружу нет. Время начала
|
||||
# cumulative-рядов экспортёра Collector (protobuf) — ноль в момент начала
|
||||
# ряда нового процесса (решение 6)
|
||||
prometheus:
|
||||
image: prom/prometheus:v3.15.1@sha256:fa3302279710be2f21a8301ec17a8b4f2301fd829bd113839b3b6b02b6f191a2
|
||||
restart: unless-stopped
|
||||
command:
|
||||
- --config.file=/etc/prometheus/prometheus.yml
|
||||
- --storage.tsdb.path=/prometheus
|
||||
- --storage.tsdb.retention.time=7d
|
||||
- --storage.tsdb.retention.size=1GB
|
||||
- --enable-feature=created-timestamp-zero-ingestion
|
||||
environment:
|
||||
GOMEMLIMIT: 300MiB
|
||||
volumes:
|
||||
# volume образа (Config.Volumes), владелец nobody
|
||||
- prometheus_data:/prometheus
|
||||
- type: bind
|
||||
source: ./infra/otel/prometheus/prometheus.yml
|
||||
target: /etc/prometheus/prometheus.yml
|
||||
read_only: true
|
||||
bind:
|
||||
create_host_path: false
|
||||
- type: bind
|
||||
source: ./infra/otel/prometheus/rules.yml
|
||||
target: /etc/prometheus/rules.yml
|
||||
read_only: true
|
||||
bind:
|
||||
create_host_path: false
|
||||
networks:
|
||||
- telemetry
|
||||
healthcheck:
|
||||
# busybox wget есть в образе
|
||||
test: ["CMD", "wget", "-q", "-O", "/dev/null", "http://127.0.0.1:9090/-/ready"]
|
||||
interval: 10s
|
||||
timeout: 3s
|
||||
retries: 5
|
||||
start_period: 30s
|
||||
start_interval: 1s
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: "0.5"
|
||||
memory: 384M
|
||||
|
||||
# Loki — логи: родной OTLP от Collector, filesystem в volume, срок 7 суток.
|
||||
# Оболочки и HTTP-клиента в образе нет: healthcheck нет, живость — цель loki
|
||||
# в Prometheus и проверка источника в Grafana
|
||||
loki:
|
||||
image: grafana/loki:3.7.9@sha256:0db216b630ae1f348a1584c67f3cead8b4c1fc839169a39501db664744158e28
|
||||
restart: unless-stopped
|
||||
command: ["-config.file=/etc/loki/loki.yaml"]
|
||||
environment:
|
||||
GOMEMLIMIT: 400MiB
|
||||
volumes:
|
||||
- loki_data:/loki
|
||||
- type: bind
|
||||
source: ./infra/otel/loki/loki.yaml
|
||||
target: /etc/loki/loki.yaml
|
||||
read_only: true
|
||||
bind:
|
||||
create_host_path: false
|
||||
networks:
|
||||
- telemetry
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: "0.5"
|
||||
memory: 512M
|
||||
|
||||
# Tempo — трассы: монолит 3.1 с локальным хранилищем, срок 7 суток. Как у
|
||||
# Loki, healthcheck нет. Пик под make test + load + student_test дошёл до
|
||||
# GOMEMLIMIT (398 МиБ, evidence/telemetry/budget.md): лимит контейнера —
|
||||
# 1,5 × GOMEMLIMIT, а не 80 / 20 (design change otel-telemetry, «Уточнения
|
||||
# apply», п. 19)
|
||||
tempo:
|
||||
image: grafana/tempo:3.1.1@sha256:64e2fbd56d9c2b3412a4b430a58ea59e91a670b1e75f920a0c702213ad145044
|
||||
restart: unless-stopped
|
||||
command: ["-config.file=/etc/tempo/tempo.yaml", "-target=all"]
|
||||
environment:
|
||||
GOMEMLIMIT: 400MiB
|
||||
volumes:
|
||||
- tempo_data:/var/tempo
|
||||
- type: bind
|
||||
source: ./infra/otel/tempo/tempo.yaml
|
||||
target: /etc/tempo/tempo.yaml
|
||||
read_only: true
|
||||
bind:
|
||||
create_host_path: false
|
||||
networks:
|
||||
- telemetry
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: "0.5"
|
||||
memory: 640M
|
||||
|
||||
# Grafana — интерфейс без своего состояния (tmpfs): источники и dashboard —
|
||||
# provisioning из git, пароль администратора из .env действует на каждом
|
||||
# старте. Наружу — только 127.0.0.1. Без анонимного входа, регистрации,
|
||||
# установки плагинов из сети, отчётов и проверок обновлений; встроенные
|
||||
# источники, кроме prometheus, loki и tempo, выключены (каждый — свой
|
||||
# процесс). Пик 294 МиБ (процесс и три источника с backend): лимит 512 —
|
||||
# не меньше 1,5 × пика (evidence/telemetry/budget.md)
|
||||
grafana:
|
||||
image: grafana/grafana:13.3.1@sha256:0615ec4fbd4072004b7d86b46ded63013a74b7d6eb1119273dd89e8fa25c13cf
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
GF_SECURITY_ADMIN_USER: admin
|
||||
GF_SECURITY_ADMIN_PASSWORD: ${GRAFANA_ADMIN_PASSWORD:?GRAFANA_ADMIN_PASSWORD is empty, run make env_setup}
|
||||
GF_SECURITY_DISABLE_GRAVATAR: "true"
|
||||
GF_AUTH_ANONYMOUS_ENABLED: "false"
|
||||
GF_AUTH_DISABLE_SIGNOUT_MENU: "false"
|
||||
GF_USERS_ALLOW_SIGN_UP: "false"
|
||||
GF_USERS_ALLOW_ORG_CREATE: "false"
|
||||
GF_ANALYTICS_REPORTING_ENABLED: "false"
|
||||
GF_ANALYTICS_CHECK_FOR_UPDATES: "false"
|
||||
GF_ANALYTICS_CHECK_FOR_PLUGIN_UPDATES: "false"
|
||||
GF_ANALYTICS_FEEDBACK_LINKS_ENABLED: "false"
|
||||
GF_NEWS_NEWS_FEED_ENABLED: "false"
|
||||
GF_SNAPSHOTS_EXTERNAL_ENABLED: "false"
|
||||
GF_PLUGINS_PREINSTALL_DISABLED: "true"
|
||||
GF_PLUGINS_PUBLIC_KEY_RETRIEVAL_DISABLED: "true"
|
||||
GF_PLUGINS_DISABLE_PLUGINS: cloudwatch,elasticsearch,grafana-postgresql-datasource,grafana-pyroscope-datasource,influxdb,jaeger,mssql,mysql,opentsdb,stackdriver,zipkin,grafana-azure-monitor-datasource,graphite,grafana-testdata-datasource
|
||||
GOMEMLIMIT: 300MiB
|
||||
ports:
|
||||
- "127.0.0.1:${GRAFANA_OUT_PORT:-3000}:3000"
|
||||
tmpfs:
|
||||
- /var/lib/grafana
|
||||
volumes:
|
||||
- type: bind
|
||||
source: ./infra/otel/grafana/datasources.yaml
|
||||
target: /etc/grafana/provisioning/datasources/datasources.yaml
|
||||
read_only: true
|
||||
bind:
|
||||
create_host_path: false
|
||||
- type: bind
|
||||
source: ./infra/otel/grafana/dashboards.yaml
|
||||
target: /etc/grafana/provisioning/dashboards/dashboards.yaml
|
||||
read_only: true
|
||||
bind:
|
||||
create_host_path: false
|
||||
- type: bind
|
||||
source: ./infra/otel/grafana/dashboards/messenger-overview.json
|
||||
target: /etc/grafana/dashboards/messenger-overview.json
|
||||
read_only: true
|
||||
bind:
|
||||
create_host_path: false
|
||||
networks:
|
||||
- telemetry
|
||||
healthcheck:
|
||||
test: ["CMD", "wget", "-q", "-O", "/dev/null", "http://127.0.0.1:3000/api/health"]
|
||||
interval: 10s
|
||||
timeout: 3s
|
||||
retries: 5
|
||||
start_period: 60s
|
||||
start_interval: 1s
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: "0.5"
|
||||
memory: 512M
|
||||
|
||||
networks:
|
||||
# хранилища телеметрии и Grafana: контейнеры приложения до них не достают,
|
||||
# связь — только через Collector (он в обеих сетях). Не internal: иначе не
|
||||
# работает опубликованный порт Grafana
|
||||
telemetry:
|
||||
|
||||
volumes:
|
||||
postgres_data:
|
||||
s3_data:
|
||||
rabbitmq_data:
|
||||
prometheus_data:
|
||||
loki_data:
|
||||
tempo_data:
|
||||
@@ -0,0 +1,246 @@
|
||||
# `driver.py --port 8080 alerts-check` (change `slo-alerts`, задачи 11.2 и 12.11)
|
||||
|
||||
- Основа: commit `ef60b47` (fix: address slo-alerts verify findings), рабочее дерево чистое
|
||||
(`git status --short` до прогона пуст). Файлы `src/` и `migrations/` (151) в контейнерах `api` (2:
|
||||
`api-13`, `api-14`), `relay`, `worker` и `cleaner` побайтно совпадают с деревом commit (SHA-256
|
||||
каждого файла); ревизия схемы `e4b8c2d17f90`. `/etc/prometheus/rules.yml` и `prometheus.yml` в
|
||||
контейнере Prometheus побайтно равны файлам дерева `ef60b47` (`cmp`). Код приложения с `15ea156` не
|
||||
менялся: `ef60b47` правит правила, их тесты, драйвер и документы. Прежний прогон этого файла — на
|
||||
`15ea156` (до правок verify).
|
||||
- Дата: 2026-11-14, 01:09:30Z – 01:27:20Z (~17,8 мин); хост macOS, Docker 29.9.2, Compose 5.6.1, ВМ
|
||||
Docker Desktop — 12 CPU / 11,6 ГиБ. Рабочий стенд `mtusi-lab6` (две реплики API, relay, worker,
|
||||
уборщик, Collector, Prometheus, Loki, Tempo, Grafana), команда из корня репозитория:
|
||||
`python3 .claude/skills/run-mtusi-messenger/driver.py --port 8080 alerts-check`, код выхода 0.
|
||||
- Всё — через HTTP API Grafana на `127.0.0.1:3000` с паролем из `.env` (источники-прокси uid
|
||||
`prometheus`, `loki`, `tempo`); моменты pending / firing / снятия — `/api/v1/rules` раз в 5 с,
|
||||
время — от начала шага (у `MessengerQueueLagHigh` — от первой загрузки, у снятия — от
|
||||
восстановления); момент pending печатается перед каждой строкой firing. Пользователи, пароли,
|
||||
токены и файлы — синтетические, в вывод не попадают. Фоновая нагрузка драйвера через LB — 6
|
||||
потоков отправки сообщения с новым `Idempotency-Key` раз в 0,25 с и 1 поток чтения истории раз в
|
||||
1 с (design, «Уточнения apply», п. 7).
|
||||
- Отказы: шаг 1 — `docker compose stop worker`, 3 загрузки, `docker start` того же контейнера через
|
||||
145 с; шаг 2 — `docker compose stop relay`, `docker start`; шаг 3 — сессия psql с
|
||||
`application_name = mtusi-alerts-check` циклами держит `LOCK TABLE messages IN SHARE MODE` 2 с с
|
||||
паузой 0,2 с, затем `pg_terminate_backend`; шаг 4 — 3 потока входа по Basic 45 с (сравнение, отказа
|
||||
нет); шаг 5 — `docker compose stop postgres`, затем `start`. В `finally` — нагрузка остановлена,
|
||||
сессия блокировки завершена, PostgreSQL, worker и relay запущены, LB готов (последняя строка).
|
||||
|
||||
## Сценарии → строки вывода
|
||||
|
||||
| Сценарий (`observability`, если не указано) | Строки |
|
||||
| --- | --- |
|
||||
| «Правила загружены» | `rule groups loaded`, `rules with evaluation errors`, `alerts loaded`, `Grafana shows rules…`, `rule change through Grafana rejected`, `alert delivery addresses`, `prometheus config has alertmanagers` |
|
||||
| «Остановленный worker» | `[worker stopped]`: pending через 84 с, firing через 144 с после первой загрузки (≤ 240), `outbox + published` +3, снято через 29 с после запуска (≤ 120), 3 `ready` |
|
||||
| «Перезапуск worker» | `[worker stopped] time to ready count…`: первая точка нового процесса — 0 (время начала), приращение по точкам ровно 3; worker стоял 145 с (> 2 мин) |
|
||||
| «Остановленный relay» | `[relay stopped] MessengerQueueMetricsMissing`: pending через 69 с, firing через 190 с (≤ 300), снято через 45 с (≤ 120) |
|
||||
| «Остановленный relay уходит из рядов» | `[relay stopped] queue depth and age series gone within 120 s` — ряды глубины и возраста ушли через 60 с |
|
||||
| «Медленная БД» | `[slow database]`: pending через 75 с, firing через 135 с (≤ 240), доля span PostgreSQL в медленных трассах отправки 0,99–1,0, пул 6 против 0, CPU реплик 0,09 предела, снято через 74 с (≤ 240), `MessengerHighErrorRate` нет |
|
||||
| «Медленный handler не путается с БД» | `[slow handler]`: доля span PostgreSQL 0,0–0,2 (медиана 0,01), пул ни одной реплики не занят целиком (не больше 0,20), отказов по сроку 0, `pending` — наблюдение (0), CPU реплик 0,81 предела, `MessengerSlowRequests` неактивно (доля медленных до 0,072) |
|
||||
| «Тяжёлая ручка вне SLI задержки» | `[slow handler] login p95 on the route panel slower than 0.25 s` (p95 входа 0,598 с) при неактивном `MessengerSlowRequests` |
|
||||
| «Недоступная БД» | `[database down]`: `MessengerNoReadyReplicas` pending через 29 с, firing через 59 с, `MessengerHighErrorRate` pending через 44 с, firing через 105 с (≤ 180), сняты через 30 и 135 с (≤ 240) |
|
||||
| «Ответы самого балансировщика» | `[database down]`: готовых реплик 0, клиент получил 2497 ответов 503 от LB (без `X-Instance-Id`), 5xx на LB +2605, у API +67 |
|
||||
| «Отказ БД виден в SLI доступности» | `availability SLI over the outage window: LB 0.5557, client 0.5581` |
|
||||
| «SLO считается» | `[SLI and panels]`: три SLI за 7 суток в [0, 1]; за час по рядам правил и по исходным счётчикам в тех же окнах — 0, 0 и 0,085 п. п. (≤ 1); у доступности и задержки и против `increase` одним окном часа — 0,58 и 0,066 п. п. (≤ 1) |
|
||||
| «История оповещения на панели», «Новые панели после трафика» | `alert history panel shows firing of the steps`, `new panel queries (31) with data: []` (у 31 запроса панелей с id от 25 данных хватает) |
|
||||
| «Без потерь» (`TelemetryDataLoss`) | `other alerts firing: []` на каждом шаге |
|
||||
|
||||
Лишних firing нет ни на одном шаге (`other alerts firing: []`); `MessengerQueueMetricsMissing` в
|
||||
pending во время недоступной БД — допустимо (relay не делает снимок без PostgreSQL).
|
||||
|
||||
## Вывод
|
||||
|
||||
```
|
||||
alerts-check 2026-11-14T01:09:30Z: rules, quiet stand
|
||||
rule groups loaded: ['messenger-alerts', 'messenger-sli', 'messenger-slo', 'telemetry-alerts']
|
||||
rules with evaluation errors: []
|
||||
alerts loaded: ['MessengerHighErrorRate', 'MessengerNoReadyReplicas', 'MessengerQueueLagHigh', 'MessengerQueueMetricsMissing', 'MessengerSlowRequests', 'TelemetryDataLoss', 'TelemetryTargetDown']
|
||||
Grafana shows rules of the Prometheus datasource: 200 ['messenger-alerts', 'messenger-sli', 'messenger-slo', 'telemetry-alerts']
|
||||
rule change through Grafana rejected: yes
|
||||
alert delivery addresses: []
|
||||
prometheus config has alertmanagers: no
|
||||
load: 6 writers every 0.25 s and 1 reader every 1.0 s
|
||||
observed: pool used before the steps (max): 0
|
||||
uploads ready before the steps: 20
|
||||
[worker stopped] stand quiet before the step: yes
|
||||
[worker stopped]
|
||||
observed: queue by stage and age before: {'outbox': 0.0, 'processing': 0.0, 'published': 0.0, 'scheduled': 0.0, 'oldest_age_s': 0.0}
|
||||
observed: worker stopped at 46 s of the drill
|
||||
[worker stopped] uploads accepted (202): 3
|
||||
observed: MessengerQueueLagHigh pending after 84 s
|
||||
[worker stopped] MessengerQueueLagHigh firing after the first upload: after 144 s
|
||||
observed: queue by stage and age: {'outbox': 0.0, 'processing': 0.0, 'published': 3.0, 'scheduled': 0.0, 'oldest_age_s': 131.9}
|
||||
[worker stopped] outbox + published grew by the uploads: 3.0
|
||||
[worker stopped] consumer spans after the stop: 0
|
||||
observed: last worker record in Loki: 'Attachment became ready' 1 s before the stop
|
||||
observed: 'Stopped worker' in stdout: yes
|
||||
[worker stopped] worker series gone before the start: 0
|
||||
observed: worker down for 145 s
|
||||
[worker stopped] uploads ready after the start: 3
|
||||
[worker stopped] MessengerQueueLagHigh resolved after the start: after 29 s
|
||||
observed: time to ready count, first points of the new process: [(2.3, 0.0)]
|
||||
[worker stopped] time to ready count grew by the uploads (by points): 3.0
|
||||
[worker stopped] other alerts firing: []
|
||||
[relay stopped] stand quiet before the step: yes
|
||||
[relay stopped]
|
||||
[relay stopped] queue depth and age series gone within 120 s: yes
|
||||
observed: queue series gone after 60 s
|
||||
observed: MessengerQueueMetricsMissing pending after 69 s
|
||||
[relay stopped] MessengerQueueMetricsMissing firing: after 190 s
|
||||
[relay stopped] MessengerQueueMetricsMissing resolved after the start: after 45 s
|
||||
[relay stopped] other alerts firing: []
|
||||
[slow database] stand quiet before the step: yes
|
||||
[slow database]
|
||||
observed: MessengerSlowRequests pending after 75 s
|
||||
[slow database] MessengerSlowRequests firing: after 135 s
|
||||
observed: slow light requests share: 0.427
|
||||
observed: p95 by route before: {'/api/v1/chats/{chat_id}/messages': 0.016}
|
||||
observed: p95 by route during: {'/api/v1/chats/{chat_id}/messages': 2.324}
|
||||
observed: PostgreSQL share of slow send traces: [1.0, 0.99, 1.0, 1.0, 1.0]
|
||||
[slow database] PostgreSQL spans over half of slow send traces (median): yes
|
||||
observed: pool used during (max): 6, before 0
|
||||
[slow database] pool busier than before: yes
|
||||
observed: CPU of replicas to limit (max): 0.09
|
||||
[slow database] CPU of replicas below half of the limit: yes
|
||||
[slow database] MessengerSlowRequests resolved after the unlock: after 74 s
|
||||
[slow database] other alerts firing: []
|
||||
[slow handler] stand quiet before the step: yes
|
||||
[slow handler]
|
||||
observed: logins: 515, median 0.25 s, max 0.73 s
|
||||
observed: PostgreSQL share of slow login traces: [0.0, 0.2, 0.01, 0.0, 0.01]
|
||||
[slow handler] PostgreSQL spans under a fifth of slow login traces (median): yes
|
||||
observed: pool: max share used 0.20, requests in checkout (max) 0, timeouts 0
|
||||
[slow handler] no request waits for a free pool connection: yes
|
||||
observed: CPU of replicas to limit (max): 0.81
|
||||
observed: p95 by route: {'/api/v1/chats/{chat_id}/messages': 0.085, '/api/v1/auth/sessions': 0.598}
|
||||
[slow handler] login p95 on the route panel slower than 0.25 s: yes
|
||||
observed: slow light requests share (max): 0.072
|
||||
[slow handler] MessengerSlowRequests stayed inactive: yes
|
||||
[slow handler] other alerts firing: []
|
||||
[database down] stand quiet before the step: yes
|
||||
[database down]
|
||||
observed: MessengerNoReadyReplicas pending after 29 s
|
||||
[database down] MessengerNoReadyReplicas firing: after 59 s
|
||||
observed: MessengerHighErrorRate pending after 44 s
|
||||
[database down] MessengerHighErrorRate firing: after 105 s
|
||||
[database down] ready replicas in LB: 0
|
||||
observed: 'Database is unavailable' records of replicas in Loki: 67
|
||||
observed: API traces with an error server span: 50, with a PostgreSQL span in error: 0
|
||||
[database down] LB ready after the start: yes
|
||||
observed: client responses during the outage: {'5xx': 2556}, from LB: 2497
|
||||
[database down] MessengerNoReadyReplicas resolved: after 30 s
|
||||
[database down] MessengerHighErrorRate resolved: after 135 s
|
||||
observed: 5xx grew: LB 2605, API 67; LB responses 5863
|
||||
[database down] 5xx on LB more than 5xx of API: yes
|
||||
[database down] LB 5xx grew by the LB's own 503 to the client or more: yes
|
||||
observed: availability SLI over the outage window: LB 0.5557, client 0.5581
|
||||
[database down] LB 5xx share equals the client's within 5%: yes
|
||||
observed: MessengerQueueMetricsMissing was pending (allowed)
|
||||
[database down] other alerts firing: []
|
||||
[SLI and panels]
|
||||
observed: client responses over the drill: {'2xx': 20911, '5xx': 2602}
|
||||
observed: messenger-slo windows in the last hour: 10 of 12
|
||||
SLI availability over 7 days within [0, 1]: yes
|
||||
observed: SLI availability: 7 days 0.93726, hour by rules 0.96010, by raw counters in the same windows 0.96010 (58645 events), raw increase over the hour 0.96590
|
||||
SLI availability over the hour, rules vs raw counters within 1 pp: yes
|
||||
SLI availability over the hour, rules vs raw increase over one window within 1 pp: yes
|
||||
observed: SLI availability over the drill: 0.88927
|
||||
SLI latency over 7 days within [0, 1]: yes
|
||||
observed: SLI latency: 7 days 0.98652, hour by rules 0.98658, by raw counters in the same windows 0.98658 (55462 events), raw increase over the hour 0.98724
|
||||
SLI latency over the hour, rules vs raw counters within 1 pp: yes
|
||||
SLI latency over the hour, rules vs raw increase over one window within 1 pp: yes
|
||||
observed: SLI latency over the drill: 0.98180
|
||||
SLI time to ready over 7 days within [0, 1]: yes
|
||||
observed: SLI time to ready: 7 days 0.93162, hour by rules 0.93586, by raw counters in the same windows 0.93501 (49 events), raw increase over the hour 0.88000
|
||||
SLI time to ready over the hour, rules vs raw counters within 1 pp: yes
|
||||
observed: SLI time to ready over the drill: 0.86957
|
||||
new panel queries (31) with data: []
|
||||
alert history panel shows firing of the steps: ['MessengerHighErrorRate', 'MessengerNoReadyReplicas', 'MessengerQueueLagHigh', 'MessengerQueueMetricsMissing', 'MessengerSlowRequests']
|
||||
memory prometheus ad08a84f4d3a: peak 128 MiB, anon+kernel+shmem 82 MiB, file 16 MiB, limit 384 MiB
|
||||
memory otel-collector 7209c9b86a7c: peak 83 MiB, anon+kernel+shmem 72 MiB, file 0 MiB, limit 256 MiB
|
||||
rule groups loaded expected ['messenger-alerts', 'messenger-sli', 'messenger-slo', 'telemetry-alerts'] got ['messenger-alerts', 'messenger-sli', 'messenger-slo', 'telemetry-alerts']
|
||||
rules with evaluation errors expected [] got []
|
||||
alerts loaded expected ['MessengerHighErrorRate', 'MessengerNoReadyReplicas', 'MessengerQueueLagHigh', 'MessengerQueueMetricsMissing', 'MessengerSlowRequests', 'TelemetryDataLoss', 'TelemetryTargetDown'] got ['MessengerHighErrorRate', 'MessengerNoReadyReplicas', 'MessengerQueueLagHigh', 'MessengerQueueMetricsMissing', 'MessengerSlowRequests', 'TelemetryDataLoss', 'TelemetryTargetDown']
|
||||
Grafana shows rules of the Prometheus datasource expected 200 ['messenger-alerts', 'messenger-sli', 'messenger-slo', 'telemetry-alerts'] got 200 ['messenger-alerts', 'messenger-sli', 'messenger-slo', 'telemetry-alerts']
|
||||
rule change through Grafana rejected expected yes got yes
|
||||
alert delivery addresses expected [] got []
|
||||
prometheus config has alertmanagers expected no got no
|
||||
uploads ready before the steps expected 20 got 20
|
||||
[worker stopped] stand quiet before the step expected yes got yes
|
||||
[worker stopped] uploads accepted (202) expected 3 got 3
|
||||
[worker stopped] MessengerQueueLagHigh firing after the first upload within 240 s expected yes got yes
|
||||
[worker stopped] outbox + published grew by the uploads expected 3.0 got 3.0
|
||||
[worker stopped] consumer spans after the stop expected 0 got 0
|
||||
[worker stopped] worker series gone before the start expected 0 got 0
|
||||
[worker stopped] uploads ready after the start expected 3 got 3
|
||||
[worker stopped] MessengerQueueLagHigh resolved after the start within 120 s expected yes got yes
|
||||
[worker stopped] time to ready count grew by the uploads (by points) expected 3.0 got 3.0
|
||||
[worker stopped] other alerts firing expected [] got []
|
||||
[relay stopped] stand quiet before the step expected yes got yes
|
||||
[relay stopped] queue depth and age series gone within 120 s expected yes got yes
|
||||
[relay stopped] MessengerQueueMetricsMissing firing within 300 s expected yes got yes
|
||||
[relay stopped] MessengerQueueMetricsMissing resolved after the start within 120 s expected yes got yes
|
||||
[relay stopped] other alerts firing expected [] got []
|
||||
[slow database] stand quiet before the step expected yes got yes
|
||||
[slow database] MessengerSlowRequests firing within 240 s expected yes got yes
|
||||
[slow database] PostgreSQL spans over half of slow send traces (median) expected yes got yes
|
||||
[slow database] pool busier than before expected yes got yes
|
||||
[slow database] CPU of replicas below half of the limit expected yes got yes
|
||||
[slow database] MessengerSlowRequests resolved after the unlock within 240 s expected yes got yes
|
||||
[slow database] other alerts firing expected [] got []
|
||||
[slow handler] stand quiet before the step expected yes got yes
|
||||
[slow handler] PostgreSQL spans under a fifth of slow login traces (median) expected yes got yes
|
||||
[slow handler] no request waits for a free pool connection expected yes got yes
|
||||
[slow handler] login p95 on the route panel slower than 0.25 s expected yes got yes
|
||||
[slow handler] MessengerSlowRequests stayed inactive expected yes got yes
|
||||
[slow handler] other alerts firing expected [] got []
|
||||
[database down] stand quiet before the step expected yes got yes
|
||||
[database down] MessengerNoReadyReplicas firing within 180 s expected yes got yes
|
||||
[database down] MessengerHighErrorRate firing within 180 s expected yes got yes
|
||||
[database down] ready replicas in LB expected 0 got 0
|
||||
[database down] LB ready after the start expected yes got yes
|
||||
[database down] MessengerNoReadyReplicas resolved within 240 s expected yes got yes
|
||||
[database down] MessengerHighErrorRate resolved within 240 s expected yes got yes
|
||||
[database down] 5xx on LB more than 5xx of API expected yes got yes
|
||||
[database down] LB 5xx grew by the LB's own 503 to the client or more expected yes got yes
|
||||
[database down] LB 5xx share equals the client's within 5% expected yes got yes
|
||||
[database down] other alerts firing expected [] got []
|
||||
SLI availability over 7 days within [0, 1] expected yes got yes
|
||||
SLI availability over the hour, rules vs raw counters within 1 pp expected yes got yes
|
||||
SLI availability over the hour, rules vs raw increase over one window within 1 pp expected yes got yes
|
||||
SLI latency over 7 days within [0, 1] expected yes got yes
|
||||
SLI latency over the hour, rules vs raw counters within 1 pp expected yes got yes
|
||||
SLI latency over the hour, rules vs raw increase over one window within 1 pp expected yes got yes
|
||||
SLI time to ready over 7 days within [0, 1] expected yes got yes
|
||||
SLI time to ready over the hour, rules vs raw counters within 1 pp expected yes got yes
|
||||
new panel queries (31) with data expected [] got []
|
||||
alert history panel shows firing of the steps expected ['MessengerHighErrorRate', 'MessengerNoReadyReplicas', 'MessengerQueueLagHigh', 'MessengerQueueMetricsMissing', 'MessengerSlowRequests'] got ['MessengerHighErrorRate', 'MessengerNoReadyReplicas', 'MessengerQueueLagHigh', 'MessengerQueueMetricsMissing', 'MessengerSlowRequests']
|
||||
PASS: each alert went firing on its fault and resolved after the recovery, no other alert fired; SLI agree by both paths
|
||||
restored: load stopped, lock session ended, PostgreSQL started, worker and relay running: yes, LB ready: yes
|
||||
```
|
||||
|
||||
## Чтение чисел
|
||||
|
||||
- **SLI за час** — по последней точке ряда `messenger-slo` (Prometheus пишет точку с временем
|
||||
предыдущего слота, design, «Уточнения apply», п. 11): окон за час 10 из 12 — Prometheus запущен
|
||||
в 00:42Z (шаг `[prometheus]` пробного `backend-outage` перед съёмкой), раньше рядов правил за этот
|
||||
час нет. В записанные окна попали пробные учения до съёмки и этот прогон, кроме последних 5–10
|
||||
мин: доступность за час 0,96010. Окно учений целиком — строки `SLI … over the drill` по исходным
|
||||
счётчикам: доступность 0,88927 (отказ БД), задержка 0,98180 (медленная БД), время до `ready`
|
||||
0,86957 (три загрузки при остановленном worker ждали дольше 30 с).
|
||||
- **Сверка путей** (спек «SLO считается», design, «Уточнения apply», пп. 12, 18): ряды правил против
|
||||
суммы `increase(…[5m])` исходных счётчиков в тех же окнах — доступность и задержка 0 п. п., время
|
||||
до `ready` 0,085 п. п. (0,93586 против 0,93501 при 49 событиях); у доступности и задержки ещё и
|
||||
против `increase` одним окном часа — 0,58 п. п. (0,96010 против 0,96590) и 0,066 п. п. (0,98658
|
||||
против 0,98724), допуск 1 п. п. У времени до `ready` одно окно (0,88000) — наблюдение: при единицах
|
||||
событий потеря приращения на границах непересекающихся окон меняет SLI на п. п.
|
||||
- **SLI за 7 суток** включает все учения и проверки этого и прошлых прогонов на рабочем стенде
|
||||
(доступность 0,93726 при SLO 0,995 — бюджет исчерпан учениями; остаток бюджета на панели
|
||||
отрицательный), это ожидаемо и названо в `REPORT.md` («Ограничения SLI»).
|
||||
- **Span PostgreSQL с ошибкой при недоступной БД — 0** из 50 найденных трасс с ошибкой server span
|
||||
(предел поиска — 50): отказ — на выдаче соединения из пула, до `before_cursor_execute` (design,
|
||||
«Уточнения apply», п. 9; наблюдение, а не проверка). Причину называют записи «Database is
|
||||
unavailable» в Loki (67 — по одной на ответ 503 реплик до вывода из LB, у API +67 ответов 5xx).
|
||||
- **Память** Prometheus и Collector — `memory.peak` с их запуска в 00:42Z и 00:44Z (пробный прогон
|
||||
`alerts-check` и этот): Prometheus 128 МиБ (неосвобождаемая часть 82), Collector 83 МиБ при
|
||||
лимитах 384 и 256 — правило «лимит ≥ 1,5 × пика» выполнено (раздел change `slo-alerts` в
|
||||
`evidence/telemetry/budget.md`).
|
||||
@@ -0,0 +1,109 @@
|
||||
# `make alerts_test` (change `slo-alerts`, задачи 11.1 и 12.11)
|
||||
|
||||
- Основа: commit `ef60b47` (fix: address slo-alerts verify findings), рабочее дерево чистое
|
||||
(`git status --short` пуст до прогона; новые файлы — только `evidence/`). Прежний прогон этого
|
||||
файла — на `15ea156` (до правок verify: 19 групп, 39 проверок оповещений, 15 проверок выражений).
|
||||
- Дата: 2026-11-14, 01:09:19Z – 01:09:20Z (~1 с); хост macOS, Docker 29.9.2, Compose 5.6.1. Стенд
|
||||
не нужен: файлы `infra/otel/prometheus/` (`prometheus.yml`, `rules.yml`, `rules.test.yml`) уходят
|
||||
`tar` через stdin в одноразовый контейнер закреплённого образа Prometheus с `--network none`, там
|
||||
`promtool check config`, `promtool check rules`, `promtool test rules rules.test.yml`; затем у
|
||||
каждого из семи оповещений `rules.yml` поле `runbook_url` — существующий файл репозитория.
|
||||
Команда из корня репозитория: `make alerts_test`, код выхода 0.
|
||||
- Состав тестов `rules.test.yml`: 22 блока синтетических рядов (интервал 15 с, как у стенда);
|
||||
43 проверки оповещений (`alert_rule_test`, в 21 блоке) и 17 проверок выражений правил записи
|
||||
(`promql_expr_test`, в 7 блоках). На каждое оповещение — срабатывание после `for`, нет
|
||||
срабатывания ниже порога и без трафика, снятие после восстановления (в `exp_annotations` — все
|
||||
аннотации дословно, с подставленным значением); `MessengerQueueMetricsMissing` молчит при
|
||||
недоступном экспортёре Collector, его описание называет возраст последнего снимка (и «more than
|
||||
an hour ago», если снимков не было); `TelemetryTargetDown` — `up` цели и число недоступных целей
|
||||
(одна и две разом); `TelemetryDataLoss` — новый ряд, рост, сброс счётчика; первая потеря
|
||||
процесса SDK: ряд суммы 0 до потери, `increase(telemetry:lost_items:total[5m])` равен потере
|
||||
(verify W1).
|
||||
- Сценарии: `observability` «Тесты правил» (проверка синтаксиса и модульные тесты правил — код 0);
|
||||
«Правила оповещений» — у каждого оповещения есть runbook в git, описание с текущим значением.
|
||||
|
||||
```
|
||||
promtool from prom/prometheus:v3.15.1@sha256:fa3302279710be2f21a8301ec17a8b4f2301fd829bd113839b3b6b02b6f191a2
|
||||
Checking prometheus.yml
|
||||
SUCCESS: 1 rule files found
|
||||
SUCCESS: prometheus.yml is valid prometheus config file syntax
|
||||
|
||||
Checking /etc/prometheus/rules.yml
|
||||
SUCCESS: 20 rules found
|
||||
|
||||
Checking rules.yml
|
||||
SUCCESS: 20 rules found
|
||||
|
||||
SUCCESS
|
||||
|
||||
runbook infra/otel/runbooks/MessengerHighErrorRate.md: ok
|
||||
runbook infra/otel/runbooks/MessengerSlowRequests.md: ok
|
||||
runbook infra/otel/runbooks/MessengerNoReadyReplicas.md: ok
|
||||
runbook infra/otel/runbooks/MessengerQueueLagHigh.md: ok
|
||||
runbook infra/otel/runbooks/MessengerQueueMetricsMissing.md: ok
|
||||
runbook infra/otel/runbooks/TelemetryTargetDown.md: ok
|
||||
runbook infra/otel/runbooks/TelemetryDataLoss.md: ok
|
||||
alerts: 7, each with an existing runbook
|
||||
```
|
||||
|
||||
Строки по шагам: `Checking prometheus.yml` и `Checking /etc/prometheus/rules.yml` — `check config`
|
||||
(он проверяет и файл из `rule_files`), `Checking rules.yml` — `check rules`, одиночное `SUCCESS` —
|
||||
итог `test rules` (43 + 17 проверок; при отказе он печатает каждую несовпавшую, как ниже).
|
||||
|
||||
## Контроли (не в git)
|
||||
|
||||
Тот же образ; три файла дерева `ef60b47` (`git archive`) — во временном каталоге вне репозитория,
|
||||
в копии `rules.yml` — одна правка, файлы репозитория не менялись; `promtool test rules
|
||||
rules.test.yml` на копии.
|
||||
|
||||
### Изменённый порог
|
||||
|
||||
Порог доли медленных «лёгких» запросов у `MessengerSlowRequests` поднят с 0.1 до 0.5:
|
||||
|
||||
```
|
||||
- expr: messenger:http_light_slow:ratio_rate2m > 0.1 and messenger:http_light_requests:rate2m > 0.1
|
||||
+ expr: messenger:http_light_slow:ratio_rate2m > 0.5 and messenger:http_light_requests:rate2m > 0.1
|
||||
```
|
||||
|
||||
Код 1:
|
||||
|
||||
```
|
||||
FAILED:
|
||||
alertname: MessengerSlowRequests, time: 6m,
|
||||
exp:[
|
||||
0:
|
||||
Labels:{alertname="MessengerSlowRequests", severity="warning"}
|
||||
Annotations:{description="50% of light API requests without 5xx in the last 2 minutes took longer than 0.25 s (threshold 10 %, SLO 99 %); login, registration and attachment bytes are not counted. Runbook: infra/otel/runbooks/MessengerSlowRequests.md", runbook_url="infra/otel/runbooks/MessengerSlowRequests.md", summary="Many light API requests are slower than 0.25 s"}
|
||||
],
|
||||
got:[]
|
||||
```
|
||||
|
||||
Доля медленных в тесте — ровно 50 %, поэтому с порогом `> 0.5` оповещение не срабатывает, и тест
|
||||
«срабатывание после `for`» красный.
|
||||
|
||||
### Правило потерь без нуля процесса SDK (verify W1)
|
||||
|
||||
Убрана третья часть `telemetry:lost_items:total` — ноль по ряду ёмкости очереди span (правило
|
||||
`15ea156`):
|
||||
|
||||
```
|
||||
sum by (job, instance) ({__name__=~"otel_sdk_(processor|exporter)_(span|log)_(processed|exported)_total",error_type!=""})
|
||||
- or
|
||||
- sum by (job, instance) (otel_sdk_processor_span_queue_capacity) * 0
|
||||
```
|
||||
|
||||
Код 1:
|
||||
|
||||
```
|
||||
FAILED:
|
||||
expr: "telemetry:lost_items:total", time: 3m,
|
||||
exp: {__name__="telemetry:lost_items:total", instance="a1", job="messenger-api"} 0E+00, {__name__="telemetry:lost_items:total", instance="r1", job="messenger-relay"} 0E+00
|
||||
got: nil
|
||||
expr: "increase(telemetry:lost_items:total[5m])", time: 6m,
|
||||
exp: {instance="a1", job="messenger-api"} 3.6E+01, {instance="r1", job="messenger-relay"} 0E+00
|
||||
got: {instance="a1", job="messenger-api"} 0E+00
|
||||
```
|
||||
|
||||
Без нуля ряда процесса нет до первой потери, ряд появляется сразу со значением 36, и `increase()`
|
||||
(как `rate()` панели потерь) это первое значение отбрасывает — 0 вместо 36. С правилом `ef60b47`
|
||||
тот же тест зелёный (вывод выше).
|
||||
@@ -0,0 +1,48 @@
|
||||
# Принявшая реплика остановлена
|
||||
|
||||
- Команда: `python3 .claude/skills/run-mtusi-messenger/driver.py --port 8080 attachment-failover --mode stop`, затем то же с `--mode kill` (`make replicas` драйвер выполняет сам в `finally`)
|
||||
- Дата: 2026-11-15, 06:38:59–06:39:10 UTC; оба прогона — код выхода 0
|
||||
- Commit: `db3340d` (ветка `feat/lab6-final`), рабочее дерево без правок кода (изменены только `QUESTIONS.md` и файлы `evidence/`)
|
||||
- Стенд: проект compose `mtusi-lab6`, две реплики за HAProxy, телеметрия включена, собран `make run_docker` из `HEAD`; пользователи синтетические
|
||||
- Сценарий: `attachments` «Принявшая реплика остановлена»
|
||||
- Вывод сокращён: убраны снимки `docker compose ps` до и после (все 15 сервисов `Up`, реплики `healthy`; после прогона `stop` у `api-14` новый `StartedAt` — его вернул `make replicas`)
|
||||
|
||||
## `stop`
|
||||
|
||||
```text
|
||||
mode: stop; fixture sample.png: 111817 bytes
|
||||
sha256 uploaded: 99ea7533c441f79cd630d15ce4d58d1ec4e06f6f0efb3b77a5c088305cd1bd75
|
||||
sha256 downloaded: 99ea7533c441f79cd630d15ce4d58d1ec4e06f6f0efb3b77a5c088305cd1bd75
|
||||
step expected got x-instance-id
|
||||
alice uploads 202 202 e6c96453fc1b
|
||||
attachment is ready ready ready
|
||||
alice sends message 201 201 e6c96453fc1b
|
||||
stop-one.sh stop 0 0 e6c96453fc1b
|
||||
bob downloads 200 200 8112fa687696
|
||||
bob reads metadata 200 200 8112fa687696
|
||||
eve reads metadata 404 404 8112fa687696
|
||||
eve downloads 404 404 8112fa687696
|
||||
make replicas 0 0
|
||||
LB slots UP 2 2
|
||||
PASS: accepted by e6c96453fc1b, served by 8112fa687696 after stop, sha256 matches, outsider gets 404
|
||||
```
|
||||
|
||||
## `kill`
|
||||
|
||||
```text
|
||||
mode: kill; fixture sample.png: 111817 bytes
|
||||
sha256 uploaded: 99ea7533c441f79cd630d15ce4d58d1ec4e06f6f0efb3b77a5c088305cd1bd75
|
||||
sha256 downloaded: 99ea7533c441f79cd630d15ce4d58d1ec4e06f6f0efb3b77a5c088305cd1bd75
|
||||
step expected got x-instance-id
|
||||
alice uploads 202 202 e6c96453fc1b
|
||||
attachment is ready ready ready
|
||||
alice sends message 201 201 e6c96453fc1b
|
||||
stop-one.sh kill 0 0 e6c96453fc1b
|
||||
bob downloads 200 200 8112fa687696
|
||||
bob reads metadata 200 200 8112fa687696
|
||||
eve reads metadata 404 404 8112fa687696
|
||||
eve downloads 404 404 8112fa687696
|
||||
make replicas 0 0
|
||||
LB slots UP 2 2
|
||||
PASS: accepted by e6c96453fc1b, served by 8112fa687696 after kill, sha256 matches, outsider gets 404
|
||||
```
|
||||
@@ -0,0 +1,108 @@
|
||||
# Вложения: метаданные, байты и ограничения обработки
|
||||
|
||||
- Команда: `python3 .claude/skills/run-mtusi-messenger/driver.py --port 8080 attachment-storage`
|
||||
- Дата: 2026-11-15, 06:37:43–06:37:47 UTC; код выхода 0
|
||||
- Commit: `db3340d` (ветка `feat/lab6-final`), рабочее дерево без правок кода (изменены только `QUESTIONS.md` и файлы `evidence/`)
|
||||
- Стенд: проект compose `mtusi-lab6`, две реплики за HAProxy, телеметрия включена, собран `make run_docker` из `HEAD`. Контейнеры `docker diff`: реплики `8112fa687696`, `e6c96453fc1b` и worker `2b6afe2410a9`
|
||||
- Сценарии: `attachments` «Байты не в БД и не на диске API», `data-storage` «Ограничения обработки в схеме» (пробы в откатываемой транзакции, запись аудита с неизвестным заданием). В списке колонок есть и колонки контекста W3C задания `traceparent`, `tracestate` (ревизия `e4b8c2d17f90`)
|
||||
- Вывод сокращён: таблица второго вложения повторяет первую и совпала с ожидаемым
|
||||
|
||||
Итог: байты — только объекты приватного bucket (анонимный GET 403), в PostgreSQL — метаданные и SHA-256 (`bytea`, 32 байта), в файловых системах реплик и worker — только смонтированный `config.toml`; четыре пробы ограничений дают названные коды, после отката — одно задание и три варианта.
|
||||
|
||||
```text
|
||||
columns of attachment tables:
|
||||
attachment_job_replays id uuid
|
||||
attachment_job_replays job_id uuid
|
||||
attachment_job_replays operator text
|
||||
attachment_job_replays error_code text
|
||||
attachment_job_replays reason text
|
||||
attachment_job_replays attempt integer
|
||||
attachment_job_replays created_at timestamp with time zone
|
||||
attachment_jobs id uuid
|
||||
attachment_jobs attachment_id uuid
|
||||
attachment_jobs pipeline_version integer
|
||||
attachment_jobs state text
|
||||
attachment_jobs attempt integer
|
||||
attachment_jobs last_error_code text
|
||||
attachment_jobs next_attempt_at timestamp with time zone
|
||||
attachment_jobs lease_expires_at timestamp with time zone
|
||||
attachment_jobs published_at timestamp with time zone
|
||||
attachment_jobs updated_at timestamp with time zone
|
||||
attachment_jobs finished_at timestamp with time zone
|
||||
attachment_jobs created_at timestamp with time zone
|
||||
attachment_jobs attempt_base integer
|
||||
attachment_jobs traceparent text
|
||||
attachment_jobs tracestate text
|
||||
attachment_variants attachment_id uuid
|
||||
attachment_variants pipeline_version integer
|
||||
attachment_variants variant text
|
||||
attachment_variants object_key text
|
||||
attachment_variants content_type text
|
||||
attachment_variants size_bytes integer
|
||||
attachment_variants width integer
|
||||
attachment_variants height integer
|
||||
attachment_variants sha256 bytea
|
||||
attachment_variants created_at timestamp with time zone
|
||||
attachments id uuid
|
||||
attachments chat_id uuid
|
||||
attachments owner_id uuid
|
||||
attachments filename text
|
||||
attachments content_type text
|
||||
attachments size_bytes integer
|
||||
attachments sha256 bytea
|
||||
attachments object_key text
|
||||
attachments status text
|
||||
attachments updated_at timestamp with time zone
|
||||
attachments created_at timestamp with time zone
|
||||
attachments lost_at timestamp with time zone
|
||||
attachments staging_key text
|
||||
attachments error_code text
|
||||
message_attachments message_id uuid
|
||||
message_attachments position smallint
|
||||
message_attachments attachment_id uuid
|
||||
message_attachments created_at timestamp with time zone
|
||||
upload via 8112fa687696: object_key messenger/attachments/178cf6ce-9630-4b2d-85a2-e7b051b328ab/original, staging_key messenger/staging/178cf6ce-9630-4b2d-85a2-e7b051b328ab/original
|
||||
sha256 uploaded 99ea7533c441f79cd630d15ce4d58d1ec4e06f6f0efb3b77a5c088305cd1bd75, downloaded by a member (200) 99ea7533c441f79cd630d15ce4d58d1ec4e06f6f0efb3b77a5c088305cd1bd75
|
||||
upload via 8112fa687696: object_key messenger/attachments/47cce102-97b2-422d-b519-3a7acecd2d27/original, staging_key messenger/staging/47cce102-97b2-422d-b519-3a7acecd2d27/original
|
||||
sha256 uploaded 99ea7533c441f79cd630d15ce4d58d1ec4e06f6f0efb3b77a5c088305cd1bd75, downloaded by a member (200) 99ea7533c441f79cd630d15ce4d58d1ec4e06f6f0efb3b77a5c088305cd1bd75
|
||||
constraint probes (rolled back):
|
||||
second job of the version: 23505 uq_attachment_jobs_attachment_id_pipeline_version
|
||||
second variant of the name: 23505 pk_attachment_variants
|
||||
error_code on not failed: 23514 ck_attachments_error_code_failed
|
||||
replay audit of an unknown job: 23503 fk_attachment_job_replays_job_id_attachment_jobs
|
||||
docker diff 8112fa687696: 2 changes
|
||||
C /app
|
||||
A /app/config.toml
|
||||
docker diff e6c96453fc1b: 2 changes
|
||||
C /app
|
||||
A /app/config.toml
|
||||
docker diff 2b6afe2410a9: 2 changes
|
||||
C /app
|
||||
A /app/config.toml
|
||||
bytea columns expected attachment_variants.sha256,attachments.sha256 got attachment_variants.sha256,attachments.sha256
|
||||
octet_length(sha256) expected 32 got 32
|
||||
object_key form expected messenger/attachments/178cf6ce-9630-4b2d-85a2-e7b051b328ab/original got messenger/attachments/178cf6ce-9630-4b2d-85a2-e7b051b328ab/original
|
||||
staging_key: its form or already empty expected yes got yes
|
||||
filename not in key expected no got no
|
||||
variant rows expected crop,optimized,thumbnail got crop,optimized,thumbnail
|
||||
crop in bucket expected yes got yes
|
||||
anonymous GET of crop expected 403 got 403
|
||||
optimized in bucket expected yes got yes
|
||||
anonymous GET of optimized expected 403 got 403
|
||||
thumbnail in bucket expected yes got yes
|
||||
anonymous GET of thumbnail expected 403 got 403
|
||||
object in bucket, bytes expected 111817 got 111817
|
||||
anonymous GET of the key expected 403 got 403
|
||||
downloaded sha256 = uploaded expected yes got yes
|
||||
(второе вложение 47cce102-…: те же 13 строк, expected = got)
|
||||
probe: second job of the version expected 23505 uq_attachment_jobs_attachment_id_pipeline_version got 23505 uq_attachment_jobs_attachment_id_pipeline_version
|
||||
probe: second variant of the name expected 23505 pk_attachment_variants got 23505 pk_attachment_variants
|
||||
probe: error_code on not failed expected 23514 ck_attachments_error_code_failed got 23514 ck_attachments_error_code_failed
|
||||
probe: replay audit of an unknown job expected 23503 fk_attachment_job_replays_job_id_attachment_jobs got 23503 fk_attachment_job_replays_job_id_attachment_jobs
|
||||
jobs | variants after the probes expected 1|3 got 1|3
|
||||
original files in 8112fa687696 expected 0 got 0
|
||||
original files in e6c96453fc1b expected 0 got 0
|
||||
original files in 2b6afe2410a9 expected 0 got 0
|
||||
sha256 of the fixture: 99ea7533c441f79cd630d15ce4d58d1ec4e06f6f0efb3b77a5c088305cd1bd75
|
||||
PASS: metadata in PostgreSQL, bytes only in the private bucket messenger, none in the API containers
|
||||
```
|
||||
@@ -0,0 +1,19 @@
|
||||
# Хранение паролей и токенов
|
||||
|
||||
- Команда: `python3 .claude/skills/run-mtusi-messenger/driver.py --port 8080 auth-storage`
|
||||
- Дата: 2026-11-15, 06:37:41–06:37:43 UTC; код выхода 0
|
||||
- Commit: `db3340d` (ветка `feat/lab6-final`), рабочее дерево без правок кода (изменены только `QUESTIONS.md` и файлы `evidence/`)
|
||||
- Стенд: проект compose `mtusi-lab6`, две реплики за HAProxy, телеметрия включена, собран `make run_docker` из `HEAD`; пользователи синтетические, пароль и токен только в памяти драйвера, в вывод не попадают
|
||||
- Спеки: `users`, «Хэш в БД», `sessions`, «Токена нет в хранилище» (исключения сверки покрытия: схема и дамп по HTTP не видны)
|
||||
|
||||
Итог: в `users` — строки Argon2id с разной солью у одного пароля, в `sessions` — только SHA-256 токена (32 байта); ни токена (текстом и в hex), ни пароля в `pg_dump --data-only` нет.
|
||||
|
||||
```text
|
||||
users auth_… and auth_…: same password P (36 characters with ':' and Cyrillic)
|
||||
password_hash $argon2id$v=19$m=65536,t=3,p=4$… (97 chars)
|
||||
password_hash $argon2id$v=19$m=65536,t=3,p=4$… (97 chars)
|
||||
hashes differ: t
|
||||
session of the first user: token T (43 characters); rows of sessions with token_hash = SHA-256(T): 1, octet_length 32
|
||||
pg_dump --data-only: 12 COPY blocks; T as text: no, T in hex: no, P as text: no
|
||||
PASS: only Argon2id strings and SHA-256 of the token are stored
|
||||
```
|
||||
@@ -0,0 +1,82 @@
|
||||
# Очереди разных баз разделены
|
||||
|
||||
- Команды по порядку: `make test_isolated KEEP_TEST_DB=1`, `python3 .claude/skills/run-mtusi-messenger/driver.py --port 8080 broker-check --require-test-queue`, `make test_isolated`
|
||||
- Дата: 2026-11-15; первый прогон 06:33:58–06:36:07 UTC, `broker-check` 06:40:52–06:41:00 UTC (код 0), второй прогон 06:41:00–06:43:17 UTC. Между первым прогоном и `broker-check` сняты другие доказательства (`evidence/broker/stand.md`, `make test-persistence` с рестартом брокера): очередь временной базы — durable и их пережила
|
||||
- Commit: `db3340d` (ветка `feat/lab6-final`), рабочее дерево без правок кода (изменены только `QUESTIONS.md` и файлы `evidence/`)
|
||||
- Стенд: рабочий `mtusi-lab6`, поверх него — контейнеры `mtusi-lab6-test-api`, `mtusi-lab6-test-worker`, `mtusi-lab6-test-relay` на временной базе `test_messenger` (телеметрия у них выключена)
|
||||
- Сценарий: `message-broker` «Очереди разных баз разделены»
|
||||
- Код 2 обоих `make test_isolated`: smoke — 0, набор — 2 только из-за `test_exclusion_evidence_exists` (в первом — 10 файлов исключений, во втором — только этот файл: его снимает сама эта последовательность). Оба прогона: 1 failed, 217 passed, 6 skipped, 147 deselected, ~117 с. Зелёный прогон после этого файла — `evidence/tests/test-isolated.md`
|
||||
- Список очередей до первого прогона не сохранён: на рабочем стенде перед ним была только `messenger.attachment.process.v1` (прежний `make test_isolated` убирает свою очередь, так и в выводе второго прогона)
|
||||
|
||||
## Очереди брокера: `rabbitmqctl -q list_queues name durable messages consumers --formatter json`
|
||||
|
||||
После `make test_isolated KEEP_TEST_DB=1` — очередь временной базы есть, рабочая не затронута:
|
||||
|
||||
```json
|
||||
[
|
||||
{"messages":0,"name":"test_messenger.attachment.process.v1","consumers":0,"durable":true}
|
||||
,{"messages":0,"name":"messenger.attachment.process.v1","consumers":1,"durable":true}
|
||||
]
|
||||
```
|
||||
|
||||
После второго `make test_isolated` — очереди временной базы нет:
|
||||
|
||||
```json
|
||||
[
|
||||
{"messages":0,"name":"messenger.attachment.process.v1","consumers":1,"durable":true}
|
||||
]
|
||||
```
|
||||
|
||||
## Вывод `make test_isolated`
|
||||
|
||||
Первый прогон (`KEEP_TEST_DB=1`):
|
||||
|
||||
```text
|
||||
[test_isolated] database=test_messenger objects=/buckets/messenger/test_messenger/ queue=test_messenger.attachment.process.v1 containers=mtusi-lab6-test-api mtusi-lab6-test-worker mtusi-lab6-test-relay base_url=http://127.0.0.1:18088
|
||||
[test_isolated] remove objects /buckets/messenger/test_messenger/ and queue test_messenger.attachment.process.v1
|
||||
...
|
||||
[test_isolated] cleanup
|
||||
[test_isolated] kept database test_messenger, objects /buckets/messenger/test_messenger/ and queue test_messenger.attachment.process.v1
|
||||
[test_isolated] results: {'test': 0, 'student_test': 2}
|
||||
```
|
||||
|
||||
Второй прогон:
|
||||
|
||||
```text
|
||||
[test_isolated] database=test_messenger objects=/buckets/messenger/test_messenger/ queue=test_messenger.attachment.process.v1 containers=mtusi-lab6-test-api mtusi-lab6-test-worker mtusi-lab6-test-relay base_url=http://127.0.0.1:18088
|
||||
[test_isolated] remove objects /buckets/messenger/test_messenger/ and queue test_messenger.attachment.process.v1
|
||||
...
|
||||
[test_isolated] cleanup
|
||||
[test_isolated] remove objects /buckets/messenger/test_messenger/ and queue test_messenger.attachment.process.v1
|
||||
[test_isolated] results: {'test': 0, 'student_test': 2}
|
||||
```
|
||||
|
||||
## `broker-check --require-test-queue` между прогонами (код 0)
|
||||
|
||||
```text
|
||||
image rabbitmq:4.3.7@sha256:bd88985187aa73cd598fa0d8b31d49b2f814a6d9e58f6d5a89bae588669d946a
|
||||
memory high watermark 419430400, container limit 536870912
|
||||
queues (name durable messages consumers):
|
||||
test_messenger.attachment.process.v1 True 0 0
|
||||
messenger.attachment.process.v1 True 0 1
|
||||
docker compose stop rabbitmq: 1.2 s
|
||||
image is tag and digest expected yes got yes
|
||||
container health expected healthy got healthy
|
||||
data volume expected mtusi-lab6_rabbitmq_data got mtusi-lab6_rabbitmq_data
|
||||
docker port expected 5672/tcp -> 127.0.0.1:5673 got 5672/tcp -> 127.0.0.1:5673
|
||||
container memory limit expected 536870912 got 536870912
|
||||
watermark below container limit expected yes got yes
|
||||
broker password holders expected rabbitmq,relay,worker got rabbitmq,relay,worker
|
||||
BROKER__* in the api service expected no got no
|
||||
work queue exists expected yes got yes
|
||||
work queue durable expected yes got yes
|
||||
queue test_messenger.attachment.process.v1 expected yes got yes
|
||||
docker compose stop exit code expected 0 got 0
|
||||
container exit code expected 0 got 0
|
||||
stopped before the 20 s grace expected yes got yes
|
||||
broker back (up --wait) expected 0 got 0
|
||||
work queue after restart expected yes got yes
|
||||
worker consumes again expected yes got yes
|
||||
relay survived the outage (StartedAt) expected yes got yes
|
||||
PASS: the broker stand matches the spec
|
||||
```
|
||||
@@ -0,0 +1,36 @@
|
||||
# Брокер рабочего стенда
|
||||
|
||||
- Команда: `python3 .claude/skills/run-mtusi-messenger/driver.py --port 8080 broker-check`
|
||||
- Дата: 2026-11-15, 06:37:33–06:37:41 UTC; код выхода 0
|
||||
- Commit: `db3340d` (ветка `feat/lab6-final`), рабочее дерево без правок кода (изменены только `QUESTIONS.md` и файлы `evidence/`)
|
||||
- Стенд: проект compose `mtusi-lab6`, телеметрия включена, собран `make run_docker` из `HEAD`. Очередь `test_messenger.…` в списке — остаток `make test_isolated KEEP_TEST_DB=1` (`evidence/broker/isolated.md`)
|
||||
- Сценарии спека `message-broker`: «Сервис брокера запущен», «Предел памяти брокера», «Остановка брокера»
|
||||
- `watermark` 419430400 байт — 400 МиБ из `infra/rabbitmq/rabbitmq.conf`; лимит контейнера 512 МиБ. Пароль брокера только у `rabbitmq`, `relay`, `worker`: у реплик API настроек брокера нет
|
||||
|
||||
```text
|
||||
image rabbitmq:4.3.7@sha256:bd88985187aa73cd598fa0d8b31d49b2f814a6d9e58f6d5a89bae588669d946a
|
||||
memory high watermark 419430400, container limit 536870912
|
||||
queues (name durable messages consumers):
|
||||
test_messenger.attachment.process.v1 True 0 0
|
||||
messenger.attachment.process.v1 True 0 1
|
||||
temporary database queue test_messenger.attachment.process.v1: not checked
|
||||
docker compose stop rabbitmq: 1.3 s
|
||||
image is tag and digest expected yes got yes
|
||||
container health expected healthy got healthy
|
||||
data volume expected mtusi-lab6_rabbitmq_data got mtusi-lab6_rabbitmq_data
|
||||
docker port expected 5672/tcp -> 127.0.0.1:5673 got 5672/tcp -> 127.0.0.1:5673
|
||||
container memory limit expected 536870912 got 536870912
|
||||
watermark below container limit expected yes got yes
|
||||
broker password holders expected rabbitmq,relay,worker got rabbitmq,relay,worker
|
||||
BROKER__* in the api service expected no got no
|
||||
work queue exists expected yes got yes
|
||||
work queue durable expected yes got yes
|
||||
docker compose stop exit code expected 0 got 0
|
||||
container exit code expected 0 got 0
|
||||
stopped before the 20 s grace expected yes got yes
|
||||
broker back (up --wait) expected 0 got 0
|
||||
work queue after restart expected yes got yes
|
||||
worker consumes again expected yes got yes
|
||||
relay survived the outage (StartedAt) expected yes got yes
|
||||
PASS: the broker stand matches the spec
|
||||
```
|
||||
Vendored
+23
@@ -0,0 +1,23 @@
|
||||
# Кэш карточки чата
|
||||
|
||||
- Команды: `make test_isolated KEEP_TEST_DB=1` (ключи временной базы), затем `python3 .claude/skills/run-mtusi-messenger/driver.py --port 8080 cache-check --require-test-keys`
|
||||
- Дата: 2026-11-15; `make test_isolated` до 06:36:07 UTC, `cache-check` 06:36:37–06:37:02 UTC, код выхода `cache-check` 0
|
||||
- Код выхода `make test_isolated` 2 и только по одной причине: `test_exclusion_evidence_exists` (этого файла и соседних исключений ещё не было); публичный `make test` в нём — код 0. Снятие файла этой команды требует её прогона, поэтому поменять порядок нельзя
|
||||
- Commit: `db3340d` (ветка `feat/lab6-final`), рабочее дерево без правок кода (изменены только `QUESTIONS.md` и файлы `evidence/`)
|
||||
- Стенд: проект compose `mtusi-lab6`, две реплики за HAProxy, телеметрия включена, собран `make run_docker` из `HEAD`; пользователи и чат синтетические
|
||||
- Спеки: `chat-cache`, «Чтение из кэша», «Срок записи», «Временная база» (исключения сверки покрытия: по HTTP ответ из кэша не отличить от ответа из PostgreSQL)
|
||||
|
||||
Итог: на 50 чтений карточки через LB — одно чтение таблицы `chats` (первое, ключ перед этим удалён), +49 попаданий и +1 промах Valkey; срок ключа не больше настроенного (3600 с), чтения его не продлевают; ключи рабочей и временной базы — под разными префиксами (1 и 166).
|
||||
|
||||
```text
|
||||
users alice_… (creator) and bob_… (reader), chat a0334358-bf18-4591-a565-056c4e4ef3e3
|
||||
key messenger:v1:messenger:chat:a0334358-bf18-4591-a565-056c4e4ef3e3
|
||||
right after 201: EXISTS 1, TTL 3600 s (configured [cache] chat_ttl_seconds 3600 s in the replica); value keys ['created_at', 'id', 'member_ids', 'title'], member_ids in creation order: yes
|
||||
DEL key: the first read is a miss; waiting 11 s
|
||||
50 × GET /api/v1/chats/{id} by the reader through LB: 50 equal to the creation response; by replica 8112fa687696 25, e6c96453fc1b 25
|
||||
after 11 s: reads of table chats (seq_scan + idx_scan) +1, keyspace_hits +49, keyspace_misses +1
|
||||
TTL 3589 s, then 10 more reads, TTL 3588 s: reads do not extend the key
|
||||
keys messenger:v1:messenger:chat:*: 1
|
||||
keys messenger:v1:test_messenger:chat:*: 166
|
||||
PASS: one read of chats, the rest from Valkey; TTL is bounded; temporary database: 166 keys under its own prefix
|
||||
```
|
||||
@@ -0,0 +1,34 @@
|
||||
# Отказ одной реплики API
|
||||
|
||||
- Команды: `make test-failover ACTION_SCRIPT=scripts/stop-one.sh STOP_MODE=stop STOP_ONE_LOG=<файл>`, `make replicas`, `make test-failover ACTION_SCRIPT=scripts/stop-one.sh STOP_MODE=kill STOP_ONE_LOG=<файл>`, `make replicas`, `make lb_stats`
|
||||
- Дата: 2026-11-15, 06:49:05–06:49:41 UTC; оба прогона — код выхода 0
|
||||
- Commit: `db3340d` (ветка `feat/lab6-final`), рабочее дерево без правок кода (изменены только `QUESTIONS.md` и файлы `evidence/`)
|
||||
- Стенд: проект compose `mtusi-lab6`, две реплики за HAProxy, телеметрия включена, собран `make run_docker` из `HEAD`
|
||||
- `STOP_ONE_LOG` назвал реплику: в обоих прогонах `TARGET_INSTANCE_ID=d34fc9b86aa4`, контейнер `d34fc9b86aa4…`, остановленный контейнер совпадает с целью; между прогонами `make replicas` вернул реплику
|
||||
- `failed_attempts` 1 в режиме `kill` — запись, которая была в полёте на убитой реплике: LB не повторяет `POST` после отправленного запроса (повтор — только на отказ соединения, `balancer.md`), клиент проверки повторяет её сам с тем же ключом и телом, дубля нет; данные и сессия сохранены (`PASS`). В лабе 5 на той же проверке было 0 — гонка момента `docker kill` с отправкой записи, а не изменение кода. 5xx на `BACKEND` в статистике — накопленные с рестарта LB, в том числе от `attachment-failover`
|
||||
|
||||
## `stop`
|
||||
|
||||
```text
|
||||
{"observed_instances_before": 2, "successful_writes": 120, "failed_attempts": 0, "first_recovery_seconds": 1.201}
|
||||
PASS: failover preserved confirmed data and existing session. Hook scope needs operator evidence.
|
||||
2026-11-15T06:49:06Z TARGET_INSTANCE_ID=d34fc9b86aa4 container=d34fc9b86aa4edfc55f531909a22818375ef6466c58d818b86de046e702d7cdb mode=stop
|
||||
```
|
||||
|
||||
## `kill`
|
||||
|
||||
```text
|
||||
{"observed_instances_before": 2, "successful_writes": 114, "failed_attempts": 1, "first_recovery_seconds": 0.231}
|
||||
PASS: failover preserved confirmed data and existing session. Hook scope needs operator evidence.
|
||||
2026-11-15T06:49:24Z TARGET_INSTANCE_ID=d34fc9b86aa4 container=d34fc9b86aa4edfc55f531909a22818375ef6466c58d818b86de046e702d7cdb mode=kill
|
||||
```
|
||||
|
||||
## После `make replicas`
|
||||
|
||||
```text
|
||||
svname addr status check_status scur stot econ wretr wredis hrsp_5xx
|
||||
api-1 192.168.96.9:8080 UP L7OK 0 1152 0 0 6 0
|
||||
api-2 192.168.96.8:8080 UP L7OK 0 1379 0 0 0 0
|
||||
BACKEND - UP - 0 2527 2 0 6 3
|
||||
free slots: 6
|
||||
```
|
||||
@@ -0,0 +1,76 @@
|
||||
# Повтор отправки после рестарта API
|
||||
|
||||
- Шаги: синтетический пользователь (регистрация, вход по Basic) и чат; `POST /api/v1/chats/<chat>/messages` с `Idempotency-Key`; `docker compose up -d --force-recreate api`; ожидание `/health/ready` 200 через LB; тот же `POST` с тем же ключом и токеном; другое тело с тем же ключом; `GET` истории. Шаги выполнил разовый скрипт на stdlib вне репозитория (те же запросы, что `driver.py --port 8080 req … --key <ключ>` скилла), шаги выше повторяются руками
|
||||
- Дата: 2026-11-15, 06:39:32–06:39:38 UTC; код выхода 0
|
||||
- Commit: `db3340d` (ветка `feat/lab6-final`), рабочее дерево без правок кода (изменены только `QUESTIONS.md` и файлы `evidence/`)
|
||||
- Стенд: проект compose `mtusi-lab6`, две реплики за HAProxy, телеметрия включена, собран `make run_docker` из `HEAD`; пользователь и чат синтетические
|
||||
- Спек: `idempotency`, «Повтор после рестарта API» (исключение сверки покрытия: тесты сервер не трогают)
|
||||
- Вывод обезличен: ключ заменён на `<key>`; токена и пароля в выводе нет
|
||||
|
||||
Итог: новые контейнеры обеих реплик (другие `id` и `StartedAt`), повтор — тот же 201 и тот же `Message` от реплики, которой при первой отправке не было (`e6c96453fc1b` → `d34fc9b86aa4`). В истории одно сообщение; другое тело с тем же ключом — 409. Сессия и ключ лежат в PostgreSQL, поэтому пересоздание реплик на них не влияет. Compose пересоздал только реплики, зависимости (`migrate`, `s3-bootstrap`) лишь повторно запустил; PostgreSQL не перезапускался.
|
||||
|
||||
```text
|
||||
--- before: api containers (name, id, StartedAt)
|
||||
/mtusi-lab6-api-13 8112fa687696 2026-11-15T06:33:44.100363013Z
|
||||
/mtusi-lab6-api-14 e6c96453fc1b 2026-11-15T06:39:07.790523426Z
|
||||
--- first send
|
||||
idempotency-key: <key>
|
||||
201 x-request-id: 2186a97e48604705a47121996a371299 x-instance-id: e6c96453fc1b
|
||||
{
|
||||
"id": "a23371cd-c05f-4d9c-b5a5-5fad6612ae9d",
|
||||
"chat_id": "9a476e8c-87fe-4ea8-985b-24880bd533b3",
|
||||
"sender_id": "c964e2db-d181-4e27-8d42-4d72e68fe2a4",
|
||||
"text": "replay after restart",
|
||||
"created_at": "2026-11-15T06:39:32.610039Z",
|
||||
"attachment_ids": []
|
||||
}
|
||||
--- docker compose up -d --force-recreate api
|
||||
Container mtusi-lab6-api-13 Recreate
|
||||
Container mtusi-lab6-api-14 Recreate
|
||||
Container mtusi-lab6-api-13 Recreated
|
||||
Container mtusi-lab6-api-14 Recreated
|
||||
Container mtusi-lab6-s3-bootstrap-1 Starting
|
||||
Container mtusi-lab6-migrate-1 Starting
|
||||
Container mtusi-lab6-s3-bootstrap-1 Started
|
||||
Container mtusi-lab6-migrate-1 Started
|
||||
Container mtusi-lab6-migrate-1 Waiting
|
||||
Container mtusi-lab6-s3-bootstrap-1 Waiting
|
||||
Container mtusi-lab6-migrate-1 Exited
|
||||
Container mtusi-lab6-s3-bootstrap-1 Exited
|
||||
Container mtusi-lab6-api-14 Starting
|
||||
Container mtusi-lab6-api-14 Started
|
||||
Container mtusi-lab6-api-13 Starting
|
||||
Container mtusi-lab6-api-13 Started
|
||||
exit 0
|
||||
LB ready: 200
|
||||
--- after: api containers (name, id, StartedAt)
|
||||
/mtusi-lab6-api-13 d34fc9b86aa4 2026-11-15T06:39:37.107929926Z
|
||||
/mtusi-lab6-api-14 35f606496f73 2026-11-15T06:39:37.041578759Z
|
||||
--- repeat with the same key, the same session
|
||||
idempotency-key: <key>
|
||||
201 x-request-id: ecdfd487a0de46f7b6f97665adf584d2 x-instance-id: d34fc9b86aa4
|
||||
{
|
||||
"id": "a23371cd-c05f-4d9c-b5a5-5fad6612ae9d",
|
||||
"chat_id": "9a476e8c-87fe-4ea8-985b-24880bd533b3",
|
||||
"sender_id": "c964e2db-d181-4e27-8d42-4d72e68fe2a4",
|
||||
"text": "replay after restart",
|
||||
"created_at": "2026-11-15T06:39:32.610039Z",
|
||||
"attachment_ids": []
|
||||
}
|
||||
--- other body with the same key
|
||||
idempotency-key: <key>
|
||||
409 x-request-id: 12ed1beb0aa5443a9181b2869e62336f x-instance-id: 35f606496f73
|
||||
{
|
||||
"error": {
|
||||
"code": "conflict",
|
||||
"message": "Idempotency key was already used with another request",
|
||||
"request_id": "12ed1beb0aa5443a9181b2869e62336f"
|
||||
}
|
||||
}
|
||||
--- history
|
||||
{"count": 1, "ids": ["a23371cd-c05f-4d9c-b5a5-5fad6612ae9d"]}
|
||||
--- compare
|
||||
Message of the repeat = Message of the first send: yes
|
||||
other instance answered the repeat: yes
|
||||
PASS
|
||||
```
|
||||
@@ -0,0 +1,259 @@
|
||||
# Ревизия `e4b8c2d17f90`: проба, откат на прежний образ и `make rolling_update` (change `job-trace-propagation`, задача 12.3)
|
||||
|
||||
- Основа: commit `72cfa9a` (feat: propagate trace context through outbox and add pipeline saturation
|
||||
metrics), рабочее дерево без правок кода (добавлены только файлы `evidence/`).
|
||||
- Дата: 2026-11-11, 16:58:47Z – 17:06:03Z; стенд — проект compose `mtusi-lab6`, PostgreSQL 18.6.
|
||||
- Ревизия (design, решение 4; `migrations.md`): `attachment_jobs.traceparent`, `tracestate` (`text
|
||||
NULL`), CHECK `ck_attachment_jobs_traceparent` и `ck_attachment_jobs_tracestate` `NOT VALID`,
|
||||
первой строкой `SET LOCAL lock_timeout = '2s'`; `downgrade` — зеркально.
|
||||
- Спеки: `db-migrations` (расширение схемы, повтор, старые реплики на новой схеме), `observability`
|
||||
«Сквозная трасса загрузки и обработки» (колонки контекста); design, решения 4, 6 и Migration Plan.
|
||||
- Вывод сокращён: из журнала alembic оставлены события «Running …», из ошибки lock_timeout —
|
||||
трассировка стека (последние строки — как есть); строки синтетические.
|
||||
|
||||
## Проба на временной базе
|
||||
|
||||
Временная база `jtp_migprobe` в контейнере `postgres` (`DATABASE__NAME` в окружении `uv run
|
||||
alembic` с хоста, в конце `DROP DATABASE` в `trap`): с нуля, `alembic check`, повтор, `downgrade
|
||||
-1`, снова `upgrade`; задание прежней ревизии; ограничения (строки вставлены с
|
||||
`session_replication_role = replica` — без триггеров FK на вложение, CHECK при этом действуют);
|
||||
транзакция держит `attachment_jobs` дольше 2 с — ревизия падает по `lock_timeout` без изменений,
|
||||
повтор проходит. Две строки с верным контекстом вставлены (итог «3|2»: задание прежней ревизии и
|
||||
две новые), пять неверных — отказ CHECK.
|
||||
|
||||
```text
|
||||
CREATE DATABASE
|
||||
--- from scratch, check, repeat, downgrade -1, upgrade
|
||||
"Running upgrade -> 16c279725564, added messenger tables"
|
||||
"Running upgrade 16c279725564 -> 42bc3b9be38f, added sessions and password hashes"
|
||||
"Running upgrade 42bc3b9be38f -> 7652184b7016, added idempotency keys"
|
||||
"Running upgrade 7652184b7016 -> e656d6bbe1a4, added message instance id"
|
||||
"Running upgrade e656d6bbe1a4 -> ef25d50b01a8, added attachments tables"
|
||||
"Running upgrade ef25d50b01a8 -> 739b8f04d5fb, added pending attachments index"
|
||||
"Running upgrade 739b8f04d5fb -> 5c3e1f0a9b7d, added attachments lost_at"
|
||||
"Running upgrade 5c3e1f0a9b7d -> a1d4c7e90b23, added attachment jobs and variants"
|
||||
"Running upgrade a1d4c7e90b23 -> c7e2f1a04b56, added job replays and attempt base"
|
||||
"Running upgrade c7e2f1a04b56 -> d3f9a6b2c1e7, added job outbox indexes"
|
||||
"Running upgrade d3f9a6b2c1e7 -> e4b8c2d17f90, added job trace context"
|
||||
alembic upgrade head: exit 0
|
||||
e4b8c2d17f90 (head)
|
||||
alembic current: exit 0
|
||||
No new upgrade operations detected.
|
||||
alembic check: exit 0
|
||||
alembic upgrade head: exit 0
|
||||
e4b8c2d17f90 (head)
|
||||
alembic current: exit 0
|
||||
"Running downgrade e4b8c2d17f90 -> d3f9a6b2c1e7, added job trace context"
|
||||
alembic downgrade -1: exit 0
|
||||
d3f9a6b2c1e7
|
||||
alembic current: exit 0
|
||||
trace columns after downgrade:
|
||||
0
|
||||
"Running upgrade d3f9a6b2c1e7 -> e4b8c2d17f90, added job trace context"
|
||||
alembic upgrade head: exit 0
|
||||
e4b8c2d17f90 (head)
|
||||
alembic current: exit 0
|
||||
--- a job of the previous revision, then upgrade
|
||||
"Running downgrade e4b8c2d17f90 -> d3f9a6b2c1e7, added job trace context"
|
||||
alembic downgrade -1: exit 0
|
||||
INSERT of the previous level: done
|
||||
"Running upgrade d3f9a6b2c1e7 -> e4b8c2d17f90, added job trace context"
|
||||
alembic upgrade head: exit 0
|
||||
job of the previous level: id | state | traceparent is null | tracestate is null
|
||||
66666666-6666-4666-8666-666666666661|queued|t|t
|
||||
columns: name | type | nullable
|
||||
traceparent|text|YES
|
||||
tracestate|text|YES
|
||||
convalidated of the new CHECKs:
|
||||
ck_attachment_jobs_traceparent|f
|
||||
ck_attachment_jobs_tracestate|f
|
||||
--- constraints (FK triggers off: session_replication_role = replica; CHECK still applies)
|
||||
sampled root (flags 01):
|
||||
root with random trace id flag (03, SDK 1.45):
|
||||
version ff:
|
||||
ERROR: new row for relation "attachment_jobs" violates check constraint "ck_attachment_jobs_traceparent"
|
||||
upper-case hex:
|
||||
ERROR: new row for relation "attachment_jobs" violates check constraint "ck_attachment_jobs_traceparent"
|
||||
tracestate without traceparent:
|
||||
ERROR: new row for relation "attachment_jobs" violates check constraint "ck_attachment_jobs_tracestate"
|
||||
empty tracestate:
|
||||
ERROR: new row for relation "attachment_jobs" violates check constraint "ck_attachment_jobs_tracestate"
|
||||
tracestate of 513 chars:
|
||||
ERROR: new row for relation "attachment_jobs" violates check constraint "ck_attachment_jobs_tracestate"
|
||||
rows now: total | with traceparent
|
||||
3|2
|
||||
--- lock_timeout: a transaction holds attachment_jobs longer than 2 s
|
||||
"Running downgrade e4b8c2d17f90 -> d3f9a6b2c1e7, added job trace context"
|
||||
alembic downgrade -1: exit 0
|
||||
asyncpg.exceptions.LockNotAvailableError: canceling statement due to lock timeout
|
||||
sqlalchemy.exc.DBAPIError: (sqlalchemy.dialects.postgresql.asyncpg.Error) canceling statement due to lock timeout
|
||||
[SQL: ALTER TABLE attachment_jobs ADD COLUMN traceparent TEXT]
|
||||
"Running upgrade d3f9a6b2c1e7 -> e4b8c2d17f90, added job trace context"
|
||||
alembic upgrade head: exit 1
|
||||
upgrade under lock took 3 s
|
||||
d3f9a6b2c1e7
|
||||
alembic current: exit 0
|
||||
trace columns after the failure:
|
||||
0
|
||||
"Running upgrade d3f9a6b2c1e7 -> e4b8c2d17f90, added job trace context"
|
||||
alembic upgrade head: exit 0
|
||||
e4b8c2d17f90 (head)
|
||||
alembic current: exit 0
|
||||
DROP DATABASE
|
||||
```
|
||||
|
||||
`alembic check` печатает ещё `SAWarning: Can't validate argument 'dialect_options'` из
|
||||
`migrations/env.py` (прежнее предупреждение, не от этой ревизии).
|
||||
|
||||
## `--sql` (офлайн, без базы)
|
||||
|
||||
`uv run alembic upgrade d3f9a6b2c1e7:e4b8c2d17f90 --sql` и `downgrade e4b8c2d17f90:d3f9a6b2c1e7
|
||||
--sql` — код 0 оба; `lock_timeout` — первой командой транзакции, оба CHECK — `NOT VALID`:
|
||||
|
||||
```sql
|
||||
BEGIN;
|
||||
|
||||
-- Running upgrade d3f9a6b2c1e7 -> e4b8c2d17f90
|
||||
|
||||
SET LOCAL lock_timeout = '2s';
|
||||
|
||||
ALTER TABLE attachment_jobs ADD COLUMN traceparent TEXT;
|
||||
|
||||
ALTER TABLE attachment_jobs ADD COLUMN tracestate TEXT;
|
||||
|
||||
ALTER TABLE attachment_jobs ADD CONSTRAINT ck_attachment_jobs_traceparent CHECK (traceparent ~ '^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$') NOT VALID;
|
||||
|
||||
ALTER TABLE attachment_jobs ADD CONSTRAINT ck_attachment_jobs_tracestate CHECK (tracestate IS NULL OR (traceparent IS NOT NULL AND char_length(tracestate) BETWEEN 1 AND 512)) NOT VALID;
|
||||
|
||||
UPDATE alembic_version SET version_num='e4b8c2d17f90' WHERE alembic_version.version_num = 'd3f9a6b2c1e7';
|
||||
|
||||
COMMIT;
|
||||
|
||||
BEGIN;
|
||||
|
||||
-- Running downgrade e4b8c2d17f90 -> d3f9a6b2c1e7
|
||||
|
||||
SET LOCAL lock_timeout = '2s';
|
||||
|
||||
ALTER TABLE attachment_jobs DROP CONSTRAINT ck_attachment_jobs_tracestate;
|
||||
|
||||
ALTER TABLE attachment_jobs DROP CONSTRAINT ck_attachment_jobs_traceparent;
|
||||
|
||||
ALTER TABLE attachment_jobs DROP COLUMN tracestate;
|
||||
|
||||
ALTER TABLE attachment_jobs DROP COLUMN traceparent;
|
||||
|
||||
UPDATE alembic_version SET version_num='d3f9a6b2c1e7' WHERE alembic_version.version_num = 'e4b8c2d17f90';
|
||||
|
||||
COMMIT;
|
||||
```
|
||||
|
||||
## Рабочий стенд: откат на прежний образ, ревизия до и после `make rolling_update`
|
||||
|
||||
Стенд был на `e4b8c2d17f90` (ревизию применил apply). Чтобы показать переход по Migration Plan
|
||||
design, реплики откачены на образ `ff0073e` (код до change: колонок не знает) `make rolling_update
|
||||
COMMIT=ff0073e MIGRATE=0` — схема остаётся новой, `make test` на прежнем образе проходит; затем
|
||||
relay, worker и уборщик нового кода остановлены (они читают новые колонки) и ревизия на рабочей
|
||||
базе снята на шаг (`uv run alembic downgrade -1` с хоста: прежний образ новой ревизии не знает);
|
||||
дальше — штатно вперёд: `make rolling_update` (ревизия один раз в контейнере `migrate` нового
|
||||
образа, затем реплики по одной), `docker compose up -d --no-deps --force-recreate relay worker
|
||||
cleaner`, `make test`. После — реплики, relay, worker, уборщик и `migrate` на одном образе
|
||||
(`66e41a7d85f2`, собран из дерева commit). Задание загрузки `make test` на прежнем образе — без
|
||||
контекста, после замены — с ним («2246 jobs, 1 with traceparent»: контекст прежних заданий снят
|
||||
откатом ревизии, новое — с контекстом).
|
||||
|
||||
```text
|
||||
--- before: 2026-11-11T17:05:13Z
|
||||
revision: e4b8c2d17f90; trace columns: 2; 2244 jobs, 531 with traceparent
|
||||
api mtusi-lab6-api-5 fe761ce3089a running
|
||||
api mtusi-lab6-api-6 fe761ce3089a running
|
||||
relay mtusi-lab6-relay-1 fe761ce3089a running
|
||||
worker mtusi-lab6-worker-1 fe761ce3089a running
|
||||
cleaner mtusi-lab6-cleaner-1 fe761ce3089a running
|
||||
migrate mtusi-lab6-migrate-1 fe761ce3089a exited
|
||||
--- rollback: replicas on ff0073e (code before the change), schema stays
|
||||
$ make rolling_update COMMIT=ff0073e MIGRATE=0
|
||||
API_REPLICAS=2 ROLLOUT_COMMIT="ff0073e" ROLLOUT_MIGRATE=0 scripts/rolling-update.sh
|
||||
17:05:14 rolling-update: start: 2 replicas a4a1f203ef70 48b425abbd15, image mtusi-messenger:lab6 from ff0073e
|
||||
17:05:25 rolling-update: build done in 11s
|
||||
17:05:25 rolling-update: migrate skipped (ROLLOUT_MIGRATE=0)
|
||||
17:05:26 rolling-update: replica 1/2: started new 8eb475bf8780
|
||||
17:05:29 rolling-update: replica 1/2: new 8eb475bf8780 addr 192.168.96.13 slot api-3 UP in 4s
|
||||
17:05:29 rolling-update: replica 1/2: drain old a4a1f203ef70 addr 192.168.96.8 slot api-2
|
||||
17:05:29 rolling-update: replica 1/2: old a4a1f203ef70 idle after 0s
|
||||
17:05:30 rolling-update: replica 1/2: maint slot api-2, stopping old a4a1f203ef70
|
||||
17:05:30 rolling-update: replica 1/2: removed old a4a1f203ef70 (stop 0s, exit 0)
|
||||
17:05:31 rolling-update: replica 1/2: slot api-2 ready
|
||||
17:05:31 rolling-update: replica 2/2: started new ce7885bbd38a
|
||||
17:05:34 rolling-update: replica 2/2: new ce7885bbd38a addr 192.168.96.8 slot api-2 UP in 3s
|
||||
17:05:34 rolling-update: replica 2/2: drain old 48b425abbd15 addr 192.168.96.6 slot api-1
|
||||
17:05:34 rolling-update: replica 2/2: old 48b425abbd15 idle after 0s
|
||||
17:05:34 rolling-update: replica 2/2: maint slot api-1, stopping old 48b425abbd15
|
||||
17:05:35 rolling-update: replica 2/2: removed old 48b425abbd15 (stop 1s, exit 0)
|
||||
17:05:35 rolling-update: replica 2/2: slot api-1 ready
|
||||
17:05:36 rolling-update: done: 2 replicas 8eb475bf8780 ce7885bbd38a UP in 22s
|
||||
-> exit 0, 22 s
|
||||
revision: e4b8c2d17f90
|
||||
api mtusi-lab6-api-7 089ea4db2c35 running
|
||||
api mtusi-lab6-api-8 089ea4db2c35 running
|
||||
relay mtusi-lab6-relay-1 fe761ce3089a running
|
||||
worker mtusi-lab6-worker-1 fe761ce3089a running
|
||||
cleaner mtusi-lab6-cleaner-1 fe761ce3089a running
|
||||
migrate mtusi-lab6-migrate-1 fe761ce3089a exited
|
||||
--- previous image on the new schema
|
||||
$ make test
|
||||
PASS: lab6 public API scenario; infrastructure and grading evidence remain separate.
|
||||
-> exit 0, 1 s
|
||||
--- revision one step back, relay, worker and cleaner of the new code stopped (they read the new columns)
|
||||
$ docker compose stop relay worker cleaner
|
||||
-> exit 0, 0 s
|
||||
$ uv run alembic downgrade -1 (host, .env; the image ff0073e does not know the new revision)
|
||||
"event": "Running downgrade e4b8c2d17f90 -> d3f9a6b2c1e7, added job trace context"
|
||||
revision: d3f9a6b2c1e7; trace columns: 0
|
||||
--- forward: make rolling_update (revision once, then replicas)
|
||||
revision before: d3f9a6b2c1e7
|
||||
$ make rolling_update
|
||||
API_REPLICAS=2 ROLLOUT_COMMIT="" ROLLOUT_MIGRATE=1 scripts/rolling-update.sh
|
||||
17:05:40 rolling-update: start: 2 replicas 8eb475bf8780 ce7885bbd38a, image mtusi-messenger:lab6 from working tree
|
||||
17:05:41 rolling-update: build done in 1s
|
||||
Container mtusi-lab6-migrate-1 Recreate
|
||||
migrate-1 | {"event": "Running alembic", … "database": "messenger", … "timestamp": "2026-11-11T17:05:43.832926Z", …}
|
||||
migrate-1 | {"event": "Running upgrade d3f9a6b2c1e7 -> e4b8c2d17f90, added job trace context", … "timestamp": "2026-11-11T17:05:43.920442Z"}
|
||||
migrate-1 | {"event": "Finished alembic", … "database": "messenger", … "timestamp": "2026-11-11T17:05:43.938574Z", …}
|
||||
migrate-1 exited with code 0
|
||||
17:05:44 rolling-update: migrate done in 3s
|
||||
17:05:44 rolling-update: replica 1/2: started new 037e58f95feb
|
||||
17:05:48 rolling-update: replica 1/2: new 037e58f95feb addr 192.168.96.6 slot api-1 UP in 4s
|
||||
17:05:48 rolling-update: replica 1/2: drain old 8eb475bf8780 addr 192.168.96.13 slot api-3
|
||||
17:05:48 rolling-update: replica 1/2: old 8eb475bf8780 idle after 0s
|
||||
17:05:48 rolling-update: replica 1/2: maint slot api-3, stopping old 8eb475bf8780
|
||||
17:05:49 rolling-update: replica 1/2: removed old 8eb475bf8780 (stop 1s, exit 0)
|
||||
17:05:50 rolling-update: replica 1/2: slot api-3 ready
|
||||
17:05:50 rolling-update: replica 2/2: started new 0ed05f658795
|
||||
17:05:54 rolling-update: replica 2/2: new 0ed05f658795 addr 192.168.96.7 slot api-3 UP in 4s
|
||||
17:05:54 rolling-update: replica 2/2: drain old ce7885bbd38a addr 192.168.96.8 slot api-2
|
||||
17:05:54 rolling-update: replica 2/2: old ce7885bbd38a idle after 0s
|
||||
17:05:54 rolling-update: replica 2/2: maint slot api-2, stopping old ce7885bbd38a
|
||||
17:05:55 rolling-update: replica 2/2: removed old ce7885bbd38a (stop 1s, exit 0)
|
||||
17:05:56 rolling-update: replica 2/2: slot api-2 ready
|
||||
17:05:56 rolling-update: done: 2 replicas 0ed05f658795 037e58f95feb UP in 16s
|
||||
-> exit 0, 17 s
|
||||
revision after: e4b8c2d17f90; trace columns: 2
|
||||
$ docker compose up -d --no-deps --force-recreate relay worker cleaner
|
||||
-> exit 0, 2 s
|
||||
api mtusi-lab6-api-10 66e41a7d85f2 running
|
||||
api mtusi-lab6-api-9 66e41a7d85f2 running
|
||||
relay mtusi-lab6-relay-1 66e41a7d85f2 running
|
||||
worker mtusi-lab6-worker-1 66e41a7d85f2 running
|
||||
cleaner mtusi-lab6-cleaner-1 66e41a7d85f2 running
|
||||
migrate mtusi-lab6-migrate-1 66e41a7d85f2 exited
|
||||
$ make test
|
||||
PASS: lab6 public API scenario; infrastructure and grading evidence remain separate.
|
||||
-> exit 0, 4 s
|
||||
2246 jobs, 1 with traceparent
|
||||
--- after: 2026-11-11T17:06:03Z
|
||||
```
|
||||
|
||||
Сборка BuildKit в выводе `make rolling_update` (все слои из кэша) и строки `Container … Creating /
|
||||
Started` сокращены. Окно без relay и worker (17:05:36–17:05:57) — по Migration Plan: загрузки в нём
|
||||
отвечают 202 и ждут в PostgreSQL; в этом прогоне загрузок в окне не было.
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user