aquasecurity/trivy

Configurable log format using trivy server

Open

#3,300 opened on Dec 14, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Go (371 forks)batch import
help wantedkind/featurepriority/backlog

Repository metrics

Stars
 (35,000 stars)
PR merge metrics
 (Avg merge 5d 2h) (53 merged PRs in 30d)

Description

We use trivy server to scan images from both CI pipelines and a Kubernetes operator. Our log infrastructure (Splunk) is much more fond of logs in machine-readable format (JSON), so it would be nice if it were possible to configure the log format when bootstrapping trivy server.

It seems like trivy uses https://github.com/uber-go/zap as the logging backend, supporting configuration, and JSON logging. A potential challenge could be that it seems hard to integrate Zap configuration with Viper/Cobra, ref. https://github.com/uber-go/zap/issues/542.

Related https://github.com/aquasecurity/trivy/issues/1526.

Contributor guide

Research direction
Investigate how to configure zap logger via Viper/Cobra configuration to support JSON log format in trivy server. Look into existing zap configuration patterns and any integration workarounds for the known issue with Viper/Cobra.
Tech stack
go
Domain
backenddevops
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoZap loggingViper/Cobra
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60