feat!: Separate logical MySQL host from connected host #487
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
MySQL server instances have a logical host name and an instance node names. This is particularly useful when running in clustered mode where a logical hostname is used to connect to a cluster but you also want to record what specific node is executing your query. Trilogy exposes the instance node name via `@connected_host` as well as the configured `host` name in its `connection_options`. This breaking change ensures that the `net.peer.name` is always set to the logical host name, while the individual instance name is being recorded in a separate attribute.
arielvalentin
changed the title
arielvalentin
commented
May 31, 2023
| } | ||
|
|
||
| attributes[::OpenTelemetry::SemanticConventions::Trace::DB_NAME] = database_name if database_name | ||
| attributes[::OpenTelemetry::SemanticConventions::Trace::PEER_SERVICE] = config[:peer_service] unless config[:peer_service].nil? | ||
| attributes['db.mysql.instance.host.name'] = @connected_host if defined?(@connected_host) |
There was a problem hiding this comment.
I have no idea what this be named and I am struggling here.
What do you think @adrianna-chang-shopify @cschleiden ?
There was a problem hiding this comment.
cc: @open-telemetry/specs-semconv-approvers I could use some of your input/feedback here as well.
There was a problem hiding this comment.
I see https://github.com/open-telemetry/opentelemetry-ruby/blob/main/semantic_conventions/lib/opentelemetry/semantic_conventions/trace.rb#L71 for something similar for MSSQL
looking at open-telemetry/opentelemetry-specification#3402, maybe
db.mysql.instance.address or db.mysql.address? But db.mysql.instance.host.name would also work for me
There was a problem hiding this comment.
cc: @andyedison
cschleiden
approved these changes
May 31, 2023
| } | ||
|
|
||
| attributes[::OpenTelemetry::SemanticConventions::Trace::DB_NAME] = database_name if database_name | ||
| attributes[::OpenTelemetry::SemanticConventions::Trace::PEER_SERVICE] = config[:peer_service] unless config[:peer_service].nil? | ||
| attributes['db.mysql.instance.host.name'] = @connected_host if defined?(@connected_host) |
There was a problem hiding this comment.
I see https://github.com/open-telemetry/opentelemetry-ruby/blob/main/semantic_conventions/lib/opentelemetry/semantic_conventions/trace.rb#L71 for something similar for MSSQL
looking at open-telemetry/opentelemetry-specification#3402, maybe
db.mysql.instance.address or db.mysql.address? But db.mysql.instance.host.name would also work for me
cschleiden
reviewed
May 31, 2023
instrumentation/trilogy/lib/opentelemetry/instrumentation/trilogy/patches/client.rb
Outdated
Show resolved
Hide resolved
…ogy/patches/client.rb Co-authored-by: Christopher Schleiden <cschleiden@live.de>
arielvalentin
requested review from
fbogsany,
mwear,
robertlaurin,
dazuma,
ericmustin,
ahayworth,
plantfansam and
robbkidd
as code owners
ericmustin
approved these changes
Jun 1, 2023
There was a problem hiding this comment.
lgtm, may wanna confirm with known users of the instrumentation (cc @adrianna-chang-shopify ) that this works for them.
|
ah @arielvalentin looks like a couple typos, my apols on the early approval, that aside this lgtm |
ericmustin
reviewed
Jun 1, 2023
instrumentation/trilogy/test/opentelemetry/instrumentation/trilogy/instrumentation_test.rb
Outdated
Show resolved
Hide resolved
ericmustin
reviewed
Jun 1, 2023
instrumentation/trilogy/test/opentelemetry/instrumentation/trilogy/instrumentation_test.rb
Outdated
Show resolved
Hide resolved
cschleiden
approved these changes
Jun 1, 2023
plantfansam
approved these changes
Jun 1, 2023
arielvalentin
added a commit
to arielvalentin/semantic-conventions
that referenced
this pull request
Sep 26, 2023
At GitHub we run MySQL in multi-node clusters and are often interested in knowing the hostname of a node that is executing a query or command. In order to acheive this we added an attribute to the Trilogy instrumentation named `db.mysql.instance.address` which is populated with the hostname of the node: <open-telemetry/opentelemetry-ruby-contrib#487> This change adds the attribute to the database model as a MySQL specific connection attribute.
3 tasks
arielvalentin
added a commit
to arielvalentin/semantic-conventions
that referenced
this pull request
Nov 15, 2023
At GitHub we run MySQL in multi-node clusters and are often interested in knowing the hostname of a node that is executing a query or command. In order to acheive this we added an attribute to the Trilogy instrumentation named `db.mysql.instance.address` which is populated with the hostname of the node: <open-telemetry/opentelemetry-ruby-contrib#487> This change adds the attribute to the database model as a MySQL specific connection attribute.
arielvalentin
added a commit
to arielvalentin/semantic-conventions
that referenced
this pull request
Nov 19, 2023
At GitHub we run MySQL in multi-node clusters and are often interested in knowing the hostname of a node that is executing a query or command. In order to acheive this we added an attribute to the Trilogy instrumentation named `db.mysql.instance.address` which is populated with the hostname of the node: <open-telemetry/opentelemetry-ruby-contrib#487> This change adds the attribute to the database model as a MySQL specific connection attribute.
arielvalentin
added a commit
to arielvalentin/semantic-conventions
that referenced
this pull request
Nov 19, 2023
At GitHub we run MySQL in multi-node clusters and are often interested in knowing the hostname of a node that is executing a query or command. In order to acheive this we added an attribute to the Trilogy instrumentation named `db.mysql.instance.address` which is populated with the hostname of the node: <open-telemetry/opentelemetry-ruby-contrib#487> This change adds the attribute to the database model as a MySQL specific connection attribute.
Closed
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.
MySQL server instances have a logical host name and an instance node names.
This is particularly useful when running in clustered mode where a logical hostname is used to connect to a cluster but you also want to record what specific node is executing your query.
Trilogy exposes the instance node name via
@connected_hostas well as the configuredhostname in itsconnection_options.This breaking change ensures that the
net.peer.nameis always set to the logical host name, while the individual instance name is being recorded in a separate attribute.cc: @cschleiden