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

feat: Main Metrics Readme #278

Merged
merged 5 commits into from
Mar 26, 2024
Merged

feat: Main Metrics Readme #278

merged 5 commits into from
Mar 26, 2024

Conversation

davidterpay
Copy link
Contributor

No description provided.

@@ -114,7 +114,7 @@ var (
// ----------------------Metrics Config----------------------- //
// ----------------------------------------------------------- //
Metrics: config.MetricsConfig{},
UpdateInterval: 1500 * time.Millisecond,
UpdateInterval: 500 * time.Millisecond,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

lowering the interval since dYdX block time is less than 1s

Copy link

codecov bot commented Mar 25, 2024

Codecov Report

Attention: Patch coverage is 0% with 9 lines in your changes are missing coverage. Please review.

Project coverage is 62.11%. Comparing base (8bc8aeb) to head (f917e72).

❗ Current head f917e72 differs from pull request most recent head 662bf27. Consider uploading reports for the commit 662bf27 to get more accurate results

Files Patch % Lines
cmd/oracle/main.go 0.00% 8 Missing ⚠️
...oviders/base/websocket/metrics/ws_query_handler.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #278      +/-   ##
==========================================
- Coverage   62.19%   62.11%   -0.08%     
==========================================
  Files         215      215              
  Lines        9495     9503       +8     
==========================================
- Hits         5905     5903       -2     
- Misses       3045     3055      +10     
  Partials      545      545              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@davidterpay davidterpay marked this pull request as ready for review March 25, 2024 22:26
metrics.md Outdated Show resolved Hide resolved
metrics.md Outdated Show resolved Hide resolved
metrics.md Outdated Show resolved Hide resolved
metrics.md Outdated Show resolved Hide resolved
metrics.md Outdated Show resolved Hide resolved
metrics.md Show resolved Hide resolved
Comment on lines +13 to +14
- ./config/dydx/oracle.json:/oracle/oracle.json
- ./config/dydx/market.json:/oracle/market.json
Copy link
Collaborator

Choose a reason for hiding this comment

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

What is the docker-compose used in again? e2e tests?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

nothing, just running locally


# Metrics

> **Definitions**:
Copy link
Collaborator

Choose a reason for hiding this comment

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

🔥

This metric should be monotonically increasing for each (provider, market) pair. To verify that the rate of updates for each provider is as expected, you can run the following query in Prometheus:

```promql
rate(side_car_health_check_provider_updates_total{provider="coinbase_api", success="true"}[5m])
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm a little confused about why the success rate over 5m is like 2/3 for all of the providers in these examples.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm going to update so that we use the rate described above and follow up with explanations on the examples.

Copy link
Contributor

@nivasan1 nivasan1 left a comment

Choose a reason for hiding this comment

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

lgtm

@davidterpay davidterpay merged commit 3de8dc2 into main Mar 26, 2024
9 of 11 checks passed
@zrbecker zrbecker deleted the terpay/main-metrics-readme branch November 5, 2024 21:07
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.

4 participants