Implement minutely probes #199
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
Implement a minutely probes system, heavily borrowing from the one in our Ruby integration.
unflxw
commented
Mar 14, 2024
Comment on lines
+9
to
+19
| from appsignal import probes, set_gauge | ||
|
|
||
| def new_carts(previous_carts=None): | ||
| current_carts = Cart.objects.all().count() | ||
|
|
||
| if previous_carts is not None: | ||
| set_gauge("new_carts", current_carts - previous_carts) | ||
|
|
||
| return current_carts | ||
|
|
||
| probes.register("new_carts", new_carts) |
There was a problem hiding this comment.
@noccor I borrowed from your draft for this example :)
The probe taking an argument and returning a value is optional, though it avoids having to make queries that explicitly say "one minute ago". The following is also okay:
# takes no arguments
def new_carts():
set_gauge("new_carts", count_new_carts_somehow())
# returns nothing
probes.register("new_carts", new_carts)
There was a problem hiding this comment.
@unflxw - amazing! Thank you so much for getting this into action so quickly 🙇
jeffkreeftmeijer
approved these changes
Mar 15, 2024
|
Apologies to @jeffkreeftmeijer, who had already reviewed this, but I ended up significantly altering the implementation to make it thread-safe and test how the thread is started, so I'm asking for a re-review. 🙇 |
unflxw
force-pushed
the
implement-minutely-probes
branch
from
78094bd to
f6216b7
Compare
Implement a config option that globally enables or disables the minutely probes system, in line with our other integrations. When disabled by the config option, the minutely probes system can still be manually enabled by calling `appsignal.probes.start()`. Ensure that calling this function multiple times will not result in the probes running multiple times per minute. Add a lock around registering, unregistering and executing probes to prevent race conditions where e.g. a probe's unregistering takes place halfway through its execution.
These functions are already in the `appsignal.opentelemetry` method, they do not need to have `_opentelemetry` in their name.
Got in a bit of a pickle to make the thread initialization testable. When `client.start()` was called, a thread was spawned, so I had to implement a way to stop these threads from executing during other tests (hence `client.stop()`) All other tests continue to call `_run_probes` directly because the resulting behaviour is easier to reason about.
Update the diagnose tests submodule for `enable_minutely_probes` to be expected for Python.
unflxw
force-pushed
the
implement-minutely-probes
branch
from
f6216b7 to
41e9bc7
Compare
This is a message from the daily scheduled checks. |
luismiramirez
approved these changes
Mar 18, 2024
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.
Implement minutely probes
Implement a minutely probes system, heavily borrowing from the one
in our Ruby integration.
Implement enable_minutely_probes config option
Implement a config option that globally enables or disables the
minutely probes system, in line with our other integrations.
When disabled by the config option, the minutely probes system can
still be manually enabled by calling
appsignal.probes.start().Ensure that calling this function multiple times will not result in
the probes running multiple times per minute.
Add a lock around registering, unregistering and executing probes
to prevent race conditions where e.g. a probe's unregistering takes
place halfway through its execution.
Rename _opentelemetry functions
These functions are already in the
appsignal.opentelemetrymethod,they do not need to have
_opentelemetryin their name.Test start and stop methods
Got in a bit of a pickle to make the thread initialization testable.
When
client.start()was called, a thread was spawned, so I had toimplement a way to stop these threads from executing during other
tests (hence
client.stop())All other tests continue to call
_run_probesdirectly because theresulting behaviour is easier to reason about.
Fixes #129. See appsignal/test-setups#189 for a test setup.