chore(logs): adjust logging to write to file #93

stormqueen1990 · 2024-05-07T14:39:12Z

Enable log-writing to file on a per-inventory basis.

* Enable log-writing to file on a per-inventory basis. Signed-off-by: Mauren Berti <mauren.berti@chainguard.dev>

Signed-off-by: Mauren Berti <mauren.berti@chainguard.dev>

internal/provider/inventory_data_source.go

internal/provider/harness.go

internal/inventory/file.go

internal/log/log.go

Signed-off-by: Mauren Berti <mauren.berti@chainguard.dev>

internal/provider/harness_docker_resource.go

internal/inventory/file.go

internal/inventory/inventory.go

Signed-off-by: Mauren Berti <mauren.berti@chainguard.dev>

joshrwolf

I think the comment about the encoding ergonomics can be a nit. its just another thing we have to remember when adding new resources but that is rare, and definitely not impactful enough to block this from going in.

thanks for addressing everything else!

follow up on #93 hoist the logger setup to a `ProviderStore.Logger()` function and call it in the resources _and_ features. sample output is: ``` # enable it provider "imagetest" { log = { file = {} } } ``` output looks like (default to jsonl): ``` {"time":"2024-05-13T10:32:28.993396-04:00","level":"INFO","msg":"Waiting for k3s service to be ready","inventory":"jpqra","harness_id":"foo-jpqra","harness_name":"foo"} {"time":"2024-05-13T10:32:30.558124-04:00","level":"INFO","msg":"testing feature against harness","inventory":"jpqra","feature_id":"13m58","feature_name":"foo","harness_name":"foo-jpqra"} {"time":"2024-05-13T10:32:30.55817-04:00","level":"INFO","msg":"stepping in k3s sandbox container","inventory":"jpqra","feature_id":"13m58","feature_name":"foo","harness_name":"foo-jpqra","command":"kubectl get po -A"} {"time":"2024-05-13T10:32:30.717917-04:00","level":"INFO","msg":"finished stepping in k3s sandbox container","inventory":"jpqra","feature_id":"13m58","feature_name":"foo","harness_name":"foo-jpqra","command":"kubectl get po -A","out":"No resources found\n"} ``` also adds a bit more field metadata that may be useful eventually. this also removes the `random` data source, which isn't being used (hopefully), and is wrong(!)

Mauren Berti added 3 commits May 7, 2024 10:26

chore(logs): adjust logging to write to file

f8b1b8e

* Enable log-writing to file on a per-inventory basis. Signed-off-by: Mauren Berti <mauren.berti@chainguard.dev>

chore(logs): fix lint issues, small adjustments

27bffb6

Signed-off-by: Mauren Berti <mauren.berti@chainguard.dev>

docs: update documentation for changed resources

aded2f9

Signed-off-by: Mauren Berti <mauren.berti@chainguard.dev>