Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add high-level details about catalogers #1726

Merged
merged 1 commit into from
Apr 10, 2023
Merged

Conversation

wagoodman
Copy link
Contributor

@wagoodman wagoodman commented Apr 10, 2023

Adds a few rules about catalogers in the developing docs.

Signed-off-by: Alex Goodman <alex.goodman@anchore.com>
@wagoodman wagoodman added the changelog-ignore Don't include this issue in the release changelog label Apr 10, 2023
@wagoodman wagoodman requested a review from a team April 10, 2023 15:29
@github-actions
Copy link

Benchmark Test Results

Benchmark results from the latest changes vs base branch
goos: linux%0Agoarch: amd64%0Apkg: github.com/anchore/syft/test/integration%0Acpu: Intel(R) Xeon(R) CPU E5-2673 v4 @ 2.30GHz%0A                                                          │ ./.tmp/benchmark-96c08cc.txt │%0A                                                          │            sec/op            │%0AImagePackageCatalogers/alpmdb-cataloger-2                                   14.32m ± 21%25%0AImagePackageCatalogers/ruby-gemspec-cataloger-2                             1.114m ±  5%25%0AImagePackageCatalogers/python-package-cataloger-2                           3.819m ±  2%25%0AImagePackageCatalogers/php-composer-installed-cataloger-2                   887.9µ ±  5%25%0AImagePackageCatalogers/javascript-package-cataloger-2                       482.8µ ±  3%25%0AImagePackageCatalogers/dpkgdb-cataloger-2                                   679.8µ ±  2%25%0AImagePackageCatalogers/rpm-db-cataloger-2                                   644.4µ ±  3%25%0AImagePackageCatalogers/java-cataloger-2                                     13.35m ±  1%25%0AImagePackageCatalogers/graalvm-native-image-cataloger-2                     10.48µ ±  4%25%0AImagePackageCatalogers/apkdb-cataloger-2                                    709.7µ ±  3%25%0AImagePackageCatalogers/go-module-binary-cataloger-2                         23.09µ ±  3%25%0AImagePackageCatalogers/dotnet-deps-cataloger-2                              1.246m ±  2%25%0AImagePackageCatalogers/portage-cataloger-2                                  465.3µ ±  4%25%0AImagePackageCatalogers/nix-store-cataloger-2                                300.3µ ±  7%25%0AImagePackageCatalogers/sbom-cataloger-2                                     138.1µ ±  4%25%0AImagePackageCatalogers/binary-cataloger-2                                   242.0µ ±  4%25%0Ageomean                                                                     577.4µ%0A%0A                                                          │ ./.tmp/benchmark-96c08cc.txt │%0A                                                          │             B/op             │%0AImagePackageCatalogers/alpmdb-cataloger-2                                   5.062Mi ± 0%25%0AImagePackageCatalogers/ruby-gemspec-cataloger-2                             123.8Ki ± 0%25%0AImagePackageCatalogers/python-package-cataloger-2                           946.5Ki ± 0%25%0AImagePackageCatalogers/php-composer-installed-cataloger-2                   155.8Ki ± 0%25%0AImagePackageCatalogers/javascript-package-cataloger-2                       90.59Ki ± 0%25%0AImagePackageCatalogers/dpkgdb-cataloger-2                                   144.6Ki ± 0%25%0AImagePackageCatalogers/rpm-db-cataloger-2                                   170.1Ki ± 0%25%0AImagePackageCatalogers/java-cataloger-2                                     2.721Mi ± 0%25%0AImagePackageCatalogers/graalvm-native-image-cataloger-2                     1.555Ki ± 0%25%0AImagePackageCatalogers/apkdb-cataloger-2                                    129.2Ki ± 0%25%0AImagePackageCatalogers/go-module-binary-cataloger-2                         3.133Ki ± 0%25%0AImagePackageCatalogers/dotnet-deps-cataloger-2                              314.3Ki ± 0%25%0AImagePackageCatalogers/portage-cataloger-2                                  77.14Ki ± 0%25%0AImagePackageCatalogers/nix-store-cataloger-2                                36.07Ki ± 0%25%0AImagePackageCatalogers/sbom-cataloger-2                                     13.56Ki ± 0%25%0AImagePackageCatalogers/binary-cataloger-2                                   29.88Ki ± 0%25%0Ageomean                                                                     101.7Ki%0A%0A                                                          │ ./.tmp/benchmark-96c08cc.txt │%0A                                                          │          allocs/op           │%0AImagePackageCatalogers/alpmdb-cataloger-2                                    86.71k ± 0%25%0AImagePackageCatalogers/ruby-gemspec-cataloger-2                              2.049k ± 0%25%0AImagePackageCatalogers/python-package-cataloger-2                            15.49k ± 0%25%0AImagePackageCatalogers/php-composer-installed-cataloger-2                    3.458k ± 0%25%0AImagePackageCatalogers/javascript-package-cataloger-2                        1.205k ± 0%25%0AImagePackageCatalogers/dpkgdb-cataloger-2                                    2.646k ± 0%25%0AImagePackageCatalogers/rpm-db-cataloger-2                                    3.759k ± 0%25%0AImagePackageCatalogers/java-cataloger-2                                      38.26k ± 0%25%0AImagePackageCatalogers/graalvm-native-image-cataloger-2                       40.00 ± 0%25%0AImagePackageCatalogers/apkdb-cataloger-2                                     3.438k ± 0%25%0AImagePackageCatalogers/go-module-binary-cataloger-2                           101.0 ± 0%25%0AImagePackageCatalogers/dotnet-deps-cataloger-2                               5.010k ± 0%25%0AImagePackageCatalogers/portage-cataloger-2                                   1.539k ± 0%25%0AImagePackageCatalogers/nix-store-cataloger-2                                  671.0 ± 0%25%0AImagePackageCatalogers/sbom-cataloger-2                                       392.0 ± 0%25%0AImagePackageCatalogers/binary-cataloger-2                                     872.0 ± 0%25%0Ageomean                                                                      2.062k

@wagoodman wagoodman merged commit 3058385 into main Apr 10, 2023
9 checks passed
@wagoodman wagoodman deleted the cataloger-high-level-details branch April 10, 2023 17:11
spiffcs added a commit that referenced this pull request Apr 17, 2023
* main: (35 commits)
  Fix kernel cataloger test fixtures (#1742)
  feat: Support scanning license files in golang packages over the network (#1630)
  Add package-to-file location evidence relationships (#1698)
  Add Linux Kernel cataloger (#1694)
  Add annotations for evidence on package locations (#1723)
  add format make target (#1733)
  Update tests to not fail on Mac M1's. (#1730)
  chore(deps): update bootstrap tools to latest versions (#1728)
  Add support for nar files. (#1727)
  add highlevel details about catalogers (#1726)
  chore(deps): bump golang.org/x/net from 0.8.0 to 0.9.0 (#1722)
  chore(deps): update stereoscope to e95d60a265e384df29b7a139f5c5402d6ad72e06 (#1721)
  feat: gradle lockfile support (#1719)
  chore(deps): bump github.com/docker/docker (#1715)
  chore(deps): bump golang.org/x/mod from 0.9.0 to 0.10.0 (#1713)
  chore(deps): bump golang.org/x/term from 0.6.0 to 0.7.0 (#1714)
  chore(deps): bump github.com/spf13/cobra from 1.6.1 to 1.7.0 (#1716)
  chore(deps): bump peter-evans/create-pull-request from 4 to 5 (#1712)
  chore: update tools-golang to v0.5.0 (#1717)
  Add Nix cataloger (#1696)
  ...

Signed-off-by: Christopher Phillips <christopher.phillips@anchore.com>
GijsCalis pushed a commit to GijsCalis/syft that referenced this pull request Feb 19, 2024
Signed-off-by: Alex Goodman <alex.goodman@anchore.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog-ignore Don't include this issue in the release changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants