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

ENH: add metrics into HTTP source #380

Merged

Conversation

chenqi0805
Copy link
Collaborator

@chenqi0805 chenqi0805 commented Oct 7, 2021

Description

This PR

  1. Introduces custom metrics into HTTP source as laid out in Adding metrics into http source #374
  2. Adds unit tests to cover metering invocation and measurement values
  3. Update README to document the introduced metrics.

Issues Resolved

#374

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@chenqi0805 chenqi0805 requested a review from cmanning09 October 8, 2021 15:25
- `requestProcessDuration`: measures latency of requests processed by the HTTP source plugin.

### Summary
- `payloadSummary`: measures the distribution of incoming requests payload sizes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the unit here?

I am concerned we are coupling the underlying metrics framework with the current name. I was confused by a payloadSummary. Why not call it payloadSize? I think that is more intuitive to our users.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. I can change it to payloadSize and specify the unit is in bytes

- `requestTimeouts`: measures total number of requests that time out in the HTTP source server.

### Timer
- `requestProcessDuration`: measures latency of requests processed by the HTTP source plugin.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add the unit for this metric.

@laneholloway laneholloway merged commit 795ade7 into opensearch-project:main Oct 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants