sonobuoy icon indicating copy to clipboard operation
sonobuoy copied to clipboard

RFE: Build api coverage into default metric gathering or as a plugin

Open timothysc opened this issue 5 years ago • 11 comments

Describe the solution you'd like As a developer I would like sonobuoy to output data from either a dynamic webhook-audit log, or from api-snoop, into the sonobuoy output which would allow me to post process analyze the api-surface area of my tests.

This will yield total api-surface used as part of [Conformance] or any other specified e2e.focus.

cc @clintkitson @hh

timothysc avatar Apr 04 '19 21:04 timothysc

Is there a code example I could look at for how this is done manually? I can dig into API snoop but I'm not familiar with how it is currently run so I'm starting from scratch there.

johnSchnake avatar Jun 17 '19 13:06 johnSchnake

https://github.com/cncf/apisnoop

johnSchnake avatar Aug 16 '19 16:08 johnSchnake

Currently we load from buckets: select * from load_audit_events('ci-kubernetes-e2e-gci-gce','1134962072287711234'); https://github.com/cncf/apisnoop/blob/v3_rainbow/org/meta.org#call-load_audit_events https://github.com/cncf/apisnoop/blob/v3_rainbow/apps/hasura/migrations/245_function_load_audit_event.up.sql#L37

Though it would be simple to create a webhook that instead wrote directly to the audit_entries table.

hh avatar Aug 20 '19 17:08 hh

https://github.com/cncf/apisnoop/tree/v3_rainbow/apps is now contains a single docker-compose.yaml that works, just need to to be fed some audit logs (currently via testgrid).

hh avatar Aug 24 '19 22:08 hh

Going to move this to next milestone; it just has been at the edge of priority so far and I haven't made progress besides initial investigations.

johnSchnake avatar Nov 04 '19 18:11 johnSchnake

There has not been much activity here. We'll be closing this issue if there are no follow-ups within 15 days.

stale[bot] avatar Nov 04 '20 23:11 stale[bot]

We have a container we use as auditsink query the populated db to generate api coverage metrics.

  • https://github.com/cncf/apisnoop/tree/master/apps/snoopdb#snoopdb

hh avatar Nov 04 '20 23:11 hh

thanks @hh. @wilsonehusin let's reprioritize this.

vladimirvivien avatar Nov 17 '20 19:11 vladimirvivien

There has not been much activity here. We'll be closing this issue if there are no follow-ups within 15 days.

stale[bot] avatar Jan 16 '21 20:01 stale[bot]

Not Stale

vladimirvivien avatar Jan 19 '21 17:01 vladimirvivien

I did not realize there was already a request to wrap api-snoop as a plugin 🎉 @wilsonehusin let's prioritize this for this/next quarter.

vladimirvivien avatar Jan 19 '21 17:01 vladimirvivien

There has not been much activity here. We'll be closing this issue if there are no follow-ups within 15 days.

stale[bot] avatar Feb 05 '23 01:02 stale[bot]