Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# SPDX-License-Identifier: Apache-2.0
# Code authors: Vijay and Codex
name: Bug report
description: Report a reproducible CLI, capture, demo, or installation problem.
body:
- type: markdown
attributes:
value: "Use synthetic data. Do not include secrets, raw prompts, identities, private summaries, or unredacted logs. Report vulnerabilities through SECURITY.md."
- type: input
id: version
attributes:
label: Version and environment
description: fleetdiff version or source revision, OS/architecture, and installation method.
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Minimal reproduction
description: Command and flags, redacted configuration, and synthetic traces or summaries.
validations:
required: true
- type: textarea
id: result
attributes:
label: Expected and observed result
description: Include the accounting view, window, units, and missing-usage state when relevant.
validations:
required: true
- type: textarea
id: verification
attributes:
label: Checks already run
description: Focused test results and any known limits. Sanitize paths and log excerpts.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# SPDX-License-Identifier: Apache-2.0
# Code authors: Vijay and Codex
name: Feature or integration request
description: Describe a measurement question or a small workflow improvement.
body:
- type: markdown
attributes:
value: "Keep examples synthetic and non-sensitive. Do not post secrets, raw content, identities, or private exports."
- type: textarea
id: question
attributes:
label: What question or workflow is blocked?
validations:
required: true
- type: textarea
id: inputs
attributes:
label: Available input and expected output
description: Attribute names, units, window scope, and a synthetic example. Explain what the result should not claim.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Existing approaches and constraints
description: Consider inspect, diagnose, scan, investigate, and the existing capture recipes first.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# SPDX-License-Identifier: Apache-2.0
# Code authors: Vijay and Codex
name: Question or feedback
description: Ask about configuration, interpretation, or the evaluation experience.
body:
- type: markdown
attributes:
value: "Please use synthetic examples and redact secrets, identities, private summaries, and raw content."
- type: textarea
id: question
attributes:
label: Question or feedback
description: Include the version, relevant guide, and the result you are trying to understand.
validations:
required: true
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ cd fleetdiff
sh examples/investigate.sh
```

Needs Git and [Go](https://go.dev/dl/) 1.25 or 1.26 with a current security patch,
Needs Git and [Go](https://go.dev/dl/) 1.26 with a current security patch,
on Linux or macOS. No Docker. The command builds current source and prints a
single-application report from synthetic collector exports:

Expand Down
2 changes: 1 addition & 1 deletion docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ processing time. See the [comparison contract](COMPARISON.md) for details.

## What If The Demo Fails?

- **Go is missing:** install Go 1.25 or 1.26 with a current security patch, open a
- **Go is missing:** install Go 1.26 with a current security patch, open a
new terminal, and rerun `sh examples/demo.sh`.
- **The first build cannot download dependencies:** check network access to the
configured Go module proxy. No private sibling checkout is required.
Expand Down
3 changes: 2 additions & 1 deletion docs/OPERATIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,8 @@ and does not include unreleased checkout features.

### Build From Source

Build with a currently patched Go 1.25 or 1.26 toolchain:
Build the current source checkout with a currently patched Go 1.26 toolchain.
The OTLP dependency requires Go 1.26; published v0.5.0 binaries are unchanged.

```sh
go mod verify
Expand Down
2 changes: 1 addition & 1 deletion docs/SUMMARY_ARCHIVE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ identifiers, summary metadata, paths, filenames, or raw operating-system errors.

## Build and Run

From the fleetdiff checkout, explicitly build the helper with a local Go 1.25+
From the fleetdiff checkout, explicitly build the helper with a local Go 1.26+
toolchain and dependencies already present in the local module cache:

```sh
Expand Down
4 changes: 2 additions & 2 deletions examples/demo.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ umask 077

usage() {
printf '%s\n' 'Usage: sh examples/demo.sh [--live]' \
'Default: compare the included sample files. Requires Go 1.25 or 1.26.' \
'Default: compare the included sample files. Requires Go 1.26.' \
'--live: first generate exports with two local collectors. Also requires Docker.'
}

Expand All @@ -19,7 +19,7 @@ case "${1:-}" in
esac

if ! command -v go >/dev/null 2>&1; then
printf '%s\n' 'Install Go 1.25 or 1.26 from https://go.dev/dl/, then run this command again.' >&2
printf '%s\n' 'Install Go 1.26 from https://go.dev/dl/, then run this command again.' >&2
exit 1
fi
root=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
Expand Down
2 changes: 1 addition & 1 deletion examples/two-operators/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ using controlled synthetic traffic.

## Run Locally

Requirements: Linux or macOS, a running Docker engine, and Go 1.25 or 1.26 with a
Requirements: Linux or macOS, a running Docker engine, and Go 1.26 with a
current security patch. Docker downloads the pinned release; Go may download the
published sketchkit dependency. No sibling checkout or cloud account is required.
See the collector's [image verification instructions](https://github.com/llm-measurement/otelcol-genai-sketches/blob/v0.1.0/docs/DEPLOYMENT.md#verify-an-image).
Expand Down
Loading