vectordotdev/vectorNew scan
82/ 100 · B

Popular and well-maintained. A little polish away from elite status.

A high-performance observability data pipeline.

Rust22,034 starsMPL-2.0updated 4d ago
DocumentationREADME, setup, examples, license
80
EngineeringTests, CI, linting, lockfiles
80
Project healthDescription, activity, stars, deps
90

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringWarning

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  2. 2
    CI/CD
    EngineeringInfo

    Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.

  3. 3
    CI/CD
    EngineeringInfo

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

Detailed breakdown

Documentation

80
  • README85
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has no code examples (−15 pts).Show a quick-start snippet so contributors can see what using your project looks like.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions55
    • README documents how to install the project.
    • No run or usage instructions found (−45 pts).Add a section showing how to start or use the project.
    • .env.example is present. Contributors can see exactly which env vars to set.
  • License100
    • Licensed under MPL-2.0.
  • Contributing guide91
    • Contributing guide is detailed and thorough.
    • Contributing guide lacks a setup section (−12 pts).Show new contributors how to get a local dev environment running.
    • Contributing guide describes code style expectations.
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Code of conduct present.

Engineering

80
  • Tests90
    • Test files detected (lib/codecs/tests).
    • Cargo.toml has dev-dependencies and test files are present.
  • CI/CD57

    Not applicable?

    • CI is configured (.github/workflows/build_preview_sites.yml).
    • The CI workflow does not appear to run any tests (−28 pts).Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
    • CI runs on pull requests, not just on pushes to main.
    • CI does not appear to run a linter (−15 pts).Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
  • Linting and formatting60
    • Linter or formatter configured (.editorconfig).
  • Reproducibility100
    • Lockfile present (Cargo.lock). Installs are reproducible.
    • Environment pinned via distribution/docker/alpine/Dockerfile.
    • Dependabot covers 8 ecosystems (cargo, docker, docker, docker, docker, github-actions, npm, npm). Dependencies stay current.
    • Cargo.toml does not specify edition 2021.Add `edition = "2021"` to [package] in Cargo.toml for the latest Rust language features.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

90
  • Dependency manifest80
    • Dependency manifest found (Cargo.toml).
    • Cargo.toml includes a description for crates.io.
    • Cargo.toml declares a license.
    • Cargo.toml is missing a repository field (−10 pts).Add `repository = "https://github.com/owner/repo"` to [package].
  • Repository metadata85
    • Repository has a description.
    • Primary language detected: Rust.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 22,034 stars.
  • Housekeeping100
    • .gitignore present.
Repository files58 root entries
  • .cargo
  • .claude
  • .config
  • .github
    Good: Contributing guide is detailed and thorough.
    Info: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
    Good: CI is configured (.github/workflows/build_preview_sites.yml).
    Good: Dependabot covers 8 ecosystems (cargo, docker, docker, docker, docker, github-actions, npm, npm). Dependencies stay current.
    Good: Issue or PR templates present.
  • benches
  • changelog.d
  • config
  • distribution
    Good: Environment pinned via distribution/docker/alpine/Dockerfile.
  • docs
  • lib
    Good: Test files detected (lib/codecs/tests).
  • licenses
  • proto
  • regression
  • rfcs
  • rust-doc
  • scripts
  • src
  • testing
  • tests
  • tilt
  • vdev
  • website
  • .dockerignore
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .markdownlint.jsonc
  • .prettierignore
  • .prettierrc.json
  • .rustfmt.toml
  • .typos.toml
  • AGENTS.md
  • AI_POLICY.md
  • buf.yaml
  • build.rs
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
  • CLAUDE.md
  • clippy.toml
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
  • Cross.toml
  • deny.toml
  • LICENSE
    Good: Licensed under MPL-2.0.
  • LICENSE-3rdparty.csv
  • license-tool.toml
  • Makefile
  • Makefile.packaging
  • NOTICE
  • PRIVACY.md
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Info: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Warning: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • RELEASES.md
  • rust-toolchain.toml
  • SECURITY.md
    Good: Security policy present.
  • STYLE.md
  • Tiltfile
  • VERSIONING.md