Skip to content
This repository was archived by the owner on Feb 15, 2025. It is now read-only.

feat(sdk): observability hooks #296

Open
16 tasks
gerred opened this issue Mar 21, 2024 · 0 comments
Open
16 tasks

feat(sdk): observability hooks #296

gerred opened this issue Mar 21, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@gerred
Copy link
Contributor

gerred commented Mar 21, 2024

User Story: Implement hooks for observability in the backends SDK

As a backend developer
I want hooks in the SDK to expose relevant inferencing performance metrics
So that I can monitor and optimize the performance of my backend systems

Acceptance Criteria:

  • Identify the key performance metrics related to inferencing in the backends
  • Define a set of hooks or extension points in the SDK to capture these metrics
  • Implement the hooks in the SDK to collect relevant metrics such as:
  • Inference request latency
  • Number of inference requests processed
  • Resource utilization (CPU, memory) during inferencing
  • Error rates and error types during inferencing
  • Provide configuration options to enable or disable the observability hooks
  • Ensure the hooks have minimal performance overhead and do not significantly impact the inferencing process
  • Expose the collected metrics through a standardized format or interface (e.g., Prometheus metrics, logging)
  • Document the available hooks, their purpose, and how to use them in the SDK documentation
  • Provide code samples and tutorials demonstrating how to leverage the observability hooks in backend implementations
  • Conduct performance tests to validate that the hooks do not introduce any significant performance degradation
  • Integrate the observability hooks with popular monitoring and alerting tools
  • Gather feedback from backend developers on the usefulness and ease of use of the observability hooks
  • Iterate on the hooks based on the feedback and real-world usage to improve their effectiveness
@jalling97 jalling97 added the enhancement New feature or request label Sep 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants