Skip to content

Migrate from OpenCensus library #1909

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Oct 27, 2025
Merged

Migrate from OpenCensus library #1909

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
6a6c999
Update OpenCensus to OpenTelemetry
tiffanny29631 Sep 15, 2025
0876108
cleanup
tiffanny29631 Oct 22, 2025
3f10a32
cleanup: restore record.go under kmetrics
tiffanny29631 Oct 22, 2025
8e1b5cd
cleanup: restore record.go under resourcegroup metrics
tiffanny29631 Oct 22, 2025
b3b700d
cleanup: refactor testexporter for readability
tiffanny29631 Oct 22, 2025
e4d1299
gemini comment: fail fast when record sees metric not initialized
tiffanny29631 Oct 22, 2025
f12fa11
gemini comment: use context with timeout for exporter graceful shutdown
tiffanny29631 Oct 22, 2025
49f9bcd
fix rebase conflict
tiffanny29631 Oct 23, 2025
f73c10a
cleanup
tiffanny29631 Oct 24, 2025
6a4f0c7
refactor: use lazy initialization for metrics
tiffanny29631 Oct 25, 2025
e26b25b
copilot: cleanup logs and comments
tiffanny29631 Oct 27, 2025
60572a8
refactor testexporter for readability and better error handling
tiffanny29631 Oct 27, 2025
a130ca8
revert to explicit metric initialization with error check
tiffanny29631 Oct 27, 2025
959aac1
cleanup
tiffanny29631 Oct 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 8 additions & 10 deletions cmd/hydration-controller/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,20 +79,18 @@ func main() {
profiler.Service()
ctrl.SetLogger(textlogger.NewLogger(textlogger.NewConfig()))

// Register the kustomize usage metric views.
if err := kmetrics.RegisterKustomizeMetricsViews(); err != nil {
klog.Fatalf("Failed to register OpenCensus views: %v", err)
}

// Register the OC Agent exporter
oce, err := kmetrics.RegisterOCAgentExporter(reconcilermanager.HydrationController)
// Register the OTLP metrics exporter and metrics instruments
ctx := context.Background()
oce, err := kmetrics.RegisterOTelExporter(ctx, reconcilermanager.HydrationController)
if err != nil {
klog.Fatalf("Failed to register the OC Agent exporter: %v", err)
klog.Fatalf("Failed to register the OTLP metrics exporter: %v", err)
}

defer func() {
if err := oce.Stop(); err != nil {
klog.Fatalf("Unable to stop the OC Agent exporter: %v", err)
shutdownCtx, cancel := context.WithTimeout(context.Background(), kmetrics.ShutdownTimeout)
defer cancel()
if err := oce.Shutdown(shutdownCtx); err != nil {
klog.Fatalf("Unable to stop the OTLP metrics exporter: %v", err)
}
}()

Expand Down
26 changes: 13 additions & 13 deletions cmd/reconciler-manager/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,21 +182,19 @@ func main() {
}
setupLog.Info("OtelSA controller registration successful")

// Register the OpenCensus views
if err := metrics.RegisterReconcilerManagerMetricsViews(); err != nil {
setupLog.Error(err, "failed to register OpenCensus views")
}

// Register the OC Agent exporter
oce, err := metrics.RegisterOCAgentExporter(reconcilermanager.ManagerName)
// Register the OTLP metrics exporter and metrics instruments
ctx := context.Background()
oce, err := metrics.RegisterOTelExporter(ctx, reconcilermanager.ManagerName)
if err != nil {
setupLog.Error(err, "failed to register the OC Agent exporter")
setupLog.Error(err, "failed to register the OTLP metrics exporter")
os.Exit(1)
}

defer func() {
if err := oce.Stop(); err != nil {
setupLog.Error(err, "failed to stop the OC Agent exporter")
shutdownCtx, cancel := context.WithTimeout(context.Background(), metrics.ShutdownTimeout)
defer cancel()
if err := oce.Shutdown(shutdownCtx); err != nil {
setupLog.Error(err, "failed to stop the OTLP metrics exporter")
}
}()

Expand All @@ -205,9 +203,11 @@ func main() {
setupLog.Info("starting manager")
if err := mgr.Start(ctrl.SetupSignalHandler()); err != nil {
setupLog.Error(err, "problem running manager")
// os.Exit(1) does not run deferred functions so explicitly stopping the OC Agent exporter.
if err := oce.Stop(); err != nil {
setupLog.Error(err, "failed to stop the OC Agent exporter")
// os.Exit(1) does not run deferred functions so explicitly stopping the OTLP metrics exporter.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest refactoring this so that the main function calls out to a helper function that returns an int, e.g.

func main() {
    os.Exit(runMain())
}

func runMain() int {
    ...
}

or alternatively for an error instead of int:

func main() {
    if err := runMain(); err != nil {
        ...
        os.Exit(1)
    }
}

func runMain() error {
    ...
}

That can be done as a separate change but just making a note of it

shutdownCtx, cancel := context.WithTimeout(context.Background(), metrics.ShutdownTimeout)
defer cancel()
if err := oce.Shutdown(shutdownCtx); err != nil {
setupLog.Error(err, "failed to stop the OTLP metrics exporter")
}
os.Exit(1)
}
Expand Down
19 changes: 9 additions & 10 deletions cmd/reconciler/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
package main

import (
"context"
"flag"
"fmt"
"os"
Expand Down Expand Up @@ -140,20 +141,18 @@ func main() {
status.EnablePanicOnMisuse()
}

// Register the OpenCensus views
if err := ocmetrics.RegisterReconcilerMetricsViews(); err != nil {
klog.Fatalf("Failed to register OpenCensus views: %v", err)
}

// Register the OC Agent exporter
oce, err := ocmetrics.RegisterOCAgentExporter(reconcilermanager.Reconciler)
// Register the OTLP metrics exporter and metrics instruments
ctx := context.Background()
oce, err := ocmetrics.RegisterOTelExporter(ctx, reconcilermanager.Reconciler)
if err != nil {
klog.Fatalf("Failed to register the OC Agent exporter: %v", err)
klog.Fatalf("Failed to register the OTLP metrics exporter: %v", err)
}

defer func() {
if err := oce.Stop(); err != nil {
klog.Fatalf("Unable to stop the OC Agent exporter: %v", err)
shutdownCtx, cancel := context.WithTimeout(context.Background(), ocmetrics.ShutdownTimeout)
defer cancel()
if err := oce.Shutdown(shutdownCtx); err != nil {
klog.Fatalf("Unable to stop the OTLP metrics exporter: %v", err)
}
}()

Expand Down
13 changes: 9 additions & 4 deletions docs/custom-metric-filter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ To **turn off the custom metrics** in Cloud Monitoring, remove this section:
```yaml
# Remove this entire section
metrics/cloudmonitoring:
receivers: [opencensus]
receivers: [otlp]
processors: [batch, filter/cloudmonitoring, metricstransform/cloudmonitoring, resourcedetection]
exporters: [googlecloud]
```
Expand All @@ -183,7 +183,7 @@ To **turn off the report to Cloud Monarch**, remove this section:
```yaml
# Remove this entire section
metrics/kubernetes:
receivers: [opencensus]
receivers: [otlp]
processors: [batch, filter/kubernetes, metricstransform/kubernetes, resourcedetection]
exporters: [googlecloud/kubernetes]
```
Expand Down Expand Up @@ -235,7 +235,12 @@ metadata:
data:
otel-collector-config.yaml: |
receivers:
opencensus:
otlp:
protocols:
grpc:
endpoint: 0.0.0.0:4317
http:
endpoint: 0.0.0.0:4318
exporters:
debug:
verbosity: detailed
Expand All @@ -245,7 +250,7 @@ data:
batch:
pipelines:
metrics:
receivers: [opencensus]
receivers: [otlp]
processors: [batch]
exporters: [debug]
```
Expand Down
Loading