docstore: Opentelemetry migration of docstore #3550
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,12 +24,17 @@ import ( | |
| "sort" | ||
| "strings" | ||
| "sync" | ||
| "time" | ||
| "unicode/utf8" | ||
|
|
||
| "go.opentelemetry.io/otel" | ||
| "go.opentelemetry.io/otel/attribute" | ||
| "go.opentelemetry.io/otel/metric" | ||
| "go.opentelemetry.io/otel/trace" | ||
| "gocloud.dev/docstore/driver" | ||
| "gocloud.dev/gcerrors" | ||
| "gocloud.dev/internal/gcerr" | ||
| gcdkotel "gocloud.dev/internal/otel" | ||
| ) | ||
|
|
||
| // A Document is a set of field-value pairs. One or more fields, called the key | ||
|
|
@@ -46,34 +51,61 @@ type Document = interface{} | |
| // To create a Collection, use constructors found in driver subpackages. | ||
| type Collection struct { | ||
| driver driver.Collection | ||
| tracer *gcdkotel.Tracer | ||
| mu sync.Mutex | ||
| closed bool | ||
| } | ||
|
|
||
| const pkgName = "gocloud.dev/docstore" | ||
|
|
||
| var ( | ||
| // Initialize OpenTelemetry meter and tracer | ||
| meter = otel.GetMeterProvider().Meter(pkgName) | ||
|
|
||
| // Define counter instrument for completed calls (replaces the previous OpenCensus metrics) | ||
| completedCallsCounter metric.Int64Counter | ||
|
|
||
| // Define histogram instrument for latency measurement | ||
| latencyHistogram metric.Float64Histogram | ||
|
|
||
| // Tracer for creating spans | ||
| tracer = otel.GetTracerProvider().Tracer(pkgName) | ||
| ) | ||
|
|
||
| // Initialize the metrics | ||
| func init() { | ||
| var err error | ||
|
|
||
| // Create the completed calls counter | ||
| completedCallsCounter, err = meter.Int64Counter( | ||
| pkgName+"/completed_calls", | ||
| metric.WithDescription("Total number of completed method calls"), | ||
| metric.WithUnit("{call}"), | ||
| ) | ||
| if err != nil { | ||
| log.Printf("Failed to create completed_calls counter: %v", err) | ||
| } | ||
|
|
||
| // Create the latency histogram | ||
| latencyHistogram, err = meter.Float64Histogram( | ||
| pkgName+"/latency", | ||
| metric.WithDescription("Latency of method calls"), | ||
| metric.WithUnit("ms"), | ||
| ) | ||
| if err != nil { | ||
| log.Printf("Failed to create latency histogram: %v", err) | ||
| } | ||
| } | ||
|
|
||
| // NewCollection is intended for use by drivers only. Do not use in application code. | ||
| var NewCollection = newCollection | ||
|
|
||
| // newCollection makes a Collection. | ||
| func newCollection(d driver.Collection) *Collection { | ||
| providerName := gcdkotel.ProviderName(d) | ||
| c := &Collection{ | ||
| driver: d, | ||
| tracer: gcdkotel.NewTracer(pkgName, providerName), | ||
| } | ||
| _, file, lineno, ok := runtime.Caller(1) | ||
| runtime.SetFinalizer(c, func(c *Collection) { | ||
|
|
@@ -338,15 +370,42 @@ func (l *ActionList) Do(ctx context.Context) error { | |
| return l.do(ctx, true) | ||
| } | ||
|
|
||
| // do implements Do with optional OpenTelemetry tracing, so it can be used internally. | ||
| func (l *ActionList) do(ctx context.Context, withTracing bool) (err error) { | ||
| if err := l.coll.checkClosed(); err != nil { | ||
| return ActionListError{{-1, errClosed}} | ||
| } | ||
|
|
||
| var startTime time.Time | ||
| var span trace.Span | ||
|
|
||
| if withTracing { | ||
| startTime = time.Now() | ||
| ctx, span = l.coll.tracer.Start(ctx, "ActionList.Do") | ||
| defer func() { | ||
| l.coll.tracer.End(span, err) | ||
|
|
||
| // Record metrics | ||
| if completedCallsCounter != nil { | ||
| attr := []attribute.KeyValue{ | ||
| gcdkotel.MethodKey.String("ActionList.Do"), | ||
| gcdkotel.ProviderKey.String(l.coll.tracer.Provider), | ||
| } | ||
| completedCallsCounter.Add(context.Background(), 1, metric.WithAttributes(attr...)) | ||
|
There was a problem hiding this comment. @jba This has been resolved appropriately |
||
| } | ||
|
|
||
| if latencyHistogram != nil { | ||
| attr := []attribute.KeyValue{ | ||
| gcdkotel.MethodKey.String("ActionList.Do"), | ||
| gcdkotel.ProviderKey.String(l.coll.tracer.Provider), | ||
| } | ||
| latencyHistogram.Record( | ||
| context.Background(), | ||
|
|
||
| float64(time.Since(startTime).Milliseconds()), | ||
| metric.WithAttributes(attr...), | ||
| ) | ||
| } | ||
| }() | ||
| } | ||
|
|
||
| das, err := l.toDriverActions() | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could these two be defined in the scope of
if withTracing {}below. Seems we dont need them outside the scope.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@pramineni01 this has been moved to the withTracing scope