internal/namingschema: add package for selecting and working with the naming schema #1819
+729
−3
Conversation
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
rarguelloF
force-pushed
the
rarguelloF/naming-schema-api
branch
from
8ca3243 to
2ed5fdb
Compare
amarziali
previously approved these changes
Mar 27, 2023
rarguelloF
force-pushed
the
rarguelloF/naming-schema-api
branch
from
feb6d72 to
f3c7822
Compare
ahmed-mez
reviewed
Mar 29, 2023
…1834) * internal/namingschema: remove init method * ddtrace/tracer: add attribute schema version config variable and tag
rarguelloF
force-pushed
the
rarguelloF/naming-schema-api
branch
from
e42132a to
2e3b0a7
Compare
ahmed-mez
previously approved these changes
Apr 3, 2023
ahmed-mez
approved these changes
Apr 3, 2023
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.
What does this PR do?
(This PR also includes changes from #1834)
Adds
internal/namingschemapackage, which provides functionality to create naming schemas used by integrations to set different service and span/operation names based on the value of theDD_TRACE_SPAN_ATTRIBUTE_SCHEMAenvironment variable.It also provides some already implemented schemas for common use cases (client-server, db, messaging, etc.).
How to use this package:
VersionSupportSchemainterface containing the correct name for each version.Schemausing theNewfunction.Schema.GetNameto get the correct name based on the user selected schema.Alternatively, the following functions can be used to get already implemented schemas for common use cases:
NewServiceNameSchema-> will be used by most integrations, the behavior is: in-code override >DD_SERVICEenvironment variable > integration default name.NewClientOutboundOp-> will be used by client integrations (i.e. http or grpc clients)NewHTTPClientOp-> specific forhttpNewGRPCClientOp-> specific forgrpcNewServerInboundOp-> will be used by server integrations (i.e. http or grpc servers)NewHTTPServerOp-> specific forhttpNewGRPCServerOp-> specific forgrpcNewDBOutboundOp-> will be used by integrations classified as DBNewElasticsearchOutboundOp-> specific for elasticsearch.NewCacheOutboundOp-> will be used by integrations classified as cacheNewMemcachedOutboundOp-> specific for memcached.NewMessagingOutboundOp-> will be used by integrations classified as messagingNewKafkaOutboundOp-> specific forkafkaintegrationsNewMessagingInboundOp-> will be used by integrations classified as messagingNewKafkaInboundOp-> specific forkafkaintegrationsSince
v0(current state) doesn't generally follow any structure among integrations, theWithVersionOverrideoption is provided to not break any existing behavior.Motivation
To bring uniformity to span names and service names across integrations and tracers.
This package is designed this way to easily update schemas in the codebase when new versions are released (update
VersionSupportSchemainterface and update implementations until build is fixed).Describe how to test/QA your changes
Reviewer's Checklist
Triagemilestone is set.