Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add histogram context manager and decorator #769

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

oldpatricka
Copy link

@oldpatricka oldpatricka commented May 5, 2023

This MR adds support for a new decorator for histograms, much the same as the distributed decorator. (It is heavily cribbed from same).

A decorator or context manager that will measure the histogram of a function's/context's run time using custom metric HISTOGRAM.

E.g. of usage follows:

@statsd.histogrammed('user.query.time', sample_rate=0.5)
def get_user(user_id):
    # Do what you need to ...
    pass

# Is equivalent to ...
with statsd.histogrammed('user.query.time', sample_rate=0.5):
    # Do what you need to ...
    pass

# Is equivalent to ...
start = time.time()
try:
    get_user(user_id)
finally:
    statsd.histogram('user.query.time', time.time() - start)

Requirements for Contributing to this repository

  • Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
  • The pull request must only fix one issue, or add one feature, at the time.
  • The pull request must update the test suite to demonstrate the changed functionality.
  • After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see CONTRIBUTING.

What does this PR do?

This adds a new histogrammed decorator that works much the same way as timed and distributed. I wanted to time a function using a histogram in my project, and added very similar code to my project to do so.

This implements #770

Description of the Change

This copies what is done with the distributed decorator extremely closely.

Alternate Designs

This is a simple change so no alternatives were considered.

Possible Drawbacks

I can't imagine any.

Verification Process

I ran a forked of the dogstatsd client against my datadog account and saw metrics appear as expected.

Additional Notes

N/A

Release Notes

N/A

Review checklist (to be filled by reviewers)

  • Feature or bug fix MUST have appropriate tests (unit, integration, etc...)
  • PR title must be written as a CHANGELOG entry (see why)
  • Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
  • PR must have one changelog/ label attached. If applicable it should have the backward-incompatible label attached.
  • PR should not have do-not-merge/ label attached.
  • If Applicable, issue must have kind/ and severity/ labels attached at least.

This MR adds support for a new decorator for histograms, much the same
as the distributed decorator. (It is heavily cribbed from same).

A decorator or context manager that will measure the histogram of a
function's/context's run time using custom metric HISTOGRAM.

E.g. of usage follows:

    @statsd.histogrammed('user.query.time', sample_rate=0.5)
    def get_user(user_id):
        # Do what you need to ...
        pass

    # Is equivalent to ...
    with statsd.histogrammed('user.query.time', sample_rate=0.5):
        # Do what you need to ...
        pass

    # Is equivalent to ...
    start = time.time()
    try:
        get_user(user_id)
    finally:
        statsd.histogram('user.query.time', time.time() - start)
@github-actions
Copy link

github-actions bot commented Jun 5, 2023

This issue has been automatically marked as stale because it has not had activity in the last 30 days.
Note that the issue will not be automatically closed, but this notification will remind us to investigate why there's been inactivity.

@github-actions github-actions bot added the stale Stale - Bot reminder label Jun 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale Stale - Bot reminder
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant