logdetective 0.10.0__tar.gz → 0.11.1__tar.gz

{logdetective-0.10.0 → logdetective-0.11.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: logdetective
-Version: 0.10.0
+Version: 0.11.1
 Summary: Log using LLM AI to search for build/test failures and provide ideas for fixing these.
 License: Apache-2.0
 Author: Jiri Podivin
@@ -358,7 +358,7 @@ using either a browser, the `curl` or the `http` command (provided by the `httpi
 
 When no time period is specified, the query defaults to the last 2 days:
 
-You can view requests and responses statistics
+You can view requests, responses and emojis statistics
  - for the `/analyze` endpoint at http://localhost:8080/metrics/analyze
  - for the `/analyze-staged` endpoint at http://localhost:8080/metrics/analyze-staged.
  - for the requests coming from gitlab: http://localhost:8080/metrics/analyze-gitlab.
@@ -370,6 +370,7 @@ You can retrieve single svg images at the following endpoints:
  - http://localhost:8080/metrics/analyze-staged/responses
  - http://localhost:8080/metrics/analyze-gitlab/requests
  - http://localhost:8080/metrics/analyze-gitlab/responses
+ - http://localhost:8080/metrics/analyze-gitlab/emojis
 
 Examples:
 

{logdetective-0.10.0 → logdetective-0.11.1}/README.md

@@ -315,7 +315,7 @@ using either a browser, the `curl` or the `http` command (provided by the `httpi
 
 When no time period is specified, the query defaults to the last 2 days:
 
-You can view requests and responses statistics
+You can view requests, responses and emojis statistics
  - for the `/analyze` endpoint at http://localhost:8080/metrics/analyze
  - for the `/analyze-staged` endpoint at http://localhost:8080/metrics/analyze-staged.
  - for the requests coming from gitlab: http://localhost:8080/metrics/analyze-gitlab.
@@ -327,6 +327,7 @@ You can retrieve single svg images at the following endpoints:
  - http://localhost:8080/metrics/analyze-staged/responses
  - http://localhost:8080/metrics/analyze-gitlab/requests
  - http://localhost:8080/metrics/analyze-gitlab/responses
+ - http://localhost:8080/metrics/analyze-gitlab/emojis
 
 Examples:
 

{logdetective-0.10.0 → logdetective-0.11.1}/logdetective/server/database/models/merge_request_jobs.py

@@ -1,6 +1,6 @@
 import enum
 import datetime
-from typing import Optional, List
+from typing import Optional, List, Tuple
 
 import backoff
 
@@ -585,3 +585,19 @@ class Reactions(Base):
             with transaction(commit=True) as session:
                 session.delete(reaction)
                 session.flush()
+
+    @classmethod
+    def get_since(
+        cls, time: datetime.datetime
+    ) -> List[Tuple[datetime.datetime, "Comments"]]:
+        """Get all the reactions on comments created after the given time
+        and the comment creation time."""
+        with transaction(commit=False) as session:
+            reactions = (
+                session.query(Comments.created_at, cls)
+                .join(Comments, cls.comment_id == Comments.id)
+                .filter(Comments.created_at > time)
+                .all()
+            )
+
+            return reactions

{logdetective-0.10.0 → logdetective-0.11.1}/logdetective/server/llm.py

@@ -115,7 +115,7 @@ def we_give_up(details: backoff._typing.Details):
 
 
 @backoff.on_exception(
-    backoff.expo,
+    lambda: backoff.constant([10, 30, 120]),
     aiohttp.ClientResponseError,
     max_tries=3,
     giveup=should_we_giveup,

{logdetective-0.10.0 → logdetective-0.11.1}/logdetective/server/metric.py

@@ -84,7 +84,24 @@ def update_metrics(
 
 def track_request(name=None):
     """
-    Decorator to track requests metrics
+    Decorator to track requests/responses metrics
+
+    On entering the decorated function, it registers the time for the request
+    and saves the passed log content.
+    On exiting the decorated function, it registers the time for the response
+    and saves the generated response.
+
+    Use it to decorate server endpoints that generate a llm response
+    as in the following example:
+
+    >>> @app.post("/analyze", response_model=Response)
+    >>> @track_request()
+    >>> async def analyze_log(build_log)
+    >>>     pass
+
+    Warning: the decorators' order is important!
+    The function returned by the *track_request* decorator is the
+    server API function we want to be called by FastAPI.
     """
 
     def decorator(f):

{logdetective-0.10.0 → logdetective-0.11.1}/logdetective/server/plot.py

@@ -1,13 +1,18 @@
 import datetime
-from typing import Optional, Union
+from typing import Optional, Union, Dict
 
 import numpy
 import matplotlib
 import matplotlib.figure
 import matplotlib.pyplot
 
+from matplotlib.pyplot import cm
 from logdetective.server import models
-from logdetective.server.database.models import AnalyzeRequestMetrics, EndpointType
+from logdetective.server.database.models import (
+    AnalyzeRequestMetrics,
+    EndpointType,
+    Reactions,
+)
 
 
 class Definition:
@@ -145,13 +150,19 @@ def _add_bar_chart(
     ax.grid(True, alpha=0.3)
 
 
-def _add_line_chart(
-    ax: matplotlib.figure.Axes, timestamps: numpy.array, values: numpy.array, label: str
-) -> None:
+def _add_line_chart(  # pylint: disable=too-many-arguments disable=too-many-positional-arguments
+    ax: matplotlib.figure.Axes,
+    timestamps: numpy.array,
+    values: numpy.array,
+    label: str,
+    color: str = "red",
+    set_label: bool = True,
+):
     """Add a red line chart"""
-    ax.plot(timestamps, values, "r-", linewidth=2, label=label)
-    ax.set_ylabel(label, color="red")
-    ax.tick_params(axis="y", labelcolor="red")
+    ax.plot(timestamps, values, color=color, linestyle="-", linewidth=2, label=label)
+    if set_label:
+        ax.set_ylabel(label, color=color)
+        ax.tick_params(axis="y", labelcolor=color)
 
 
 def requests_per_time(
@@ -249,7 +260,9 @@ def average_time_per_responses(  # pylint: disable=too-many-locals
     )
 
     fig, ax1 = matplotlib.pyplot.subplots(figsize=(12, 6))
-    _add_bar_chart(ax1, plot_def, timestamps, average_time, "average response time (seconds)")
+    _add_bar_chart(
+        ax1, plot_def, timestamps, average_time, "average response time (seconds)"
+    )
 
     responses_average_length = (
         AnalyzeRequestMetrics.get_responses_average_length_in_period(
@@ -279,3 +292,138 @@ def average_time_per_responses(  # pylint: disable=too-many-locals
     matplotlib.pyplot.tight_layout()
 
     return fig
+
+
+def _collect_emoji_data(
+    start_time: datetime.datetime, plot_def: Definition
+) -> Dict[str, Dict[datetime.datetime, int]]:
+    """Collect and organize emoji feedback data
+
+    Counts all emojis given to logdetective comments created since start_time.
+    Collect counts in time accordingly to the plot definition.
+    """
+    reactions = Reactions.get_since(start_time)
+    reactions_values_dict: Dict[str, Dict] = {}
+    for comment_created_at, reaction in reactions:
+        comment_created_at_formatted = comment_created_at.strptime(
+            comment_created_at.strftime(plot_def.time_format), plot_def.time_format
+        )
+        if reaction.reaction_type in reactions_values_dict:
+            reaction_values_dict = reactions_values_dict[reaction.reaction_type]
+            if comment_created_at_formatted in reaction_values_dict:
+                reaction_values_dict[comment_created_at_formatted] += reaction.count
+            else:
+                reaction_values_dict[comment_created_at_formatted] = reaction.count
+        else:
+            reaction_values_dict = {comment_created_at_formatted: reaction.count}
+            reactions_values_dict.update({reaction.reaction_type: reaction_values_dict})
+
+    return reactions_values_dict
+
+
+def _plot_emoji_data(  # pylint: disable=too-many-locals
+    ax: matplotlib.figure.Axes,
+    reactions_values_dict: Dict[str, Dict[datetime.datetime, int]],
+    plot_def: Definition,
+    start_time: datetime.datetime,
+    end_time: datetime.datetime,
+):
+    """Plot each emoji's data on its own axis."""
+    emoji_lines = {}
+    emoji_labels = {}
+
+    # Find global min and max y values to set consistent scale
+    all_counts = []
+    for emoji, dict_counts in reactions_values_dict.items():
+        timestamps, counts = create_time_series_arrays(
+            dict_counts, plot_def, start_time, end_time
+        )
+        all_counts.extend(counts)
+
+    colors = [cm.viridis(i) for i in numpy.linspace(0, 1, len(reactions_values_dict))]    # pylint: disable=no-member
+
+    first_emoji = True
+    for i, (emoji, dict_counts) in enumerate(reactions_values_dict.items()):
+        timestamps, counts = create_time_series_arrays(
+            dict_counts, plot_def, start_time, end_time
+        )
+
+        if first_emoji:
+            current_ax = ax
+            first_emoji = False
+        else:
+            current_ax = ax.twinx()
+            current_ax.spines["right"].set_position(("outward", 60 * (i - 1)))
+
+        _add_line_chart(current_ax, timestamps, counts, f"{emoji}", colors[i], False)
+        emoji_lines[emoji], emoji_labels[emoji] = current_ax.get_legend_handles_labels()
+
+        # Set the same y-limits for all axes
+        current_ax.set_ylim(0, max(all_counts) * 1.1)
+
+        # Only show y-ticks on the first axis to avoid clutter
+        if 0 < i < len(reactions_values_dict):
+            current_ax.set_yticks([])
+
+    return emoji_lines, emoji_labels
+
+
+def emojis_per_time(
+    period_of_time: models.TimePeriod,
+    end_time: Optional[datetime.datetime] = None,
+) -> matplotlib.figure.Figure:
+    """
+    Generate a visualization of overall emoji feedback
+    over a specified time period.
+
+    This function creates a multiple-axis plot showing
+    a line chart for every found emoji
+
+    The time intervals are determined by the provided TimePeriod object, which defines
+    the granularity and formatting of the time axis.
+
+    Args:
+        period_of_time: A TimePeriod object that defines the time period and interval
+                        for the analysis (e.g., hourly, daily, weekly)
+        end_time: The end time for the analysis period. If None, defaults to the current
+                  UTC time
+
+    Returns:
+        A matplotlib Figure object containing the generated visualization
+    """
+    plot_def = Definition(period_of_time)
+    end_time = end_time or datetime.datetime.now(datetime.timezone.utc)
+    start_time = period_of_time.get_period_start_time(end_time)
+    reactions_values_dict = _collect_emoji_data(start_time, plot_def)
+
+    fig, ax = matplotlib.pyplot.subplots(figsize=(12, 6))
+
+    emoji_lines, emoji_labels = _plot_emoji_data(
+        ax, reactions_values_dict, plot_def, start_time, end_time
+    )
+
+    matplotlib.pyplot.title(
+        f"Emoji feedback ({start_time.strftime(plot_def.time_format)} "
+        f"to {end_time.strftime(plot_def.time_format)})"
+    )
+
+    all_lines = []
+    for lines in emoji_lines.values():
+        all_lines.extend(lines)
+    all_labels = []
+    for labels in emoji_labels.values():
+        all_labels.extend(labels)
+
+    ax.legend(all_lines, all_labels, loc="upper left")
+    ax.set_xlabel("Time")
+    ax.set_ylabel("Count")
+
+    # Format x-axis
+    ax.xaxis.set_major_formatter(matplotlib.dates.DateFormatter(plot_def.time_format))
+    ax.xaxis.set_major_locator(plot_def.locator)
+    ax.tick_params(axis="x", labelrotation=45)
+    ax.grid(True, alpha=0.3)
+
+    matplotlib.pyplot.tight_layout()
+
+    return fig

{logdetective-0.10.0 → logdetective-0.11.1}/logdetective/server/server.py

@@ -158,8 +158,8 @@ async def analyze_log(
     return Response(explanation=response, response_certainty=certainty)
 
 
-@track_request()
 @app.post("/analyze/staged", response_model=StagedResponse)
+@track_request()
 async def analyze_log_staged(
     build_log: BuildLog, http_session: aiohttp.ClientSession = Depends(get_http_session)
 ):
@@ -420,6 +420,7 @@ class Plot(str, Enum):
 
     REQUESTS = "requests"
     RESPONSES = "responses"
+    EMOJIS = "emojis"
     BOTH = ""
 
 
@@ -450,12 +451,16 @@ async def get_metrics(
                 period_since_now, endpoint_type
             )
             return _svg_figure_response(fig)
+        if plot == Plot.EMOJIS:
+            fig = plot_engine.emojis_per_time(period_since_now)
+            return _svg_figure_response(fig)
         # BOTH
         fig_requests = plot_engine.requests_per_time(period_since_now, endpoint_type)
         fig_responses = plot_engine.average_time_per_responses(
             period_since_now, endpoint_type
         )
-        return _multiple_svg_figures_response([fig_requests, fig_responses])
+        fig_emojis = plot_engine.emojis_per_time(period_since_now)
+        return _multiple_svg_figures_response([fig_requests, fig_responses, fig_emojis])
 
     descriptions = {
         Plot.REQUESTS: (
@@ -466,6 +471,10 @@ async def get_metrics(
             "Show statistics for responses given in the specified period of time "
             f"for the /{endpoint_type.value} API endpoint."
         ),
+        Plot.EMOJIS: (
+            "Show statistics for emoji feedback in the specified period of time "
+            f"for the /{endpoint_type.value} API endpoint."
+        ),
         Plot.BOTH: (
             "Show statistics for requests and responses in the given period of time "
             f"for the /{endpoint_type.value} API endpoint."

{logdetective-0.10.0 → logdetective-0.11.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "logdetective"
-version = "0.10.0"
+version = "0.11.1"
 description = "Log using LLM AI to search for build/test failures and provide ideas for fixing these."
 authors = ["Jiri Podivin <jpodivin@gmail.com>"]
 license = "Apache-2.0"