Provisioning: Improve logging and tracing in job processing (#113454)
* Provisioning: Improve logging and tracing in job processing - Add comprehensive tracing with OpenTelemetry spans across all job operations - Enhance logging with consistent style: lowercase, concise messages, appropriate log levels - Use past tense for completed lifecycle events (e.g., 'stopped' vs 'stop') - Add structured logging with contextual attributes for better searchability - Handle graceful shutdowns without throwing errors on context cancellation - Refactor Cleanup method into listExpiredJobs and cleanUpExpiredJob for better code quality - Avoid double logging by only logging errors when handled locally - Add tracing and logging to historyjob controller cleanup operations Files modified: - pkg/registry/apis/provisioning/jobs/driver.go: Add tracing spans and improve error handling for graceful shutdown - pkg/registry/apis/provisioning/jobs/concurrent_driver.go: Add tracing and consistent logging - pkg/registry/apis/provisioning/jobs/persistentstore.go: Add comprehensive tracing and logging to all public methods, refactor cleanup - apps/provisioning/pkg/controller/historyjob.go: Add tracing and improve logging consistency * Update pkg/registry/apis/provisioning/jobs/persistentstore.go Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Refactor logging in persistentstore.go - Remove debug log statements at the start of job operations for cleaner output - Maintain structured logging with contextual attributes for improved traceability Files modified: - pkg/registry/apis/provisioning/jobs/persistentstore.go: Clean up logging for job operations * Enhance logging and tracing in provisioning job operations - Introduce OpenTelemetry spans for better observability in job processing and webhook handling - Improve structured logging with contextual attributes for key operations - Remove unnecessary tracing spans in long-running functions to streamline performance - Update error handling to record errors in spans for better traceability Files modified: - pkg/registry/apis/provisioning/controller/repository.go: Add tracing and structured logging to sync job operations - pkg/registry/apis/provisioning/jobs/concurrent_driver.go: Remove tracing span from long-running function - pkg/registry/apis/provisioning/jobs/driver.go: Enhance logging and tracing in job processing - pkg/registry/apis/provisioning/webhooks/webhook.go: Implement tracing and structured logging for webhook connections * Update pkg/registry/apis/provisioning/jobs/driver.go Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Improve error handling in ConcurrentJobDriver to differentiate between graceful shutdown and unexpected stops * Remove unused import in driver.go to clean up code --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
co-authored by
Copilot
parent
6d64c373ce
commit
cdc6a6114c
@@ -6,6 +6,7 @@ import (
|
||||
"net/http"
|
||||
"time"
|
||||
|
||||
"go.opentelemetry.io/otel/attribute"
|
||||
"k8s.io/apimachinery/pkg/api/errors"
|
||||
"k8s.io/apimachinery/pkg/runtime"
|
||||
"k8s.io/apiserver/pkg/authorization/authorizer"
|
||||
@@ -17,6 +18,7 @@ import (
|
||||
provisioning "github.com/grafana/grafana/apps/provisioning/pkg/apis/provisioning/v0alpha1"
|
||||
"github.com/grafana/grafana/apps/provisioning/pkg/repository"
|
||||
"github.com/grafana/grafana/pkg/apimachinery/identity"
|
||||
"github.com/grafana/grafana/pkg/infra/tracing"
|
||||
provisioningapis "github.com/grafana/grafana/pkg/registry/apis/provisioning"
|
||||
"github.com/grafana/grafana/pkg/registry/apis/provisioning/webhooks/pullrequest"
|
||||
"github.com/prometheus/client_golang/prometheus"
|
||||
@@ -122,8 +124,16 @@ func (s *webhookConnector) Connect(ctx context.Context, name string, opts runtim
|
||||
}
|
||||
|
||||
return provisioningapis.WithTimeout(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
logger := logging.FromContext(r.Context()).With("logger", "webhook-connector", "repo", name)
|
||||
ctx := logging.Context(r.Context(), logger)
|
||||
ctx, span := tracing.Start(r.Context(), "provisioning.webhook.handle")
|
||||
defer span.End()
|
||||
|
||||
span.SetAttributes(
|
||||
attribute.String("repository", name),
|
||||
attribute.String("namespace", namespace),
|
||||
)
|
||||
|
||||
logger := logging.FromContext(ctx).With("logger", "webhook-connector", "repo", name)
|
||||
ctx = logging.Context(ctx, logger)
|
||||
if !s.webhooksEnabled {
|
||||
responder.Error(errors.NewBadRequest("webhooks are not enabled"))
|
||||
return
|
||||
@@ -140,12 +150,15 @@ func (s *webhookConnector) Connect(ctx context.Context, name string, opts runtim
|
||||
|
||||
rsp, err := hooks.Webhook(ctx, r)
|
||||
if err != nil {
|
||||
span.RecordError(err)
|
||||
responder.Error(err)
|
||||
return
|
||||
}
|
||||
|
||||
if rsp == nil {
|
||||
responder.Error(fmt.Errorf("expecting a response"))
|
||||
err := fmt.Errorf("expecting a response")
|
||||
span.RecordError(err)
|
||||
responder.Error(err)
|
||||
return
|
||||
}
|
||||
|
||||
@@ -162,12 +175,17 @@ func (s *webhookConnector) Connect(ctx context.Context, name string, opts runtim
|
||||
if rsp.Job != nil {
|
||||
rsp.Job.Repository = name
|
||||
actionTaken = string(rsp.Job.Action)
|
||||
span.SetAttributes(attribute.String("job.action", actionTaken))
|
||||
|
||||
job, err := s.core.GetJobQueue().Insert(ctx, namespace, *rsp.Job)
|
||||
if err != nil {
|
||||
span.RecordError(err)
|
||||
logger.Error("failed to insert job", "error", err)
|
||||
responder.Error(err)
|
||||
return
|
||||
}
|
||||
span.SetAttributes(attribute.String("job.name", job.Name))
|
||||
logger.Info("webhook job created", "job", job.Name, "action", actionTaken)
|
||||
responder.Object(rsp.Code, job)
|
||||
return
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user