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 (35,000 stars) (371 forks)batch import
help wantedkind/featurepriority/backlog

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

Tech stack
go
Domain
backendobservability
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Go programmingZap loggingViper configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate how trivy initializes logging using zap and viper. Look at the related issue #1526 for previous discussion. Propose a method to add a log format flag that sets zap's logging format to JSON. Consider modifying the configuration struct and Cobra command to accept the flag and pass it to the logger initializer.
Configurable log format using trivy server · aquasecurity/trivy#3300 | Good First Issue