feat: enable collection of OpenCensus metrics #550
Merged
Conversation
This file contains 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
For some Google Cloud libraries, metrics are emitted that are useful to understanding the operation of a service but they are using the OpenCensus SDKs rather than the OpenTelemetry ones. A notable example is GoogleCloudPlatform/cloud-sql-go-connector which is used as a proxy when connecting Cloud Run instances to Cloud SQL. There is a [suite of metrics](https://github.com/GoogleCloudPlatform/cloud-sql-go-connector/blob/v1.4.5/internal/trace/metrics.go) that are particularly useful in monitoring the health of the proxy. This change allows users to enable capturing OpenCensus formatted metrics using the OpenTelemetry bridge shim. By default this will be disabled. There is a downside to enabling this producer, mainly that since OpenCensus telemetry uses globals, installing a bridge will result in telemetry collection from all libraries that use OpenCensus, including some you may not expect, such as the telemetry exporter itself. More info can be found in the following documentation: https://pkg.go.dev/go.opentelemetry.io/otel/bridge/opencensus#hdr-Migration_Guide
DavyJ0nes
force-pushed
the
allow-collecting-opencensus-metrics
branch
from
171f9f0 to
ef05a4f
Compare
|
Too many custom metrics by default? |
|
@odsod yeah exactly, it's an all or nothing by the looks of it (https://pkg.go.dev/go.opentelemetry.io/otel/bridge/opencensus#hdr-Warnings) I will test out the behaviour to see the impact but depending on the other libraries people might use it could cause unforeseen costs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
For some Google Cloud libraries, metrics are emitted that are useful to understanding the operation of a service but they are using the OpenCensus SDKs rather than the OpenTelemetry ones.
A notable example is GoogleCloudPlatform/cloud-sql-go-connector which is used as a proxy when connecting Cloud Run instances to Cloud SQL. There is a suite of metrics that are particularly useful in monitoring the health of the proxy.
This change allows users to enable capturing OpenCensus formatted metrics using the OpenTelemetry bridge shim. By default this will be disabled.
There is a downside to enabling this producer, mainly that since OpenCensus telemetry uses globals, installing a bridge will result in telemetry collection from all libraries that use OpenCensus, including some you may not expect, such as the telemetry exporter itself.
More info can be found in the following documentation: https://pkg.go.dev/go.opentelemetry.io/otel/bridge/opencensus#hdr-Migration_Guide
I have been able to test with a service that this configuration works as expected, in the image below we can see the cloudsqlconn metrics being exported to Google Cloud Monitoring as expected.
