DT-732 AWS X-Ray tracing via OpenTelemetry #153
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
hugh-emerson
approved these changes
Jun 13, 2024
| @@ -73,6 +75,7 @@ class ADLdapLoginService( | |||
| @Blocking | |||
| private fun ldapBind(userDn: String, password: String): IADLdapLoginService.LdapLoginResult { | |||
| var context: InitialDirContext? = null | |||
| val span = ldapSpanFactory("AD-ldap-user-bind").startSpan() | |||
| return try { | |||
| context = ldapRepository.bind(userDn, password) | |||
There was a problem hiding this comment.
Does it make sense to do it inside ldapRepository.bind instead? Or are you deliberately not logging every lookup?
There was a problem hiding this comment.
We'd need another span for mapUserFromContext then (my understanding is that's also an LDAP call), and for running the block in useServiceUserBind. I think either would be fine but probably not worth changing
We almost always build in CI and invoking gradle twice slows it down
|
One thing I meant to mention: OpenTelemetry can also be used for metrics where we currently use MicroMeter, I don't think there's any rush to replace MicroMeter, especially as the OTel libraries aren't all stable, but something to keep in mind |
* Add note to Readme * Update comment in build.gradle.kts * Move LDAP bind inside LdapServiceUserBind span
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.
Description
There are two options for using X-Ray: the X-Ray SDK and OpenTelemetry. The SDK seems more mature, but only supports the servlet API. AWS seems to be encouraging use of OpenTelemetry, although the core library should be stable I've used several integrations which are in alpha.
Add support for OpenTelemetry to the auth service, including running a collector as a sidecar in ECS, all optionally enabled by a Terraform variable and associated feature flag, currently on only for the test environment.
The unit tests log spans to stderr, but otherwise the tracing is disabled locally by default, but can be abled using the feature flag and running the collector with a docker compose profile.
Local testing Tested a bit locally and on test. It definitely sends some stuff to AWS X-Ray, though I haven't tested much past that.
Release Normal Terraform apply. Feature flagged but should still be sanity tested on staging with the flag off.
Depends on communitiesuk/delta-common-infrastructure#420