Merge pull request opensearch-project#303 from kakkoyun/reduce_noisy_…

…logging

*: Reduce noisy logging

pkg/debuginfo/upload.go

@@ -60,7 +60,7 @@ func (u *Uploader) UploadAll(ctx context.Context, dbgInfoFilePaths map[string]st
 		}
 
 		level.Debug(u.logger).Log(
-			"msg", "debug info uploaded successfully",
+			"msg", "debug information uploaded successfully",
 			"buildid", buildID, "file", filePath,
 		)
 	}

pkg/discovery/discovery_manager.go

@@ -1,4 +1,4 @@
-// Copyright 2016 The Prometheus Authors
+// Copyright (c) 2022 The Parca Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
@@ -10,6 +10,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+//
 
 package discovery
 
@@ -185,7 +186,7 @@ func (m *Manager) StartCustomProvider(ctx context.Context, name string, worker D
 }
 
 func (m *Manager) startProvider(ctx context.Context, p *provider) {
-	level.Debug(m.logger).Log("msg", "Starting provider", "provider", p.name, "subs", fmt.Sprintf("%v", p.subs))
+	level.Debug(m.logger).Log("msg", "starting provider", "provider", p.name, "subs", fmt.Sprintf("%v", p.subs))
 	ctx, cancel := context.WithCancel(ctx)
 	updates := make(chan []*target.Group)
 
@@ -207,7 +208,7 @@ func (m *Manager) updater(ctx context.Context, p *provider, updates chan []*targ
 		case tgs, ok := <-updates:
 			m.metrics.receivedUpdates.Inc()
 			if !ok {
-				level.Debug(m.logger).Log("msg", "Discoverer channel closed", "provider", p.name)
+				level.Debug(m.logger).Log("msg", "discoverer channel closed", "provider", p.name)
 				return
 			}
 
@@ -239,7 +240,7 @@ func (m *Manager) sender() {
 				case m.syncCh <- m.allGroups():
 				default:
 					m.metrics.delayedUpdates.Inc()
-					level.Debug(m.logger).Log("msg", "Discovery receiver's channel was full so will retry the next cycle")
+					level.Debug(m.logger).Log("msg", "discovery receiver's channel was full so will retry the next cycle")
 					select {
 					case m.triggerSend <- struct{}{}:
 					default:

pkg/maps/mapping.go

@@ -1,4 +1,4 @@
-// Copyright 2021 The Parca Authors
+// Copyright (c) 2022 The Parca Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
@@ -10,13 +10,18 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+//
 
 package maps
 
 import (
+	"errors"
+
 	"github.com/google/pprof/profile"
 )
 
+var ErrNotFound = errors.New("not found")
+
 type Mapping struct {
 	fileCache   *PIDMappingFileCache
 	pidMappings map[uint32][]*profile.Mapping

pkg/maps/maps.go

@@ -1,4 +1,4 @@
-// Copyright 2021 The Parca Authors
+// Copyright (c) 2022 The Parca Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
@@ -10,6 +10,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+//
 
 package maps
 
@@ -71,6 +72,9 @@ func (c *PIDMappingFileCache) mappingForPID(pid uint32) ([]*profile.Mapping, err
 	mapsFile := fmt.Sprintf("/proc/%d/maps", pid)
 	h, err := hash.File(c.fs, mapsFile)
 	if err != nil {
+		if os.IsNotExist(err) {
+			return nil, ErrNotFound
+		}
 		return nil, err
 	}
 	if c.pidMapHash[pid] == h {

pkg/objectfile/cache.go

@@ -21,7 +21,6 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/go-kit/log"
 	burrow "github.com/goburrow/cache"
 	"github.com/google/pprof/profile"
 )
@@ -35,8 +34,10 @@ type cache struct {
 }
 
 // NewCache creates a new cache for object files.
-func NewCache(logger log.Logger, size int) Cache {
-	return &cache{cache: burrow.New(burrow.WithMaximumSize(size))}
+func NewCache(size int) Cache {
+	return &cache{
+		cache: burrow.New(burrow.WithMaximumSize(size)),
+	}
 }
 
 // ObjectFileForProcess returns the object file for the given mapping and process id.

pkg/objectfile/object_file.go

@@ -1,4 +1,4 @@
-// Copyright 2022 The Parca Authors
+// Copyright (c) 2022 The Parca Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
@@ -10,6 +10,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+//
 
 // This package includes modified code from the github.com/google/pprof/internal/binutils
 

pkg/perf/perf.go

@@ -1,5 +1,4 @@
-// Copyright 2021 The Parca Authors
-//
+// Copyright (c) 2022 The Parca Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
@@ -11,6 +10,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+//
 
 package perf
 
@@ -49,7 +49,10 @@ type Map struct {
 
 type realfs struct{}
 
-var ErrNoSymbolFound = errors.New("no symbol found")
+var (
+	ErrNotFound      = errors.New("not found")
+	ErrNoSymbolFound = errors.New("no symbol found")
+)
 
 func (f *realfs) Open(name string) (fs.File, error) {
 	return os.Open(name)
@@ -125,6 +128,9 @@ func (p *Cache) CacheForPID(pid uint32) (*Map, error) {
 	if !found {
 		nsPids, err := findNSPIDs(p.fs, pid)
 		if err != nil {
+			if os.IsNotExist(err) {
+				return nil, ErrNotFound
+			}
 			return nil, err
 		}
 
@@ -133,9 +139,11 @@ func (p *Cache) CacheForPID(pid uint32) (*Map, error) {
 	}
 
 	perfFile := fmt.Sprintf("/proc/%d/root/tmp/perf-%d.map", pid, nsPid)
-	// TODO(zecke): Log other than file not found errors?
 	h, err := hash.File(p.fs, perfFile)
 	if err != nil {
+		if os.IsNotExist(err) {
+			return nil, ErrNotFound
+		}
 		return nil, err
 	}
 

pkg/profiler/profiler.go

@@ -1,4 +1,4 @@
-// Copyright 2021 The Parca Authors
+// Copyright (c) 2022 The Parca Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
@@ -10,6 +10,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+//
 
 package profiler
 
@@ -18,6 +19,7 @@ import (
 	"context"
 	_ "embed"
 	"encoding/binary"
+	"errors"
 	"fmt"
 	"io"
 	"os"
@@ -298,7 +300,7 @@ func (p *CgroupProfiler) Run(ctx context.Context) error {
 		captureTime := time.Now()
 		err := p.profileLoop(ctx, captureTime)
 		if err != nil {
-			level.Debug(p.logger).Log("msg", "profile loop error", "err", err)
+			level.Warn(p.logger).Log("msg", "profile loop error", "err", err)
 		}
 
 		p.loopReport(captureTime, err)
@@ -434,7 +436,9 @@ func (p *CgroupProfiler) profileLoop(ctx context.Context, captureTime time.Time)
 		if err != nil {
 			// We expect only a minority of processes to have a JIT and produce
 			// the perf map.
-			level.Debug(p.logger).Log("msg", "no perfmap", "err", err)
+			if !errors.Is(err, perf.ErrNotFound) {
+				level.Warn(p.logger).Log("msg", "failed to obtain perf map for pid", "pid", pid, "err", err)
+			}
 		}
 		// Collect User stack trace samples.
 		for _, addr := range stack[:stackDepth] {
@@ -446,7 +450,9 @@ func (p *CgroupProfiler) profileLoop(ctx context.Context, captureTime time.Time)
 
 					m, err := mapping.PIDAddrMapping(pid, addr)
 					if err != nil {
-						level.Debug(p.logger).Log("msg", "failed to get process mapping", "err", err)
+						if !errors.Is(err, maps.ErrNotFound) {
+							level.Warn(p.logger).Log("msg", "failed to get process mapping", "err", err)
+						}
 					}
 
 					var objFile *objectfile.MappedObjectFile

pkg/target/manager.go

@@ -1,4 +1,4 @@
-// Copyright 2021 The Parca Authors
+// Copyright (c) 2022 The Parca Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
@@ -10,6 +10,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+//
 
 package target
 
@@ -91,7 +92,7 @@ func (m *Manager) reconcileTargets(ctx context.Context, targetSets map[string][]
 			cacheSize := len(targetSet) * 5
 			pp = NewProfilerPool(
 				ctx, m.logger, m.reg,
-				m.ksymCache, objectfile.NewCache(m.logger, cacheSize),
+				m.ksymCache, objectfile.NewCache(cacheSize),
 				m.writeClient, m.debugInfoClient,
 				m.profilingDuration, m.externalLabels,
 				m.tmp,

pkg/target/profiler_pool.go

@@ -1,4 +1,4 @@
-// Copyright 2022 The Parca Authors
+// Copyright (c) 2022 The Parca Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
@@ -10,6 +10,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+//
 
 package target
 
@@ -145,7 +146,7 @@ func (pp *ProfilerPool) Sync(tg []*Group) {
 
 			go func() {
 				err := newProfiler.Run(pp.ctx)
-				level.Debug(pp.logger).Log("msg", "profiler ended with error", "error", err, "labels", newProfiler.Labels().String())
+				level.Warn(pp.logger).Log("msg", "profiler ended with error", "error", err, "labels", newProfiler.Labels().String())
 			}()
 
 			pp.activeTargets[h] = newTarget