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(mgmt): update metrics endpoints to serve new dashboard design #435

Merged
merged 5 commits into from
Nov 20, 2024

Conversation

jvallesm
Copy link
Collaborator

@jvallesm jvallesm commented Aug 22, 2024

Because

  • Pipeline and credit endpoints have different params and schemas.
  • Some of the information served by the existing endpoints will be handled by the pipeline run feature.

This commit

  • Adds endpoints to serve the new dashboard design:
    • GetPipelineTriggerCount path is updated to align with API guidelines.
    • ListCreditConsumptionChartRecords path is updated to align with API guidelines (previous path will be kept in the gateway to keep the current UX running).
    • ListPipelineTriggerChartRecords is added.
  • A separate PR will take care of removing the deprecated endpoints once the new dashboard is rolled out.

@jvallesm jvallesm self-assigned this Aug 22, 2024
Copy link

linear bot commented Aug 22, 2024

@jvallesm jvallesm changed the title y feat(mgmt): update metrics endpoints to serve new dashboard design Aug 22, 2024
@jvallesm jvallesm force-pushed the jvalles/ins-5379-credit-dashboard-endpoints branch from e4e7c4a to d1807cf Compare October 4, 2024 10:59
Copy link

github-actions bot commented Oct 4, 2024

The latest Buf updates on your PR. Results from workflow Buf CI / buf (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed❌ failed (1)✅ passed✅ passedNov 20, 2024, 4:58 PM

The new path reflects that the endpoint isn't resource-oriented and that
it is a custom method.
As a non-resource-based endpoint, this path is aligned with the pipeline
and model chart endpoints.
@jvallesm jvallesm force-pushed the jvalles/ins-5379-credit-dashboard-endpoints branch from d7d4b49 to 5d4c17e Compare November 20, 2024 16:58
@jvallesm jvallesm marked this pull request as ready for review November 20, 2024 17:00
@jvallesm jvallesm merged commit 0cfe99f into main Nov 20, 2024
1 check passed
@jvallesm jvallesm deleted the jvalles/ins-5379-credit-dashboard-endpoints branch November 20, 2024 17:01
jvallesm added a commit to instill-ai/api-gateway that referenced this pull request Nov 26, 2024
Because

- Pipeline and credit endpoints have different params and schemas.
- Some of the information served by the existing endpoints will be
handled by the pipeline run feature.

This commit

- Applies contracts defined in
instill-ai/protobufs#435
jvallesm added a commit to instill-ai/mgmt-backend that referenced this pull request Nov 26, 2024
Because

- The new dashboard introduces changes in the metrics endpoints.

This commit

- Applies contracts defined in
instill-ai/protobufs#435, keeping the API
backwards-compatible.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: 🚧 Planned
Development

Successfully merging this pull request may close these issues.

2 participants