From 1f226c7222f7a16f2a7b4b7ab9779d1b17b82063 Mon Sep 17 00:00:00 2001 From: Hank Donnay Date: Wed, 31 Jan 2024 16:49:26 -0600 Subject: [PATCH] introspection: lints Signed-off-by: Hank Donnay --- introspection/server.go | 35 ++++++++++++++++++++++++++--------- 1 file changed, 26 insertions(+), 9 deletions(-) diff --git a/introspection/server.go b/introspection/server.go index 31ce6e5929..160166b6f0 100644 --- a/introspection/server.go +++ b/introspection/server.go @@ -1,3 +1,5 @@ +// Package introspection holds the implementation details for the +// "introspection" HTTP server that Clair hosts. package introspection import ( @@ -22,18 +24,32 @@ import ( "github.com/quay/clair/v4/health" ) +// Valid backends for both metrics and traces. const ( - Prom = "prometheus" - DefaultPromEndpoint = "/metrics" - Stdout = "stdout" - Jaeger = "jaeger" - HealthEndpoint = "/healthz" - ReadyEndpoint = "/readyz" - DefaultIntrospectionAddr = ":8089" + Stdout = "stdout" ) -// Server provides an http server -// exposing Clair metrics and traces +// Valid backends for metrics. +const ( + Prom = "prometheus" +) + +// Valid backends for traces. +const ( + Jaeger = "jaeger" +) + +// Endpoints on the introspection HTTP server. +const ( + DefaultPromEndpoint = "/metrics" + HealthEndpoint = "/healthz" + ReadyEndpoint = "/readyz" +) + +// DefaultIntrospectionAddr is the default address if not provided in the configuration. +const DefaultIntrospectionAddr = ":8089" + +// Server provides an HTTP server exposing Clair metrics and debugging information. type Server struct { // configuration provided when starting Clair conf *config.Config @@ -46,6 +62,7 @@ type Server struct { health func() bool } +// New constructs a [*Server], which has an embedded [*http.Server]. func New(ctx context.Context, conf *config.Config, health func() bool) (*Server, error) { ctx = zlog.ContextWithValues(ctx, "component", "introspection/New")