tracing: observe modes and other tracing improvements. #5612
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
edwintorok
reviewed
May 2, 2024
edwintorok
reviewed
May 2, 2024
I think it's |
GabrielBuica
force-pushed
the
private/dbuica/CP-48195-tracing-observe-modes
branch
from
e01650c to
847aeba
Compare
|
Passed BST-BVT 197856 and some manual testing. |
mg12
reviewed
May 3, 2024
GabrielBuica
commented
May 3, 2024
lindig
approved these changes
May 3, 2024
It is not safe to access a global hashtable from multiple threads, even if the operations are read-only (it may be concurrently changed by another thread, which then may result in errors in the racing thread). This means we must always take the mutex, and because OCaml doesn't have a reader-writer mutex, we need to take the exclusive mutex. Eventually we should use a better datastructure here (immutable maps, or lock-free datastructures), but for now fix the datastructure that we currently use to be thread-safe. Signed-off-by: Edwin Török <[email protected]>
In preparation for OCaml 5, on OCaml 4 they'd be equivalent. Note that adding Atomic doesn't make operations on these values always atomic: that is the responsibility of surrounding code. E.g. Atomic.get + Atomic.set is not atomic, because another domain might've raced and changed the value inbetween (so in that case Atomic.compare_and_set should be used). However for global flags that are read multiple times, but set from a central place this isn't a problem. Signed-off-by: Edwin Török <[email protected]>
Sets `observe` to `false` until at least one tracer provider is enabled. If all tracer providers are disabled we set it back to `false`. Prior to this `observe` seemed to be always `true` (apart from unit tests). This would cause `with_tracing` to spam the logs with warnings `No provider found...` until at least one tracer provider is enabled. By setting `observe` to `false` as default and updating it depending on the state of the tracer providers, `with_tracing` should now execute no extra operations. Therefore, we avoid spamming the logs unnecessarily. Signed-off-by: Gabriel Buica <[email protected]>
GabrielBuica
force-pushed
the
private/dbuica/CP-48195-tracing-observe-modes
branch
from
5a627c8 to
f4eb5f2
Compare
lindig
approved these changes
May 7, 2024
ocaml/tests/test_observer.ml
Outdated
| @@ -405,6 +404,13 @@ let test_hashtbl_leaks () = | |||
| let test_trace_log_dir = trace_log_dir ~test_name:"test_hashtbl_leaks" () in | |||
| let __context = Test_common.make_test_database () in | |||
| let self = test_create ~__context ~enabled:true () in | |||
| let filter_export_spans span = | |||
| match Span.get_name span with | |||
| | "Tracing.flush_spans" | "Tracing.File.export" | "Tracing.Http.export" -> | |||
There was a problem hiding this comment.
These are very specific names. Can we be sure they arrive exactly like this? Otherwise it would be good to downcase them before the match.
There was a problem hiding this comment.
I've downcased them before matching.
Create a new unit test file `test_tracing.ml` for the `tracing` library. Add tests for `create`/`set`/`destroy` tracer providers. Now that we change the library to have `observe` modes based on whether or not we have `tracer providers` enabled, we want to make sure that functions on applied on tracer providers set the correct mode for the library. Signed-off-by: Gabriel Buica <[email protected]>
Removes code duplication in `storage_mux.ml` by using the already existing `with_dbg` implementation from `debuginfo` module. This should lower the chances of unintentionally introducing bugs by having to maintain two version of the same functions. e.g. Not using the no op when tracing is disabled and generating unwanted warning messages. Signed-off-by: Gabriel Buica <[email protected]>
Moves the following: - `create` under `TracerProvider`; - `set` under `TracerProvider`; - `destroy` under `TracerProvider; - `get_tracer_providers` unde `TracerProvider`; - `get_tracer` under `Tracer`. Adds documentation for `TracerProvider` module. It kept being confusing of what `Tracing.set` does unless I was going through the implementation again and again. Therefore, I moved some of the functions so that their functionality becomes (hopefully) more intuitive. Signed-off-by: Gabriel Buica <[email protected]>
GabrielBuica
force-pushed
the
private/dbuica/CP-48195-tracing-observe-modes
branch
from
f4eb5f2 to
43e26f3
Compare
mg12
approved these changes
May 17, 2024
|
Latest BVT+BST 198401 passed |
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.
As a follow-up to commenting out the warning when no tracer providers were enabled here #5583. This is meant to solve the issue of spamming the logs by properly setting the observe mode inside the library.
This is based on top of #5601 that addresses missing lock in the library.
Some other improvements: